com.consol.citrus.actions

Class ReceiveMessageAction

java.lang.Object

com.consol.citrus.actions.AbstractTestAction

com.consol.citrus.actions.ReceiveMessageAction

All Implemented Interfaces:

TestAction

public class ReceiveMessageAction
extends AbstractTestAction

This action receives messages from a service destination. Action uses a Endpoint to receive the message, this means that action is independent from any message transport. The received message is validated using a MessageValidator supporting expected control message payload and header templates.

Since:

2008

Author:

Christoph Deppisch

Field Summary

Fields inherited from class com.consol.citrus.actions.AbstractTestAction

description

Constructor Summary

Constructors

Constructor and Description
ReceiveMessageAction() Default constructor.

Method Summary

Modifier and Type	Method and Description
ReceiveMessageAction	addVariableExtractors(VariableExtractor variableExtractor) Adds a new variable extractor.
protected Message	createControlMessage(TestContext context, String messageType) Create control message that is expected.
void	doExecute(TestContext context) Method receives a message via Endpoint instance constructs a validation context and starts the message validation via MessageValidator.
DataDictionary	getDataDictionary() Gets the data dictionary.
Endpoint	getEndpoint() Get the message endpoint.
String	getEndpointUri() Gets the endpoint uri.
MessageContentBuilder	getMessageBuilder() Gets the messageBuilder.
Map<String,Object>	getMessageSelector() Gets the messageSelector.
String	getMessageSelectorString() Gets the messageSelectorString.
String	getMessageType() Gets the message type for this receive action.
Endpoint	getOrCreateEndpoint(TestContext context) Creates or gets the endpoint instance.
long	getReceiveTimeout() Gets the receiveTimeout.
ValidationCallback	getValidationCallback() Gets the validationCallback.
List<ValidationContext>	getValidationContexts() Gets the validationContexts.
MessageValidator<? extends ValidationContext>	getValidator() Gets the validator.
List<VariableExtractor>	getVariableExtractors() Gets the variable extractors.
boolean	isDisabled(TestContext context) Checks if this test action is disabled.
ReceiveMessageAction	setDataDictionary(DataDictionary dataDictionary) Sets the data dictionary.
ReceiveMessageAction	setEndpoint(Endpoint endpoint) Set message endpoint instance.
ReceiveMessageAction	setEndpointUri(String endpointUri) Sets the endpoint uri.
ReceiveMessageAction	setMessageBuilder(MessageContentBuilder messageBuilder) Sets the message builder implementation.
ReceiveMessageAction	setMessageSelector(Map<String,Object> messageSelector) Setter for messageSelector.
ReceiveMessageAction	setMessageSelectorString(String messageSelectorString) Set message selector string.
ReceiveMessageAction	setMessageType(String messageType) Sets the expected message type for this receive action.
ReceiveMessageAction	setReceiveTimeout(long receiveTimeout) Set the receive timeout.
ReceiveMessageAction	setValidationCallback(ValidationCallback validationCallback) Sets the validationCallback.
ReceiveMessageAction	setValidationContexts(List<ValidationContext> validationContexts) Sets the list of available validation contexts for this action.
ReceiveMessageAction	setValidator(MessageValidator<? extends ValidationContext> validator) Set single message validator.
ReceiveMessageAction	setVariableExtractors(List<VariableExtractor> variableExtractors) Set the list of variable extractors.
protected void	validateMessage(Message receivedMessage, TestContext context) Override this message if you want to add additional message validation

Methods inherited from class com.consol.citrus.actions.AbstractTestAction

execute, getActor, getDescription, getName, setActor, setDescription, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

ReceiveMessageAction

public ReceiveMessageAction()

Default constructor.

Method Detail

doExecute

public void doExecute(TestContext context)

Method receives a message via Endpoint instance constructs a validation context and starts the message validation via MessageValidator.

Specified by:

doExecute in class AbstractTestAction

Throws:

CitrusRuntimeException

validateMessage

protected void validateMessage(Message receivedMessage,
                               TestContext context)
                        throws IOException

Override this message if you want to add additional message validation

Parameters:

receivedMessage -

Throws:

IOException

createControlMessage

protected Message createControlMessage(TestContext context,
                                       String messageType)

Create control message that is expected.

Parameters:

context -

messageType -

Returns:

isDisabled

public boolean isDisabled(TestContext context)

Description copied from class: AbstractTestAction

Checks if this test action is disabled. Delegates to test actor defined for this test action by default. Subclasses may add additional disabled logic here.

Specified by:

isDisabled in interface TestAction

Overrides:

isDisabled in class AbstractTestAction

Parameters:

context - the current test context.

Returns:

true if action is marked disabled.

setMessageSelector

public ReceiveMessageAction setMessageSelector(Map<String,Object> messageSelector)

Setter for messageSelector.

Parameters:

messageSelector -

setMessageSelectorString

public ReceiveMessageAction setMessageSelectorString(String messageSelectorString)

Set message selector string.

Parameters:

messageSelectorString -

setValidator

public ReceiveMessageAction setValidator(MessageValidator<? extends ValidationContext> validator)

Set single message validator.

Parameters:

validator - the message validator to set

getOrCreateEndpoint

public Endpoint getOrCreateEndpoint(TestContext context)

Creates or gets the endpoint instance.

Parameters:

context -

Returns:

setEndpoint

public ReceiveMessageAction setEndpoint(Endpoint endpoint)

Set message endpoint instance.

Parameters:

endpoint - the message endpoint

getEndpoint

public Endpoint getEndpoint()

Get the message endpoint.

Returns:

the message endpoint

getEndpointUri

public String getEndpointUri()

Gets the endpoint uri.

Returns:

setEndpointUri

public ReceiveMessageAction setEndpointUri(String endpointUri)

Sets the endpoint uri.

Parameters:

endpointUri -

setReceiveTimeout

public ReceiveMessageAction setReceiveTimeout(long receiveTimeout)

Set the receive timeout.

Parameters:

receiveTimeout - the receiveTimeout to set

addVariableExtractors

public ReceiveMessageAction addVariableExtractors(VariableExtractor variableExtractor)

Adds a new variable extractor.

Parameters:

variableExtractor - the variableExtractor to set

setVariableExtractors

public ReceiveMessageAction setVariableExtractors(List<VariableExtractor> variableExtractors)

Set the list of variable extractors.

Parameters:

variableExtractors - the variableExtractors to set

setValidationContexts

public ReceiveMessageAction setValidationContexts(List<ValidationContext> validationContexts)

Sets the list of available validation contexts for this action.

Parameters:

validationContexts - the validationContexts to set

getVariableExtractors

public List<VariableExtractor> getVariableExtractors()

Gets the variable extractors.

Returns:

the variableExtractors

setMessageType

public ReceiveMessageAction setMessageType(String messageType)

Sets the expected message type for this receive action.

Parameters:

messageType - the messageType to set

getMessageType

public String getMessageType()

Gets the message type for this receive action.

Returns:

the messageType

getMessageSelector

public Map<String,Object> getMessageSelector()

Gets the messageSelector.

Returns:

the messageSelector

getMessageSelectorString

public String getMessageSelectorString()

Gets the messageSelectorString.

Returns:

the messageSelectorString

getReceiveTimeout

public long getReceiveTimeout()

Gets the receiveTimeout.

Returns:

the receiveTimeout

getValidator

public MessageValidator<? extends ValidationContext> getValidator()

Gets the validator.

Returns:

the validator

getValidationContexts

public List<ValidationContext> getValidationContexts()

Gets the validationContexts.

Returns:

the validationContexts

getValidationCallback

public ValidationCallback getValidationCallback()

Gets the validationCallback.

Returns:

the validationCallback the validationCallback to get.

setValidationCallback

public ReceiveMessageAction setValidationCallback(ValidationCallback validationCallback)

Sets the validationCallback.

Parameters:

validationCallback - the validationCallback to set

getDataDictionary

public DataDictionary getDataDictionary()

Gets the data dictionary.

Returns:

setDataDictionary

public ReceiveMessageAction setDataDictionary(DataDictionary dataDictionary)

Sets the data dictionary.

Parameters:

dataDictionary -

getMessageBuilder

public MessageContentBuilder getMessageBuilder()

Gets the messageBuilder.

Returns:

the messageBuilder

setMessageBuilder

public ReceiveMessageAction setMessageBuilder(MessageContentBuilder messageBuilder)

Sets the message builder implementation.

Parameters:

messageBuilder - the messageBuilder to set