Jakarta SOAP with Attachments API 3.0.0 · jakarta.xml.soap.SOAPBody

Method Summary

Modifier and Type	Method and Description
public SOAPBodyElement	Returns: the new `SOAPBodyElement` object addBodyElement(Name a `Name` object with the name for the new `SOAPBodyElement` object name) Creates a new `SOAPBodyElement` object with the specified name and adds it to this `SOAPBody` object.
public SOAPBodyElement	Returns: the new `SOAPBodyElement` object addBodyElement(QName a `QName` object with the qname for the new `SOAPBodyElement` object qname) Creates a new `SOAPBodyElement` object with the specified QName and adds it to this `SOAPBody` object.
public SOAPBodyElement	Returns: the `SOAPBodyElement` that represents the root node that was added. addDocument(Document the `Document` object whose root node will be added to this `SOAPBody`. document) Adds the root node of the DOM `org.w3c.dom.Document` to this `SOAPBody` object.
public SOAPFault	Returns: the new `SOAPFault` object addFault() Creates a new `SOAPFault` object and adds it to this `SOAPBody` object.
public SOAPFault	Returns: the new `SOAPFault` object addFault(Name 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 faultCode, String a `String` giving an explanation of the fault faultString, Locale a `java.util.Locale` object indicating the native language of the `faultString` locale) Creates a new `SOAPFault` object and adds it to this `SOAPBody` object.
public SOAPFault	Returns: the new `SOAPFault` object addFault(QName 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. faultCode, String a `String` giving an explanation of the fault faultString, Locale a `Locale` object indicating the native language of the `faultString` locale) Creates a new `SOAPFault` object and adds it to this `SOAPBody` object.
public SOAPFault	Returns: the new `SOAPFault` object addFault(Name 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 faultCode, String a `String` giving an explanation of the fault faultString) Creates a new `SOAPFault` object and adds it to this `SOAPBody` object.
public SOAPFault	Returns: the new `SOAPFault` object addFault(QName 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 faultCode, String a `String` giving an explanation of the fault faultString) Creates a new `SOAPFault` object and adds it to this `SOAPBody` object.
public Document	Returns: the `org.w3c.dom.Document` representation of the `SOAPBody` content. extractContentAsDocument() Creates a new DOM `org.w3c.dom.Document` and sets the first child of this `SOAPBody` as it's document element.
public SOAPFault	Returns: the `SOAPFault` object in this `SOAPBody` object if present, null otherwise. getFault() Returns the `SOAPFault` object in this `SOAPBody` object.
public boolean	Returns: `true` if a `SOAPFault` object exists in this `SOAPBody` object; `false` otherwise hasFault() Indicates whether a `SOAPFault` object exists in this `SOAPBody` object.

Method Detail

addBodyElement back to summary

addBodyElement	back to summary
public SOAPBodyElement addBodyElement(Name name) throws SOAPException Creates a new `SOAPBodyElement` object with the specified name and adds it to this `SOAPBody` object. Parameters name:Name a `Name` object with the name for the new `SOAPBodyElement` object Returns:SOAPBodyElement the new `SOAPBodyElement` object Exceptions SOAPException: if a SOAP error occurs See Also `SOAPBody#addBodyElement(javax.xml.namespace.QName)`

public SOAPBodyElement addBodyElement(Name name) throws SOAPException

Creates a new SOAPBodyElement object with the specified name and adds it to this SOAPBody object.

Parameters

name:Name: a Name object with the name for the new SOAPBodyElement object

Returns:SOAPBodyElement

the new SOAPBodyElement object

Exceptions

SOAPException:: if a SOAP error occurs

addBodyElement back to summary

addBodyElement	back to summary
public SOAPBodyElement addBodyElement(QName qname) throws SOAPException Creates a new `SOAPBodyElement` object with the specified QName and adds it to this `SOAPBody` object. Parameters qname:QName a `QName` object with the qname for the new `SOAPBodyElement` object Returns:SOAPBodyElement the new `SOAPBodyElement` object Exceptions SOAPException: if a SOAP error occurs Since 1.6, SAAJ 1.3 See Also `SOAPBody#addBodyElement(Name)`

public SOAPBodyElement addBodyElement(QName qname) throws SOAPException

Creates a new SOAPBodyElement object with the specified QName and adds it to this SOAPBody object.

Parameters

qname:QName: a QName object with the qname for the new SOAPBodyElement object

Returns:SOAPBodyElement

the new SOAPBodyElement object

Exceptions

SOAPException:: if a SOAP error occurs

Since

1.6, SAAJ 1.3

See Also

SOAPBody#addBodyElement(Name)

addDocument back to summary

addDocument	back to summary
public SOAPBodyElement addDocument(Document document) throws SOAPException 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:Document the `Document` object whose root node will be added to this `SOAPBody`. Returns:SOAPBodyElement the `SOAPBodyElement` that represents the root node that was added. Exceptions SOAPException: if the `Document` cannot be added Since 1.6, SAAJ 1.2

public SOAPBodyElement addDocument(Document document) throws SOAPException

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:Document: the Document object whose root node will be added to this SOAPBody.

Returns:SOAPBodyElement

the SOAPBodyElement that represents the root node that was added.

Exceptions

SOAPException:: if the Document cannot be added

Since

