Package org.citrusframework.message.builder

Class MessageBuilderSupport<T extends TestAction,B extends MessageBuilderSupport.MessageActionBuilder<T,S,B>,S extends MessageBuilderSupport<T,B,S>>

java.lang.Object

org.citrusframework.message.builder.MessageBuilderSupport<T,B,S>

All Implemented Interfaces:

ReferenceResolverAware, TestActionBuilder<T>

Direct Known Subclasses:

ReceiveMessageBuilderSupport, SendMessageBuilderSupport

public abstract class MessageBuilderSupport<T extends TestAction,B extends MessageBuilderSupport.MessageActionBuilder<T,S,B>,S extends MessageBuilderSupport<T,B,S>>
extends Object
implements TestActionBuilder<T>, ReferenceResolverAware

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessageBuilderSupport.MessageActionBuilder<T extends TestAction,M extends MessageBuilderSupport<T,B,M>,B extends MessageBuilderSupport.MessageActionBuilder<T,M,B>>	Basic message action builder provides settings on a message object and common message related operations such as processors.

Nested classes/interfaces inherited from interface org.citrusframework.TestActionBuilder

TestActionBuilder.DelegatingTestActionBuilder<T extends TestAction>

Field Summary

Fields

Modifier and Type	Field	Description
protected DataDictionary<?>	dataDictionary
protected String	dataDictionaryName
protected final B	delegate
protected MessageBuilder	messageBuilder
protected String	messageType
protected final S	self

Fields inherited from interface org.citrusframework.TestActionBuilder

logger, RESOURCE_PATH, TYPE_RESOLVER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MessageBuilderSupport(B delegate)

Method Summary

Modifier and Type	Method	Description
S	body(String payload)	Adds message payload data to this builder.
S	body(MessagePayloadBuilder payloadBuilder)	Sets the payload data on the message builder implementation.
S	body(MessagePayloadBuilder.Builder<?,?> payloadBuilder)	Sets the payload data on the message builder implementation.
S	body(Resource payloadResource)	Adds message payload resource to this builder.
S	body(Resource payloadResource, Charset charset)	Adds message payload resource to this builder.
T	build()
S	dictionary(String dictionaryName)	Sets explicit data dictionary by name.
S	dictionary(DataDictionary<?> dictionary)	Sets explicit data dictionary for this action.
S	extract(VariableExtractor extractor)	Adds variable extractor on the message.
S	extract(VariableExtractor.Builder<?,?> builder)	Adds message processor on the message as fluent builder.
S	extract(VariableExtractorAdapter adapter)	Adds message processor on the message.
S	from(Message controlMessage)	Build message from given message template.
S	from(MessageBuilder messageBuilder)	Build message from given message builder.
DataDictionary<?>	getDataDictionary()
String	getDataDictionaryName()
MessageBuilder	getMessageBuilder()
String	getMessageType()
S	header(String data)	Adds message header data to this builder's message.
S	header(String name, Object value)	Adds message header name value pair to this builder's message.
S	header(MessageHeaderDataBuilder headerDataBuilder)	Adds message header data builder to this builder's message.
S	header(Resource resource)	Adds message header data as file resource to this builder's message.
S	header(Resource resource, Charset charset)	Adds message header data as file resource to this builder's message.
S	headers(Map<String,Object> headers)	Adds message headers to this builder's message.
S	name(String name)	Sets the message name.
S	process(MessageProcessor processor)	Adds message processor on the message.
S	process(MessageProcessor.Builder<?,?> builder)	Adds message processor on the message as fluent builder.
S	process(MessageProcessorAdapter adapter)	Adds message processor on the message as fluent builder.
void	setReferenceResolver(ReferenceResolver referenceResolver)
S	type(String messageType)	Sets an explicit message type for this message.
S	type(MessageType messageType)	Sets a explicit message type for this message.
S	withReferenceResolver(ReferenceResolver referenceResolver)	Sets the bean reference resolver.

Methods inherited from class java.lang.Object

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

Field Details

self

protected final S extends MessageBuilderSupport<T,B,S> self

messageBuilder

protected MessageBuilder messageBuilder

delegate

protected final B extends MessageBuilderSupport.MessageActionBuilder<T,S,B> delegate

messageType

protected String messageType

dataDictionary

protected DataDictionary<?> dataDictionary

dataDictionaryName

protected String dataDictionaryName

Constructor Details

MessageBuilderSupport

protected MessageBuilderSupport(B delegate)

Method Details

