org.opencms.security

类 CmsPrincipal

java.lang.Object

org.opencms.security.CmsPrincipal

所有已实现的接口:

java.lang.Comparable<I_CmsPrincipal>, java.security.Principal, I_CmsPrincipal

直接已知子类:

CmsGroup, CmsHistoryPrincipal, CmsUser

public abstract class CmsPrincipal
extends java.lang.Object
implements I_CmsPrincipal, java.lang.Comparable<I_CmsPrincipal>

Common methods shared among user and group principals, also contains several utility functions to deal with principal instances.

从以下版本开始:

6.2.0

字段概要

字段

限定符和类型	字段和说明
protected java.lang.String	m_description The description of this principal.
protected int	m_flags The flags of this principal.
protected CmsUUID	m_id The unique id of this principal.
protected java.lang.String	m_name The fully qualified name of this principal.

从接口继承的字段 org.opencms.security.I_CmsPrincipal

FLAG_CORE_LIMIT, FLAG_DISABLED, FLAG_ENABLED, FLAG_GROUP_PROJECT_MANAGER, FLAG_GROUP_PROJECT_USER, FLAG_GROUP_ROLE, FLAG_GROUP_VIRTUAL, FLAG_USER_MANAGED, FLAG_USER_WEBUSER, PRINCIPAL_GROUP, PRINCIPAL_USER

构造器概要

构造器

限定符	构造器和说明
protected	CmsPrincipal() Empty constructor for subclassing.

方法概要

方法

限定符和类型	方法和说明
int	compareTo(I_CmsPrincipal obj)
boolean	equals(java.lang.Object obj) Compares the given object with this principal.
static java.util.List<? extends CmsPrincipal>	filterCoreFlag(java.util.List<? extends CmsPrincipal> principals, int flag) Filters out all principals that do not have the given flag set, but leaving principals with flags less than I_CmsPrincipal.FLAG_CORE_LIMIT untouched.
static java.util.List<CmsGroup>	filterCoreGroups(java.util.List<CmsGroup> groups) Filters out all groups with flags greater than I_CmsPrincipal.FLAG_CORE_LIMIT.
static java.util.List<CmsUser>	filterCoreUsers(java.util.List<CmsUser> users) Filters out all users with flags greater than I_CmsPrincipal.FLAG_CORE_LIMIT.
static java.util.List<? extends CmsPrincipal>	filterFlag(java.util.List<? extends CmsPrincipal> principals, int flag) Filters out all principals that do not have the given flag set.
java.lang.String	getDescription() Returns the description of this principal.
java.lang.String	getDisplayName(CmsObject cms, java.util.Locale locale) Returns the display name of this principal including the organizational unit.
java.lang.String	getDisplayName(CmsObject cms, java.util.Locale locale, I_CmsGroupNameTranslation translation) Returns the translated display name of this principal if it is a group and the display name otherwise.
int	getFlags() Returns the flags of this principal.
CmsUUID	getId() Returns the unique id of this principal.
java.lang.String	getName() Returns the fully qualified name of this principal.
java.lang.String	getOuFqn() Returns the fully qualified name of the associated organizational unit.
static java.lang.String	getPrefixedGroup(java.lang.String name) Returns the provided group name prefixed with I_CmsPrincipal.PRINCIPAL_GROUP.
java.lang.String	getPrefixedName() Returns this principals unique name prefixed with it's type.
static java.lang.String	getPrefixedUser(java.lang.String name) Returns the provided user name prefixed with I_CmsPrincipal.PRINCIPAL_USER.
java.lang.String	getSimpleName() Returns the simple name of this organizational unit.
int	hashCode() Returns the hash code of this object.
boolean	isEnabled() Returns true if this principal is enabled.
boolean	isGroup() Returns true if this principal is of type CmsGroup.
boolean	isUser() Returns true if this principal is of type CmsUser.
static I_CmsPrincipal	readPrefixedPrincipal(CmsObject cms, java.lang.String name) Utility function to read a prefixed principal from the OpenCms database using the provided OpenCms user context.
static I_CmsPrincipal	readPrincipal(CmsObject cms, CmsUUID id) Utility function to read a principal by its id from the OpenCms database using the provided OpenCms user context.
static I_CmsPrincipal	readPrincipal(CmsObject cms, java.lang.String type, java.lang.String name) Utility function to read a principal of the given type from the OpenCms database using the provided OpenCms user context.
static I_CmsPrincipal	readPrincipalIncludingHistory(CmsObject cms, CmsUUID id) Utility function to read a principal by its id from the OpenCms database using the provided OpenCms user context.
void	setDescription(java.lang.String description) Sets the description of this principal.
void	setEnabled(boolean enabled) Enables (or disables) this principal, depending on the given status.
void	setFlags(int value) Sets this principals flags to the specified value.
void	setName(java.lang.String name) Sets the unique name of this principal.

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.opencms.security.I_CmsPrincipal

checkName

从接口继承的方法 java.security.Principal

toString

字段详细资料

m_description

protected java.lang.String m_description

The description of this principal.

m_flags

protected int m_flags

The flags of this principal.

m_id

protected CmsUUID m_id

The unique id of this principal.

m_name

protected java.lang.String m_name

The fully qualified name of this principal.

构造器详细资料

CmsPrincipal

protected CmsPrincipal()

Empty constructor for subclassing.

方法详细资料

filterCoreFlag

public static java.util.List<? extends CmsPrincipal> filterCoreFlag(java.util.List<? extends CmsPrincipal> principals,
                                                    int flag)

Filters out all principals that do not have the given flag set, but leaving principals with flags less than I_CmsPrincipal.FLAG_CORE_LIMIT untouched.

The given parameter list is directly modified, so the returned list is the same object as the input list.

参数:

principals - a list of CmsPrincipal objects

flag - the flag for filtering

返回:

the filtered principal list

filterCoreGroups

public static java.util.List<CmsGroup> filterCoreGroups(java.util.List<CmsGroup> groups)

Filters out all groups with flags greater than I_CmsPrincipal.FLAG_CORE_LIMIT.

The given parameter list is directly modified, so the returned list is the same object as the input list.

参数:

groups - a list of CmsGroup objects

返回:

the filtered principal list

filterCoreUsers

public static java.util.List<CmsUser> filterCoreUsers(java.util.List<CmsUser> users)

Filters out all users with flags greater than I_CmsPrincipal.FLAG_CORE_LIMIT.

The given parameter list is directly modified, so the returned list is the same object as the input list.

参数:

users - a list of CmsUser objects

返回:

the filtered principal list

filterFlag

public static java.util.List<? extends CmsPrincipal> filterFlag(java.util.List<? extends CmsPrincipal> principals,
                                                int flag)

Filters out all principals that do not have the given flag set.

The given parameter list is directly modified, so the returned list is the same object as the input list.

参数:

principals - the list of CmsPrincipal objects

flag - the flag for filtering

返回:

the filtered principal list

getPrefixedGroup

public static java.lang.String getPrefixedGroup(java.lang.String name)

Returns the provided group name prefixed with I_CmsPrincipal.PRINCIPAL_GROUP..

参数:

name - the name to add the prefix to

返回:

the provided group name prefixed with I_CmsPrincipal.PRINCIPAL_GROUP.

getPrefixedUser

public static java.lang.String getPrefixedUser(java.lang.String name)

Returns the provided user name prefixed with I_CmsPrincipal.PRINCIPAL_USER..

参数:

name - the name to add the prefix to

返回:

the provided user name prefixed with I_CmsPrincipal.PRINCIPAL_USER.

readPrefixedPrincipal

public static I_CmsPrincipal readPrefixedPrincipal(CmsObject cms,
                                   java.lang.String name)
                                            throws CmsException

Utility function to read a prefixed principal from the OpenCms database using the provided OpenCms user context.

The principal must be either prefixed with I_CmsPrincipal.PRINCIPAL_GROUP. or I_CmsPrincipal.PRINCIPAL_USER..

参数:

cms - the OpenCms user context to use when reading the principal

