com.consol.citrus.dsl.builder

Class SendMessageBuilder<A extends SendMessageAction,T extends SendMessageBuilder>

java.lang.Object

com.consol.citrus.dsl.builder.AbstractTestActionBuilder<DelegatingTestAction<TestAction>>

com.consol.citrus.dsl.builder.SendMessageBuilder<A,T>

All Implemented Interfaces:

TestActionBuilder<DelegatingTestAction<TestAction>>, TestAction

Direct Known Subclasses:

HttpClientRequestActionBuilder, HttpServerResponseActionBuilder, SoapClientRequestActionBuilder, SoapServerFaultResponseActionBuilder, SoapServerResponseActionBuilder

public class SendMessageBuilder<A extends SendMessageAction,T extends SendMessageBuilder>
extends AbstractTestActionBuilder<DelegatingTestAction<TestAction>>

Action builder creates a send message action with several message payload and header constructing build methods.

Since:

2.3

Author:

Christoph Deppisch

Field Summary

Fields inherited from class com.consol.citrus.dsl.builder.AbstractTestActionBuilder

action

Constructor Summary

Constructors

Constructor and Description
SendMessageBuilder() Default constructor.
SendMessageBuilder(A action) Default constructor with test action.
SendMessageBuilder(DelegatingTestAction<TestAction> action) Constructor using delegate test action.

Method Summary

