jet.server.api.admin.security

Interface JPrincipal

All Superinterfaces:

Principal, Serializable

All Known Subinterfaces:

JGroup, JRole, JUser

public interface JPrincipal
extends Principal, Serializable

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEPARATOR
static int	TYPE_GROUP TYPE_GROUP Int identifier for principal type: group, value: 3.
static int	TYPE_ROLE TYPE_ROLE Int identifier for principal type: role, value: 2.
static int	TYPE_USER TYPE_USER Int identifier for principal type: user, value: 1.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Gets the principal's description.
String	getDisplayName() get display name of the principal.
String	getOrganization() get the organization that principal belongs to.
int	getType() Gets the principal's type.

Methods inherited from interface java.security.Principal

equals, getName, hashCode, implies, toString

Field Detail

SEPARATOR

static final String SEPARATOR

See Also:

Constant Field Values

TYPE_USER

static final int TYPE_USER

TYPE_USER Int identifier for principal type: user, value: 1.

See Also:

Constant Field Values

TYPE_ROLE

static final int TYPE_ROLE

TYPE_ROLE Int identifier for principal type: role, value: 2.

See Also:

Constant Field Values

TYPE_GROUP

static final int TYPE_GROUP

TYPE_GROUP Int identifier for principal type: group, value: 3.

See Also:

Constant Field Values

Method Detail

getDescription

String getDescription()

Gets the principal's description.

Returns:

the principal's description.

getType

int getType()

Gets the principal's type. This type is used for checking whether this principal is created in local or imported from LDAP server. If this type is 0, it is created in local. If the type is 1, it is imported from LDAP server.

Returns:

the principal's type.

getOrganization

String getOrganization()

get the organization that principal belongs to.

Returns:

organization name, return null if does not belong to any organization.

See Also:

jet.server.api.admin.security.JOrganization JOrganization}

getDisplayName

String getDisplayName()

get display name of the principal.

Returns:

the principal's display name. if organization is not null, return organization + SEPARATOR + name, otherwise return value is same as name.