name - the prefixed principal name

返回:

the principal read from the OpenCms database

抛出:

CmsException - in case the principal could not be read

readPrincipal

public static I_CmsPrincipal readPrincipal(CmsObject cms,
                           CmsUUID id)
                                    throws CmsException

Utility function to read a principal by its id from the OpenCms database using the provided OpenCms user context.

参数:

cms - the OpenCms user context to use when reading the principal

id - the id of the principal to read

返回:

the principal read from the OpenCms database

抛出:

CmsException - in case the principal could not be read

readPrincipal

public static I_CmsPrincipal readPrincipal(CmsObject cms,
                           java.lang.String type,
                           java.lang.String name)
                                    throws CmsException

Utility function to read a principal of the given type from the OpenCms database using the provided OpenCms user context.

The type must either be I_CmsPrincipal.PRINCIPAL_GROUP or I_CmsPrincipal.PRINCIPAL_USER.

参数:

cms - the OpenCms user context to use when reading the principal

type - the principal type

name - the principal name

返回:

the principal read from the OpenCms database

抛出:

CmsException - in case the principal could not be read

readPrincipalIncludingHistory

public static I_CmsPrincipal readPrincipalIncludingHistory(CmsObject cms,
                                           CmsUUID id)
                                                    throws CmsException

Utility function to read a principal by its id from the OpenCms database using the provided OpenCms user context.

参数:

cms - the OpenCms user context to use when reading the principal

id - the id of the principal to read

返回:

the principal read from the OpenCms database

抛出:

CmsException - in case the principal could not be read

compareTo

public int compareTo(I_CmsPrincipal obj)

指定者:

compareTo 在接口中 java.lang.Comparable<I_CmsPrincipal>

另请参阅:

Comparable.compareTo(java.lang.Object)

equals

public boolean equals(java.lang.Object obj)

从接口复制的说明: I_CmsPrincipal

Compares the given object with this principal.

指定者:

equals 在接口中 java.security.Principal

指定者:

equals 在接口中 I_CmsPrincipal

覆盖:

equals 在类中 java.lang.Object

参数:

obj - object to compare

返回:

true if the object is equal

另请参阅:

Object.equals(java.lang.Object)

getDescription

public java.lang.String getDescription()

从接口复制的说明: I_CmsPrincipal

Returns the description of this principal.

指定者:

getDescription 在接口中 I_CmsPrincipal

返回:

the description of this principal

另请参阅:

I_CmsPrincipal.getDescription()

getDisplayName

public java.lang.String getDisplayName(CmsObject cms,
                              java.util.Locale locale)
                                throws CmsException

Returns the display name of this principal including the organizational unit.

参数:

cms - the cms context

locale - the locale

返回:

the display name of this principal including the organizational unit

抛出:

CmsException - if the organizational unit could not be read

getDisplayName

public java.lang.String getDisplayName(CmsObject cms,
                              java.util.Locale locale,
                              I_CmsGroupNameTranslation translation)
                                throws CmsException

Returns the translated display name of this principal if it is a group and the display name otherwise.

参数:

cms - the current CMS context

locale - the locale

translation - the group name translation to use

返回:

the translated display name

抛出:

CmsException - if something goes wrong

getFlags

public int getFlags()

从接口复制的说明: I_CmsPrincipal

Returns the flags of this principal.

The principal flags are used to store special information about the principals state encoded bitwise. Usually the flags int value should not be directly accessed. Utility methods like I_CmsPrincipal.isEnabled() provide a much easier way to access the information contained in the flags.

指定者:

getFlags 在接口中 I_CmsPrincipal

返回:

the flags of this principal

另请参阅:

I_CmsPrincipal.getFlags()

getId

public CmsUUID getId()

从接口复制的说明: I_CmsPrincipal

Returns the unique id of this principal.

指定者:

getId 在接口中 I_CmsPrincipal

返回:

the unique id of this principal

另请参阅:

I_CmsPrincipal.getId()

getName

public java.lang.String getName()

Returns the fully qualified name of this principal.

