oracle.security.xmlsec.saml2.core

Class AuthnStatement

java.lang.Object

oracle.security.xmlsec.util.XMLNode

oracle.security.xmlsec.util.XMLElement

oracle.security.xmlsec.saml2.core.Statement

oracle.security.xmlsec.saml2.core.AuthnStatement

public class AuthnStatement
extends Statement

Represent a statement about an authentication event concerning a subject.

Field Summary

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

node, systemId

Constructor Summary

Constructors

Modifier	Constructor and Description
	AuthnStatement(org.w3c.dom.Document owner) Creates a new AuthnStatement instance.
protected	AuthnStatement(org.w3c.dom.Document owner, java.lang.String nsURI, java.lang.String localName) Creates a new AuthnStatement instance.
	AuthnStatement(org.w3c.dom.Element element) Creates a new AuthnStatement instance from the given Element node.
	AuthnStatement(org.w3c.dom.Element element, java.lang.String systemId) Creates a new AuthnStatement instance from the given Element node.

Method Summary

Methods

Modifier and Type	Method and Description
AuthnContext	getAuthnContext() Gets the context of the authentication.
java.util.Date	getAuthnInstant() Returns the authentication instant attribute from this element, or null if the attribute is not specified.
java.lang.String	getSessionIndex() Returns the index of the session between the subject and the authentication authority.
java.util.Date	getSessionNotOnOrAfter() Returns the time at which the session between subject and authentication authority must be considered ended.
SubjectLocality	getSubjectLocality() Gets the subject locality.
void	setAuthnContext(AuthnContext authnCtx) Sets the context of the authentication.
void	setAuthnInstant(java.util.Date authenticationInstant) Sets the time at which authentication took place.
void	setSessionIndex(java.lang.String index) Sets the index of the session between the subject and the authentication authority.
void	setSessionNotOnOrAfter(java.util.Date notOnOrAfter) Sets the time at which the session between subject and authentication authority must be considered ended.
void	setSubjectLocality(SubjectLocality subjectLocality) Sets the subject locality consisting of the IP address and/or the DNS domain name of the machine where the authentication took place.

Methods inherited from class oracle.security.xmlsec.saml2.core.Statement

getXsiType, setXsiType

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

addNSPrefixAttr, addNSPrefixAttr, addNSPrefixAttrDefault, addNSPrefixAttrDefault, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getChildElementsByTagName, getChildElementsByTagName, getChildElementsByTagNameNS, getChildElementsByTagNameNS, getDefaultNSPrefix, getElement, getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, 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

AuthnStatement

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

Creates a new AuthnStatement instance from the given Element node.

Parameters:

element - An AuthnStatement element.

Throws:

org.w3c.dom.DOMException

AuthnStatement

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

Creates a new AuthnStatement instance from the given Element node.

Parameters:

element - An AuthnStatement element.

systemId - The URI string system ID for the AuthnStatement.

Throws:

org.w3c.dom.DOMException

AuthnStatement

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

Creates a new AuthnStatement instance.

Parameters:

owner - The owner document of the new AuthnStatement.

Throws:

org.w3c.dom.DOMException

AuthnStatement

protected AuthnStatement(org.w3c.dom.Document owner,
              java.lang.String nsURI,
              java.lang.String localName)
                  throws org.w3c.dom.DOMException

Creates a new AuthnStatement instance. For use by classes extending the saml:AuthnStatement element.

Parameters:

owner - The owner document of the new element.

nsURI - The namespace in which the new element is to be created.

localName - The localName of the element.

Throws:

org.w3c.dom.DOMException

Method Detail

setSessionIndex

public void setSessionIndex(java.lang.String index)

Sets the index of the session between the subject and the authentication authority.

Parameters:

index - A String value.

getSessionIndex

public java.lang.String getSessionIndex()

Returns the index of the session between the subject and the authentication authority.

Returns:

The index value.

setAuthnInstant

public void setAuthnInstant(java.util.Date authenticationInstant)

Sets the time at which authentication took place.

Parameters:

authenticationInstant - A Date object that specifies the authentication time.

getAuthnInstant

public java.util.Date getAuthnInstant()

Returns the authentication instant attribute from this element, or null if the attribute is not specified.

Returns:

A Date object representing the time of authentication.

setSessionNotOnOrAfter

public void setSessionNotOnOrAfter(java.util.Date notOnOrAfter)

Sets the time at which the session between subject and authentication authority must be considered ended.

Parameters:

notOnOrAfter - A Date object that specifies the session ended time.

getSessionNotOnOrAfter

public java.util.Date getSessionNotOnOrAfter()

Returns the time at which the session between subject and authentication authority must be considered ended.

Returns:

A Date object that specifies the session ended time.

setSubjectLocality

public void setSubjectLocality(SubjectLocality subjectLocality)

Sets the subject locality consisting of the IP address and/or the DNS domain name of the machine where the authentication took place.

Parameters:

subjectLocality - A SubjectLocality object defining an entity.

getSubjectLocality

public SubjectLocality getSubjectLocality()

Gets the subject locality.

Returns:

A SubjectLocality object containing an IP address and/or DNS domain name.

setAuthnContext

public void setAuthnContext(AuthnContext authnCtx)

Sets the context of the authentication.

Parameters:

authnCtx - A AuthnContext object.

getAuthnContext

public AuthnContext getAuthnContext()

Gets the context of the authentication.

Returns:

A AuthnContext object.