public class SOAPEnvelope extends XMLElement
SOAPFault
Constructor and Description |
---|
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. |
Modifier and Type | Method and Description |
---|---|
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.
|
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
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
public SOAPEnvelope(org.w3c.dom.Document owner) throws org.w3c.dom.DOMException
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.owner
- The document to contain the env:Envelope.org.w3c.dom.DOMException
public SOAPEnvelope(org.w3c.dom.Element env) throws org.w3c.dom.DOMException
SOAPEnvelope
instance for the given env:Envelope element.env
- A SOAP Envelope element.org.w3c.dom.DOMException
public SOAPEnvelope(org.w3c.dom.Element env, java.lang.String systemId) throws org.w3c.dom.DOMException
SOAPEnvelope
instance for the given env:Envelope element.env
- A SOAP Envelope element.systemId
- The URI string system ID for the SOAPEnvelope
.org.w3c.dom.DOMException
public void addHeaderElement(org.w3c.dom.Element headerElement) throws org.w3c.dom.DOMException
headerElement
- An XML element specifies a header entry (block) for this SOAP Envelope.org.w3c.dom.DOMException
public void addHeaderElement(XMLElement headerElement) throws org.w3c.dom.DOMException
headerElement
- An XMLElement that specifies a header entry (block) for this SOAP Envelope.org.w3c.dom.DOMException
public void addBodyElement(org.w3c.dom.Element bodyElement) throws org.w3c.dom.DOMException
bodyElement
- A XML element specifies a body entry (block) for this SOAP Envelope.org.w3c.dom.DOMException
public void addBodyElement(XMLElement bodyElement) throws org.w3c.dom.DOMException
bodyElement
- An XMLElement
object specifies a body entry (block) for this SOAP Envelope.org.w3c.dom.DOMException
public SOAPFault addSOAPFault(java.lang.String code, java.lang.String reasonText, java.lang.String reasonLang) throws org.w3c.dom.DOMException
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.SOAPFault
instance created.org.w3c.dom.DOMException
public SOAPFault addSOAPFault() throws org.w3c.dom.DOMException
SOAPFault
instance created.org.w3c.dom.DOMException
public org.w3c.dom.Element getHeader()
null
if the Header is not specified.public java.util.List getHeaderElements()
List
of org.w3c.dom.Element
s for all the header entries in this SOAP Envelope.public java.util.List getHeaderElements(java.lang.String role)
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.List
of org.w3c.dom.Element
s for all the header entries in this SOAP Envelope with the specified role attribute value.public java.util.List getHeaderElements(boolean mustUnderstand)
role
- A boolean specifying the mustUnderstand value of the header entries.List
of org.w3c.dom.Element
s for all the header entries in this SOAP Envelope with the specified env:mustUnderstand attribute value.public org.w3c.dom.Element getBody()
null
if none is present.public java.util.List getBodyElements()
List
of XML element for all the Body entries in this SOAP Envelope.public java.util.List getBodyElementsByTagNameNS(java.lang.String nsURI, java.lang.String localName)
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.List
of XML elements for all matched the Body entries.public SOAPFault getSOAPFault()
SOAPFault
instance, or null
if no env:Fault entry is present in the Body child.