oracle.security.xmlsec.liberty.v11

Class LogoutResponse

java.lang.Object

oracle.security.xmlsec.util.XMLNode

oracle.security.xmlsec.util.XMLElement

oracle.security.xmlsec.saml.SAMLMessage

oracle.security.xmlsec.samlp.ResponseType

oracle.security.xmlsec.liberty.v11.LibResponseMessage

oracle.security.xmlsec.liberty.v11.LogoutResponse

public class LogoutResponse
extends LibResponseMessage

This class represents the LogoutResponse element in the Liberty Single Logout Protocol. This element is used by a provider in reponse to a LogoutRequest from another provider.

See Also:

LogoutRequest

Field Summary

Fields inherited from class oracle.security.xmlsec.liberty.v11.LibResponseMessage

NO_AVAILABLE_IDP, NO_SUPPORTED_IDP, UNSUPPORTED_PROFILE

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

node, systemId

Constructor Summary

Constructors

Constructor and Description
LogoutResponse(org.w3c.dom.Document owner) Creates a new LogoutResponse instance within the specified XML Document.
LogoutResponse(org.w3c.dom.Document owner, java.lang.String responseId, java.util.Date issueInstant, java.lang.String providerId) Creates a new LogoutResponse instance within the specified XML Document.
LogoutResponse(org.w3c.dom.Element element) Creates a new LogoutResponse instance from the given Element node.
LogoutResponse(org.w3c.dom.Element element, java.lang.String systemId) Creates a new LogoutResponse 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.
java.lang.String	toURLString(java.security.PrivateKey key, java.lang.String sigAlg) Returns this LogoutResponse 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.LibResponseMessage

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

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

getID, getInResponseTo, getIssueInstant, getLocalNamesPrecedeDSig, getNSURIsPrecedeDSig, getRecipient, getResponseID, setInResponseTo, setIssueInstant, setRecipient, setResponseID

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

LogoutResponse

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

Creates a new LogoutResponse instance from the given Element node.

Parameters:

element - A Liberty LogoutResponse XML element.

Throws:

org.w3c.dom.DOMException

LogoutResponse

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

Creates a new LogoutResponse instance from the given Element node.

Parameters:

element - A Liberty LogoutResponse XML element.

systemId - The URI string system ID for the LogoutResponse.

Throws:

org.w3c.dom.DOMException

LogoutResponse

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

Creates a new LogoutResponse instance within the specified XML Document.

Parameters:

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

Throws:

org.w3c.dom.DOMException

LogoutResponse

public LogoutResponse(org.w3c.dom.Document owner,
              java.lang.String responseId,
              java.util.Date issueInstant,
              java.lang.String providerId)

Creates a new LogoutResponse instance within the specified XML Document.

Parameters:

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

responseId - The ResponseID attribute.

issueInstant - The IssueInstant attribute.

providerId - The ProviderID child element.

Method Detail

toURLString

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

Returns this LogoutResponse 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: LibResponseMessage

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 LibResponseMessage

getChildElementsLocalNames

protected java.lang.String[] getChildElementsLocalNames()

Description copied from class: LibResponseMessage

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 LibResponseMessage