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

public interface PrincipalReference

The PrincipalReference class contains reference information for a Principal. A principal contains a union of information found in a User and a Group.

Field Summary

static String	PRINCIPALTYPE_GROUP Group principal type.
static String	PRINCIPALTYPE_SERVICE Service principal type.
static String	PRINCIPALTYPE_SPECIAL Deprecated. Use PrincipalReference.PRINCIPALTYPE_SYSTEM or PrincipalReference.PRINCIPALTYPE_SERVICE instead.
static String	PRINCIPALTYPE_SYSTEM System principal type.
static String	PRINCIPALTYPE_USER User principal type.
static String	STATUS_CURRENT The principal is current (active in the system).
static String	STATUS_OBSOLETE The principal is obsolete (deleted from the system).

Method Summary

String	getCanonicalName() Retrieves the canonical name of this principal.
String	getCommonName() Retrieves the common (display) name of this principal.
String	getDomainCommonName() Retrieves the common (display) name of the domain associated with this principal.
String	getDomainName() Retrieves the canonical name of the domain associated with this principal.
String	getEmail() Retrieves the primary email identifier associated with this principal.
String	getOid() Retrieves the principal identifier.
String	getOrg() Retrieves the organization to which the principal belongs.
String	getPrincipalType() Retrieves the principal type.
String	getStatus() Retrieves the principal's status.
int	getVisibility() Retrieves the visibility level of the Principal.
boolean	isSystem() Determines whether this is a system principal.
void	setCanonicalName(String canonicalName) Sets the principal's canonical name.
void	setCommonName(String commonName) Sets the principal's common name.
void	setDomainName(String domainName) Sets the principal's domain name.
void	setEmail(String email) Sets the principal's email identifier.
void	setOid(String oid) Sets the principal's identifier.
void	setOrg(String org) Sets the principal's organization.
void	setPrincipalType(String principalType) Sets the principal's type.
void	setStatus(String status) Sets the principal's status.

Field Detail

STATUS_CURRENT

static final String STATUS_CURRENT

The principal is current (active in the system).

STATUS_OBSOLETE

static final String STATUS_OBSOLETE

The principal is obsolete (deleted from the system).

PRINCIPALTYPE_GROUP

static final String PRINCIPALTYPE_GROUP

Group principal type.

PRINCIPALTYPE_SERVICE

static final String PRINCIPALTYPE_SERVICE

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

PRINCIPALTYPE_SPECIAL

static final String PRINCIPALTYPE_SPECIAL

Deprecated. Use PrincipalReference.PRINCIPALTYPE_SYSTEM or PrincipalReference.PRINCIPALTYPE_SERVICE instead.

Do not use.

PRINCIPALTYPE_SYSTEM

static final 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 String PRINCIPALTYPE_USER

User principal type.

Method Detail

getCanonicalName

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. Foe example, uid=doe,ou=People,o=adobe.com.

Returns:

The canonical name of this principal.

getCommonName

String getCommonName()

Retrieves the common (display) name of this principal. For example, John Doe.

Returns:

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

getDomainName

String getDomainName()

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

Returns:

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

getDomainCommonName

String getDomainCommonName()

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

Returns:

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

getOid

String getOid()

Retrieves the principal identifier.

Returns:

A string value that specifies the principal identifier.

getPrincipalType

String getPrincipalType()

Retrieves the principal type.

Returns:

A string value that specifies the principal type.

getStatus

String getStatus()

Retrieves the principal's status.

Returns:

A string value that specifies the principal's status.

getEmail

String getEmail()

Retrieves the primary email identifier associated with this principal. For example, doe@adobe.com.

Returns:

A string value that specifies the primary email identifier associated with this principal.

getOrg

String getOrg()

Retrieves the organization to which the principal belongs. For example, Adobe.

Returns:

A string value that specifies the organization to which the principal belongs.

getVisibility

int getVisibility()

Retrieves the visibility level of the Principal. The following values are valid:

• INVISIBLE: The principal is invisible. 0
• SEARCHES: The principal can be found with searches. 1
• GUI: The principal can appear in the user interface.2

Returns:

An integer value that specifies the visibility level of the Principal.

setCommonName

void setCommonName(String commonName)

Sets the principal's common name.

Parameters:

commonName - The principal's common name.

setStatus

void setStatus(String status)

Sets the principal's status.

Parameters:

status - The principal's status.

setDomainName

void setDomainName(String domainName)

Sets the principal's domain name.

Parameters:

domainName - The principal's domain name.

setCanonicalName

void setCanonicalName(String canonicalName)

Sets the principal's canonical name.

Parameters:

canonicalName - The principal's canonical name.

setOid

void setOid(String oid)

Sets the principal's identifier.

Parameters:

oid - The principal's identifier.

setPrincipalType

void setPrincipalType(String principalType)

Sets the principal's type.

Parameters:

principalType - The principal's type.

setEmail

void setEmail(String email)

Sets the principal's email identifier.

Parameters:

email - The principal's email identifier.

setOrg

void setOrg(String org)

Sets the principal's organization.

Parameters:

org - The principal's organization.

isSystem

boolean isSystem()

Determines whether this is a system principal.

Returns:

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