oracle.security.xmlsec.liberty.v11

Class LogoutRequest

java.lang.Object

oracle.security.xmlsec.util.XMLNode

oracle.security.xmlsec.util.XMLElement

oracle.security.xmlsec.saml.SAMLMessage

oracle.security.xmlsec.samlp.RequestType

oracle.security.xmlsec.liberty.v11.LibRequestMessage

oracle.security.xmlsec.liberty.v11.LogoutRequest

public class LogoutRequest
extends LibRequestMessage

This class represents the LogoutRequest element in the Liberty Single Logout protocol.

See Also:

LogoutResponse

Field Summary

Fields inherited from class oracle.security.xmlsec.samlp.RequestType

ATTRIBUTE_STATEMENT, AUTHENTICATION_STATEMENT, AUTHORIZATION_DECISION_STATEMENT

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

node, systemId

Constructor Summary

Constructors

Constructor and Description
LogoutRequest(org.w3c.dom.Document owner) Creates a new LogoutRequest instance within the specified XML Document.
LogoutRequest(org.w3c.dom.Document owner, java.lang.String requestId, java.util.Date issueInstant, java.lang.String providerId) Creates a new LogoutRequest instance within the specified XML Document.
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

Methods

Modifier and Type	Method and Description
protected java.lang.String[]	getChildElementsLocalNames() Returns the orderded set of the local names of the child elements specified in the schema for the XML element represented by the concrete subclass.
protected java.lang.String[]	getChildElementsNSURIs() Returns the orderded set of the namespce URIs for the child elements specified in the schema for the XML element represented by the concrete subclass.
oracle.security.xmlsec.saml.NameIdentifier	getNameIdentifier() Gets the smal:NameIdentifier element contained in this element.
java.lang.String	getSessionIndex() Return the value contained in the SessionIndex child element of this LogoutRequest.
void	setNameIdentifier(oracle.security.xmlsec.saml.NameIdentifier nameId) Sets the smal:NameIdentifier child element in this element.
void	setSessionIndex(java.lang.String sessionIndex) Sets the SessionIndex child element in this LogoutRequest element.
java.lang.String	toURLString(java.security.PrivateKey key, java.lang.String sigAlg) Returns this LogoutRequest as a URL-encoded query string, optionally signed using the given private key and signature algorithm.

Methods inherited from class oracle.security.xmlsec.liberty.v11.LibRequestMessage

addSignature, addSignature, getChildElementPosition, getId, getInstance, getProviderID, getRelayState, setId, setProviderID, setRelayState

Methods inherited from class oracle.security.xmlsec.samlp.RequestType

addRespondWith, addRespondWithValue, getID, getIssueInstant, getLocalNamesPrecedeDSig, getNSURIsPrecedeDSig, getRequestID, getRespondWiths, getRespondWithValues, setIssueInstant, setRequestID

Methods inherited from class oracle.security.xmlsec.saml.SAMLMessage

clearSignature, getInstance, getMajorVersion, getMinorVersion, getSignature, isSigned, 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, 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

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 - A Liberty LogoutRequest XML element.

Throws:

org.w3c.dom.DOMException

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 - A Liberty LogoutRequest XML element.

systemId - The URI string system ID for the LogoutRequest.

Throws:

org.w3c.dom.DOMException

LogoutRequest

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

Creates a new LogoutRequest instance within the specified XML Document.

Parameters:

owner - The owner document of the new Liberty LogoutRequest element.

Throws:

org.w3c.dom.DOMException

LogoutRequest

public LogoutRequest(org.w3c.dom.Document owner,
             java.lang.String requestId,
             java.util.Date issueInstant,
             java.lang.String providerId)
              throws org.w3c.dom.DOMException

Creates a new LogoutRequest instance within the specified XML Document.

Parameters:

owner - The owner document of the new Liberty LogoutRequest element.

requestID - The RequestID attribute.

issueInstant - The IssueInstant attribute.

providerId - The ProviderID child element.

Throws:

org.w3c.dom.DOMException

Method Detail

setNameIdentifier

public void setNameIdentifier(oracle.security.xmlsec.saml.NameIdentifier nameId)

Sets the smal:NameIdentifier child element in this element. This required child element contains the name identifier of the Principle to which this notification pertains.

getNameIdentifier

public oracle.security.xmlsec.saml.NameIdentifier getNameIdentifier()

Gets the smal:NameIdentifier element contained in this element.

Returns:

A SAML NameIdentifier object.

setSessionIndex

public void setSessionIndex(java.lang.String sessionIndex)

Sets the SessionIndex child element in this LogoutRequest element. This optional child contains the session index in the authentication statement in the assertion that was used in establishing the session being terminated.

getSessionIndex

public java.lang.String getSessionIndex()

Return the value contained in the SessionIndex child element of this LogoutRequest.

Returns:

The session index specified in the SessionIndex child or null if this child is not specified.

toURLString

public java.lang.String toURLString(java.security.PrivateKey key,
                           java.lang.String sigAlg)
                             throws oracle.security.xmlsec.dsig.SigningException

Returns this LogoutRequest as a URL-encoded query string, optionally signed using the given private key and signature algorithm.

Parameters:

key - The private signing key. If null, the query string will not be signed.

sigAlg - The URI identifying the signature algorithm to use. If null, the query string will not be signed.

Throws:

oracle.security.xmlsec.dsig.SigningException - If an error occurs computing the signature.

Since:

2.0 Build B

getChildElementsNSURIs

protected java.lang.String[] getChildElementsNSURIs()

Description copied from class: LibRequestMessage

Returns the orderded set of the namespce URIs for the child elements specified in the schema for the XML element represented by the concrete subclass.

Specified by:

getChildElementsNSURIs in class LibRequestMessage

getChildElementsLocalNames

protected java.lang.String[] getChildElementsLocalNames()

Description copied from class: LibRequestMessage

Returns the orderded set of the local names of the child elements specified in the schema for the XML element represented by the concrete subclass.

Specified by:

getChildElementsLocalNames in class LibRequestMessage