|
| |
|
| javax.xml.soap.SOAPBody
All known Subclasses: com.sun.xml.messaging.saaj.soap.impl.BodyImpl,
| SOAPBody | | public interface SOAPBody extends SOAPElement(Code) | | 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: SOAPFault |
| addBodyElement | | public SOAPBodyElement addBodyElement(QName qname) throws SOAPException(Code) | | 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 the new SOAPBodyElement object
exception:
SOAPException - if a SOAP error occurs
See Also: SOAPBody.addBodyElement(Name)
since:
SAAJ 1.3 |
| addDocument | | public SOAPBodyElement addDocument(org.w3c.dom.Document document) throws SOAPException(Code) | | Adds the root node of the DOM
org.w3c.dom.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.
Parameters:
document - the Document object whose root node will beadded to this SOAPBody. the SOAPBodyElement that represents the root nodethat was added.
exception:
SOAPException - if the Document cannot be added
since:
SAAJ 1.2 |
| addFault | | public SOAPFault addFault() throws SOAPException(Code) | | 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.
the new SOAPFault object
exception:
SOAPException - if there is a SOAP error |
| addFault | | public SOAPFault addFault(Name faultCode, String faultString, Locale locale) throws SOAPException(Code) | | 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 faultcode to be set; must be one of the fault codes defined in the Version of SOAP specification in use
Parameters:
faultString - a String giving an explanation ofthe fault
Parameters:
locale - a java.util.Locale object indicatingthe native language of the faultString the new SOAPFault object
exception:
SOAPException - if there is a SOAP error
See Also: SOAPFault.setFaultCode
See Also: SOAPFault.setFaultString
since:
SAAJ 1.2 |
| addFault | | public SOAPFault addFault(QName faultCode, String faultString, Locale locale) throws SOAPException(Code) | | 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 beset; must be one of the fault codes defined in the versionof SOAP specification in use.
Parameters:
faultString - a String giving an explanation of the fault
Parameters:
locale - a java.util.Locale Locale object indicating thenative language of the faultString the new SOAPFault object
exception:
SOAPException - if there is a SOAP error
See Also: SOAPFault.setFaultCode
See Also: SOAPFault.setFaultString
See Also: SOAPBody.addFault(Name faultCodeString faultStringLocale locale)
since:
SAAJ 1.3 |
| addFault | | public SOAPFault addFault(Name faultCode, String faultString) throws SOAPException(Code) | | 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 to
java.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 SOAPspecification in use
Parameters:
faultString - a String giving an explanation of the fault the new SOAPFault object
exception:
SOAPException - if there is a SOAP error
See Also: SOAPFault.setFaultCode
See Also: SOAPFault.setFaultString
since:
SAAJ 1.2 |
| addFault | | public SOAPFault addFault(QName faultCode, String faultString) throws SOAPException(Code) | | 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 to
java.util.Locale.getDefault()
A SOAPBody may contain at most one SOAPFault
child element
Parameters:
faultCode - a QName object giving the fault code to beset; must be one of the fault codes defined in the version of SOAP specification in use
Parameters:
faultString - a String giving an explanation of the fault the new SOAPFault object
exception:
SOAPException - if there is a SOAP error
See Also: SOAPFault.setFaultCode
See Also: SOAPFault.setFaultString
See Also: SOAPBody.addFault(Name faultCodeString faultString)
since:
SAAJ 1.3 |
| getFault | | public SOAPFault getFault()(Code) | | Returns the SOAPFault object in this SOAPBody
object.
the SOAPFault object in this SOAPBodyobject if present, null otherwise. |
| hasFault | | public boolean hasFault()(Code) | | Indicates whether a SOAPFault object exists in this
SOAPBody object.
true if a SOAPFault object existsin this SOAPBody object; falseotherwise |
|
|
|