All attributes of the ClientPrincipal class are private. The following table lists the accessor methods of the ClientPrincipal class attributes.

Note: In general, attributes may only be updated on a ClientPrincipal object with a loginState of "INITIAL". Attempts to update attributes once the ClientPrincipal object is sealed, expired, failed, or logged out will throw an exception.
Table 1. Accessor methods of ClientPrincipal attributes
Accessor methods Description of attribute
getAuditEventContext() The application-defined audit context string
getClientTTY()

setClientTTY(String clientTTY)

The value of this attribute is defined by the application.
getClientWorkstation()

setClientWorkstation(String clientWS )

The value of this attribute is defined by the application.
getDomainDescription()

setDomainDescription(String domainDescr )

A description of the domain that authenticated the user represented by the ClientPrincipal object
getDomainName()

setDomainName(String domainName )

 The name of the security domain to which the user represented by the ClientPrincipal object belongs
getDomainType()

setDomainType(String domainType )

 The name of the authentication system configured for the security domain to which the user represented by the ClientPrincipal object belongs
getLoginExpirationTimestamp()

setLoginExpirationTimestamp(long timeStamp )

 The timestamp of when the ClientPrincipal object will expire, expressed as the number of seconds since midnight, January 1, 1970
getLoginHost()

setLoginHost(String loginHost )

The value of this attribute is defined by the application.
getLoginState() A string representing the current state of the ClientPrincipal object. This field may contain a value of "INITIAL", "LOGIN", "LOGOUT", "EXPIRED", or "FAILED". This value is set as a result of calling the seal(), validateSeal(), or logout() methods.
setPrimaryPassphrase(String passphrase ) The password required to authenticate the user identity represented by the ClientPrincipal object
getQualifiedUserID()

setQualifiedUserID(String qualifiedUserID )

A string containing the userID and domainName attributes separated by the "@" delimiter.
getRoles() setRoles(String domainRoles ) A comma-separated list of domain roles for the user represented by the ClientPrincipal object
getSealTimestamp(long timeStamp ) The timestamp of when the ClientPrincipal object was sealed, expressed as the number of seconds since midnight, January 1, 1970. This value is set as a result of calling the seal() method.
getSessionID()

setSessionID(String sessionID )

The user login session ID for the user represented by the ClientPrincipal object
getStateDetail() A string that provides detailed information regarding the state of the ClientPrincipal object
getUserID()

setUserID(String userID )

 The unqualified name of the user represented by the ClientPrincipal object. The value of this attribute will also be set automatically if the setQualifiedUserID() method is called.