Package org.opencms.file

Class CmsGroup

java.lang.Object

org.opencms.security.CmsPrincipal

org.opencms.file.CmsGroup

All Implemented Interfaces:

Serializable, Comparable<I_CmsPrincipal>, Principal, I_CmsPrincipal

public class CmsGroup
extends CmsPrincipal

A group principal in the OpenCms permission system.

Since:

6.0.0

See Also:

• CmsUser
• Serialized Form

Field Summary

Fields inherited from class org.opencms.security.CmsPrincipal

m_description, m_flags, m_id, m_name

Fields inherited from interface org.opencms.security.I_CmsPrincipal

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

Constructor Summary

Constructors

Constructor	Description
CmsGroup()	Creates a new, empty OpenCms group principal.
CmsGroup(CmsUUID id, CmsUUID parentId, String name, String description, int flags)	Creates a new OpenCms group principal.

Method Summary

Modifier and Type	Method	Description
void	checkName(String name)	Checks if the provided group name is valid and can be used as an argument value for CmsPrincipal.setName(String).
Object	clone()
String	getDescription(Locale locale)	Returns the description of this organizational unit.
CmsUUID	getParentId()	Returns the parent group id of this group.
static boolean	hasPrefix(String principalName)	Checks if the given String starts with I_CmsPrincipal.PRINCIPAL_GROUP followed by a dot.
boolean	isGroup()	Returns true if this principal is of type CmsGroup.
boolean	isRole()	Checks if this group is a role group.
boolean	isUser()	Returns true if this principal is of type CmsUser.
boolean	isVirtual()	Checks if this group is a virtual group, emulating a role.
static String	removePrefix(String principalName)	Removes the prefix if the given String starts with I_CmsPrincipal.PRINCIPAL_GROUP followed by a dot.
void	setParentId(CmsUUID parentId)	Sets the parent group id of this group.
String	toString()

Methods inherited from class org.opencms.security.CmsPrincipal

compareTo, equals, filterCoreFlag, filterCoreGroups, filterCoreUsers, filterFlag, getDescription, getDisplayName, getDisplayName, getFlags, getId, getName, getOuFqn, getPrefixedGroup, getPrefixedName, getPrefixedUser, getSimpleName, getType, hashCode, isEnabled, readPrefixedPrincipal, readPrincipal, readPrincipal, readPrincipal, readPrincipalIncludingHistory, setDescription, setEnabled, setFlags, setName

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.security.Principal

implies

Constructor Details

CmsGroup

public CmsGroup()

Creates a new, empty OpenCms group principal.

CmsGroup

public CmsGroup(CmsUUID id,
 CmsUUID parentId,
 String name,
 String description,
 int flags)

Creates a new OpenCms group principal.

Parameters:

id - the unique id of the group

parentId - the is of the parent group

name - the fully qualified name of the name of the group

description - the description of the group

flags - the flags of the group

Method Details

hasPrefix

public static boolean hasPrefix(String principalName)

Checks if the given String starts with I_CmsPrincipal.PRINCIPAL_GROUP followed by a dot.

• Works if the given String is null.
• Removes white spaces around the String before the check.
• Also works with prefixes not being in upper case.
• Does not check if the group after the prefix actually exists.

Parameters:

principalName - the group name to check

Returns:

true in case the String starts with I_CmsPrincipal.PRINCIPAL_GROUP

removePrefix

public static String removePrefix(String principalName)

Removes the prefix if the given String starts with I_CmsPrincipal.PRINCIPAL_GROUP followed by a dot.

• Works if the given String is null.
• If the given String does not start with I_CmsPrincipal.PRINCIPAL_GROUP followed by a dot it is returned unchanged.
• Removes white spaces around the group name.
• Also works with prefixes not being in upper case.
• Does not check if the group after the prefix actually exists.

Parameters:

principalName - the group name to remove the prefix from

Returns:

the given String with the prefix I_CmsPrincipal.PRINCIPAL_GROUP with the following dot removed

checkName

public void checkName(String name)

Checks if the provided group name is valid and can be used as an argument value for CmsPrincipal.setName(String).

A group name must not be empty or whitespace only.

Parameters:

name - the group name to check

See Also:

• I_CmsValidationHandler.checkGroupName(String)

clone

public Object clone()

Overrides:

clone in class Object

See Also:

• Object.clone()

getDescription

public String getDescription(Locale locale)

Returns the description of this organizational unit.

Parameters:

locale - the locale

Returns:

the description of this organizational unit

getParentId

public CmsUUID getParentId()

Returns the parent group id of this group.

Returns:

the parent group id of this group

isGroup

public boolean isGroup()

Description copied from interface: I_CmsPrincipal

Returns true if this principal is of type CmsGroup.

Specified by:

isGroup in interface I_CmsPrincipal

Overrides:

isGroup in class CmsPrincipal

Returns:

true if this principal is of type CmsGroup

See Also:

• I_CmsPrincipal.isGroup()

isRole

public boolean isRole()

Checks if this group is a role group.

Returns:

true if this group is a role group

isUser

public boolean isUser()

Description copied from interface: I_CmsPrincipal

Returns true if this principal is of type CmsUser.

Specified by:

isUser in interface I_CmsPrincipal

Overrides:

isUser in class CmsPrincipal

Returns:

true if this principal is of type CmsUser

See Also:

• I_CmsPrincipal.isUser()

isVirtual

public boolean isVirtual()

Checks if this group is a virtual group, emulating a role.

Returns:

if this group is a virtual group

setParentId

public void setParentId(CmsUUID parentId)

Sets the parent group id of this group.

Parameters:

parentId - the parent group id to set

toString

public String toString()

Specified by:

toString in interface Principal

Overrides:

toString in class Object

See Also:

• Object.toString()