1.6, SAAJ 1.2

addFault back to summary

addFault	back to summary
public 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:SOAPFault the new `SOAPFault` object Exceptions SOAPException: if there is a SOAP error

public 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:SOAPFault

the new SOAPFault object

Exceptions

SOAPException:: if there is a SOAP error

addFault back to summary

addFault	back to summary
public 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:Name 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:String a `String` giving an explanation of the fault locale:Locale a `java.util.Locale` object indicating the native language of the `faultString` Returns:SOAPFault the new `SOAPFault` object Exceptions SOAPException: if there is a SOAP error Since 1.6, SAAJ 1.2 See Also `SOAPFault#setFaultCode`, `SOAPFault#setFaultString`

public 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:Name: 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:String: a String giving an explanation of the fault
locale:Locale: a java.util.Locale object indicating the native language of the faultString

Returns:SOAPFault

the new SOAPFault object

Exceptions

SOAPException:: if there is a SOAP error

Since

1.6, SAAJ 1.2

addFault back to summary

addFault	back to summary
public 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:QName 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:String a `String` giving an explanation of the fault locale:Locale a `Locale` object indicating the native language of the `faultString` Returns:SOAPFault the new `SOAPFault` object Exceptions SOAPException: if there is a SOAP error Since 1.6, SAAJ 1.3 See Also `SOAPFault#setFaultCode`, `SOAPFault#setFaultString`, `SOAPBody#addFault(Name faultCode, String faultString, Locale locale)`

public SOAPFault addFault(QName faultCode, String faultString, Locale locale) throws SOAPException

A SOAPBody may contain at most one SOAPFault child element.

Parameters

faultCode:QName: 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:String: a String giving an explanation of the fault
locale:Locale: a Locale object indicating the native language of the faultString

Returns:SOAPFault

the new SOAPFault object

Exceptions

SOAPException:: if there is a SOAP error

Since

1.6, SAAJ 1.3

addFault back to summary

addFault	back to summary
public 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 to `java.util.Locale.getDefault()` A `SOAPBody` may contain at most one `SOAPFault` child element. Parameters faultCode:Name 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:String a `String` giving an explanation of the fault Returns:SOAPFault the new `SOAPFault` object Exceptions SOAPException: if there is a SOAP error Since 1.6, SAAJ 1.2 See Also `SOAPFault#setFaultCode`, `SOAPFault#setFaultString`

public SOAPFault addFault(Name faultCode, String faultString) throws SOAPException

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:Name: 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:String: a String giving an explanation of the fault

Returns:SOAPFault

the new SOAPFault object

Exceptions

SOAPException:: if there is a SOAP error

Since

1.6, SAAJ 1.2

addFault back to summary

addFault	back to summary
public 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 to `java.util.Locale.getDefault()` A `SOAPBody` may contain at most one `SOAPFault` child element Parameters faultCode:QName 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:String a `String` giving an explanation of the fault Returns:SOAPFault the new `SOAPFault` object Exceptions SOAPException: if there is a SOAP error Since 1.6, SAAJ 1.3 See Also `SOAPFault#setFaultCode`, `SOAPFault#setFaultString`, `SOAPBody#addFault(Name faultCode, String faultString)`

public SOAPFault addFault(QName faultCode, String faultString) throws SOAPException

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:QName: 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:String: a String giving an explanation of the fault

Returns:SOAPFault

the new SOAPFault object

Exceptions

SOAPException:: if there is a SOAP error

Since

1.6, SAAJ 1.3

extractContentAsDocument back to summary

extractContentAsDocument	back to summary
public Document extractContentAsDocument() throws SOAPException Creates a new DOM `org.w3c.dom.Document` and sets the first child of this `SOAPBody` as it's document element. The child `SOAPElement` is removed as part of the process. Returns:Document the `org.w3c.dom.Document` representation of the `SOAPBody` content. Exceptions SOAPException: if there is not exactly one child `SOAPElement` of the `SOAPBody`. Since 1.6, SAAJ 1.3

public Document extractContentAsDocument() throws SOAPException

Creates a new DOM org.w3c.dom.Document and sets the first child of this SOAPBody as it's document element. The child SOAPElement is removed as part of the process.

Returns:Document

the org.w3c.dom.Document representation of the SOAPBody content.

Exceptions

SOAPException:: if there is not exactly one child SOAPElement of the SOAPBody.

Since

1.6, SAAJ 1.3

getFault back to summary

getFault	back to summary
public SOAPFault getFault() Returns the `SOAPFault` object in this `SOAPBody` object. Returns:SOAPFault the `SOAPFault` object in this `SOAPBody` object if present, null otherwise.

public SOAPFault getFault()

Returns the SOAPFault object in this SOAPBody object.

Returns:SOAPFault: the SOAPFault object in this SOAPBody object if present, null otherwise.

hasFault back to summary

hasFault	back to summary
public boolean hasFault() Indicates whether a `SOAPFault` object exists in this `SOAPBody` object. Returns:boolean `true` if a `SOAPFault` object exists in this `SOAPBody` object; `false` otherwise

public boolean hasFault()

Indicates whether a SOAPFault object exists in this SOAPBody object.

Returns:boolean: true if a SOAPFault object exists in this SOAPBody object; false otherwise

public Interface SOAPBody

Method Summary

Method Detail