oracle.security.xmlsec.saml2.core
Class SubjectConfirmationData

java.lang.Object
oracle.security.xmlsec.util.XMLNode
oracle.security.xmlsec.util.XMLElement
oracle.security.xmlsec.saml2.core.SubjectConfirmationData

public class SubjectConfirmationData

extends oracle.security.xmlsec.util.XMLElement

Represents information that allows the subject of the assertion to be confirmed.

Field Summary

Fields inherited from class oracle.security.xmlsec.util.XMLNode

node, systemId

Constructor Summary

SubjectConfirmationData(org.w3c.dom.Document owner)
Creates a new SubjectConfirmationData instance.

SubjectConfirmationData(org.w3c.dom.Element element)
Creates a new SubjectConfirmationData instance from the given Element node.

SubjectConfirmationData(org.w3c.dom.Element element, java.lang.String systemId)
Creates a new SubjectConfirmationData instance from the given Element node.

Method Summary

java.lang.String	getAddress() Returns the network address/location from which an entity can present the assertion.
java.lang.String	getAttributeNS(java.lang.String namespaceURI, java.lang.String localName) Retrieves an attribute value by local name and namespace URI.
java.util.List	getConfirmationData() Returns the ConfirmationData pertaining to the subject.
java.lang.String	getInResponseTo() Returns the identifier of the SAML protocol message in response to which an entity can present the assertion.
java.util.List	getKeyInfoConfirmationData() Returns the specified KeyInfoConfirmationData.
java.util.Date	getNotBefore() Returns the time instant before which the subject can not be confirmed.
java.util.Date	getNotOnOrAfter() Returns the time instant on or after which the subject can not be confirmed.
java.lang.String	getRecipient() Returns the URI to which an entity can present the assertion.
void	setAddress(java.lang.String address) Specify the network address/location from which an entity can present the assertion.
void	setAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String value) Specify an arbitrary attribute.
void	setConfirmationData(java.util.List elements) Set the ConfirmationData pertaining to the subject.
void	setInResponseTo(java.lang.String inResponseTo) Sets the identifier of the SAML protocol message in response to which an entity can present the assertion.
void	setKeyInfoConfirmationData(java.util.List keyInfos) Set the KeyInfoConfirmationData, which specifies a cryptographic key(s) held by the subject.
void	setNotBefore(java.util.Date notBefore) Sets the time instant before which the subject can not be confirmed.
void	setNotOnOrAfter(java.util.Date notOnOrAfter) Sets the time instant on or after which the subject can not be confirmed.
void	setRecipient(java.lang.String recipient) Sets the URI to which an entity can present the assertion.

Methods inherited from class oracle.security.xmlsec.util.XMLElement

addNSPrefixAttr, addNSPrefixAttr, addNSPrefixAttrDefault, addNSPrefixAttrDefault, getAttribute, getAttributeNode, getAttributeNodeNS, getChildElementsByTagName, getChildElementsByTagName, getChildElementsByTagNameNS, getChildElementsByTagNameNS, getDefaultNSPrefix, getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setDefaultNSPrefix

Methods inherited from class oracle.security.xmlsec.util.XMLNode

appendChild, appendChild, appendTo, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNode, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getSystemId, hasAttributes, hasChildNodes, insertBefore, insertBefore, isSupported, normalize, removeChild, removeChild, replaceChild, replaceChild, setNodeValue, setPrefix, setSystemId, toBytesXML, toStringXML

Methods inherited from class java.lang.Object

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

Constructor Detail

SubjectConfirmationData

public SubjectConfirmationData(org.w3c.dom.Element element)
                        throws org.w3c.dom.DOMException

Creates a new SubjectConfirmationData instance from the given Element node.

Parameters:

element - A SubjectConfirmationData element.

SubjectConfirmationData

public SubjectConfirmationData(org.w3c.dom.Element element,
                               java.lang.String systemId)
                        throws org.w3c.dom.DOMException

