- All Superinterfaces:
Element
,Node
,Node
,SOAPElement
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.
- Since:
- 1.6
- See Also:
-
Field Summary
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
-
Method Summary
Modifier and TypeMethodDescriptionaddBodyElement
(Name name) Creates a newSOAPBodyElement
object with the specified name and adds it to thisSOAPBody
object.addBodyElement
(QName qname) Creates a newSOAPBodyElement
object with the specified QName and adds it to thisSOAPBody
object.addDocument
(Document document) Adds the root node of the DOMDocument
to thisSOAPBody
object.addFault()
Creates a newSOAPFault
object and adds it to thisSOAPBody
object.Creates a newSOAPFault
object and adds it to thisSOAPBody
object.Creates a newSOAPFault
object and adds it to thisSOAPBody
object.Creates a newSOAPFault
object and adds it to thisSOAPBody
object.Creates a newSOAPFault
object and adds it to thisSOAPBody
object.Creates a new DOMDocument
and sets the first child of thisSOAPBody
as it's document element.getFault()
Returns theSOAPFault
object in thisSOAPBody
object.boolean
hasFault()
Indicates whether aSOAPFault
object exists in thisSOAPBody
object.Methods inherited from interface org.w3c.dom.Element
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
Methods inherited from interface jakarta.xml.soap.Node
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData
Methods inherited from interface jakarta.xml.soap.SOAPElement
addAttribute, addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, createQName, getAllAttributes, getAllAttributesAsQNames, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildElements, getElementName, getElementQName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeAttribute, removeContents, removeNamespaceDeclaration, setElementQName, setEncodingStyle
-
Method Details
-
addFault
Creates a newSOAPFault
object and adds it to thisSOAPBody
object. The newSOAPFault
will have default values set for the mandatory child elements. The type of theSOAPFault
will be a SOAP 1.1 or a SOAP 1.2SOAPFault
depending on theprotocol
specified while creating theMessageFactory
instance.A
SOAPBody
may contain at most oneSOAPFault
child element.- Returns:
- the new
SOAPFault
object - Throws:
SOAPException
- if there is a SOAP error
-
addFault
Creates a newSOAPFault
object and adds it to thisSOAPBody
object. The type of theSOAPFault
will be a SOAP 1.1 or a SOAP 1.2SOAPFault
depending on theprotocol
specified while creating theMessageFactory
instance.For SOAP 1.2 the
faultCode
parameter is the value of the Fault/Code/Value element and thefaultString
parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 thefaultCode
parameter is the value of thefaultcode
element and thefaultString
parameter is the value of thefaultstring
element.A
SOAPBody
may contain at most oneSOAPFault
child element.- Parameters:
faultCode
- aName
object giving the fault code to be set; must be one of the fault codes defined in the Version of SOAP specification in usefaultString
- aString
giving an explanation of the faultlocale
- aLocale
object indicating the native language of thefaultString
- Returns:
- the new
SOAPFault
object - Throws:
SOAPException
- if there is a SOAP error- Since:
- 1.6, SAAJ 1.2
- See Also:
-
addFault
Creates a newSOAPFault
object and adds it to thisSOAPBody
object. The type of theSOAPFault
will be a SOAP 1.1 or a SOAP 1.2SOAPFault
depending on theprotocol
specified while creating theMessageFactory
instance.For SOAP 1.2 the
faultCode
parameter is the value of the Fault/Code/Value element and thefaultString
parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 thefaultCode
parameter is the value of thefaultcode
element and thefaultString
parameter is the value of thefaultstring
element.A
SOAPBody
may contain at most oneSOAPFault
child element.- Parameters:
faultCode
- aQName
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
- aString
giving an explanation of the faultlocale
- aLocale
object indicating the native language of thefaultString
- Returns:
- the new
SOAPFault
object - Throws:
SOAPException
- if there is a SOAP error- Since:
- 1.6, SAAJ 1.3
- See Also:
-
addFault
Creates a newSOAPFault
object and adds it to thisSOAPBody
object. The type of theSOAPFault
will be a SOAP 1.1 or a SOAP 1.2SOAPFault
depending on theprotocol
specified while creating theMessageFactory
instance.For SOAP 1.2 the
faultCode
parameter is the value of the Fault/Code/Value element and thefaultString
parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 thefaultCode
parameter is the value of the faultcode element and thefaultString
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 oneSOAPFault
child element.- Parameters:
faultCode
- aName
object giving the fault code to be set; must be one of the fault codes defined in the version of SOAP specification in usefaultString
- aString
giving an explanation of the fault- Returns:
- the new
SOAPFault
object - Throws:
SOAPException
- if there is a SOAP error- Since:
- 1.6, SAAJ 1.2
- See Also:
-
addFault
Creates a newSOAPFault
object and adds it to thisSOAPBody
object. The type of theSOAPFault
will be a SOAP 1.1 or a SOAP 1.2SOAPFault
depending on theprotocol
specified while creating theMessageFactory
instance.For SOAP 1.2 the
faultCode
parameter is the value of the Fault/Code/Value element and thefaultString
parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 thefaultCode
parameter is the value of the faultcode element and thefaultString
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 oneSOAPFault
child element- Parameters:
faultCode
- aQName
object giving the fault code to be set; must be one of the fault codes defined in the version of SOAP specification in usefaultString
- aString
giving an explanation of the fault- Returns:
- the new
SOAPFault
object - Throws:
SOAPException
- if there is a SOAP error- Since:
- 1.6, SAAJ 1.3
- See Also:
-
hasFault
boolean hasFault()Indicates whether aSOAPFault
object exists in thisSOAPBody
object.- Returns:
true
if aSOAPFault
object exists in thisSOAPBody
object;false
otherwise
-
getFault
SOAPFault getFault()Returns theSOAPFault
object in thisSOAPBody
object.- Returns:
- the
SOAPFault
object in thisSOAPBody
object if present, null otherwise.
-
addBodyElement
Creates a newSOAPBodyElement
object with the specified name and adds it to thisSOAPBody
object.- Parameters:
name
- aName
object with the name for the newSOAPBodyElement
object- Returns:
- the new
SOAPBodyElement
object - Throws:
SOAPException
- if a SOAP error occurs- See Also:
-
addBodyElement
Creates a newSOAPBodyElement
object with the specified QName and adds it to thisSOAPBody
object.- Parameters:
qname
- aQName
object with the qname for the newSOAPBodyElement
object- Returns:
- the new
SOAPBodyElement
object - Throws:
SOAPException
- if a SOAP error occurs- Since:
- 1.6, SAAJ 1.3
- See Also:
-
addDocument
Adds the root node of the DOMDocument
to thisSOAPBody
object.Calling this method invalidates the
document
parameter. The client application should discard all references to thisDocument
and its contents upon callingaddDocument
. The behavior of an application that continues to use such references is undefined.- Parameters:
document
- theDocument
object whose root node will be added to thisSOAPBody
.- Returns:
- the
SOAPBodyElement
that represents the root node that was added. - Throws:
SOAPException
- if theDocument
cannot be added- Since:
- 1.6, SAAJ 1.2
-
extractContentAsDocument
Creates a new DOMDocument
and sets the first child of thisSOAPBody
as it's document element. The childSOAPElement
is removed as part of the process.- Returns:
- the
Document
representation of theSOAPBody
content. - Throws:
SOAPException
- if there is not exactly one childSOAPElement
of theSOAPBody
.- Since:
- 1.6, SAAJ 1.3
-