org.springframework.ws.soap.soap12

Interface Soap12Body

All Superinterfaces:

SoapBody, SoapElement

public interface Soap12Body
extends SoapBody

Subinterface of SoapBody that exposes SOAP 1.2 functionality. Necessary because SOAP 1.1 differs from SOAP 1.2 with respect to SOAP Faults.

Since:

1.0.0

Author:

Arjen Poutsma

Method Summary

Modifier and Type	Method and Description
Soap12Fault	addClientOrSenderFault(String faultStringOrReason, Locale locale) Adds a Client/Sender fault to the body.
Soap12Fault	addDataEncodingUnknownFault(QName[] subcodes, String reason, Locale locale) Adds a DataEncodingUnknown fault to the body.
Soap12Fault	addMustUnderstandFault(String faultStringOrReason, Locale locale) Adds a MustUnderstand fault to the body.
Soap12Fault	addServerOrReceiverFault(String faultStringOrReason, Locale locale) Adds a Server/Receiver fault to the body.
Soap12Fault	addVersionMismatchFault(String faultStringOrReason, Locale locale) Adds a VersionMismatch fault to the body.
Soap12Fault	getFault() Returns the SoapFault of this body.

Methods inherited from interface org.springframework.ws.soap.SoapBody

getPayloadResult, getPayloadSource, hasFault

Methods inherited from interface org.springframework.ws.soap.SoapElement

addAttribute, addNamespaceDeclaration, getAllAttributes, getAttributeValue, getName, getSource, removeAttribute

Method Detail

addDataEncodingUnknownFault

Soap12Fault addDataEncodingUnknownFault(QName[] subcodes,
                                        String reason,
                                        Locale locale)
                                 throws SoapFaultException

Adds a DataEncodingUnknown fault to the body.

Adding a fault removes the current content of the body.

Parameters:

subcodes - the optional fully qualified fault subcodes

reason - the fault reason

locale - the language of the fault reason

Returns:

the created SoapFault

Throws:

SoapFaultException

getFault

Soap12Fault getFault()

Description copied from interface: SoapBody

Returns the SoapFault of this body.

Specified by:

getFault in interface SoapBody

Returns:

the SoapFault, or null if none is present

addMustUnderstandFault

Soap12Fault addMustUnderstandFault(String faultStringOrReason,
                                   Locale locale)
                            throws SoapFaultException

Description copied from interface: SoapBody

Adds a MustUnderstand fault to the body. A MustUnderstand is returned when a SOAP header with a MustUnderstand attribute is not understood.

Adding a fault removes the current content of the body.

Specified by:

addMustUnderstandFault in interface SoapBody

Parameters:

faultStringOrReason - the SOAP 1.1 fault string or SOAP 1.2 reason text

locale - the language of faultStringOrReason. Optional for SOAP 1.1

Returns:

the created SoapFault

Throws:

SoapFaultException

addClientOrSenderFault

Soap12Fault addClientOrSenderFault(String faultStringOrReason,
                                   Locale locale)
                            throws SoapFaultException

Description copied from interface: SoapBody

Adds a Client/Sender fault to the body. For SOAP 1.1, this adds a fault with a Client fault code. For SOAP 1.2, this adds a fault with a Sender code.

Adding a fault removes the current content of the body.

Specified by:

addClientOrSenderFault in interface SoapBody

Parameters:

faultStringOrReason - the SOAP 1.1 fault string or SOAP 1.2 reason text

locale - the language of faultStringOrReason. Optional for SOAP 1.1

Returns:

the created SoapFault

Throws:

SoapFaultException

addServerOrReceiverFault

Soap12Fault addServerOrReceiverFault(String faultStringOrReason,
                                     Locale locale)
                              throws SoapFaultException

Description copied from interface: SoapBody

Adds a Server/Receiver fault to the body. For SOAP 1.1, this adds a fault with a Server fault code. For SOAP 1.2, this adds a fault with a Receiver code.

Adding a fault removes the current content of the body.

Specified by:

addServerOrReceiverFault in interface SoapBody

Parameters:

faultStringOrReason - the SOAP 1.1 fault string or SOAP 1.2 reason text

locale - the language of faultStringOrReason. Optional for SOAP 1.1

Returns:

the created SoapFault

Throws:

SoapFaultException

addVersionMismatchFault

Soap12Fault addVersionMismatchFault(String faultStringOrReason,
                                    Locale locale)
                             throws SoapFaultException

Description copied from interface: SoapBody

Adds a VersionMismatch fault to the body.

Adding a fault removes the current content of the body.

Specified by:

addVersionMismatchFault in interface SoapBody

Parameters:

faultStringOrReason - the SOAP 1.1 fault string or SOAP 1.2 reason text

locale - the language of faultStringOrReason. Optional for SOAP 1.1

Returns:

the created SoapFault

Throws:

SoapFaultException