com.sun.identity.saml2.assertion.impl

Class SubjectConfirmationImpl

java.lang.Object

com.sun.identity.saml2.assertion.impl.SubjectConfirmationImpl

All Implemented Interfaces:

SubjectConfirmation

public class SubjectConfirmationImpl
extends Object
implements SubjectConfirmation

The SubjectConfirmation provides the means for a relying party to verify the correspondence of the subject of the assertion with the party with whom the relying party is communicating.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_ID_ELEMENT
static String	ENCRYPTED_ID_ELEMENT
static String	METHOD_ATTR
static String	NAME_ID_ELEMENT
static String	SUBJECT_CONFIRMATION_DATA_ELEMENT
static String	SUBJECT_CONFIRMATION_ELEMENT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
BaseID	getBaseID() Returns the base ID
EncryptedID	getEncryptedID() Returns the encrypted ID
String	getMethod() Returns the confirmation method
NameID	getNameID() Returns the identifier in NameID format
SubjectConfirmationData	getSubjectConfirmationData() Returns the subject confirmation data
boolean	isMutable() Returns true if the object is mutable
void	makeImmutable() Makes the object immutable
void	setBaseID(BaseID value) Sets the base ID
void	setEncryptedID(EncryptedID value) Sets the encrypted ID
void	setMethod(String value) Sets the confirmation method
void	setNameID(NameID value) Sets the identifier in NameID format
void	setSubjectConfirmationData(SubjectConfirmationData value) Sets the subject confirmation data
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_CONFIRMATION_ELEMENT

public static final String SUBJECT_CONFIRMATION_ELEMENT

See Also:

Constant Field Values

SUBJECT_CONFIRMATION_DATA_ELEMENT

public static final String SUBJECT_CONFIRMATION_DATA_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

METHOD_ATTR

public static final String METHOD_ATTR

See Also:

Constant Field Values

Constructor Detail

SubjectConfirmationImpl

public SubjectConfirmationImpl()

Default constructor

SubjectConfirmationImpl

public SubjectConfirmationImpl(String xml)
                        throws SAML2Exception

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

Parameters:

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

Throws:

SAML2Exception - if it could not process the XML string

SubjectConfirmationImpl

public SubjectConfirmationImpl(Element element)
                        throws SAML2Exception

This constructor is used to build SubjectConfirmation 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 SubjectConfirmation object

Throws:

SAML2Exception - if it could not process the Element

Method Detail

getEncryptedID

public EncryptedID getEncryptedID()

Returns the encrypted ID

Specified by:

getEncryptedID in interface SubjectConfirmation

Returns:

the encrypted ID

setEncryptedID

public void setEncryptedID(EncryptedID value)
                    throws SAML2Exception

Sets the encrypted ID

Specified by:

setEncryptedID in interface SubjectConfirmation

Parameters:

value - the encrypted ID

Throws:

SAML2Exception - if the object is immutable

getNameID

public NameID getNameID()

Returns the identifier in NameID format

Specified by:

getNameID in interface SubjectConfirmation

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 SubjectConfirmation

Parameters:

value - the identifier in NameID format

Throws:

SAML2Exception - if the object is immutable

getSubjectConfirmationData

public SubjectConfirmationData getSubjectConfirmationData()

Returns the subject confirmation data

Specified by:

getSubjectConfirmationData in interface SubjectConfirmation

Returns:

the subject confirmation data

setSubjectConfirmationData

public void setSubjectConfirmationData(SubjectConfirmationData value)
                                throws SAML2Exception

Sets the subject confirmation data

Specified by:

setSubjectConfirmationData in interface SubjectConfirmation

Parameters:

value - the subject confirmation data

Throws:

SAML2Exception - if the object is immutable

getBaseID

public BaseID getBaseID()

Returns the base ID

Specified by:

getBaseID in interface SubjectConfirmation

Returns:

the base ID

setBaseID

public void setBaseID(BaseID value)
               throws SAML2Exception

Sets the base ID

Specified by:

setBaseID in interface SubjectConfirmation

Parameters:

value - the base ID

Throws:

SAML2Exception - if the object is immutable

getMethod

public String getMethod()

Returns the confirmation method

Specified by:

getMethod in interface SubjectConfirmation

Returns:

the confirmation method

setMethod

public void setMethod(String value)
               throws SAML2Exception

Sets the confirmation method

Specified by:

setMethod in interface SubjectConfirmation

Parameters:

value - the confirmation method

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 SubjectConfirmation

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 SubjectConfirmation

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 SubjectConfirmation

isMutable

public boolean isMutable()

Returns true if the object is mutable

Specified by:

isMutable in interface SubjectConfirmation

Returns:

true if the object is mutable