from

public S from(MessageBuilder messageBuilder)

Build message from given message builder.

Parameters:

messageBuilder -

Returns:

The modified message action builder

from

public S from(Message controlMessage)

Build message from given message template.

Parameters:

controlMessage -

Returns:

The modified message action builder

type

public S type(MessageType messageType)

Sets a explicit message type for this message.

Parameters:

messageType -

Returns:

The modified message action builder

type

public S type(String messageType)

Sets an explicit message type for this message.

Parameters:

messageType - the type of the message indicates the content type (e.g. Xml, Json, binary).

Returns:

The modified message action builder

body

public S body(MessagePayloadBuilder.Builder<?,?> payloadBuilder)

Sets the payload data on the message builder implementation.

Parameters:

payloadBuilder -

Returns:

The modified message action builder

body

public S body(MessagePayloadBuilder payloadBuilder)

Sets the payload data on the message builder implementation.

Parameters:

payloadBuilder -

Returns:

The modified message action builder

body

public S body(String payload)

Adds message payload data to this builder.

Parameters:

payload -

Returns:

The modified message action builder

body

public S body(Resource payloadResource)

Adds message payload resource to this builder.

Parameters:

payloadResource -

Returns:

The modified message action builder

body

public S body(Resource payloadResource,
 Charset charset)

Adds message payload resource to this builder.

Parameters:

payloadResource -

charset -

Returns:

The modified message action builder

header

public S header(String name,
 Object value)

Adds message header name value pair to this builder's message.

Parameters:

name -

value -

Returns:

The modified message action builder

headers

public S headers(Map<String,Object> headers)

Adds message headers to this builder's message.

Parameters:

headers -

Returns:

The modified message action builder

header

public S header(String data)

Adds message header data to this builder's message. Message header data is used in SOAP messages for instance as header XML fragment.

Parameters:

data -

Returns:

The modified message action builder

header

public S header(MessageHeaderDataBuilder headerDataBuilder)

Adds message header data builder to this builder's message. Message header data is used in SOAP messages as XML fragment for instance.

Parameters:

headerDataBuilder -

Returns:

The modified message action builder

header

public S header(Resource resource)

Adds message header data as file resource to this builder's message. Message header data is used in SOAP messages for instance as header XML fragment.

Parameters:

resource -

Returns:

The modified message action builder

header

public S header(Resource resource,
 Charset charset)

Adds message header data as file resource to this builder's message. Message header data is used in SOAP messages for instance as header XML fragment.

Parameters:

resource -

charset -

Returns:

The modified message action builder

name

public S name(String name)

Sets the message name.

Parameters:

name -

Returns:

The modified message action builder

process

public S process(MessageProcessor processor)

Adds message processor on the message.

Parameters:

processor -

Returns:

The modified message action builder

process

public S process(MessageProcessor.Builder<?,?> builder)

Adds message processor on the message as fluent builder.

Parameters:

builder -

Returns:

The modified message action builder

process

public S process(MessageProcessorAdapter adapter)

Adds message processor on the message as fluent builder.

Parameters:

adapter -

Returns:

The modified message action builder

extract

public S extract(VariableExtractor extractor)

Adds variable extractor on the message.

Parameters:

extractor -

Returns:

extract

public S extract(VariableExtractorAdapter adapter)

Adds message processor on the message.

Parameters:

adapter -

Returns:

extract

public S extract(VariableExtractor.Builder<?,?> builder)

Adds message processor on the message as fluent builder.

Parameters:

builder -

Returns:

dictionary

public S dictionary(DataDictionary<?> dictionary)

Sets explicit data dictionary for this action.

Parameters:

dictionary -

Returns:

The modified message action builder

dictionary

public S dictionary(String dictionaryName)

Sets explicit data dictionary by name.

Parameters:

dictionaryName -

Returns:

The modified message action builder

withReferenceResolver

public S withReferenceResolver(ReferenceResolver referenceResolver)

Sets the bean reference resolver.

Parameters:

referenceResolver -

build

public T build()

Specified by:

build in interface TestActionBuilder<T extends TestAction>

setReferenceResolver

public void setReferenceResolver(ReferenceResolver referenceResolver)

Specified by:

setReferenceResolver in interface ReferenceResolverAware

getDataDictionaryName

public String getDataDictionaryName()

getDataDictionary

public DataDictionary<?> getDataDictionary()

getMessageBuilder

public MessageBuilder getMessageBuilder()

getMessageType

public String getMessageType()