com.adobe.idp.um.api.infomodel
Interface Principal

All Known Subinterfaces:

Group, User

public interface Principal

This class contains information for a principal. This information is the union of information found in a User and a Group. To see an object of this type used in a code example, see the Managing users and groups using the Java API quick start in Programming with LiveCycle ES4.

Field Summary

static java.lang.String	PRINCIPALTYPE_GROUP Group principal type.
static java.lang.String	PRINCIPALTYPE_SERVICE Service principal type.
static java.lang.String	PRINCIPALTYPE_SPECIAL Deprecated. Use Principal.PRINCIPALTYPE_SYSTEM or Principal.PRINCIPALTYPE_SERVICE instead.
static java.lang.String	PRINCIPALTYPE_SYSTEM System principal type.
static java.lang.String	PRINCIPALTYPE_USER User principal type.
static java.lang.String	STATUS_CURRENT Represents when the status of an object is current (active in the system).
static java.lang.String	STATUS_OBSOLETE Represents when the status of an object is obsolete (deleted from the system).
static int	VISIBILITY_SEARCHES The principal is visible to searches.
static int	VISIBLITY_GUI The principal is visible and can be shown in the user interface.
static int	VISIBLITY_INVISIBLE The principal is invisible.

Method Summary

void	addEmailAlias(java.lang.String alias) Adds an email alias for this principal.
void	clearEmailAlias() Clears the email alias for this principal.
java.lang.String	getCanonicalName() Retrieves the canonical name of this principal.
java.lang.String	getCommonName() Retrieves the common (display) name of this principal.
java.lang.String	getDescription() Retrieves the description.
java.util.Set	getDirectGroupMemberships() Retrieves a set of Group objects indicating those groups to which this principal directly belongs.
java.lang.String	getDomainCommonName() Retrieves the common (display) name of the domain associated with this principal.
java.lang.String	getDomainName() Retrieves the canonical name of the domain associated with this principal.
java.lang.String	getEmail() Retrieves the primary email identifier associated with this principal.
java.util.List	getEmailAlias() Retrieves a list of the secondary email addresses of the principal.
java.util.Set	getGroupMemberships() Retrieves a set of Group objects indicating those groups to which this principal belongs.
java.lang.String	getOid() Retrieves the principal identifier.
java.lang.String	getOrg() Retrieves the organization to which the principal belongs.
java.lang.String	getPrincipalType() Retrieves the principal type.
java.util.Set	getRoleMembership() Retrieves a set of Role objects indicating those roles which this principal has.
java.lang.String	getStatus() Retrieves the principal's status.
java.util.Date	getTimestampCreated() Retrieves the timestamp that was created for the principal.
java.util.Date	getTimestampUpdated() Retrieves the timestamp that was updated for the principal.
int	getVisibility() Retrieves the visibility level of the principal, indicating whether the principal can be shown in the user interface, or whether it qualifies for searches.
boolean	isLocal() Determines whether this principal is local.
boolean	isLocked() Determines whether this principal is locked.
boolean	isSystem() Determines whether this is a system principal.
void	setCanonicalName(java.lang.String canonicalName) Sets the principal's canonical name.
void	setCommonName(java.lang.String commonName) Sets the principal's common name.
void	setDescription(java.lang.String description) Sets the description.
void	setDomainName(java.lang.String domainName) Sets the principal's domain name.
void	setEmail(java.lang.String email) Sets the principal's email identifier.
void	setEmailAliases(java.util.List emailAlias) Sets the email aliases.
void	setIsSystem(boolean isSystem) Sets whether this principal is a system principal.
void	setLocked(boolean locked) Sets whether the principal is locked.
void	setOid(java.lang.String oid) Sets the principal's identifier.
void	setOrg(java.lang.String org) Sets the principal's organization.
void	setPrincipalType(java.lang.String principalType) Sets the principal's type.
void	setStatus(java.lang.String status) Sets the principal's status.
void	setVisibility(int visibility) Sets the principal's visibility level.

Field Detail

VISIBLITY_INVISIBLE

static final int VISIBLITY_INVISIBLE

The principal is invisible.

VISIBILITY_SEARCHES

static final int VISIBILITY_SEARCHES

The principal is visible to searches.

VISIBLITY_GUI

static final int VISIBLITY_GUI

The principal is visible and can be shown in the user interface.

STATUS_CURRENT

static final java.lang.String STATUS_CURRENT

Represents when the status of an object is current (active in the system).

STATUS_OBSOLETE

static final java.lang.String STATUS_OBSOLETE

Represents when the status of an object is obsolete (deleted from the system).

PRINCIPALTYPE_GROUP

static final java.lang.String PRINCIPALTYPE_GROUP

Group principal type.

PRINCIPALTYPE_SERVICE

static final java.lang.String PRINCIPALTYPE_SERVICE

Service principal type. Service accounts are for services that are expected to run continually.

PRINCIPALTYPE_SPECIAL

static final java.lang.String PRINCIPALTYPE_SPECIAL

Deprecated. Use Principal.PRINCIPALTYPE_SYSTEM or Principal.PRINCIPALTYPE_SERVICE instead.

Do not use.

PRINCIPALTYPE_SYSTEM

static final java.lang.String PRINCIPALTYPE_SYSTEM

System principal type. The system type can be used for hidden accounts that will not run as a service.

PRINCIPALTYPE_USER

static final java.lang.String PRINCIPALTYPE_USER

User principal type.

Method Detail

setEmailAliases

void setEmailAliases(java.util.List emailAlias)

Sets the email aliases.

Parameters:

emailAlias - A list of email aliases.

getDescription

java.lang.String getDescription()

Retrieves the description.

Returns:

A string value that represents the description.

getTimestampCreated

java.util.Date getTimestampCreated()

Retrieves the timestamp that was created for the principal.

Returns:

The timestamp that was created for the principal.

getTimestampUpdated

java.util.Date getTimestampUpdated()

Retrieves the timestamp that was updated for the principal.

Returns:

The timestamp that was updated for the principal.

setDescription

void setDescription(java.lang.String description)

Sets the description.

Parameters:

description - The description.

getCanonicalName

java.lang.String getCanonicalName()

Retrieves the canonical name of this principal. This string is unique within the scope of the domain. Thus the pair {getCanonicalName(), getDomainName()} uniquely identifies the principal. For example, uid=doe,ou=People,o=adobe.com.

Returns:

A string value that specifies the canonical name of this principal.

getCommonName

java.lang.String getCommonName()

Retrieves the common (display) name of this principal. Foe example, Tony Blue.

Returns:

A string value that represents the common name of this principal.

getDomainName

java.lang.String getDomainName()

Retrieves the canonical name of the domain associated with this principal. For example, adobe.com.

Returns:

A string value that represents the canonical name of the domain associated with this principal.

getDomainCommonName

java.lang.String getDomainCommonName()

Retrieves the common (display) name of the domain associated with this principal. For example, Adobe Systems.

Returns:

A string value that represents the common name of the domain associated with this principal.

getOid

java.lang.String getOid()

Retrieves the principal identifier.

Returns:

A string value that represents the principal identifier.

getStatus

java.lang.String getStatus()

Retrieves the principal's status.

Returns:

The principal's status.

getEmail

java.lang.String getEmail()

Retrieves the primary email identifier associated with this principal.

Returns:

The primary email identifier associated with this principal.

getOrg

java.lang.String getOrg()

Retrieves the organization to which the principal belongs.

Returns:

The organization to which the principal belongs.

setCommonName

void setCommonName(java.lang.String commonName)

Sets the principal's common name.

Parameters:

commonName - The principal's common name.

setStatus

void setStatus(java.lang.String status)

Sets the principal's status.

Parameters:

status - A string value that specifies the principal's status.

setDomainName

void setDomainName(java.lang.String domainName)

Sets the principal's domain name.

Parameters:

domainName - The principal's domain name.

setCanonicalName

void setCanonicalName(java.lang.String canonicalName)

Sets the principal's canonical name.

Parameters:

canonicalName - A string value that specifies the principal's canonical name.

setOid

void setOid(java.lang.String oid)

Sets the principal's identifier.

Parameters:

oid - A string value that specifies the principal's identifier.

setPrincipalType

void setPrincipalType(java.lang.String principalType)

Sets the principal's type.

Parameters:

principalType - The principal's type.

setEmail

void setEmail(java.lang.String email)

Sets the principal's email identifier.

Parameters:

email - A string value that specifies the principal's email identifier.

setOrg

void setOrg(java.lang.String org)

Sets the principal's organization.

Parameters:

org - The principal's organization.

getEmailAlias

java.util.List getEmailAlias()

Retrieves a list of the secondary email addresses of the principal. For example, {john_doe@adobe.com, john.doe@adobe.com}.

Returns:

A list of the secondary email addresses of the principal.

getGroupMemberships

java.util.Set getGroupMemberships()

Retrieves a set of Group objects indicating those groups to which this principal belongs.

Returns:

A set of groups to which this principal belongs. The returned value may be null, depending on the method that returned this object. For example, a search could omit this for efficiency.

getDirectGroupMemberships

java.util.Set getDirectGroupMemberships()

Retrieves a set of Group objects indicating those groups to which this principal directly belongs. This is a subset of those groups that would be returned by getGroupMemberships().

Returns:

A set of groups to which this principal directly belongs. The returned value may be null, depending on the method that returned this object. For example, a search could omit this for efficiency.

getRoleMembership

java.util.Set getRoleMembership()

Retrieves a set of Role objects indicating those roles which this principal has. The roles returned are either directly assigned or inherited by the principal from its ancestors.

Returns:

A set of groups to which this principal directly belongs. The returned value may be null, depending on the method that returned this object. For example, a search could omit this for efficiency.

getVisibility

int getVisibility()

Retrieves the visibility level of the principal, indicating whether the principal can be shown in the user interface, or whether it qualifies for searches.

Returns:

The visibility level of the principal. The default value is VISIBLITY_GUI.

isSystem

boolean isSystem()

Determines whether this is a system principal.

Returns:

The value true if this is a system principal, false otherwise.

clearEmailAlias

void clearEmailAlias()

Clears the email alias for this principal.

addEmailAlias

void addEmailAlias(java.lang.String alias)

Adds an email alias for this principal.

Parameters:

alias - A string value that specifies the alias for this principal.

isLocal

boolean isLocal()

Determines whether this principal is local.

Returns:

The value true if this principal is local, false otherwise.

getPrincipalType

java.lang.String getPrincipalType()

Retrieves the principal type.

Returns:

A string value that specifies the principal type.

setVisibility

void setVisibility(int visibility)

Sets the principal's visibility level. For example, specify Principal.VISIBILITY_SEARCHES to enable this prinicpal to be visible in searches.

Parameters:

visibility - An integer value that specifies the principal's visibility level.

setIsSystem

void setIsSystem(boolean isSystem)

Sets whether this principal is a system principal.

Parameters:

isSystem - The value true if this principal is to be a system principal, false otherwise.

setLocked

void setLocked(boolean locked)

Sets whether the principal is locked.

Parameters:

locked - The value true if the principal is locked, false otherwise.

isLocked

boolean isLocked()

Determines whether this principal is locked.

Returns:

The value true if the principal is locked, false otherwise.