-
- All Superinterfaces:
- Element, Node, SOAPElement
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 containsSOAPBodyElement
objects, which have the content for the SOAP body. ASOAPFault
object, which carries status and/or error information, is an example of aSOAPBodyElement
object.- See Also:
SOAPFault
-
-
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
Methods Modifier and Type Method and Description SOAPBodyElement
addBodyElement(Name name)
Creates a newSOAPBodyElement
object with the specified name and adds it to thisSOAPBody
object.SOAPBodyElement
addBodyElement(QName qname)
Creates a newSOAPBodyElement
object with the specified QName and adds it to thisSOAPBody
object.SOAPBodyElement
addDocument(Document document)
Adds the root node of the DOM
to thisDocument
SOAPBody
object.SOAPFault
addFault()
Creates a newSOAPFault
object and adds it to thisSOAPBody
object.SOAPFault
addFault(Name faultCode, String faultString)
Creates a newSOAPFault
object and adds it to thisSOAPBody
object.SOAPFault
addFault(Name faultCode, String faultString, Locale locale)
Creates a newSOAPFault
object and adds it to thisSOAPBody
object.SOAPFault
addFault(QName faultCode, String faultString)
Creates a newSOAPFault
object and adds it to thisSOAPBody
object.SOAPFault
addFault(QName faultCode, String faultString, Locale locale)
Creates a newSOAPFault
object and adds it to thisSOAPBody
object.Document
extractContentAsDocument()
Creates a new DOM
and sets the first child of thisDocument
SOAPBody
as it's document element.SOAPFault
getFault()
Returns theSOAPFault
object in thisSOAPBody
object.boolean
hasFault()
Indicates whether aSOAPFault
object exists in thisSOAPBody
object.-
Methods inherited from interface javax.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
-
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, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
-
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
-
-
-
-
Method Detail
-
addFault
SOAPFault addFault() throws SOAPException
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
SOAPFault addFault(Name faultCode, String faultString, Locale locale) throws SOAPException
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:
- 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 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:
- SAAJ 1.3
- See Also:
SOAPFault.setFaultCode(javax.xml.soap.Name)
,SOAPFault.setFaultString(java.lang.String)
,addFault(Name faultCode, String faultString, Locale locale)
-
addFault
SOAPFault addFault(Name faultCode, String faultString) throws SOAPException
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:
- 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 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:
- SAAJ 1.3
- See Also:
SOAPFault.setFaultCode(javax.xml.soap.Name)
,SOAPFault.setFaultString(java.lang.String)
,addFault(Name faultCode, String faultString)
-
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
SOAPBodyElement addBodyElement(Name name) throws SOAPException
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(javax.xml.namespace.QName)
-
addBodyElement
SOAPBodyElement addBodyElement(QName qname) throws SOAPException
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:
- SAAJ 1.3
- See Also:
addBodyElement(Name)
-
addDocument
SOAPBodyElement addDocument(Document document) throws SOAPException
Adds the root node of the DOM
to thisDocument
SOAPBody
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:
- SAAJ 1.2
-
extractContentAsDocument
Document extractContentAsDocument() throws SOAPException
Creates a new DOM
and sets the first child of thisDocument
SOAPBody
as it's document element. The childSOAPElement
is removed as part of the process.- Returns:
- the
representation of theDocument
SOAPBody
content. - Throws:
SOAPException
- if there is not exactly one childSOAPElement
of theSOAPBody
.- Since:
- SAAJ 1.3
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/xml/soap/SOAPBody.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.