com.consol.citrus.message

Interface Message

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultMessage, RawMessage, ZipMessage

public interface Message
extends Serializable

Since:

2.0

Author:

Christoph Deppisch

Method Summary

Modifier and Type	Method and Description
Message	addHeaderData(String headerData) Adds new header data.
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.
Map<String,Object>	getHeaders() Gets message headers.
String	getId() Gets the unique message id;
String	getName() Gets the message name for internal use;
Object	getPayload() Gets the message payload.
<T> T	getPayload(Class<T> type) Gets message payload with required type conversion.
void	removeHeader(String headerName) Removes the message header if it not a reserved message header such as unique message id.
Message	setHeader(String headerName, Object headerValue) Sets new header entry in message header list.
void	setName(String name) Sets the message name for internal use.
void	setPayload(Object payload) Sets the message payload.

Method Detail

getId

String getId()

Gets the unique message id;

Returns:

getName

String getName()

Gets the message name for internal use;

Returns:

setName

void setName(String name)

Sets the message name for internal use.

Parameters:

name -

getHeader

Object getHeader(String headerName)

Gets the message header value by its header name.

Parameters:

headerName -

Returns:

setHeader

Message setHeader(String headerName,
                  Object headerValue)

Sets new header entry in message header list.

Parameters:

headerName -

headerValue -

Returns:

removeHeader

void removeHeader(String headerName)

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

Parameters:

headerName -

addHeaderData

Message addHeaderData(String headerData)

Adds new header data.

Parameters:

headerData -

Returns:

getHeaderData

List<String> getHeaderData()

Gets the list of header data in this message.

Returns:

getHeaders

Map<String,Object> getHeaders()

Gets message headers.

Returns:

getPayload

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

Gets message payload with required type conversion.

Type Parameters:

T -

Parameters:

type -

Returns:

getPayload

Object getPayload()

Gets the message payload.

Returns:

setPayload

void setPayload(Object payload)

Sets the message payload.

Parameters:

payload -