Package com.sun.identity.saml2.assertion.impl

Class SubjectConfirmationDataImpl

java.lang.Object

com.sun.identity.saml2.assertion.impl.SubjectConfirmationDataImpl

All Implemented Interfaces:

SubjectConfirmationData

Direct Known Subclasses:

KeyInfoConfirmationDataImpl

public class SubjectConfirmationDataImpl
extends Object
implements SubjectConfirmationData

The SubjectConfirmationData specifies additional data that allows the subject to be confirmed or constrains the circumstances under which the act of subject confirmation can take place. Subejct confirmation takes place when a relying party seeks to verify the relationship between an entity presenting the assertion and the subject of the assertion's claims.

Field Summary

Fields

Modifier and Type	Field	Description
String	elementName
protected boolean	mutable

Constructor Summary

Constructors

Constructor	Description
SubjectConfirmationDataImpl()
SubjectConfirmationDataImpl(String xmlString)
SubjectConfirmationDataImpl(Element element)

Method Summary

Modifier and Type	Method	Description
String	getAddress()	Returns the network address/location from which an attesting entity can present the assertion
List	getContent()	Returns a list of arbitrary XML elements to be added to this SubejctConfirmationData object.
String	getContentType()	Returns the content type attribute
protected String	getElementValue(boolean includeNSPrefix, boolean declareNS)	Returns a String representation of the element value
String	getInResponseTo()	Returns the ID of a SAML protocol message in response to which an attesting entity can present the assertion
Date	getNotBefore()	Returns the time instant before which the subject cannot be confirmed
Date	getNotOnOrAfter()	Returns the time instant at which the subject can no longer be confirmed
String	getRecipient()	Returns the URI specifying the entity or location to which an attesting entity can present the assertion
boolean	isMutable()	Returns true if the object is mutable
void	makeImmutable()	Makes the object immutable
protected void	parseAttributes(NamedNodeMap attrs)	Sets all the attribute values
protected void	parseContent(Element element)	Parse and sets content values
void	setAddress(String value)	Sets the network address/location from which an attesting entity can present the assertion
void	setContent(List value)	Sets a list of arbitrary XML elements to be added to this SubejctConfirmationData object.
void	setContentType(String attribute)	Sets the content type attribute.
void	setInResponseTo(String value)	Sets the ID of a SAML protocol message in response to which an attesting entity can present the assertion
void	setNotBefore(Date value)	Sets the time instant before which the subject cannot be confirmed
void	setNotOnOrAfter(Date value)	Sets the time instant at which the subject can no longer be confirmed
void	setRecipient(String value)	Sets the URI specifying the entity or location to which an attesting entity can present the assertion
String	toXMLString()	Returns a String representation of the element
String	toXMLString(boolean includeNSPrefix, boolean declareNS)	Returns a String representation of the element

Methods inherited from class java.lang.Object

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

Field Detail

elementName

public final String elementName

See Also:

Constant Field Values

mutable

protected boolean mutable

Constructor Detail

SubjectConfirmationDataImpl

public SubjectConfirmationDataImpl()

SubjectConfirmationDataImpl

public SubjectConfirmationDataImpl(Element element)
                            throws SAML2Exception

Throws:

SAML2Exception

SubjectConfirmationDataImpl

public SubjectConfirmationDataImpl(String xmlString)
                            throws SAML2Exception

Throws:

SAML2Exception

Method Detail

parseContent

protected void parseContent(Element element)
                     throws SAML2Exception

Parse and sets content values

Parameters:

element - Element for this class object

Throws:

SAML2Exception

parseAttributes

protected void parseAttributes(NamedNodeMap attrs)
                        throws SAML2Exception

Sets all the attribute values

Parameters:

attrs - Map table has attribute name and value pairs

Throws:

SAML2Exception

getNotOnOrAfter

public Date getNotOnOrAfter()

Returns the time instant at which the subject can no longer be confirmed

Specified by:

getNotOnOrAfter in interface SubjectConfirmationData

Returns:

the time instant at which the subject can no longer be confirmed

See Also:

setNotOnOrAfter(Date)

setNotOnOrAfter

public void setNotOnOrAfter(Date value)
                     throws SAML2Exception

Sets the time instant at which the subject can no longer be confirmed

Specified by:

setNotOnOrAfter in interface SubjectConfirmationData

Parameters:

value - the time instant at which the subject can no longer be confirmed

Throws:

SAML2Exception - if the object is immutable

See Also:

getNotOnOrAfter()

getInResponseTo

public String getInResponseTo()

Returns the ID of a SAML protocol message in response to which an attesting entity can present the assertion

