Package org.citrusframework.message

Class DefaultMessage

java.lang.Object

org.citrusframework.message.DefaultMessage

All Implemented Interfaces:

Serializable, Message

Direct Known Subclasses:

RawMessage, ZipMessage

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

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultMessage()	Empty constructor initializing with empty message payload.
DefaultMessage(Object payload)	Default constructor using just message payload.
DefaultMessage(Object payload, Map<String,Object> headers)	Default constructor using payload and headers.
DefaultMessage(Message message)	Constructs copy of given message.
DefaultMessage(Message message, boolean forceCitrusHeaderUpdate)	Constructs a new DefaultMessage based on the provided Message object, with an option to force Citrus header update.

Method Summary

Modifier and Type	Method	Description
DefaultMessage	addHeaderData(String headerData)
Object	getHeader(String headerName)
List<String>	getHeaderData()
Map<String,Object>	getHeaders()
String	getId()
String	getName()
Object	getPayload()
<T> T	getPayload(Class<T> type)
Long	getTimestamp()	Gets the message creation timestamp;
String	getType()
void	removeHeader(String headerName)
DefaultMessage	setHeader(String headerName, Object headerValue)
DefaultMessage	setName(String name)
DefaultMessage	setPayload(Object payload)
DefaultMessage	setType(String type)
DefaultMessage	setType(MessageType type)	Specifies the message type.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.citrusframework.message.Message

print, print, print

Constructor Details

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(Message message,
 boolean forceCitrusHeaderUpdate)

Constructs a new DefaultMessage based on the provided Message object, with an option to force Citrus header update. If forceCitrusHeaderUpdate is true, it overwrites existing values for ID and TIMESTAMP headers with new values. If forceCitrusHeaderUpdate is false, it updates the ID and TIMESTAMP headers only if they are absent in the provided headers.

Parameters:

message - the Message object to copy

forceCitrusHeaderUpdate - flag indicating whether to force Citrus header update

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 Details

getId

public String getId()

Specified by:

getId in interface Message

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)

Specified by:

setHeader in interface Message

getHeader

public Object getHeader(String headerName)

Specified by:

getHeader in interface Message

removeHeader

public void removeHeader(String headerName)

Specified by:

removeHeader in interface Message

addHeaderData

public DefaultMessage addHeaderData(String headerData)

Specified by:

addHeaderData in interface Message

getHeaderData

public List<String> getHeaderData()

Specified by:

getHeaderData in interface Message

getPayload

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

Specified by:

getPayload in interface Message

getPayload

public Object getPayload()

Specified by:

getPayload in interface Message

setPayload

public DefaultMessage setPayload(Object payload)

Specified by:

setPayload in interface Message

getHeaders

public Map<String,Object> getHeaders()

Specified by:

getHeaders in interface Message

setName

public DefaultMessage setName(String name)

Specified by:

setName in interface Message

getName

public String getName()

Specified by:

getName in interface Message

setType

public DefaultMessage setType(MessageType type)

Specifies the message type.

Parameters:

type - one of the default message types.

setType

public DefaultMessage setType(String type)

Specified by:

setType in interface Message

getType

public String getType()

Specified by:

getType in interface Message