指定者:

getName 在接口中 java.security.Principal

指定者:

getName 在接口中 I_CmsPrincipal

返回:

the fully qualified name of this principal

另请参阅:

Principal.getName()

getOuFqn

public java.lang.String getOuFqn()

Returns the fully qualified name of the associated organizational unit.

指定者:

getOuFqn 在接口中 I_CmsPrincipal

返回:

the fully qualified name of the associated organizational unit

getPrefixedName

public java.lang.String getPrefixedName()

从接口复制的说明: I_CmsPrincipal

Returns this principals unique name prefixed with it's type.

The type prefix can either be I_CmsPrincipal.PRINCIPAL_GROUP. (for groups) or I_CmsPrincipal.PRINCIPAL_USER. (for users).

指定者:

getPrefixedName 在接口中 I_CmsPrincipal

返回:

this principals unique name prefixed with this principals type

另请参阅:

I_CmsPrincipal.getPrefixedName()

getSimpleName

public java.lang.String getSimpleName()

Returns the simple name of this organizational unit.

指定者:

getSimpleName 在接口中 I_CmsPrincipal

返回:

the simple name of this organizational unit.

hashCode

public int hashCode()

从接口复制的说明: I_CmsPrincipal

Returns the hash code of this object.

指定者:

hashCode 在接口中 java.security.Principal

指定者:

hashCode 在接口中 I_CmsPrincipal

覆盖:

hashCode 在类中 java.lang.Object

返回:

the hash code

另请参阅:

Object.hashCode()

isEnabled

public boolean isEnabled()

从接口复制的说明: I_CmsPrincipal

Returns true if this principal is enabled.

A principal may be disabled in order to disable it, for example to prevent logins of a user. If a principal is just disabled but not deleted, the credentials of the principal in the VFS are still valid.

指定者:

isEnabled 在接口中 I_CmsPrincipal

返回:

true if this principal is enabled

另请参阅:

I_CmsPrincipal.isEnabled()

isGroup

public boolean isGroup()

从接口复制的说明: I_CmsPrincipal

Returns true if this principal is of type CmsGroup.

指定者:

isGroup 在接口中 I_CmsPrincipal

返回:

true if this principal is of type CmsGroup

另请参阅:

I_CmsPrincipal.isGroup()

isUser

public boolean isUser()

从接口复制的说明: I_CmsPrincipal

Returns true if this principal is of type CmsUser.

指定者:

isUser 在接口中 I_CmsPrincipal

返回:

true if this principal is of type CmsUser

另请参阅:

I_CmsPrincipal.isUser()

setDescription

public void setDescription(java.lang.String description)

从接口复制的说明: I_CmsPrincipal

Sets the description of this principal.

指定者:

setDescription 在接口中 I_CmsPrincipal

参数:

description - the principal description to set

另请参阅:

I_CmsPrincipal.setDescription(java.lang.String)

setEnabled

public void setEnabled(boolean enabled)

从接口复制的说明: I_CmsPrincipal

Enables (or disables) this principal, depending on the given status.

指定者:

setEnabled 在接口中 I_CmsPrincipal

参数:

enabled - the principal status to set

另请参阅:

I_CmsPrincipal.setEnabled(boolean)

setFlags

public void setFlags(int value)

从接口复制的说明: I_CmsPrincipal

Sets this principals flags to the specified value.

The principal flags are used to store special information about the principals state encoded bitwise. Usually the flags integer value should not be directly accessed. Utility methods like I_CmsPrincipal.setEnabled(boolean) provide a much easier way to manipulate the information contained in the flags.

指定者:

setFlags 在接口中 I_CmsPrincipal

参数:

value - the value to set this principals flags to

另请参阅:

I_CmsPrincipal.setFlags(int)

setName

public void setName(java.lang.String name)

从接口复制的说明: I_CmsPrincipal

Sets the unique name of this principal.

指定者:

setName 在接口中 I_CmsPrincipal

参数:

name - the unique name of this principal to set

另请参阅:

I_CmsPrincipal.setName(java.lang.String)