org.opencms.security
Interface I_CmsPrincipal

All Known Implementing Classes:

CmsGroup, CmsUser

public interface I_CmsPrincipal

Representation of an identity in the cms (currently user or group), used to define permissions on a resource.

Since:

6.0.0

Version:

$Revision: 1.14 $

Author:

Carsten Weinholz

Field Summary

static int	FLAG_CORE_LIMIT Upper limit for core flags, any principal object with flags greater than this value will be filtered out.
static int	FLAG_DISABLED This flag is set for disabled principals in the database.
static int	FLAG_ENABLED This flag is set for enabled principals in the database.
static int	FLAG_GROUP_PROJECT_MANAGER Flag to indicate a goup is a potential project manager group.
static int	FLAG_GROUP_PROJECT_USER Flag to indicate a goup is a potential project user group.
static int	FLAG_GROUP_WORKFLOW_ROLE Flag to indicate a goup is used as a role in the workflow.
static String	PRINCIPAL_GROUP Identifier for group principals.
static String	PRINCIPAL_USER Identifier for user principals.

Method Summary

boolean	equals(Object obj) Compares the given object with this principal.
CmsUUID	getId() Gets the id of this principal.
String	getName() Gets the name of this principal.
int	hashCode() Returns the hash code of this object.

Field Detail

FLAG_DISABLED

static final int FLAG_DISABLED

This flag is set for disabled principals in the database.

See Also:

Constant Field Values

FLAG_ENABLED

static final int FLAG_ENABLED

This flag is set for enabled principals in the database.

See Also:

Constant Field Values

FLAG_GROUP_PROJECT_MANAGER

static final int FLAG_GROUP_PROJECT_MANAGER

Flag to indicate a goup is a potential project manager group.

See Also:

Constant Field Values

FLAG_GROUP_PROJECT_USER

static final int FLAG_GROUP_PROJECT_USER

Flag to indicate a goup is a potential project user group.

See Also:

Constant Field Values

FLAG_GROUP_WORKFLOW_ROLE

static final int FLAG_GROUP_WORKFLOW_ROLE

Flag to indicate a goup is used as a role in the workflow.

See Also:

Constant Field Values

PRINCIPAL_GROUP

static final String PRINCIPAL_GROUP

Identifier for group principals.

See Also:

Constant Field Values

PRINCIPAL_USER

static final String PRINCIPAL_USER

Identifier for user principals.

See Also:

Constant Field Values

FLAG_CORE_LIMIT

static final int FLAG_CORE_LIMIT

Upper limit for core flags, any principal object with flags greater than this value will be filtered out.

See Also:

Constant Field Values

Method Detail

equals

boolean equals(Object obj)

Compares the given object with this principal.

Overrides:

equals in class Object

Parameters:

obj - object to comapre

Returns:

true if the object is equal

getId

CmsUUID getId()

Gets the id of this principal.

Returns:

the unique id of the principal.

getName

String getName()

Gets the name of this principal.

Returns:

the name of the principal

hashCode

int hashCode()

Returns the hash code of this object.

Overrides:

hashCode in class Object

Returns:

the hash code