org.springframework.ws

Interface WebServiceMessage

All Known Subinterfaces:

FaultAwareWebServiceMessage, MimeMessage, PoxMessage, SoapMessage, StreamingWebServiceMessage

All Known Implementing Classes:

AbstractMimeMessage, AbstractSoapMessage, AxiomSoapMessage, DomPoxMessage, SaajSoapMessage

public interface WebServiceMessage

Represents a protocol-agnostic XML message.

Contains methods that provide access to the payload of the message.

Since:

1.0.0

Author:

Arjen Poutsma

See Also:

SoapMessage, WebServiceMessageFactory

Method Summary

Modifier and Type	Method and Description
Result	getPayloadResult() Returns the contents of the message as a Result.
Source	getPayloadSource() Returns the contents of the message as a Source.
void	writeTo(OutputStream outputStream) Writes the entire message to the given output stream.

Method Detail

getPayloadSource

Source getPayloadSource()

Returns the contents of the message as a Source.

Depending on the implementation, this can be retrieved multiple times, or just a single time.

Returns:

the message contents

getPayloadResult

Result getPayloadResult()

Returns the contents of the message as a Result.

Calling this method removes the current payload.

Implementations that are read-only will throw an UnsupportedOperationException.

Returns:

the message contents

Throws:

UnsupportedOperationException - if the message is read-only

writeTo

void writeTo(OutputStream outputStream)
      throws IOException

Writes the entire message to the given output stream.

If the given stream is an instance of TransportOutputStream, the corresponding headers will be written as well.

Parameters:

outputStream - the stream to write to

Throws:

IOException - if an I/O exception occurs