Packagecom.adobe.idp.um.api.infomodel
Interfacepublic interface Principal

This class contains information for a principal. This information is the union of information found in a User and a Group.


Public Methods
 MethodDefined By
  
void addEmailAlias(String alias)
Adds an email alias for this principal.
Principal
  
void clearEmailAlias()
Clears the email alias for this principal.
Principal
  
String getCanonicalName()
Retrieves the canonical name of this principal.
Principal
  
String getCommonName()
Retrieves the common (display) name of this principal.
Principal
  
String getDescription()
Retrieves the description.
Principal
  
Set getDirectGroupMemberships()
Retrieves a set of Group objects indicating those groups to which this principal directly belongs.
Principal
  
String getDomainCommonName()
Retrieves the common (display) name of the domain associated with this principal.
Principal
  
String getDomainName()
Retrieves the canonical name of the domain associated with this principal.
Principal
  
String getEmail()
Retrieves the primary email identifier associated with this principal.
Principal
  
List getEmailAlias()
Retrieves a list of the secondary email addresses of the principal.
Principal
  
Set getGroupMemberships()
Retrieves a set of Group objects indicating those groups to which this principal belongs.
Principal
  
String getOid()
Retrieves the principal identifier.
Principal
  
String getOrg()
Retrieves the organization to which the principal belongs.
Principal
  
String getPrincipalType()
Retrieves the principal type.
Principal
  
Set getRoleMembership()
Retrieves a set of Role objects indicating those roles which this principal has.
Principal
  
String getStatus()
Retrieves the principal's status.
Principal
  
Date getTimestampCreated()
Retrieves the timestamp that was created for the principal.
Principal
  
Date getTimestampUpdated()
Retrieves the timestamp that was updated for the principal.
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.
Principal
  
boolean isLocal()
Determines whether this principal is local.
Principal
  
boolean isLocked()
Determines whether this principal is locked.
Principal
  
boolean isSystem()
Determines whether this is a system principal.
Principal
  
void setCanonicalName(String canonicalName)
Sets the principal's canonical name.
Principal
  
void setCommonName(String commonName)
Sets the principal's common name.
Principal
  
void setDescription(String description)
Sets the description.
Principal
  
void setDomainName(String domainName)
Sets the principal's domain name.
Principal
  
void setEmail(String email)
Sets the principal's email identifier.
Principal
  
void setEmailAliases(List emailAlias)
Sets the email aliases.
Principal
  
void setIsSystem(boolean isSystem)
Sets whether this principal is a system principal.
Principal
  
void setLocked(boolean locked)
Sets whether the principal is locked.
Principal
  
void setOid(String oid)
Sets the principal's identifier.
Principal
  
void setOrg(String org)
Sets the principal's organization.
Principal
  
void setPrincipalType(String principalType)
Sets the principal's type.
Principal
  
void setStatus(String status)
Sets the principal's status.
Principal
  
void setVisibility(int visibility)
Sets the principal's visibility level.
Principal
Public Constants
 ConstantDefined By
  PRINCIPALTYPE_GROUP
[static] Group principal type.
Principal
  PRINCIPALTYPE_SERVICE
[static] Service principal type.
Principal
  PRINCIPALTYPE_SPECIAL
[static] Do not use.
Principal
  PRINCIPALTYPE_SYSTEM
[static] System principal type.
Principal
  PRINCIPALTYPE_USER
[static] User principal type.
Principal
  STATUS_CURRENT
[static] Represents when the status of an object is current (active in the system).
Principal
  STATUS_OBSOLETE
[static] Represents when the status of an object is obsolete (deleted from the system).
Principal
  VISIBILITY_SEARCHES
[static] The principal is visible to searches.
Principal
  VISIBLITY_GUI
[static] The principal is visible and can be shown in the user interface.
Principal
  VISIBLITY_INVISIBLE
[static] The principal is invisible.
Principal
Method Detail
addEmailAlias()
public void addEmailAlias(String alias)

Adds an email alias for this principal.

Parameters

alias

clearEmailAlias() 
public void clearEmailAlias()

Clears the email alias for this principal.

getCanonicalName() 
public 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.

Returns
The canonical name of this principal.

Example
How to use examples
"uid=doe,ou=People,o=adobe.com"
getCommonName() 
public String getCommonName()

Retrieves the common (display) name of this principal.

Returns
The common (display) name of this principal.

Example
How to use examples
"John Doe"
getDescription() 
public String getDescription()

Retrieves the description.

Returns
The description.
getDirectGroupMemberships() 
public 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.
getDomainCommonName() 
public String getDomainCommonName()

Retrieves the common (display) name of the domain associated with this principal.

Returns
The common (display) name of the domain associated with this principal.

Example
How to use examples
"Adobe Systems"
getDomainName() 
public String getDomainName()

Retrieves the canonical name of the domain associated with this principal.

