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

java.lang.Object
  extended by com.adobe.idp.um.spi.directoryservices.DSPrincipalIdRecord
Direct Known Subclasses:
DSGroupContainmentRecord, DSPrincipalRecord

public class DSPrincipalIdRecord
extends java.lang.Object

The DSPrincipalIdRecord class provides a container for the unique identification of a principal. The name and domain of a principal together constitute a unique identifier.

This class provides methods that User Management uses to retrieve information from the container and that user providers use to add the information to the container. To see an instance of this type used in a code example, see the Creating Authentication Providers topic located in Programming with LiveCycle ES4.


Constructor Summary
DSPrincipalIdRecord()
           
 
Method Summary
 java.lang.String getCanonicalName()
          Retrieves the canonical name of the principal.
 java.lang.String getDomainName()
          Retrieves the domain name of the principal.
 void setCanonicalName(java.lang.String canonicalName)
          Sets the canonical name of the principal.
 void setDomainName(java.lang.String domainName)
          Sets the domain name of the principal.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DSPrincipalIdRecord

public DSPrincipalIdRecord()
Method Detail

getDomainName

public java.lang.String getDomainName()
Retrieves the domain name of the principal.

Returns:
A java.lang.String that contains the domain name.

getCanonicalName

public java.lang.String getCanonicalName()
Retrieves the canonical name of the principal.

Returns:
A java.lang.String that contains the principal name.

setDomainName

public void setDomainName(java.lang.String domainName)
Sets the domain name of the principal.

Parameters:
string - A java.lang.String that contains the domain name. The maximum length of the domain name is 50 characters; errors can occur if greater lengths are used.

setCanonicalName

public void setCanonicalName(java.lang.String canonicalName)
Sets the canonical name of the principal.

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


[an error occurred while processing this directive] [an error occurred while processing this directive]