com.sun.identity.saml2.assertion.impl

Class SubjectImpl

java.lang.Object

com.sun.identity.saml2.assertion.impl.SubjectImpl

All Implemented Interfaces:

Subject

public class SubjectImpl
extends Object
implements 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_ID_ELEMENT
static String	ENCRYPTED_ID_ELEMENT
static String	NAME_ID_ELEMENT
static String	SUBJECT_CONFIRMATION_ELEMENT
static String	SUBJECT_ELEMENT

Constructor Summary

Constructors

Constructor and Description
SubjectImpl() Default constructor
SubjectImpl(Element element) This constructor is used to build Subject object from a block of existing XML that has already been built into a DOM.
SubjectImpl(String xml) This constructor is used to build Subject object from a XML string.

Method Summary

Modifier and Type	Method and Description
BaseID	getBaseID() Returns the identifier in BaseID format
EncryptedID	getEncryptedID() Returns the encrypted identifier
NameID	getNameID() Returns the identifier in NameID format
List	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 confirmations) Sets a list of subject confirmations
String	toXMLString() Returns a String representation
String	toXMLString(boolean includeNSPrefix, boolean declareNS) Returns a String representation

Methods inherited from class java.lang.Object

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

Field Detail

SUBJECT_ELEMENT

public static final String SUBJECT_ELEMENT

See Also:

Constant Field Values

SUBJECT_CONFIRMATION_ELEMENT

public static final String SUBJECT_CONFIRMATION_ELEMENT

See Also:

Constant Field Values

BASE_ID_ELEMENT

public static final String BASE_ID_ELEMENT

See Also:

Constant Field Values

NAME_ID_ELEMENT

public static final String NAME_ID_ELEMENT

See Also:

Constant Field Values

ENCRYPTED_ID_ELEMENT

public static final String ENCRYPTED_ID_ELEMENT

See Also:

Constant Field Values

Constructor Detail

SubjectImpl

public SubjectImpl()

Default constructor

SubjectImpl

public SubjectImpl(String xml)
            throws SAML2Exception

This constructor is used to build Subject object from a XML string.

Parameters:

xml - A java.lang.String representing a Subject object

Throws:

SAML2Exception - if it could not process the XML string

SubjectImpl

public SubjectImpl(Element element)
            throws SAML2Exception

This constructor is used to build Subject object from a block of existing XML that has already been built into a DOM.

Parameters:

element - A org.w3c.dom.Element representing DOM tree for Subject object

Throws:

SAML2Exception - if it could not process the Element

Method Detail

getEncryptedID

public EncryptedID getEncryptedID()

Returns the encrypted identifier

Specified by:

getEncryptedID in interface Subject

Returns:

the encrypted identifier

setEncryptedID

public void setEncryptedID(EncryptedID value)
                    throws SAML2Exception

Sets the encrypted identifier

Specified by:

setEncryptedID in interface Subject

Parameters:

value - the encrypted identifier

Throws:

SAML2Exception - if the object is immutable

getNameID

public NameID getNameID()

Returns the identifier in NameID format

Specified by:

getNameID in interface Subject

Returns:

the identifier in NameID format

setNameID

public void setNameID(NameID value)
               throws SAML2Exception

Sets the identifier in NameID format

Specified by:

setNameID in interface Subject

Parameters:

value - the identifier in NameID format

Throws:

SAML2Exception - if the object is immutable

getSubjectConfirmation

public List getSubjectConfirmation()

Returns a list of subject confirmations

Specified by:

getSubjectConfirmation in interface Subject

Returns:

a list of subject confirmations

setSubjectConfirmation

public void setSubjectConfirmation(List confirmations)
                            throws SAML2Exception

Sets a list of subject confirmations

Specified by:

setSubjectConfirmation in interface Subject

Parameters:

confirmations - a list of subject confirmations

Throws:

SAML2Exception - if the object is immutable

getBaseID

public BaseID getBaseID()

Returns the identifier in BaseID format

Specified by:

getBaseID in interface Subject

Returns:

the identifier in BaseID format

setBaseID

public void setBaseID(BaseID value)
               throws SAML2Exception

Sets the identifier in BaseID format

Specified by:

setBaseID in interface Subject

Parameters:

value - the identifier in BaseID format

Throws:

SAML2Exception - if the object is immutable

toXMLString

public String toXMLString(boolean includeNSPrefix,
                          boolean declareNS)
                   throws SAML2Exception

Returns a String representation

Specified by:

toXMLString in interface Subject

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

public String toXMLString()
                   throws SAML2Exception

Returns a String representation

Specified by:

toXMLString in interface Subject

Returns:

A String representation

Throws:

SAML2Exception - if something is wrong during conversion

makeImmutable

public void makeImmutable()

Makes the object immutable

Specified by:

makeImmutable in interface Subject

isMutable

public boolean isMutable()

Returns true if the object is mutable

Specified by:

isMutable in interface Subject

Returns:

true if the object is mutable