com.adobe.idp.um.spi.directoryservices
Class DSPrincipalRecord

java.lang.Object
  com.adobe.idp.um.spi.directoryservices.DSPrincipalIdRecord
      com.adobe.idp.um.spi.directoryservices.DSPrincipalRecord

All Implemented Interfaces:

java.io.Serializable

public class DSPrincipalRecord
extends DSPrincipalIdRecord
implements java.io.Serializable

The DSPrincipalRecord class provides a container for storing information that constitutes a User Management user or group record. Group providers and user providers store user records in this container when they retrieve them from the data store.

This class provides methods that User Management uses to retrieve user information from the container and methods that group and user providers use to add user information to the container.

This class defines constant values that represent the user and group types of principals.

This class inherits the domain name and canonical identifier from DSPrincipalIdRecord.

See Also:

Serialized Form

Field Summary

static java.lang.String	GROUPTYPE_ORGANIZATION Do not use.
static java.lang.String	GROUPTYPE_PRINCIPALS Indicates that this is an arbitrary grouping of principals, rather than a special group type.
static java.lang.String	GROUPTYPE_ROLE Do not use.
static java.lang.String	PRINCIPALTYPE_GROUP A constant to indicate that this is a group record.
static java.lang.String	PRINCIPALTYPE_USER A constant to indicate that this is a user record.

Constructor Summary

DSPrincipalRecord()
Default constructor.

Method Summary

void	addEmailAlias(java.lang.String alias) Adds an email alias of the principal.
java.lang.String	getCommonName() Retrieves the full name of the principal that will be displayed in the user interface.
java.lang.String	getDescription() Retrieves the string used to describe the principal.
java.lang.String	getEmail() Retrieves the primary email address of the principal.
java.util.Set	getEmailAlias() Retrieves the email aliases of the principal if the aliases are provided.
java.lang.String	getFamilyName() Retrieves the user's last (family) name.
java.lang.String	getGivenName() Retrieves the user's first (given) name.
java.lang.String	getGroupType() Retrieves the type of group record this describes.
java.lang.String	getInitials() Retrieves the user's initials.
boolean	getIsSystem() Determines whether the principal is a system principal.
java.lang.String	getLocale() Retrieves the locale in standard ISO language and country form.
java.lang.String	getOid() Retrieves the principal identifier.
java.lang.String	getOrg() Retrieves the organization to which the principal belongs.
java.lang.String	getOriginalName() Retrieves the original name of the principal.
java.lang.String	getPostalAddress() Retrieves the user's postal address.
java.lang.String	getPrincipalType() Retrieves the type of the principal.
java.lang.String	getRelAppOid() Retrieves the reliant application identifier for which the role is being defined.
java.lang.String	getTelephoneNumber() Retrieves the user's telephone number.
java.lang.String	getTimezone() Retrieves the standard Java string representation of a time zone.
java.lang.String	getUserid() Retrieves the user identification of the principal.
int	getVisibility() Retrieves the visibility level of the principal.
boolean	isDisabled() Determines whether the principal is disabled.
boolean	isMutable() Retrieves the mutable status of the role.
void	setCommonName(java.lang.String commonName) Sets the full name of the principal.
void	setDescription(java.lang.String description) Sets the string used to describe the principal.
void	setDisabled(boolean isDisabled) Sets whether the principal is disabled.
void	setEmail(java.lang.String email) Sets the primary email address of the principal.
void	setEmailAliases(java.util.List emailAlias) Sets the secondary email addresses of the principal.
void	setFamilyName(java.lang.String familyName) Sets the user's last (family) name.
void	setGivenName(java.lang.String givenName) Sets the user's first (given) name.
void	setGroupType(java.lang.String groupType) Sets the type of group record this describes.
void	setInitials(java.lang.String initials) Sets the user's initials.
void	setIsSystem(boolean isSystem) Sets whether the principal type is a system principal.
void	setLocale(java.lang.String locale) Sets the locale in standard ISO language and country form.
void	setMutableStatus(boolean isMutable) Sets the mutable status of the role.
void	setOid(java.lang.String oid) Sets the principal identifier.
void	setOrg(java.lang.String org) Sets the organization to which the principal belongs.
void	setOriginalName(java.lang.String originalName) Sets the original name of the principal.
void	setPostalAddress(java.lang.String postalAddress) Sets the user's postal address.
void	setPrincipalType(java.lang.String principalType) Sets the type of the principal.
void	setRelAppOid(java.lang.String reliantApp) Sets the reliant application identifier for which the role is being defined.
void	setTelephoneNumber(java.lang.String telephoneNumber) Sets the user's telephone number.
void	setTimezone(java.lang.String timezone) Sets the standard Java string representation of a time zone.
void	setUserid(java.lang.String userid) Sets the user identification of the principal.
void	setVisibility(int visibility) Sets the visibility level of the prinicpal.

Methods inherited from class com.adobe.idp.um.spi.directoryservices.DSPrincipalIdRecord