Specified by:

getInResponseTo in interface SubjectConfirmationData

Returns:

the ID of a SAML protocol message in response to which an attesting entity can present the assertion

See Also:

setInResponseTo(String)

setInResponseTo

public void setInResponseTo(String value)
                     throws SAML2Exception

Sets the ID of a SAML protocol message in response to which an attesting entity can present the assertion

Specified by:

setInResponseTo in interface SubjectConfirmationData

Parameters:

value - the ID of a SAML protocol message in response to which an attesting entity can present the assertion

Throws:

SAML2Exception - if the object is immutable

See Also:

getInResponseTo()

getContent

public List getContent()

Returns a list of arbitrary XML elements to be added to this SubejctConfirmationData object.

Specified by:

getContent in interface SubjectConfirmationData

Returns:

a list of arbitrary XML elements to be added to this SubejctConfirmationData object.

See Also:

setContent(List)

setContent

public void setContent(List value)
                throws SAML2Exception

Sets a list of arbitrary XML elements to be added to this SubejctConfirmationData object.

Specified by:

setContent in interface SubjectConfirmationData

Parameters:

value - a list of arbitrary XML elements to be added to this SubejctConfirmationData object.

Throws:

SAML2Exception - if the object is immutable

See Also:

getContent()

getRecipient

public String getRecipient()

Returns the URI specifying the entity or location to which an attesting entity can present the assertion

Specified by:

getRecipient in interface SubjectConfirmationData

Returns:

the URI specifying the entity or location to which an attesting entity can present the assertion

See Also:

setRecipient(String)

setRecipient

public void setRecipient(String value)
                  throws SAML2Exception

Sets the URI specifying the entity or location to which an attesting entity can present the assertion

Specified by:

setRecipient in interface SubjectConfirmationData

Parameters:

value - the URI specifying the entity or location to which an attesting entity can present the assertion

Throws:

SAML2Exception - if the object is immutable

See Also:

getRecipient()

getNotBefore

public Date getNotBefore()

Returns the time instant before which the subject cannot be confirmed

Specified by:

getNotBefore in interface SubjectConfirmationData

Returns:

the time instant before which the subject cannot be confirmed

See Also:

setNotBefore(Date)

setNotBefore

public void setNotBefore(Date value)
                  throws SAML2Exception

Sets the time instant before which the subject cannot be confirmed

Specified by:

setNotBefore in interface SubjectConfirmationData

Parameters:

value - the time instant before which the subject cannot be confirmed

Throws:

SAML2Exception - if the object is immutable

See Also:

getNotBefore()

getAddress

public String getAddress()

Returns the network address/location from which an attesting entity can present the assertion

Specified by:

getAddress in interface SubjectConfirmationData

Returns:

the network address/location from which an attesting entity can present the assertion

See Also:

setAddress(String)

setAddress

public void setAddress(String value)
                throws SAML2Exception

Sets the network address/location from which an attesting entity can present the assertion

Specified by:

setAddress in interface SubjectConfirmationData

Parameters:

value - the network address/location from which an attesting entity can present the assertion

Throws:

SAML2Exception - if the object is immutable

See Also:

getAddress()

getContentType

public String getContentType()

Returns the content type attribute

Specified by:

getContentType in interface SubjectConfirmationData

Returns:

the content type attribute

See Also:

setContentType(String)

setContentType

public void setContentType(String attribute)
                    throws SAML2Exception

Sets the content type attribute.

Specified by:

setContentType in interface SubjectConfirmationData

Parameters:

attribute - attribute type value for the content that will be added

Throws:

SAML2Exception - if the object is immutable

See Also:

SubjectConfirmationData.getContentType()

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns a String representation of the element

Specified by:

toXMLString in interface SubjectConfirmationData

Returns:

A String representation

Throws:

SAML2Exception - if something is wrong during conversion

toXMLString

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

Returns a String representation of the element

Specified by:

toXMLString in interface SubjectConfirmationData

Parameters:

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

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

Returns:

A String representation

Throws:

SAML2Exception - if something is wrong during conversion

getElementValue

protected String getElementValue(boolean includeNSPrefix,
                                 boolean declareNS)
                          throws SAML2Exception

Returns a String representation of the element value

Parameters:

includeNSPrefix - Determines whether 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

makeImmutable

public void makeImmutable()

Makes the object immutable

Specified by:

makeImmutable in interface SubjectConfirmationData

isMutable

public boolean isMutable()

Returns true if the object is mutable

Specified by:

isMutable in interface SubjectConfirmationData

Returns:

true if the object is mutable