oracle.security.xmlsec.saml2.protocol
Class LogoutRequest

java.lang.Object
oracle.security.xmlsec.util.XMLNode
oracle.security.xmlsec.util.XMLElement
oracle.security.xmlsec.saml2.protocol.RequestAbstract
oracle.security.xmlsec.saml2.protocol.LogoutRequest

public class LogoutRequest

extends RequestAbstract

Represent a message that indicates that the session has been terminated.

Field Summary

Fields inherited from class oracle.security.xmlsec.saml2.protocol.RequestAbstract

VERSION

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

node, systemId

Constructor Summary

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

Method Summary

void	addSessionIndex(java.lang.String index) Add a SessionIndex value.
java.util.Date	getNotOnOrAfter() Return the time instant on or after which the subject can not be confirmed.
java.lang.String	getReason() Returns the reason for the logout.
java.util.List	getSessionIndexes() Gets the SessionIndex values.
SAML2NameIdentifier	getSubjectNameIdentifier() Sets the identifier that specifies the principal.
void	setNotOnOrAfter(java.util.Date notOnOrAfter) Set the time instant on or after which the subject can not be confirmed.
void	setReason(java.lang.String reason) Sets the reason for the logout.
void	setSubjectNameIdentifier(SAML2NameIdentifier nid) Sets the name identifier that specifies the principal.

Methods inherited from class oracle.security.xmlsec.saml2.protocol.RequestAbstract

addSignature, addSignature, clearSignature, getConsent, getDestination, getExtensions, getID, getIssueInstant, getIssuer, getSignature, getVersion, isSigned, setConsent, setDestination, setExtensions, setID, setIssueInstant, setIssuer, setVersion, sign, sign, verify, verify

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

addNSPrefixAttr, addNSPrefixAttr, addNSPrefixAttrDefault, addNSPrefixAttrDefault, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getChildElementsByTagName, getChildElementsByTagName, getChildElementsByTagNameNS, getChildElementsByTagNameNS, getDefaultNSPrefix, 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

LogoutRequest

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

Creates a new LogoutRequest instance from the given Element node.

Parameters:

element - An LogoutRequest element.

LogoutRequest

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

Creates a new LogoutRequest instance from the given Element node.

Parameters:

element - An LogoutRequest element.

systemId - The URI string system ID for the LogoutRequest.

LogoutRequest

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

Creates a new LogoutRequest instance.

Parameters:

owner - The owner document of the new LogoutRequest.

LogoutRequest

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

Creates a new LogoutRequest instance. This constructor is for use in subclass for extension of the LogoutRequest element.

Parameters:

owner - The owner document of the new LogoutRequest.

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

localName - The localName of the element represented by the class that extends this class.

Method Detail

setSubjectNameIdentifier

public void setSubjectNameIdentifier(SAML2NameIdentifier nid)

Sets the name identifier that specifies the principal.

Parameters:

nid - The name identifier of the session participant.

getSubjectNameIdentifier

public SAML2NameIdentifier getSubjectNameIdentifier()

Sets the identifier that specifies the principal.

Returns:

The name identifier or null if not specified.

addSessionIndex

public void addSessionIndex(java.lang.String index)

Add a SessionIndex value.

Parameters:

index - A String object containing session index.

getSessionIndexes

public java.util.List getSessionIndexes()

Gets the SessionIndex values.

Returns:

A list of String objects, where each String represent a SessionIndex value or an empty list if none were present

setReason

public void setReason(java.lang.String reason)

Sets the reason for the logout.

Parameters:

reason - A URI reference.

getReason

public java.lang.String getReason()

Returns the reason for the logout.

Returns:

A URI reference.

setNotOnOrAfter

public void setNotOnOrAfter(java.util.Date notOnOrAfter)

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

Parameters:

notOnOrAfter - The specified time.

getNotOnOrAfter

public java.util.Date getNotOnOrAfter()

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

Returns:

The specified time or null if not specified.