getCanonicalName, getDomainName, setCanonicalName, setDomainName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PRINCIPALTYPE_GROUP

public static final java.lang.String PRINCIPALTYPE_GROUP

A constant to indicate that this is a group record.

PRINCIPALTYPE_USER

public static final java.lang.String PRINCIPALTYPE_USER

A constant to indicate that this is a user record.

GROUPTYPE_PRINCIPALS

public static final java.lang.String GROUPTYPE_PRINCIPALS

Indicates that this is an arbitrary grouping of principals, rather than a special group type.

GROUPTYPE_ORGANIZATION

public static final java.lang.String GROUPTYPE_ORGANIZATION

Do not use.

GROUPTYPE_ROLE

public static final java.lang.String GROUPTYPE_ROLE

Do not use.

Constructor Detail

DSPrincipalRecord

public DSPrincipalRecord()

Default constructor.

Method Detail

getOid

public java.lang.String getOid()

Retrieves the principal identifier.

Returns:

A java.lang.String containing the principal's identifier.

getIsSystem

public boolean getIsSystem()

Determines whether the principal is a system principal.

Returns:

true if the principal is a system principal, false otherwise.

getVisibility

public int getVisibility()

Retrieves the visibility level of the principal.

Returns:

The visibility level of the principal.

There are three visibility levels:

• 0 means INVISIBLE; the principal does not qualify to be returned via a find API.
• 1 means SEARCHES; the principal qualifies for being returned via a find API.
• 2 means GUI; the principal qualifies for being displayed in a user interface.

getCommonName

public java.lang.String getCommonName()

Retrieves the full name of the principal that will be displayed in the user interface.

Returns:

A java.lang.String containing the full name of the principal that will be displayed in the user interface.

getDescription

public java.lang.String getDescription()

Retrieves the string used to describe the principal. For example, "This group contains all people managers."

Returns:

A java.lang.String describing the principal.

getEmail

public java.lang.String getEmail()

Retrieves the primary email address of the principal.

Returns:

A java.lang.String containing the primary email address of the principal.

getEmailAlias

public java.util.Set getEmailAlias()

Retrieves the email aliases of the principal if the aliases are provided. The set of email aliases should include the primary email address of the principal.

Returns:

A java.util.Set that contains the email aliases of the principal.

getFamilyName

public java.lang.String getFamilyName()

Retrieves the user's last (family) name.

Returns:

A java.lang.String containing the user's family name.

getGivenName

public java.lang.String getGivenName()

Retrieves the user's first (given) name.

Returns:

A java.lang.String containing the user's given name.

getGroupType

public java.lang.String getGroupType()

Retrieves the type of group record this describes.

Returns:

A java.lang.String containing the type of group record.

See Also:

DSPrincipalRecord.GROUPTYPE_PRINCIPALS, DSPrincipalRecord.GROUPTYPE_ORGANIZATION, DSPrincipalRecord.GROUPTYPE_ROLE

getInitials

public java.lang.String getInitials()

Retrieves the user's initials.

Returns:

A java.lang.String containing the user's initials.

getLocale

public java.lang.String getLocale()

Retrieves the locale in standard ISO language and country form. For example, "en_US".

Returns:

A java.lang.String containing the locale.

getOrg

public java.lang.String getOrg()

Retrieves the organization to which the principal belongs.

Returns:

A java.lang.String containing the organization to which the principal belongs.

getPostalAddress

public java.lang.String getPostalAddress()

Retrieves the user's postal address.

Returns:

A java.lang.String containing the user's postal address.

getPrincipalType

public java.lang.String getPrincipalType()

Retrieves the type of the principal.

Returns:

A java.lang.String that contains either TYPE_USER to indicate a user or TYPE_GROUP to indicate a group.

getTelephoneNumber

public java.lang.String getTelephoneNumber()

Retrieves the user's telephone number.

Returns:

A java.lang.String containing the user's telephone number.

getTimezone

public java.lang.String getTimezone()

Retrieves the standard Java string representation of a time zone. For example, "America/Los Angeles".

Returns:

A java.lang.String containing the time zone.

getUserid

public java.lang.String getUserid()

Retrieves the user identification of the principal. The user identification is the user name used to log into User Management.

Returns:

A java.lang.String that contains the identification if the principal is a user and null if the principal is a group.

setOid

public void setOid(java.lang.String oid)

Sets the principal identifier.

Parameters:

oid - A java.lang.String containing the principal's identifier.

setIsSystem

public void setIsSystem(boolean isSystem)

Sets whether the principal type is a system principal.

Parameters:

isSystem - true if the principal type is a system principal, false otherwise.

getOriginalName

public java.lang.String getOriginalName()

Retrieves the original name of the principal.

Returns:

A java.lang.String that contains the original name of the principal.

setCommonName

public void setCommonName(java.lang.String commonName)

Sets the full name of the principal. This name also appears in the User Management user interface.

Parameters:

