weblogic.security.providers.authentication

Class SubjectComponentData

java.lang.Object

weblogic.security.providers.authentication.SubjectComponentData

public final class SubjectComponentData
extends Object

SubjectComponentData is an immutable collection of subject components which may be used to create a Subject.

Constructor Summary

Constructors

Constructor and Description
SubjectComponentData(String userName, Set<String> groups, Set<Principal> principals, Set<Object> privateCredentials, Set<Object> publicCredentials) Constructs an instance with an undefined Identity Domain.
SubjectComponentData(String userName, Set<String> groups, Set<Principal> principals, Set<Object> privateCredentials, Set<Object> publicCredentials, String identityDomain) Constructs an instance with the specified Identity Domain.
SubjectComponentData(SubjectComponentData subjectComponentData, String identityDomain) Constructs an instance with the specified Identity Domain, copying the other subject component references from the given SubjectComponentData object.

Method Summary

Modifier and Type	Method and Description
Set<String>	getGroups() Determines the Subject group membership.
String	getIdentityDomain() Determines the Subject identity domain.
Set<Principal>	getPrincipals() Determines the Subject set of additional principals.
Set<Object>	getPrivateCredentials() Determines the Subject set of private credentials.
Set<Object>	getPublicCredentials() Determines the Subject set of public credentials.
String	getUserName() Determines the Subject username, without encoded identity domain.
boolean	isIdentityDomainSet() Determines whether the Subject identity domain has been set.
String	toString() Provides a string representation of the contained data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SubjectComponentData

public SubjectComponentData(String userName,
                            Set<String> groups,
                            Set<Principal> principals,
                            Set<Object> privateCredentials,
                            Set<Object> publicCredentials)

Constructs an instance with an undefined Identity Domain.

The instance created, using this constructor, would have SubjectComponentData.isIdentityDomainSet() return false. This implies callers, such as Identity Asserter implementations, may supplement the SubjectComponentData with a configured IdentityDomain.

NOTE THAT null given to any parameter is accepted and returned in the corresponding getter.

Parameters:

userName - Subject user name, without encoded identity domain.

groups - Subject group membership

principals - Additional subject principals, we assume Principal implementations are immutable.

privateCredentials - Subject private credentials, we assume credentials are immutable.

publicCredentials - Subject public credentials, we assume credentials are immutable.

SubjectComponentData

public SubjectComponentData(String userName,
                            Set<String> groups,
                            Set<Principal> principals,
                            Set<Object> privateCredentials,
                            Set<Object> publicCredentials,
                            String identityDomain)

Constructs an instance with the specified Identity Domain.

The instance created, using this constructor, would have SubjectComponentData.isIdentityDomainSet() return true.

NOTE THAT null given to any parameter is accepted and returned in the corresponding getter.

Parameters:

userName - Subject user name, without encoded identity domain.

groups - Subject group membership

principals - Additional subject principals, we assume Principal implementations are immutable.

privateCredentials - Subject private credentials, we assume credentials are immutable.

publicCredentials - Subject public credentials, we assume credentials are immutable.

identityDomain - Subject identity domain, which may be null or empty String.

SubjectComponentData

public SubjectComponentData(SubjectComponentData subjectComponentData,
                            String identityDomain)
                     throws NullPointerException

Constructs an instance with the specified Identity Domain, copying the other subject component references from the given SubjectComponentData object.

The instance created, using this constructor, would have SubjectComponentData.isIdentityDomainSet() return true.

Parameters:

subjectComponentData - SubjectComponentData instance from which to copy.

identityDomain - Subject identity domain, which may be null or empty String.

Throws:

NullPointerException - The given subjectComponentData was null.

Method Detail

getUserName

public String getUserName()

Determines the Subject username, without encoded identity domain.

Returns:

The username, or null if none

getIdentityDomain

public String getIdentityDomain()

Determines the Subject identity domain.

Returns:

The identity domain if SubjectComponentData.isIdentityDomainSet() returns true. Otherwise, this returned value is invalid.

isIdentityDomainSet

public boolean isIdentityDomainSet()

Determines whether the Subject identity domain has been set.

Returns:

true if identity domain has been set, otherwise false.

getGroups

public Set<String> getGroups()

Determines the Subject group membership.

Returns:

The immutable set of groups, or null if none.

getPrincipals

public Set<Principal> getPrincipals()

Determines the Subject set of additional principals.

Returns:

The immutable set of principals, or null if none.

getPrivateCredentials

public Set<Object> getPrivateCredentials()

Determines the Subject set of private credentials.

Returns:

The immutable set of private credentials, or null if none.

getPublicCredentials

public Set<Object> getPublicCredentials()

Determines the Subject set of public credentials.

Returns:

The immutable set of public credentials, or null if none.

toString

public String toString()

Provides a string representation of the contained data.

Overrides:

toString in class Object

See Also:

Object.toString()