Package org.citrusframework.message

Interface Message

All Superinterfaces:

Serializable

public interface Message
extends Serializable

Since:

2.0

Author:

Christoph Deppisch

Method Summary

Modifier and Type	Method	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.
String	getType()	Indicates the type of the message content (e.g.
default String	print()	Prints message content to String representation.
default String	print(String body, Map<String,Object> headers, List<String> headerData)	Prints given message content (body, headers, headerData) to String representation.
default String	print(TestContext context)	Prints message content and applies logger modifier provided in given test context.
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.
Message	setName(String name)	Sets the message name for internal use.
Message	setPayload(Object payload)	Sets the message payload.
Message	setType(String type)	Sets the message type indicating the content type.

Method Details

print

default String print()

Prints message content to String representation.

Returns:

print

default String print(String body,
 Map<String,Object> headers,
 List<String> headerData)

Prints given message content (body, headers, headerData) to String representation.

Parameters:

body -

headers -

headerData -

Returns:

print

default String print(TestContext context)

Prints message content and applies logger modifier provided in given test context.

Returns:

getId

String getId()

Gets the unique message id;

Returns:

getType

String getType()

Indicates the type of the message content (e.g. Xml, Json, binary)

Returns:

setType

Message setType(String type)

Sets the message type indicating the content type.

Parameters:

type -

getName

String getName()

Gets the message name for internal use;

Returns:

setName

Message 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

Message setPayload(Object payload)

Sets the message payload.

Parameters:

payload -