SOAPBody (Java Platform SE 6) (original) (raw)
javax.xml.soap
Interface SOAPBody
All Superinterfaces:
public interface SOAPBody
extends SOAPElement
An object that represents the contents of the SOAP body element in a SOAP message. A SOAP body element consists of XML data that affects the way the application-specific content is processed.
A SOAPBody object contains SOAPBodyElement objects, which have the content for the SOAP body. A SOAPFault object, which carries status and/or error information, is an example of a SOAPBodyElement object.
See Also:
| Field Summary |
|---|
| Method Summary | |
|---|---|
| SOAPBodyElement | addBodyElement(Name name) Creates a new SOAPBodyElement object with the specified name and adds it to this SOAPBody object. |
| SOAPBodyElement | addBodyElement(QName qname) Creates a new SOAPBodyElement object with the specified QName and adds it to this SOAPBody object. |
| SOAPBodyElement | addDocument(Document document) Adds the root node of the DOM Document to this SOAPBody object. |
| SOAPFault | addFault() Creates a new SOAPFault object and adds it to this SOAPBody object. |
| SOAPFault | [addFault](../../../javax/xml/soap/SOAPBody.html#addFault%28javax.xml.soap.Name, java.lang.String%29)(Name faultCode,String faultString) Creates a new SOAPFault object and adds it to this SOAPBody object. |
| SOAPFault | [addFault](../../../javax/xml/soap/SOAPBody.html#addFault%28javax.xml.soap.Name, java.lang.String, java.util.Locale%29)(Name faultCode,String faultString,Locale locale) Creates a new SOAPFault object and adds it to this SOAPBody object. |
| SOAPFault | [addFault](../../../javax/xml/soap/SOAPBody.html#addFault%28javax.xml.namespace.QName, java.lang.String%29)(QName faultCode,String faultString) Creates a new SOAPFault object and adds it to this SOAPBody object. |
| SOAPFault | [addFault](../../../javax/xml/soap/SOAPBody.html#addFault%28javax.xml.namespace.QName, java.lang.String, java.util.Locale%29)(QName faultCode,String faultString,Locale locale) Creates a new SOAPFault object and adds it to this SOAPBody object. |
| Document | extractContentAsDocument() Creates a new DOM Document and sets the first child of this SOAPBody as it's document element. |
| SOAPFault | getFault() Returns the SOAPFault object in this SOAPBody object. |
| boolean | hasFault() Indicates whether a SOAPFault object exists in thisSOAPBody object. |
| Methods inherited from interface javax.xml.soap.SOAPElement |
|---|
| [addAttribute](../../../javax/xml/soap/SOAPElement.html#addAttribute%28javax.xml.soap.Name, java.lang.String%29), [addAttribute](../../../javax/xml/soap/SOAPElement.html#addAttribute%28javax.xml.namespace.QName, java.lang.String%29), addChildElement, addChildElement, addChildElement, addChildElement, [addChildElement](../../../javax/xml/soap/SOAPElement.html#addChildElement%28java.lang.String, java.lang.String%29), [addChildElement](../../../javax/xml/soap/SOAPElement.html#addChildElement%28java.lang.String, java.lang.String, java.lang.String%29), [addNamespaceDeclaration](../../../javax/xml/soap/SOAPElement.html#addNamespaceDeclaration%28java.lang.String, java.lang.String%29), addTextNode, [createQName](../../../javax/xml/soap/SOAPElement.html#createQName%28java.lang.String, java.lang.String%29), getAllAttributes, getAllAttributesAsQNames, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildElements, getElementName, getElementQName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeAttribute, removeContents, removeNamespaceDeclaration, setElementQName, setEncodingStyle |
| Methods inherited from interface javax.xml.soap.Node |
|---|
| detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue |
| Methods inherited from interface org.w3c.dom.Element |
|---|
| getAttribute, getAttributeNode, [getAttributeNodeNS](../../../org/w3c/dom/Element.html#getAttributeNodeNS%28java.lang.String, java.lang.String%29), [getAttributeNS](../../../org/w3c/dom/Element.html#getAttributeNS%28java.lang.String, java.lang.String%29), getElementsByTagName, [getElementsByTagNameNS](../../../org/w3c/dom/Element.html#getElementsByTagNameNS%28java.lang.String, java.lang.String%29), getSchemaTypeInfo, getTagName, hasAttribute, [hasAttributeNS](../../../org/w3c/dom/Element.html#hasAttributeNS%28java.lang.String, java.lang.String%29), removeAttribute, removeAttributeNode, [removeAttributeNS](../../../org/w3c/dom/Element.html#removeAttributeNS%28java.lang.String, java.lang.String%29), [setAttribute](../../../org/w3c/dom/Element.html#setAttribute%28java.lang.String, java.lang.String%29), setAttributeNode, setAttributeNodeNS, [setAttributeNS](../../../org/w3c/dom/Element.html#setAttributeNS%28java.lang.String, java.lang.String, java.lang.String%29), [setIdAttribute](../../../org/w3c/dom/Element.html#setIdAttribute%28java.lang.String, boolean%29), [setIdAttributeNode](../../../org/w3c/dom/Element.html#setIdAttributeNode%28org.w3c.dom.Attr, boolean%29), [setIdAttributeNS](../../../org/w3c/dom/Element.html#setIdAttributeNS%28java.lang.String, java.lang.String, boolean%29) |
| Methods inherited from interface org.w3c.dom.Node |
|---|
| appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, [getFeature](../../../org/w3c/dom/Node.html#getFeature%28java.lang.String, java.lang.String%29), getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, [insertBefore](../../../org/w3c/dom/Node.html#insertBefore%28org.w3c.dom.Node, org.w3c.dom.Node%29), isDefaultNamespace, isEqualNode, isSameNode, [isSupported](../../../org/w3c/dom/Node.html#isSupported%28java.lang.String, java.lang.String%29), lookupNamespaceURI, lookupPrefix, normalize, removeChild, [replaceChild](../../../org/w3c/dom/Node.html#replaceChild%28org.w3c.dom.Node, org.w3c.dom.Node%29), setNodeValue, setPrefix, setTextContent, [setUserData](../../../org/w3c/dom/Node.html#setUserData%28java.lang.String, java.lang.Object, org.w3c.dom.UserDataHandler%29) |
| Method Detail |
|---|
addFault
SOAPFault addFault() throws SOAPException
Creates a new SOAPFault object and adds it to this SOAPBody object. The new SOAPFault will have default values set for the mandatory child elements. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance.
A SOAPBody may contain at most one SOAPFault child element.
Returns:
the new SOAPFault object
Throws:
[SOAPException](../../../javax/xml/soap/SOAPException.html "class in javax.xml.soap") - if there is a SOAP error
addFault
SOAPFault addFault(Name faultCode, String faultString, Locale locale) throws SOAPException
Creates a new SOAPFault object and adds it to this SOAPBody object. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance.
For SOAP 1.2 the faultCode parameter is the value of the Fault/Code/Value element and the faultString parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 the faultCode parameter is the value of the faultcode element and the faultString parameter is the value of the faultstring element.
A SOAPBody may contain at most one SOAPFault child element.
Parameters:
faultCode - a Name object giving the fault code to be set; must be one of the fault codes defined in the Version of SOAP specification in use
faultString - a String giving an explanation of the fault
locale - a Locale object indicating the native language of the faultString
Returns:
the new SOAPFault object
Throws:
[SOAPException](../../../javax/xml/soap/SOAPException.html "class in javax.xml.soap") - if there is a SOAP error
Since:
SAAJ 1.2
See Also:
SOAPFault.setFaultCode(javax.xml.soap.Name), SOAPFault.setFaultString(java.lang.String)
addFault
SOAPFault addFault(QName faultCode, String faultString, Locale locale) throws SOAPException
Creates a new SOAPFault object and adds it to this SOAPBody object. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance.
For SOAP 1.2 the faultCode parameter is the value of the Fault/Code/Value element and the faultString parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 the faultCode parameter is the value of the faultcode element and the faultString parameter is the value of the faultstring element.
A SOAPBody may contain at most one SOAPFault child element.
Parameters:
faultCode - a QName object giving the fault code to be set; must be one of the fault codes defined in the version of SOAP specification in use.
faultString - a String giving an explanation of the fault
locale - a Locale object indicating the native language of the faultString
Returns:
the new SOAPFault object
Throws:
[SOAPException](../../../javax/xml/soap/SOAPException.html "class in javax.xml.soap") - if there is a SOAP error
Since:
SAAJ 1.3
See Also:
SOAPFault.setFaultCode(javax.xml.soap.Name), SOAPFault.setFaultString(java.lang.String), [addFault(Name faultCode, String faultString, Locale locale)](../../../javax/xml/soap/SOAPBody.html#addFault%28javax.xml.soap.Name, java.lang.String, java.util.Locale%29)
addFault
SOAPFault addFault(Name faultCode, String faultString) throws SOAPException
Creates a new SOAPFault object and adds it to this SOAPBody object. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance.
For SOAP 1.2 the faultCode parameter is the value of the Fault/Code/Value element and the faultString parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 the faultCode parameter is the value of the faultcode element and the faultString parameter is the value of the faultstring element.
In case of a SOAP 1.2 fault, the default value for the mandatory xml:lang attribute on the Fault/Reason/Text element will be set tojava.util.Locale.getDefault()
A SOAPBody may contain at most one SOAPFault child element.
Parameters:
faultCode - a Name object giving the fault code to be set; must be one of the fault codes defined in the version of SOAP specification in use
faultString - a String giving an explanation of the fault
Returns:
the new SOAPFault object
Throws:
[SOAPException](../../../javax/xml/soap/SOAPException.html "class in javax.xml.soap") - if there is a SOAP error
Since:
SAAJ 1.2
See Also:
SOAPFault.setFaultCode(javax.xml.soap.Name), SOAPFault.setFaultString(java.lang.String)
addFault
SOAPFault addFault(QName faultCode, String faultString) throws SOAPException
Creates a new SOAPFault object and adds it to this SOAPBody object. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance.
For SOAP 1.2 the faultCode parameter is the value of the Fault/Code/Value element and the faultString parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 the faultCode parameter is the value of the faultcode element and the faultString parameter is the value of the faultstring element.
In case of a SOAP 1.2 fault, the default value for the mandatory xml:lang attribute on the Fault/Reason/Text element will be set tojava.util.Locale.getDefault()
A SOAPBody may contain at most one SOAPFault child element
Parameters:
faultCode - a QName object giving the fault code to be set; must be one of the fault codes defined in the version of SOAP specification in use
faultString - a String giving an explanation of the fault
Returns:
the new SOAPFault object
Throws:
[SOAPException](../../../javax/xml/soap/SOAPException.html "class in javax.xml.soap") - if there is a SOAP error
Since:
SAAJ 1.3
See Also:
SOAPFault.setFaultCode(javax.xml.soap.Name), SOAPFault.setFaultString(java.lang.String), [addFault(Name faultCode, String faultString)](../../../javax/xml/soap/SOAPBody.html#addFault%28javax.xml.soap.Name, java.lang.String%29)
hasFault
boolean hasFault()
Indicates whether a SOAPFault object exists in thisSOAPBody object.
Returns:
true if a SOAPFault object exists in this SOAPBody object; false otherwise
getFault
SOAPFault getFault()
Returns the SOAPFault object in this SOAPBody object.
Returns:
the SOAPFault object in this SOAPBody object if present, null otherwise.
addBodyElement
SOAPBodyElement addBodyElement(Name name) throws SOAPException
Creates a new SOAPBodyElement object with the specified name and adds it to this SOAPBody object.
Parameters:
name - a Name object with the name for the new SOAPBodyElement object
Returns:
the new SOAPBodyElement object
Throws:
[SOAPException](../../../javax/xml/soap/SOAPException.html "class in javax.xml.soap") - if a SOAP error occurs
See Also:
addBodyElement(javax.xml.namespace.QName)
addBodyElement
SOAPBodyElement addBodyElement(QName qname) throws SOAPException
Creates a new SOAPBodyElement object with the specified QName and adds it to this SOAPBody object.
Parameters:
qname - a QName object with the qname for the newSOAPBodyElement object
Returns:
the new SOAPBodyElement object
Throws:
[SOAPException](../../../javax/xml/soap/SOAPException.html "class in javax.xml.soap") - if a SOAP error occurs
Since:
SAAJ 1.3
See Also:
addDocument
SOAPBodyElement addDocument(Document document) throws SOAPException
Adds the root node of the DOM [Document](../../../org/w3c/dom/Document.html "interface in org.w3c.dom") to this SOAPBody object.
Calling this method invalidates the document parameter. The client application should discard all references to this Document and its contents upon calling addDocument. The behavior of an application that continues to use such references is undefined.
Parameters:
document - the Document object whose root node will be added to this SOAPBody.
Returns:
the SOAPBodyElement that represents the root node that was added.
Throws:
[SOAPException](../../../javax/xml/soap/SOAPException.html "class in javax.xml.soap") - if the Document cannot be added
Since:
SAAJ 1.2
extractContentAsDocument
Document extractContentAsDocument() throws SOAPException
Creates a new DOM [Document](../../../org/w3c/dom/Document.html "interface in org.w3c.dom") and sets the first child of this SOAPBody as it's document element. The child SOAPElement is removed as part of the process.
Returns:
the [Document](../../../org/w3c/dom/Document.html "interface in org.w3c.dom") representation of the SOAPBody content.
Throws:
[SOAPException](../../../javax/xml/soap/SOAPException.html "class in javax.xml.soap") - if there is not exactly one child SOAPElement of the `SOAPBody`.
**Since:**
`SAAJ 1.3
`
``
``
`---
| Overview Package Class Use Tree Deprecated Index Help | Java™ PlatformStandard Ed. 6 | |||
|---|---|---|---|---|
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.
`