com.consol.citrus.ws.message

Class SoapMessage

java.lang.Object

com.consol.citrus.message.DefaultMessage

com.consol.citrus.ws.message.SoapMessage

All Implemented Interfaces:

Message, Serializable

Direct Known Subclasses:

SoapFault

public class SoapMessage
extends DefaultMessage

SOAP message representation holding additional elements like SOAP action, header fragment data and attachments.

Since:

2.0

Author:

Christoph Deppisch

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SoapMessage() Empty constructor initializing with empty message payload.
SoapMessage(Message message) Constructs copy of given message.
SoapMessage(Object payload) Default constructor using just message payload.
SoapMessage(Object payload, Map<String,Object> headers) Default constructor using payload and headers.

Method Summary

Modifier and Type	Method and Description
SoapMessage	addAttachment(SoapAttachment attachment) Adds new attachment to this message.
SoapMessage	addHeaderData(String headerData)
List<SoapAttachment>	getAttachments() Gets the list of message attachments.
String	getSoapAction() Gets the soap action for this message.
SoapMessage	header(String headerName, Object headerValue) Sets new header name value pair.
boolean	isMtomEnabled() Gets mtom attachments enabled
SoapMessage	mtomEnabled(boolean mtomEnabled) Enable or disable mtom attachments
SoapMessage	setHeader(String headerName, Object headerValue)
SoapMessage	soapAction(String soapAction) Set soap action for this message.
String	toString()

Methods inherited from class com.consol.citrus.message.DefaultMessage

copyHeaders, getHeader, getHeaderData, getId, getPayload, getPayload, getTimestamp, removeHeader, setPayload

Methods inherited from class java.lang.Object

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

Constructor Detail

SoapMessage

public SoapMessage()

Empty constructor initializing with empty message payload.

SoapMessage

public SoapMessage(Message message)

Constructs copy of given message.

Parameters:

message -

SoapMessage

public SoapMessage(Object payload)

Default constructor using just message payload.

Parameters:

payload -

SoapMessage

public SoapMessage(Object payload,
                   Map<String,Object> headers)

Default constructor using payload and headers.

Parameters:

payload -

headers -

Method Detail

header

public SoapMessage header(String headerName,
                          Object headerValue)

Sets new header name value pair.

Parameters:

headerName -

headerValue -

Returns:

setHeader

public SoapMessage setHeader(String headerName,
                             Object headerValue)

Specified by:

setHeader in interface Message

Overrides:

setHeader in class DefaultMessage

addHeaderData

public SoapMessage addHeaderData(String headerData)

Specified by:

addHeaderData in interface Message

Overrides:

addHeaderData in class DefaultMessage

soapAction

public SoapMessage soapAction(String soapAction)

Set soap action for this message.

Parameters:

soapAction -

mtomEnabled

public SoapMessage mtomEnabled(boolean mtomEnabled)

Enable or disable mtom attachments

Parameters:

mtomEnabled -

addAttachment

public SoapMessage addAttachment(SoapAttachment attachment)

Adds new attachment to this message.

Parameters:

attachment -

getSoapAction

public String getSoapAction()

Gets the soap action for this message.

Returns:

getAttachments

public List<SoapAttachment> getAttachments()

Gets the list of message attachments.

Returns:

isMtomEnabled

public boolean isMtomEnabled()

Gets mtom attachments enabled

Returns:

toString

public String toString()

Overrides:

toString in class DefaultMessage