com.sun.identity.saml2.assertion
Interface SubjectConfirmation

public interface 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.

Method Summary

BaseID	getBaseID() Returns the base ID
EncryptedID	getEncryptedID() Returns the encrypted ID
java.lang.String	getMethod() Returns the confirmation method
NameID	getNameID() Returns the name identifier
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(java.lang.String value) Sets the confirmation method
void	setNameID(NameID value) Sets the name identifier
void	setSubjectConfirmationData(SubjectConfirmationData value) Sets the subject confirmation data
java.lang.String	toXMLString() Returns a String representation
java.lang.String	toXMLString(boolean includeNSPrefix, boolean declareNS) Returns a String representation

Method Detail

getEncryptedID

public EncryptedID getEncryptedID()

Returns the encrypted ID

Returns:

the encrypted ID

setEncryptedID

public void setEncryptedID(EncryptedID value)
                    throws SAML2Exception

Sets the encrypted ID

Parameters:

value - the encrypted ID

Throws:

SAML2Exception - if the object is immutable

getSubjectConfirmationData

public SubjectConfirmationData getSubjectConfirmationData()

Returns the subject confirmation data

Returns:

the subject confirmation data

setSubjectConfirmationData

public void setSubjectConfirmationData(SubjectConfirmationData value)
                                throws SAML2Exception

Sets the subject confirmation data

Parameters:

value - the subject confirmation data

Throws:

SAML2Exception - if the object is immutable

getNameID

public NameID getNameID()

Returns the name identifier

Returns:

the name identifier

setNameID

public void setNameID(NameID value)
               throws SAML2Exception

Sets the name identifier

Parameters:

value - the name identifier

Throws:

SAML2Exception - if the object is immutable

getBaseID

public BaseID getBaseID()

Returns the base ID

Returns:

the base ID

setBaseID

public void setBaseID(BaseID value)
               throws SAML2Exception

Sets the base ID

Parameters:

value - the base ID

Throws:

SAML2Exception - if the object is immutable

getMethod

public java.lang.String getMethod()

Returns the confirmation method

Returns:

the confirmation method

setMethod

public void setMethod(java.lang.String value)
               throws SAML2Exception

Sets the confirmation method

Parameters:

value - the confirmation method

Throws:

SAML2Exception - if the object is immutable

toXMLString

public java.lang.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

public java.lang.String toXMLString()
                             throws SAML2Exception

Returns a String representation

Returns:

A String representation

Throws:

SAML2Exception - if something is wrong during conversion

makeImmutable

public void makeImmutable()

Makes the object immutable

isMutable

public boolean isMutable()

Returns true if the object is mutable

Returns:

true if the object is mutable