|
J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
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.
SOAPFault| Field Summary |
| Fields inherited from interface org.w3c.dom.Node |
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE |
| Method Summary | |
SOAPBodyElement |
addBodyElement(Name name)
Creates a new SOAPBodyElement object with the
specified name and adds it to this SOAPBody object. |
SOAPBodyElement |
addDocument(org.w3c.dom.Document document)
Adds the root node of the DOM to this
SOAPBody object.
|
SOAPFault |
addFault()
Creates a new SOAPFault object and adds it to
this SOAPBody object. |
SOAPFault |
addFault(Name faultCode,
java.lang.String faultString)
Creates a new SOAPFault object and adds it to
this SOAPBody object. |
SOAPFault |
addFault(Name faultCode,
java.lang.String faultString,
java.util.Locale locale)
Creates a new SOAPFault object and adds it to
this SOAPBody object. |
SOAPFault |
getFault()
Returns the SOAPFault object in this SOAPBody
object. |
boolean |
hasFault()
Indicates whether a SOAPFault object exists in
this SOAPBody object. |
| Methods inherited from interface javax.xml.soap.Node |
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue |
| Methods inherited from interface org.w3c.dom.Node |
appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix |
| Methods inherited from interface org.w3c.dom.Element |
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS |
| Method Detail |
public SOAPFault addFault()
throws SOAPException
SOAPFault object and adds it to
this SOAPBody object. The new SOAPFault will
have default values set for the mandatory child elements
faultcode and faultstring.
A SOAPBody may contain at most one SOAPFault
child element
SOAPFault object
SOAPException - if there is a SOAP error
public SOAPFault addFault(Name faultCode,
java.lang.String faultString,
java.util.Locale locale)
throws SOAPException
SOAPFault object and adds it to
this SOAPBody object. The new SOAPFault will
have a faultcode element that is set to the
faultCode parameter and a faultstring set to
faultString and localized to locale.
A SOAPBody may contain at most one SOAPFault
child element
faultCode - a Name object giving the fault
code to be set; must be one of the fault codes defined in the SOAP
1.1 specification and of type QNamefaultString - a String giving an explanation of
the faultlocale - a Locale object indicating
the native language of the faultString
SOAPFault object
SOAPException - if there is a SOAP errorSOAPFault.setFaultCode(javax.xml.soap.Name),
SOAPFault.setFaultString(java.lang.String)
public SOAPFault addFault(Name faultCode,
java.lang.String faultString)
throws SOAPException
SOAPFault object and adds it to
this SOAPBody object. The new SOAPFault will
have a faultcode element that is set to the
faultCode parameter and a faultstring set to
faultString.
A SOAPBody may contain at most one SOAPFault
child element
faultCode - a Name object giving the fault
code to be set; must be one of the fault codes defined in the SOAP
1.1 specification and of type QNamefaultString - a String giving an explanation of
the fault
SOAPFault object
SOAPException - if there is a SOAP errorSOAPFault.setFaultCode(javax.xml.soap.Name),
SOAPFault.setFaultString(java.lang.String)public boolean hasFault()
SOAPFault object exists in
this SOAPBody object.
true if a SOAPFault object exists in
this SOAPBody object; false
otherwisepublic SOAPFault getFault()
SOAPFault object in this SOAPBody
object.
SOAPFault object in this SOAPBody
object
public SOAPBodyElement addBodyElement(Name name)
throws SOAPException
SOAPBodyElement object with the
specified name and adds it to this SOAPBody object.
name - a Name object with the name for the new
SOAPBodyElement object
SOAPBodyElement object
SOAPException - if a SOAP error occurs
public SOAPBodyElement addDocument(org.w3c.dom.Document document)
throws SOAPException
Document 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.
document - the Document object whose root node will be
added to this SOAPBody.
SOAPBodyElement that represents the root node
that was added.
SOAPException - if the Document cannot be added
|
J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2003 Sun Microsystems, Inc. All rights reserved.