Skip navigation links

oracle.security.xmlsec.soap.v12
Class SOAPEnvelope

java.lang.Object
oracle.security.xmlsec.util.XMLNode
oracle.security.xmlsec.util.XMLElement
oracle.security.xmlsec.soap.v12.SOAPEnvelope

public class SOAPEnvelope

extends XMLElement

A SOAP v1.2 Envelope element. The envelope contains a required Body child element and an optional Header child element.

Since:

2.3.0

See Also:

SOAPFault

Field Summary

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

node, systemId

Constructor Summary

SOAPEnvelope(org.w3c.dom.Document owner)
Creates a new v1.2 SOAPEnvelope instance in the given owner document, but does not appended the Envelope element to the document node.

SOAPEnvelope(org.w3c.dom.Element env)
Creates a SOAPEnvelope instance for the given env:Envelope element.

SOAPEnvelope(org.w3c.dom.Element env, java.lang.String systemId)
Creates a SOAPEnvelope instance for the given env:Envelope element.

Method Summary

void	addBodyElement(org.w3c.dom.Element bodyElement) Add a body entry to the Body child of this SOAP Envelope.
void	addBodyElement(XMLElement bodyElement) Add a body entry to the Body child of this SOAP Envelope.
void	addHeaderElement(org.w3c.dom.Element headerElement) Adds a header entry to the Header child of this SOAP Envelope.
void	addHeaderElement(XMLElement headerElement) Add a header entry to the Header child of this SOAP Envelope.
SOAPFault	addSOAPFault() Creates a new, empty SOAP Fault element and adds it to the Body child of this SOAP Envelope.
SOAPFault	addSOAPFault(java.lang.String code, java.lang.String reasonText, java.lang.String reasonLang) Creates a new SOAP Fault element with the given fault Code and Reason, and adds it to the Body child of this SOAP Envelope.
org.w3c.dom.Element	getBody() Get the Body child element of this SOAP Envelope.
java.util.List	getBodyElements() Get all the Body entries in the Body child element of the this SOAP Envelope.
java.util.List	getBodyElementsByTagNameNS(java.lang.String nsURI, java.lang.String localName) Get all the Body entries with the given namespace URI and local name in the Body child element of the this SOAP Envelope.
org.w3c.dom.Element	getHeader() Get the Header child element of this SOAP Envelope.
java.util.List	getHeaderElements() Get all the Header entries in the Header child element of this SOAP Envelope.
java.util.List	getHeaderElements(boolean mustUnderstand) Get all the Header entries in the Header element for the given mustUnderstand setting.
java.util.List	getHeaderElements(java.lang.String role) Get all the Header entries in the Header element for the given role.
SOAPFault	getSOAPFault() Get the env:Fault body element in this SOAP Envelope.

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

SOAPEnvelope

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

Creates a new v1.2 SOAPEnvelope instance in the given owner document, but does not appended the Envelope element to the document node. The default prefix for the SOAP Envelope namespace is used, and a env:Body child element is also created.

Parameters:

owner - The document to contain the env:Envelope.

Throws:

org.w3c.dom.DOMException

SOAPEnvelope

public SOAPEnvelope(org.w3c.dom.Element env)
             throws org.w3c.dom.DOMException

Creates a SOAPEnvelope instance for the given env:Envelope element.

Parameters:

env - A SOAP Envelope element.

Throws:

org.w3c.dom.DOMException

SOAPEnvelope

public SOAPEnvelope(org.w3c.dom.Element env,
                    java.lang.String systemId)
             throws org.w3c.dom.DOMException

Creates a SOAPEnvelope instance for the given env:Envelope element.

Parameters:

env - A SOAP Envelope element.

systemId - The URI string system ID for the SOAPEnvelope.

Throws:

org.w3c.dom.DOMException

Method Detail

addHeaderElement

public void addHeaderElement(org.w3c.dom.Element headerElement)
                      throws org.w3c.dom.DOMException

Adds a header entry to the Header child of this SOAP Envelope. A header entry must be an namespace-qualified element.

Parameters:

headerElement - An XML element specifies a header entry (block) for this SOAP Envelope.

Throws:

org.w3c.dom.DOMException

addHeaderElement

public void addHeaderElement(XMLElement headerElement)
                      throws org.w3c.dom.DOMException

