com.consol.citrus.message

Class DefaultMessage

java.lang.Object

com.consol.citrus.message.DefaultMessage

All Implemented Interfaces:

Message, Serializable

Direct Known Subclasses:

RawMessage

public class DefaultMessage
extends Object
implements Message

Default message implementation holds message payload and message headers. Also provides access methods for special header elements such as unique message id and creation timestamp.

Since:

2.0

Author:

Christoph Deppisch

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
DefaultMessage	addHeaderData(String headerData) Adds new header data.
Map<String,Object>	copyHeaders() Gets exact copy of actual message headers.
Object	getHeader(String headerName) Gets the message header value by its header name.
List<String>	getHeaderData() Gets the list of header data in this message.
String	getId() Gets the unique message id;
Object	getPayload() Gets the message payload.
<T> T	getPayload(Class<T> type) Gets message payload with required type conversion.
Long	getTimestamp() Gets the message creation timestamp;
void	removeHeader(String headerName) Removes the message header if it not a reserved message header such as unique message id.
DefaultMessage	setHeader(String headerName, Object headerValue) Sets new header entry in message header list.
void	setPayload(Object payload) Sets the message payload.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMessage

public DefaultMessage()

Empty constructor initializing with empty message payload.

DefaultMessage

public DefaultMessage(Message message)

Constructs copy of given message.

Parameters:

message -

DefaultMessage

public DefaultMessage(Object payload)

Default constructor using just message payload.

Parameters:

payload -

DefaultMessage

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

Default constructor using payload and headers.

Parameters:

payload -

headers -

Method Detail

getId

public String getId()

Description copied from interface: Message

Gets the unique message id;

Specified by:

getId in interface Message

Returns:

getTimestamp

public Long getTimestamp()

Gets the message creation timestamp;

Returns:

toString

public String toString()

Overrides:

toString in class Object

setHeader

public DefaultMessage setHeader(String headerName,
                                Object headerValue)

Description copied from interface: Message

Sets new header entry in message header list.

Specified by:

setHeader in interface Message

Returns:

getHeader

public Object getHeader(String headerName)

Description copied from interface: Message

Gets the message header value by its header name.

Specified by:

getHeader in interface Message

Returns:

removeHeader

public void removeHeader(String headerName)

Description copied from interface: Message

Removes the message header if it not a reserved message header such as unique message id.

Specified by:

removeHeader in interface Message

addHeaderData

public DefaultMessage addHeaderData(String headerData)

Description copied from interface: Message

Adds new header data.

Specified by:

addHeaderData in interface Message

Returns:

getHeaderData

public List<String> getHeaderData()

Description copied from interface: Message

Gets the list of header data in this message.

Specified by:

getHeaderData in interface Message

Returns:

getPayload

public <T> T getPayload(Class<T> type)

Description copied from interface: Message

Gets message payload with required type conversion.

Specified by:

getPayload in interface Message

Returns:

getPayload

public Object getPayload()

Description copied from interface: Message

Gets the message payload.

Specified by:

getPayload in interface Message

Returns:

setPayload

public void setPayload(Object payload)

Description copied from interface: Message

Sets the message payload.

Specified by:

setPayload in interface Message

copyHeaders

public Map<String,Object> copyHeaders()

Description copied from interface: Message

Gets exact copy of actual message headers.

Specified by:

copyHeaders in interface Message

Returns: