Package com.sun.identity.saml2.assertion

Interface Subject

@SupportedAll
public interface Subject

The Subject specifies the principal that is the subject of all of the statements in the assertion. It contains an identifier, a series of one or more subject confirmations, or both.

Method Summary

Modifier and Type	Method	Description
BaseID	getBaseID()	Returns the identifier in BaseID format
EncryptedID	getEncryptedID()	Returns the encrypted identifier
NameID	getNameID()	Returns the identifier in NameID format
List<SubjectConfirmation>	getSubjectConfirmation()	Returns a list of subject confirmations
boolean	isMutable()	Returns true if the object is mutable
void	makeImmutable()	Makes the object immutable
void	setBaseID(BaseID value)	Sets the identifier in BaseID format
void	setEncryptedID(EncryptedID value)	Sets the encrypted identifier
void	setNameID(NameID value)	Sets the identifier in NameID format
void	setSubjectConfirmation(List<SubjectConfirmation> confirmations)	Sets a list of subject confirmations
String	toXMLString()	Returns a String representation
String	toXMLString(boolean includeNSPrefix, boolean declareNS)	Returns a String representation

Method Detail

getEncryptedID

EncryptedID getEncryptedID()

Returns the encrypted identifier

Returns:

the encrypted identifier

setEncryptedID

void setEncryptedID(EncryptedID value)
             throws SAML2Exception

Sets the encrypted identifier

Parameters:

value - the encrypted identifier

Throws:

SAML2Exception - if the object is immutable

getNameID

NameID getNameID()

Returns the identifier in NameID format

Returns:

the identifier in NameID format

setNameID

void setNameID(NameID value)
        throws SAML2Exception

Sets the identifier in NameID format

Parameters:

value - the identifier in NameID format

Throws:

SAML2Exception - if the object is immutable

getSubjectConfirmation

List<SubjectConfirmation> getSubjectConfirmation()

Returns a list of subject confirmations

Returns:

a list of subject confirmations

setSubjectConfirmation

void setSubjectConfirmation(List<SubjectConfirmation> confirmations)
                     throws SAML2Exception

Sets a list of subject confirmations

Parameters:

confirmations - a list of subject confirmations

Throws:

SAML2Exception - if the object is immutable

getBaseID

BaseID getBaseID()

Returns the identifier in BaseID format

Returns:

the identifier in BaseID format

setBaseID

void setBaseID(BaseID value)
        throws SAML2Exception

Sets the identifier in BaseID format

Parameters:

value - the identifier in BaseID format

Throws:

SAML2Exception - if the object is immutable

toXMLString

String toXMLString(boolean includeNSPrefix,
                   boolean declareNS)
            throws SAML2Exception

Returns a String representation

Parameters:

includeNSPrefix - Determines whether or not the namespace qualifier is prepended to the Element when converted

declareNS - Determines whether or not the namespace is declared within the Element.

Returns:

A String representation

Throws:

SAML2Exception - if something is wrong during conversion

toXMLString

String toXMLString()
            throws SAML2Exception

Returns a String representation

Returns:

A String representation

Throws:

SAML2Exception - if something is wrong during conversion

makeImmutable

void makeImmutable()

Makes the object immutable

isMutable

boolean isMutable()

Returns true if the object is mutable

Returns:

true if the object is mutable