Returns
The canonical name of the domain associated with this principal.

Example
How to use examples
"adobe.com"
getEmail() 
public String getEmail()

Retrieves the primary email identifier associated with this principal.

Returns
The primary email identifier associated with this principal.

Example
How to use examples
"doe@adobe.com"
getEmailAlias() 
public List getEmailAlias()

Retrieves a list of the secondary email addresses of the principal.

Returns
A list of the secondary email addresses of the principal.

Example
How to use examples
{"john_doe@adobe.com","john.doe@adobe.com"}
getGroupMemberships() 
public 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.
getOid() 
public String getOid()

Retrieves the principal identifier.

Returns
The principal identifier.
getOrg() 
public String getOrg()

Retrieves the organization to which the principal belongs.

Returns
The organization to which the principal belongs.

Example
How to use examples
"Adobe"
getPrincipalType() 
public String getPrincipalType()

Retrieves the principal type.

Returns
The principal type.
getRoleMembership() 
public 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.
getStatus() 
public String getStatus()

Retrieves the principal's status.

Returns
The principal's status.
getTimestampCreated() 
public Date getTimestampCreated()

Retrieves the timestamp that was created for the principal.

Returns
The timestamp that was created for the principal.
getTimestampUpdated() 
public Date getTimestampUpdated()

Retrieves the timestamp that was updated for the principal.

Returns
The timestamp that was updated for the principal.
getVisibility() 
public 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.
isLocal() 
public boolean isLocal()

Determines whether this principal is local.

Returns
true if this principal is local, false otherwise.
isLocked() 
public boolean isLocked()

Determines whether this principal is locked.

Returns
true if the principal is locked, false otherwise.
isSystem() 
public boolean isSystem()

Determines whether this is a system principal.

Returns
true if this is a system principal, false otherwise.
setCanonicalName() 
public void setCanonicalName(String canonicalName)

Sets the principal's canonical name.

Parameters

canonicalName — The principal's canonical name.

setCommonName() 
public void setCommonName(String commonName)

Sets the principal's common name.

Parameters

commonName — The principal's common name.

setDescription() 
public void setDescription(String description)

Sets the description.

Parameters

description — The description.

setDomainName() 
public void setDomainName(String domainName)

Sets the principal's domain name.

Parameters

domainName — The principal's domain name.

setEmail() 
public void setEmail(String email)

Sets the principal's email identifier.

Parameters

email — The principal's email identifier.

setEmailAliases() 
public void setEmailAliases(List emailAlias)

Sets the email aliases.

Parameters

emailAlias — A list of email aliases.

setIsSystem() 
public void setIsSystem(boolean isSystem)

Sets whether this principal is a system principal.

Parameters

isSystem — true if this principal is to be a system principal, false otherwise.

setLocked() 
public void setLocked(boolean locked)

Sets whether the principal is locked.

Parameters

locked — true if the principal is locked, false otherwise.

setOid() 
public void setOid(String oid)

Sets the principal's identifier.

Parameters

oid — The principal's identifier.

setOrg() 
public void setOrg(String org)

Sets the principal's organization.

Parameters

org — The principal's organization.

setPrincipalType() 
public void setPrincipalType(String principalType)

Sets the principal's type.

Parameters

principalType — The principal's type.

setStatus() 
public void setStatus(String status)

Sets the principal's status.

Parameters

status — The principal's status.

setVisibility() 
public void setVisibility(int visibility)

Sets the principal's visibility level.

Parameters

visibility — The principal's visibility level.

Constant Detail
PRINCIPALTYPE_GROUPConstant
public static final PRINCIPALTYPE_GROUP

Group principal type.

PRINCIPALTYPE_SERVICEConstant 
public static final PRINCIPALTYPE_SERVICE

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

PRINCIPALTYPE_SPECIALConstant 
public static final PRINCIPALTYPE_SPECIAL
Deprecated: Use PRINCIPALTYPE_SYSTEM or PRINCIPALTYPE_SERVICE instead.

Do not use.

PRINCIPALTYPE_SYSTEMConstant 
public static final PRINCIPALTYPE_SYSTEM

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

PRINCIPALTYPE_USERConstant 
public static final PRINCIPALTYPE_USER

User principal type.

STATUS_CURRENTConstant 
public static final STATUS_CURRENT

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

STATUS_OBSOLETEConstant 
public static final STATUS_OBSOLETE

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

VISIBILITY_SEARCHESConstant 
public static final VISIBILITY_SEARCHES

The principal is visible to searches.

VISIBLITY_GUIConstant 
public static final VISIBLITY_GUI

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

VISIBLITY_INVISIBLEConstant 
public static final VISIBLITY_INVISIBLE

The principal is invisible.




© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Wed Oct 1 2008, 10:46 PM -04:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/javadoc/com/adobe/idp/um/api/infomodel/Principal.html