commonName - A java.lang.String that contains the full name of the principal. The maximum length of the full name is 250 characters; errors can occur if greater lengths are used.

setDescription

public void setDescription(java.lang.String description)

Sets the string used to describe the principal. For example, "This group contains all people managers."

Parameters:

description - A java.lang.String that contains the description of the principal.

setEmail

public void setEmail(java.lang.String email)

Sets the primary email address of the principal. If provided, the email address appears in the User Management user interface.

Parameters:

email - A java.lang.String that contains the primary email address of the principal. The maximum length of the primary email address is 250 characters; errors can occur if greater lengths are used.

addEmailAlias

public void addEmailAlias(java.lang.String alias)

Adds an email alias of the principal. You can add several email aliases.

Parameters:

alias - A java.lang.String that contains the email alias to add. The maximum length of the email alias is 250 characters; errors can occur if greater lengths are used.

setFamilyName

public void setFamilyName(java.lang.String familyName)

Sets the user's last (family) name.

Parameters:

familyName - A java.lang.String that contains the user's family name.

setGivenName

public void setGivenName(java.lang.String givenName)

Sets the user's first (given) name.

Parameters:

givenName - A java.lang.String that contains the user's given name.

setGroupType

public void setGroupType(java.lang.String groupType)

Sets the type of group record this describes.

Parameters:

groupType - A java.lang.String that contains the type of group record.

See Also:

DSPrincipalRecord.GROUPTYPE_PRINCIPALS, DSPrincipalRecord.GROUPTYPE_ORGANIZATION, DSPrincipalRecord.GROUPTYPE_ROLE

setInitials

public void setInitials(java.lang.String initials)

Sets the user's initials.

Parameters:

initials - A java.lang.String that contains the user's initials.

setLocale

public void setLocale(java.lang.String locale)

Sets the locale in standard ISO language and country form. For example, "en_US".

Parameters:

locale - A java.lang.String that contains the locale.

setOrg

public void setOrg(java.lang.String org)

Sets the organization to which the principal belongs.

Parameters:

org - A java.lang.String that contains the organization.

setPostalAddress

public void setPostalAddress(java.lang.String postalAddress)

Sets the user's postal address.

Parameters:

postalAddress - A java.lang.String that contains the user's postal address.

setPrincipalType

public void setPrincipalType(java.lang.String principalType)

Sets the type of the principal.

Parameters:

principalType - A java.lang.String that contains either TYPE_USER to indicate a user or TYPE_GROUP to indicate a group.

setTelephoneNumber

public void setTelephoneNumber(java.lang.String telephoneNumber)

Sets the user's telephone number.

Parameters:

telephoneNumber - A java.lang.String that contains the user's telephone number.

setTimezone

public void setTimezone(java.lang.String timezone)

Sets the standard Java string representation of a time zone. For example, "America/Los Angeles".

Parameters:

timezone - A java.lang.String that contains the time zone.

setUserid

public void setUserid(java.lang.String userid)

Sets the user identification of the principal. The user identification is the user name used to log into User Management.

Parameters:

userid - A java.lang.String object that contains the user identification. The maximum length of the user identification is 100 characters; errors can occur if greater lengths are used.

setEmailAliases

public void setEmailAliases(java.util.List emailAlias)

Sets the secondary email addresses of the principal.

Parameters:

emailAlias - The secondary email addressPrin.

setVisibility

public void setVisibility(int visibility)

Sets the visibility level of the prinicpal.

Parameters:

visibility - The visibility level of the principal.

There are three visibility levels:

• 0 means INVISIBLE; the principal does not qualify to be returned via a find API.
• 1 means SEARCHES; the principal qualifies for being returned via a find API.
• 2 means GUI; the principal qualifies for being displayed in a user interface.

setOriginalName

public void setOriginalName(java.lang.String originalName)

Sets the original name of the principal. This could be the original distinguished name retrieved from an LDAP server.

Parameters:

originalName - The original distinguished name of the principal.

getRelAppOid

public java.lang.String getRelAppOid()

Retrieves the reliant application identifier for which the role is being defined.

Returns:

The reliant application identifier for which the role is being defined.

setRelAppOid

public void setRelAppOid(java.lang.String reliantApp)

Sets the reliant application identifier for which the role is being defined.

Parameters:

reliantApp - The reliant application identifier for which the role is being defined.

setMutableStatus

public void setMutableStatus(boolean isMutable)

Sets the mutable status of the role.

Parameters:

isMutable - true if the role is mutable, false otherwise.

isMutable

public boolean isMutable()

Retrieves the mutable status of the role.

Returns:

true if the role is mutable, false otherwise.

isDisabled

public boolean isDisabled()

Determines whether the principal is disabled.

Returns:

true if the principal is disabled, false otherwise.

setDisabled

public void setDisabled(boolean isDisabled)

Sets whether the principal is disabled.

Parameters:

isDisabled - true if the principal is disabled, false otherwise.