Package org.springframework.ws.soap

Class AbstractSoapMessage

java.lang.Object

org.springframework.ws.mime.AbstractMimeMessage

org.springframework.ws.soap.AbstractSoapMessage

All Implemented Interfaces:

FaultAwareWebServiceMessage, MimeMessage, SoapMessage, WebServiceMessage

Direct Known Subclasses:

SaajSoapMessage

public abstract class AbstractSoapMessage
extends AbstractMimeMessage
implements SoapMessage

Abstract implementation of the SoapMessage interface. Contains convenient default implementations.

Since:

1.0.0

Author:

Arjen Poutsma

Constructor Summary

Constructors

Constructor	Description
AbstractSoapMessage()

Method Summary

Modifier and Type	Method	Description
final QName	getFaultCode()	Returns getSoapBody().getFault().getFaultCode().
final String	getFaultReason()	Returns getSoapBody().getFault().getFaultStringOrReason().
final Result	getPayloadResult()	Returns getSoapBody().getPayloadResult().
final Source	getPayloadSource()	Returns getSoapBody().getPayloadSource().
final SoapBody	getSoapBody()	Returns getEnvelope().getBody().
final SoapHeader	getSoapHeader()	Returns getEnvelope().getHeader().
SoapVersion	getVersion()	Returns the SOAP version of this message.
final boolean	hasFault()	Returns getSoapBody().hasFault().

Methods inherited from class org.springframework.ws.mime.AbstractMimeMessage

addAttachment, addAttachment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.ws.mime.MimeMessage

addAttachment, addAttachment, addAttachment, convertToXopPackage, getAttachment, getAttachments, isXopPackage

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

getDocument, getEnvelope, getSoapAction, setDocument, setSoapAction

Methods inherited from interface org.springframework.ws.WebServiceMessage

writeTo

Constructor Details

AbstractSoapMessage

public AbstractSoapMessage()

Method Details

getSoapBody

public final SoapBody getSoapBody()

Returns getEnvelope().getBody().

Specified by:

getSoapBody in interface SoapMessage

See Also:

• SoapEnvelope.getBody()

getSoapHeader

public final SoapHeader getSoapHeader()

Returns getEnvelope().getHeader().

Specified by:

getSoapHeader in interface SoapMessage

See Also:

• SoapEnvelope.getHeader()

getPayloadSource

public final Source getPayloadSource()

Returns getSoapBody().getPayloadSource().

Specified by:

getPayloadSource in interface WebServiceMessage

Returns:

the message contents

getPayloadResult

public final Result getPayloadResult()

Returns getSoapBody().getPayloadResult().

Specified by:

getPayloadResult in interface WebServiceMessage

Returns:

the message contents

hasFault

public final boolean hasFault()

Returns getSoapBody().hasFault().

Specified by:

hasFault in interface FaultAwareWebServiceMessage

Returns:

true if the message has a fault.

See Also:

• FaultAwareWebServiceMessage.getFaultReason()

getFaultCode

public final QName getFaultCode()

Returns getSoapBody().getFault().getFaultCode().

Specified by:

getFaultCode in interface FaultAwareWebServiceMessage

getFaultReason

public final String getFaultReason()

Returns getSoapBody().getFault().getFaultStringOrReason().

Specified by:

getFaultReason in interface FaultAwareWebServiceMessage

Returns:

the fault reason message, if any; returns null when no fault is present.

See Also:

• FaultAwareWebServiceMessage.hasFault()

getVersion

public SoapVersion getVersion()

Description copied from interface: SoapMessage

Returns the SOAP version of this message. This can be either SOAP 1.1 or SOAP 1.2.

Specified by:

getVersion in interface SoapMessage

Returns:

the SOAP version

See Also:

• SoapVersion.SOAP_11
• SoapVersion.SOAP_12