Creates a new SubjectConfirmationData instance from the given Element node.

Parameters:

element - A SubjectConfirmationData element.

systemId - The URI string system ID for the SubjectConfirmationData.

SubjectConfirmationData

public SubjectConfirmationData(org.w3c.dom.Document owner)
                        throws org.w3c.dom.DOMException

Creates a new SubjectConfirmationData instance.

Parameters:

owner - The owner document of the new SubjectConfirmationData.

Method Detail

setNotBefore

public void setNotBefore(java.util.Date notBefore)

Sets the time instant before which the subject can not be confirmed.

Parameters:

notBefore - The specified time.

getNotBefore

public java.util.Date getNotBefore()

Returns the time instant before which the subject can not be confirmed.

Returns:

The specified time or null if not specified.

setNotOnOrAfter

public void setNotOnOrAfter(java.util.Date notOnOrAfter)

Sets the time instant on or after which the subject can not be confirmed.

Parameters:

notOnOrAfter - The specified time.

getNotOnOrAfter

public java.util.Date getNotOnOrAfter()

Returns the time instant on or after which the subject can not be confirmed.

Returns:

The specified time or null if not specified.

setRecipient

public void setRecipient(java.lang.String recipient)

Sets the URI to which an entity can present the assertion.

Parameters:

recipient - A URI specifying an entity or a location.

getRecipient

public java.lang.String getRecipient()

Returns the URI to which an entity can present the assertion.

Returns:

A URI reference.

setInResponseTo

public void setInResponseTo(java.lang.String inResponseTo)

Sets the identifier of the SAML protocol message in response to which an entity can present the assertion.

Parameters:

inResponseTo - An "ID" attribute value.

getInResponseTo

public java.lang.String getInResponseTo()

Returns the identifier of the SAML protocol message in response to which an entity can present the assertion.

Returns:

The "ID" attribute value or <ocde>null if not specified.

setAddress

public void setAddress(java.lang.String address)

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

Parameters:

address - A String containing an IP address or other types of location information.

getAddress

public java.lang.String getAddress()

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

Returns:

The location information.

setAttributeNS

public void setAttributeNS(java.lang.String namespaceURI,
                           java.lang.String qualifiedName,
                           java.lang.String value)

Specify an arbitrary attribute.

Parameters:

namespaceURI - The namespace URI of the attribute.

qualifiedName - The qualified name of the attribute.

value - The attribute value to set.

getAttributeNS

public java.lang.String getAttributeNS(java.lang.String namespaceURI,
                                       java.lang.String localName)

Retrieves an attribute value by local name and namespace URI.

Parameters:

namespaceURI - The namespace URI of the attribute.

localName - The local name of the attribute.

Returns:

The attribute value String or an empty String.

setConfirmationData

public void setConfirmationData(java.util.List elements)

Set the ConfirmationData pertaining to the subject.

Any existing SubjectConfirmationData will be erased. Note that you SHOULD consider setting the xsi:type if this is a derived type.

Parameters:

elements - A List of ConfirmationData Element objects.

getConfirmationData

public java.util.List getConfirmationData()

Returns the ConfirmationData pertaining to the subject.

Returns:

A List of org.w3c.dom.Element objects or null if the confirmation data is empty

setKeyInfoConfirmationData

public void setKeyInfoConfirmationData(java.util.List keyInfos)

Set the KeyInfoConfirmationData, which specifies a cryptographic key(s) held by the subject.

Any existing SubjectConfirmationData will be erased. This method will set the xsi:type attribute.

Parameters:

keyInfos - A List of XSKeyInfo objects containing the information of a key.

getKeyInfoConfirmationData

public java.util.List getKeyInfoConfirmationData()

Returns the specified KeyInfoConfirmationData.

Returns:

A List of XSKeyInfo objects or null if the xsi:type is not set correctly or if the confirmation data is empty