Package com.sun.identity.saml2.assertion
Interface SubjectConfirmationData
-
- All Known Subinterfaces:
KeyInfoConfirmationData
- All Known Implementing Classes:
KeyInfoConfirmationDataImpl,SubjectConfirmationDataImpl
public interface SubjectConfirmationDataTheSubjectConfirmationDataspecifies additional data that allows the subject to be confirmed or constrains the circumstances under which the act of subject confirmation can take place. Subject 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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetAddress()Returns the network address/location from which an attesting entity can present the assertionListgetContent()Returns a list of arbitrary XML elements to be added to thisSubjectConfirmationDataobject.StringgetContentType()Returns the content type attributeStringgetInResponseTo()Returns the ID of a SAML protocol message in response to which an attesting entity can present the assertionDategetNotBefore()Returns the time instant before which the subject cannot be confirmedDategetNotOnOrAfter()Returns the time instant at which the subject can no longer be confirmedStringgetRecipient()Returns the URI specifying the entity or location to which an attesting entity can present the assertionbooleanisMutable()Returns true if the object is mutablevoidmakeImmutable()Makes the object immutablevoidsetAddress(String value)Sets the network address/location from which an attesting entity can present the assertionvoidsetContent(List content)Sets a list of arbitrary XML elements to be added to thisSubjectConfirmationDataobject.voidsetContentType(String attribute)Sets the content type attributevoidsetInResponseTo(String value)Sets the ID of a SAML protocol message in response to which an attesting entity can present the assertionvoidsetNotBefore(Date value)Sets the time instant before which the subject cannot be confirmedvoidsetNotOnOrAfter(Date value)Sets the time instant at which the subject can no longer be confirmedvoidsetRecipient(String value)Sets the URI specifying the entity or location to which an attesting entity can present the assertionStringtoXMLString()Returns a String representationStringtoXMLString(boolean includeNSPrefix, boolean declareNS)Returns a String representation
-
-
-
Method Detail
-
getNotOnOrAfter
Date getNotOnOrAfter()
Returns the time instant at which the subject can no longer be confirmed- Returns:
- the time instant at which the subject can no longer be confirmed
-
setNotOnOrAfter
void setNotOnOrAfter(Date value) throws SAML2Exception
Sets the time instant at which the subject can no longer be confirmed- Parameters:
value- the time instant at which the subject can no longer be confirmed- Throws:
SAML2Exception- if the object is immutable
-
getInResponseTo
String getInResponseTo()
Returns the ID of a SAML protocol message in response to which an attesting entity can present the assertion- Returns:
- the ID of a SAML protocol message in response to which an attesting entity can present the assertion
-
setInResponseTo
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- 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
-
getContent
List getContent()
Returns a list of arbitrary XML elements to be added to thisSubjectConfirmationDataobject.- Returns:
- a list of arbitrary XML elements to be added to this
SubjectConfirmationDataobject.
-
setContent
void setContent(List content) throws SAML2Exception
Sets a list of arbitrary XML elements to be added to thisSubjectConfirmationDataobject.- Parameters:
content- a list of arbitrary XML elements to be added to thisSubjectConfirmationDataobject.- Throws:
SAML2Exception- if the object is immutable
-
getRecipient
String getRecipient()
Returns the URI specifying the entity or location to which an attesting entity can present the assertion- Returns:
- the URI specifying the entity or location to which an attesting entity can present the assertion
-
setRecipient
void setRecipient(String value) throws SAML2Exception
Sets the URI specifying the entity or location to which an attesting entity can present the assertion- 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
-
getNotBefore
Date getNotBefore()
Returns the time instant before which the subject cannot be confirmed- Returns:
- the time instant before which the subject cannot be confirmed
-
setNotBefore
void setNotBefore(Date value) throws SAML2Exception
Sets the time instant before which the subject cannot be confirmed- Parameters:
value- the time instant before which the subject cannot be confirmed- Throws:
SAML2Exception- if the object is immutable
-
getAddress
String getAddress()
Returns the network address/location from which an attesting entity can present the assertion- Returns:
- the network address/location from which an attesting entity can present the assertion
-
setAddress
void setAddress(String value) throws SAML2Exception
Sets the network address/location from which an attesting entity can present the assertion- Parameters:
value- the network address/location from which an attesting entity can present the assertion- Throws:
SAML2Exception- if the object is immutable
-
getContentType
String getContentType()
Returns the content type attribute- Returns:
- the content type attribute
- See Also:
setContentType(String)
-
setContentType
void setContentType(String attribute) throws SAML2Exception
Sets the content type attribute- Parameters:
attribute- attribute type value for the content that will be added- Throws:
SAML2Exception- if the object is immutable- See Also:
getContentType()
-
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 converteddeclareNS- 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
-
-