Add a header entry to the Header child of this SOAP Envelope. A header entry must be an namespace-qualified element.

Parameters:

headerElement - An XMLElement that specifies a header entry (block) for this SOAP Envelope.

Throws:

org.w3c.dom.DOMException

addBodyElement

public void addBodyElement(org.w3c.dom.Element bodyElement)
                    throws org.w3c.dom.DOMException

Add a body entry to the Body child of this SOAP Envelope. A body entry must be a namespace-qualified element.

Parameters:

bodyElement - A XML element specifies a body entry (block) for this SOAP Envelope.

Throws:

org.w3c.dom.DOMException

addBodyElement

public void addBodyElement(XMLElement bodyElement)
                    throws org.w3c.dom.DOMException

Add a body entry to the Body child of this SOAP Envelope. A body entry must be a namespace-qualified element.

Parameters:

bodyElement - An XMLElement object specifies a body entry (block) for this SOAP Envelope.

Throws:

org.w3c.dom.DOMException

addSOAPFault

public SOAPFault addSOAPFault(java.lang.String code,
                              java.lang.String reasonText,
                              java.lang.String reasonLang)
                       throws org.w3c.dom.DOMException

Creates a new SOAP Fault element with the given fault Code and Reason, and adds it to the Body child of this SOAP Envelope.

Parameters:

code - The string local part of the env:Code's element's env:Value element QName content.

reasonText - A string that specifies the human-readable value of the env:Reason element's env:Text element.

reasonLang - The xml:lang attribute value for the env:Text element.

Returns:

The new SOAPFault instance created.

Throws:

org.w3c.dom.DOMException

addSOAPFault

public SOAPFault addSOAPFault()
                       throws org.w3c.dom.DOMException

Creates a new, empty SOAP Fault element and adds it to the Body child of this SOAP Envelope.

Returns:

The new SOAPFault instance created.

Throws:

org.w3c.dom.DOMException

getHeader

public org.w3c.dom.Element getHeader()

Get the Header child element of this SOAP Envelope.

Returns:

An XML element for the Header or null if the Header is not specified.

getHeaderElements

public java.util.List getHeaderElements()

Get all the Header entries in the Header child element of this SOAP Envelope.

Returns:

A List of org.w3c.dom.Elements for all the header entries in this SOAP Envelope.

getHeaderElements

public java.util.List getHeaderElements(java.lang.String role)

Get all the Header entries in the Header element for the given role.

Parameters:

role - A URI string specifying the role of the header entries. If null, all header entries will be returned. If XMLURI.uri_soap12_role_ultimateReceiver, then any header entries with that role or missing the role attribute will be returned.

Returns:

A List of org.w3c.dom.Elements for all the header entries in this SOAP Envelope with the specified role attribute value.

getHeaderElements

public java.util.List getHeaderElements(boolean mustUnderstand)

Get all the Header entries in the Header element for the given mustUnderstand setting.

Parameters:

role - A boolean specifying the mustUnderstand value of the header entries.

Returns:

A List of org.w3c.dom.Elements for all the header entries in this SOAP Envelope with the specified env:mustUnderstand attribute value.

getBody

public org.w3c.dom.Element getBody()

Get the Body child element of this SOAP Envelope.

Returns:

An XML element for the Body child of this SOAP Envelope, or null if none is present.

getBodyElements

public java.util.List getBodyElements()

Get all the Body entries in the Body child element of the this SOAP Envelope.

Returns:

A List of XML element for all the Body entries in this SOAP Envelope.

getBodyElementsByTagNameNS

public java.util.List getBodyElementsByTagNameNS(java.lang.String nsURI,
                                                 java.lang.String localName)

Get all the Body entries with the given namespace URI and local name in the Body child element of the this SOAP Envelope.

Parameters:

nsURI - The namespace URI of the elements to match on. The special value "*" matches all namespaces.

localName - The local name of the elements to match on. The special value "*" matches all local names.

Returns:

A List of XML elements for all matched the Body entries.

getSOAPFault

public SOAPFault getSOAPFault()

Get the env:Fault body element in this SOAP Envelope.

Returns:

A SOAPFault instance, or null if no env:Fault entry is present in the Body child.

Skip navigation links