Modifier and Type	Method and Description
T	dictionary(DataDictionary dictionary) Sets explicit data dictionary for this receive action.
T	dictionary(String dictionaryName) Sets explicit data dictionary by name.
SendMessageBuilder	endpoint(Endpoint messageEndpoint) Sets the message endpoint to send messages to.
SendMessageBuilder	endpoint(String messageEndpointUri) Sets the message endpoint uri to send messages to.
T	extractFromHeader(String headerName, String variable) Extract message header entry as variable before message is sent.
T	extractFromPayload(String path, String variable) Extract message element via XPath or JSONPath from payload before message is sent.
T	fork(boolean forkMode) Sets the fork mode for this send action builder.
protected SendMessageAction	getAction() Provides access to receive message action delegate.
protected AbstractMessageContentBuilder	getMessageContentBuilder() Get message builder, if already registered or create a new message builder and register it
T	header(org.springframework.core.io.Resource resource) Adds message header data as file resource to this builder's message sending action.
T	header(org.springframework.core.io.Resource resource, Charset charset) Adds message header data as file resource to this builder's message sending action.
T	header(String data) Adds message header data to this builder's message sending action.
T	header(String name, Object value) Adds message header name value pair to this builder's message sending action.
T	headerFragment(Object model) Sets header data POJO object which is marshalled to a character sequence using the default object to xml or object to json mapper that is available in Spring bean application context.
T	headerFragment(Object model, org.springframework.oxm.Marshaller marshaller) Sets header data POJO object which is marshalled to a character sequence using the given object to xml mapper.
T	headerFragment(Object model, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Sets header data POJO object which is mapped to a character sequence using the given object to json mapper.
T	headerFragment(Object model, String mapperName) Sets header data POJO object which is marshalled to a character sequence using the given object to xml mapper that is accessed by its bean name in Spring bean application context.
T	headers(Map<String,Object> headers) Adds message headers to this builder's message sending action.
T	jsonPath(String expression, String value) Adds JSONPath manipulating expression that evaluates to message payload before sending.
T	message(Message message) Sets the message instance to send.
T	messageType(MessageType messageType) Sets a explicit message type for this send action.
T	messageType(String messageType) Sets a explicit message type for this send action.
T	name(String name) Sets the message name.
T	payload(Object payload, org.springframework.oxm.Marshaller marshaller) Sets payload POJO object which is marshalled to a character sequence using the given object to xml mapper.
T	payload(Object payload, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Sets payload POJO object which is mapped to a character sequence using the given object to json mapper.
T	payload(Object payload, String mapperName) Sets payload POJO object which is marshalled to a character sequence using the given object to xml mapper that is accessed by its bean name in Spring bean application context.
T	payload(org.springframework.core.io.Resource payloadResource) Adds message payload resource to this builder.
T	payload(org.springframework.core.io.Resource payloadResource, Charset charset) Adds message payload resource to this builder.
T	payload(String payload) Adds message payload data to this builder.
T	payloadModel(Object payload) Sets payload POJO object which is marshalled to a character sequence using the default object to xml or object to json mapper that is available in Spring bean application context.
protected void	setPayload(String payload) Sets the payload data on the message builder implementation.
T	withApplicationContext(org.springframework.context.ApplicationContext applicationContext) Sets the Spring bean application context.
T	xpath(String expression, String value) Adds XPath manipulating expression that evaluates to message payload before sending.

Methods inherited from class com.consol.citrus.dsl.builder.AbstractTestActionBuilder

actor, build, description, execute, getActor, getDescription, getName, isDisabled, setActor, setDescription, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

SendMessageBuilder

public SendMessageBuilder(A action)

Default constructor with test action.

Parameters:

action -

SendMessageBuilder

public SendMessageBuilder()

Default constructor.

SendMessageBuilder

public SendMessageBuilder(DelegatingTestAction<TestAction> action)

Constructor using delegate test action.

Parameters:

action -

Method Detail

endpoint

public SendMessageBuilder endpoint(Endpoint messageEndpoint)

Sets the message endpoint to send messages to.

Parameters:

messageEndpoint -

Returns:

endpoint

public SendMessageBuilder endpoint(String messageEndpointUri)

Sets the message endpoint uri to send messages to.

Parameters:

messageEndpointUri -

Returns:

fork

public T fork(boolean forkMode)

Sets the fork mode for this send action builder.

Parameters:

forkMode -

Returns:

message

public T message(Message message)

Sets the message instance to send.

Parameters:

message -

Returns:

setPayload

protected void setPayload(String payload)

Sets the payload data on the message builder implementation.

Parameters:

payload -

name

public T name(String name)

Sets the message name.

Parameters:

name -

Returns:

payload

public T payload(String payload)

Adds message payload data to this builder.

Parameters:

payload -

Returns:

payload

public T payload(org.springframework.core.io.Resource payloadResource)

Adds message payload resource to this builder.

Parameters:

payloadResource -

Returns:

payload

public T payload(org.springframework.core.io.Resource payloadResource,
                 Charset charset)

Adds message payload resource to this builder.

Parameters:

payloadResource -

charset -

Returns:

payload

public T payload(Object payload,
                 org.springframework.oxm.Marshaller marshaller)

Sets payload POJO object which is marshalled to a character sequence using the given object to xml mapper.

Parameters:

payload -

marshaller -

Returns:

payload

public T payload(Object payload,
                 com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Sets payload POJO object which is mapped to a character sequence using the given object to json mapper.

Parameters:

payload -

objectMapper -

Returns:

payloadModel

public T payloadModel(Object payload)

Sets payload POJO object which is marshalled to a character sequence using the default object to xml or object to json mapper that is available in Spring bean application context.

Parameters:

payload -

Returns:

payload

public T payload(Object payload,
                 String mapperName)

Sets payload POJO object which is marshalled to a character sequence using the given object to xml mapper that is accessed by its bean name in Spring bean application context.

Parameters:

payload -

mapperName -

Returns:

header

public T header(String name,
                Object value)

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

Parameters:

name -

value -

headers

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

Adds message headers to this builder's message sending action.

Parameters:

headers -

header

public T header(String data)

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

Parameters:

data -

header

public T header(org.springframework.core.io.Resource resource)

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

Parameters:

resource -

header

public T header(org.springframework.core.io.Resource resource,
                Charset charset)

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

Parameters:

resource -

charset -

headerFragment

public T headerFragment(Object model,
                        org.springframework.oxm.Marshaller marshaller)

Sets header data POJO object which is marshalled to a character sequence using the given object to xml mapper.

Parameters:

model -

marshaller -

Returns:

headerFragment

public T headerFragment(Object model,
                        com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Sets header data POJO object which is mapped to a character sequence using the given object to json mapper.

Parameters:

model -

objectMapper -

Returns:

headerFragment

public T headerFragment(Object model)

Sets header data POJO object which is marshalled to a character sequence using the default object to xml or object to json mapper that is available in Spring bean application context.

Parameters:

model -

Returns:

headerFragment

public T headerFragment(Object model,
                        String mapperName)

Sets header data POJO object which is marshalled to a character sequence using the given object to xml mapper that is accessed by its bean name in Spring bean application context.

Parameters:

model -

mapperName -

Returns:

messageType

public T messageType(MessageType messageType)

Sets a explicit message type for this send action.

Parameters:

messageType -

Returns:

messageType

public T messageType(String messageType)

Sets a explicit message type for this send action.

Parameters:

messageType -

Returns:

getMessageContentBuilder

protected AbstractMessageContentBuilder getMessageContentBuilder()

Get message builder, if already registered or create a new message builder and register it

Returns:

the message builder in use

extractFromHeader

public T extractFromHeader(String headerName,
                           String variable)

Extract message header entry as variable before message is sent.

Parameters:

headerName -

variable -

Returns:

extractFromPayload

public T extractFromPayload(String path,
                            String variable)

Extract message element via XPath or JSONPath from payload before message is sent.

Parameters:

path -

variable -

Returns:

xpath

public T xpath(String expression,
               String value)

Adds XPath manipulating expression that evaluates to message payload before sending.

Parameters:

expression -

value -

Returns:

jsonPath

public T jsonPath(String expression,
                  String value)

Adds JSONPath manipulating expression that evaluates to message payload before sending.

Parameters:

expression -

value -

Returns:

withApplicationContext

public T withApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Sets the Spring bean application context.

Parameters:

applicationContext -

dictionary

public T dictionary(DataDictionary dictionary)

Sets explicit data dictionary for this receive action.

Parameters:

dictionary -

Returns:

dictionary

public T dictionary(String dictionaryName)

Sets explicit data dictionary by name.

Parameters:

dictionaryName -

Returns:

getAction

protected SendMessageAction getAction()

Provides access to receive message action delegate.

Returns: