ReceiveMessageBuilder (citrus-java-dsl 2.7.9 API)

java.lang.Object
- com.consol.citrus.dsl.builder.AbstractTestActionBuilder<DelegatingTestAction<TestAction>>
- - com.consol.citrus.dsl.builder.ReceiveMessageBuilder<A,T>

All Implemented Interfaces:

TestActionBuilder<DelegatingTestAction<TestAction>>, TestAction

Direct Known Subclasses:

HttpClientResponseActionBuilder, HttpServerRequestActionBuilder, SoapClientResponseActionBuilder, SoapServerRequestActionBuilder
```
public class ReceiveMessageBuilder<A extends ReceiveMessageAction,T extends ReceiveMessageBuilder>
extends AbstractTestActionBuilder<DelegatingTestAction<TestAction>>
```
Receive message action builder offers configuration methods for a receive test action. Build options include construction of control message payload and headers as well as value extraction.

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
`ReceiveMessageBuilder()` Default constructor.
`ReceiveMessageBuilder(A action)` Default constructor using test action, basic application context and position handle.
`ReceiveMessageBuilder(DelegatingTestAction<TestAction> action)` Constructor using delegate test action.

Method Summary

All Methods Instance Methods Concrete Methods
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.
`ReceiveMessageBuilder`	`endpoint(Endpoint messageEndpoint)` Sets the message endpoint to receive messages from.
`ReceiveMessageBuilder`	`endpoint(String messageEndpointUri)` Sets the message endpoint uri to receive messages from.
`T`	`extractFromHeader(String headerName, String variable)` Extract message header entry as variable.
`T`	`extractFromPayload(String path, String variable)` Extract message element via XPath or JSONPath from message payload as new test variable.
`protected ReceiveMessageAction`	`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)` Expect this message header data in received message from file resource.
`T`	`header(org.springframework.core.io.Resource resource, Charset charset)` Expect this message header data in received message from file resource.
`T`	`header(String data)` Expect this message header data in received message.
`T`	`header(String name, Object value)` Expect this message header entry in received message.
`T`	`headerFragment(Object model)` Expect this message header data as model object which is marshalled to a character sequence using the default object to xml mapper that is available in Spring bean application context.
`T`	`headerFragment(Object model, org.springframework.oxm.Marshaller marshaller)` Expect this message header data as model object which is marshalled to a character sequence using the default object to xml mapper before validation is performed.
`T`	`headerFragment(Object model, com.fasterxml.jackson.databind.ObjectMapper objectMapper)` Expect this message header data as model object which is mapped to a character sequence using the default object to json mapper before validation is performed.
`T`	`headerFragment(Object model, String mapperName)` Expect this message header data as model 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`	`headerNameIgnoreCase(boolean value)` Validate header names with case insensitive keys.
`T`	`headers(Map<String,Object> headers)` Expect this message header entries in received message.
`T`	`headerValidator(HeaderValidator... validators)` Sets explicit header validator for this receive action.
`T`	`headerValidator(String... validatorNames)` Sets explicit header validators by name.
`T`	`ignore(String path)` Adds ignore path expression for message element.
`T`	`jsonPath(String jsonPathExpression, Object controlValue)` Adds JsonPath message element validation.
`T`	`jsonSchema(String schemaName)` Sets explicit schema instance name to use for schema validation.
`T`	`jsonSchemaRepository(String schemaRepository)` Sets explicit json schema repository instance to use for validation.
`T`	`message(Message controlMessage)` Expect a control message in this receive action.
`T`	`messageType(MessageType messageType)` Sets a explicit message type for this receive action.
`T`	`messageType(String messageType)` Sets a explicit message type for this receive action.
`T`	`name(String name)` Sets the message name.
`T`	`namespace(String prefix, String namespaceUri)` Adds explicit namespace declaration for later path validation expressions.
`T`	`namespaces(Map<String,String> namespaceMappings)` Sets default namespace declarations on this action builder.
`T`	`payload(Object payload, org.springframework.oxm.Marshaller marshaller)` Expect this message payload as model object which is marshalled to a character sequence using the default object to xml mapper before validation is performed.
`T`	`payload(Object payload, com.fasterxml.jackson.databind.ObjectMapper objectMapper)` Expect this message payload as model object which is mapped to a character sequence using the default object to json mapper before validation is performed.
`T`	`payload(Object payload, String mapperName)` Expect this message payload as model 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)` Expect this message payload data in received message.
`T`	`payload(org.springframework.core.io.Resource payloadResource, Charset charset)` Expect this message payload data in received message.
`T`	`payload(String payload)` Expect this message payload data in received message.
`T`	`payloadModel(Object payload)` Expect this message payload as model object which is marshalled to a character sequence using the default object to xml mapper that is available in Spring bean application context.
`T`	`schemaValidation(boolean enabled)` Sets schema validation enabled/disabled for this message.
`T`	`selector(Map<String,Object> messageSelector)` Sets message selector elements.
`T`	`selector(String messageSelector)` Sets message selector string.
`protected void`	`setHeaderExtractor(MessageHeaderVariableExtractor headerExtractor)` Sets the header extractor.
`protected void`	`setHeaderValidationContext(HeaderValidationContext validationContext)` Sets the header validation context.
`protected void`	`setJsonMessageValidationContext(JsonMessageValidationContext validationContext)` Sets the JSON validation context.
`protected void`	`setJsonPathExtractor(JsonPathVariableExtractor jsonPathExtractor)` Sets the jsonPath extractor.
`protected void`	`setJsonPathValidationContext(JsonPathMessageValidationContext jsonPathValidationContext)` Sets the script message validator.
`protected void`	`setMessageType(MessageType messageType)` Sets the message type.
`protected void`	`setMessageType(String messageType)` Sets the message type.
`protected void`	`setPayload(String payload)` Sets the payload data on the message builder implementation.
`protected void`	`setScriptValidationContext(ScriptValidationContext scriptValidationContext)` Sets the script message validator.
`protected void`	`setXmlMessageValidationContext(XmlMessageValidationContext validationContext)` Sets the XML validation context.
`protected void`	`setXpathExtractor(XpathPayloadVariableExtractor xpathExtractor)` Sets the xpath extractor.
`T`	`timeout(long receiveTimeout)` Adds a custom timeout to this message receiving action.
`T`	`validate(String path, Object controlValue)` Adds message element validation.
`T`	`validateNamespace(String prefix, String namespaceUri)` Validates XML namespace with prefix and uri.
`T`	`validateScript(org.springframework.core.io.Resource scriptResource)` Reads validation script file resource and sets content as validation script.
`T`	`validateScript(org.springframework.core.io.Resource scriptResource, Charset charset)` Reads validation script file resource and sets content as validation script.
`T`	`validateScript(String validationScript)` Adds script validation.
`T`	`validateScriptResource(String fileResourcePath)` Adds script validation file resource.
`T`	`validateScriptType(String type)` Adds custom validation script type.
`T`	`validationCallback(ValidationCallback callback)` Adds validation callback to the receive action for validating the received message with Java code.
`T`	`validator(MessageValidator<? extends ValidationContext>... validators)` Sets explicit message validators for this receive action.
`T`	`validator(String... validatorNames)` Sets explicit message validators by name.
`T`	`withApplicationContext(org.springframework.context.ApplicationContext applicationContext)` Sets the Spring bean application context.
`T`	`xpath(String xPathExpression, Object controlValue)` Adds XPath message element validation.
`T`	`xsd(String schemaName)` Sets explicit schema instance name to use for schema validation.
`T`	`xsdSchemaRepository(String schemaRepository)` Sets explicit xsd schema repository instance to use for validation.

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
  - ReceiveMessageBuilder
```
public ReceiveMessageBuilder(A action)
```
    Default constructor using test action, basic application context and position handle.
    
    Parameters:
    
    action -
  - ReceiveMessageBuilder
```
public ReceiveMessageBuilder()
```
    Default constructor.
  - ReceiveMessageBuilder
```
public ReceiveMessageBuilder(DelegatingTestAction<TestAction> action)
```
    Constructor using delegate test action.
    
    Parameters:
    
    action -
- Method Detail
  - endpoint
```
public ReceiveMessageBuilder endpoint(Endpoint messageEndpoint)
```
    Sets the message endpoint to receive messages from.
    
    Parameters:
    
    messageEndpoint -
    
    Returns:
  - endpoint
```
public ReceiveMessageBuilder endpoint(String messageEndpointUri)
```
    Sets the message endpoint uri to receive messages from.
    
    Parameters:
    
    messageEndpointUri -
    
    Returns:
  - timeout
```
public T timeout(long receiveTimeout)
```
    Adds a custom timeout to this message receiving action.
    
    Parameters:
    
    receiveTimeout -
    
    Returns:
  - message
```
public T message(Message controlMessage)
```
    Expect a control message in this receive action.
    
    Parameters:
    
    controlMessage -
    
    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)
```
    Expect this message payload data in received message.
    
    Parameters:
    
    payload -
    
    Returns:
  - payload
```
public T payload(org.springframework.core.io.Resource payloadResource)
```
    Expect this message payload data in received message.
    
    Parameters:
    
    payloadResource -
    
    Returns:
  - payload
```
public T payload(org.springframework.core.io.Resource payloadResource,
                 Charset charset)
```
    Expect this message payload data in received message.
    
    Parameters:
    
    payloadResource -
    
    charset -
    
    Returns:
  - payload
```
public T payload(Object payload,
                 org.springframework.oxm.Marshaller marshaller)
```
    Expect this message payload as model object which is marshalled to a character sequence using the default object to xml mapper before validation is performed.
    
    Parameters:
    
    payload -
    
    marshaller -
    
    Returns:
  - payload
```
public T payload(Object payload,
                 com.fasterxml.jackson.databind.ObjectMapper objectMapper)
```
    Expect this message payload as model object which is mapped to a character sequence using the default object to json mapper before validation is performed.
    
    Parameters:
    
    payload -
    
    objectMapper -
    
    Returns:
  - payloadModel
```
public T payloadModel(Object payload)
```
    Expect this message payload as model object which is marshalled to a character sequence using the default object to xml mapper that is available in Spring bean application context.
    
    Parameters:
    
    payload -
    
    Returns:
  - payload
```
public T payload(Object payload,
                 String mapperName)
```
    Expect this message payload as model 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)
```
    Expect this message header entry in received message.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
  - headers
```
public T headers(Map<String,Object> headers)
```
    Expect this message header entries in received message.
    
    Parameters:
    
    headers -
    
    Returns:
  - header
```
public T header(String data)
```
    Expect this message header data in received message. Message header data is used in SOAP messages as XML fragment for instance.
    
    Parameters:
    
    data -
    
    Returns:
  - headerFragment
```
public T headerFragment(Object model)
```
    Expect this message header data as model object which is marshalled to a character sequence using the default object to xml mapper that is available in Spring bean application context.
    
    Parameters:
    
    model -
    
    Returns:
  - headerFragment
```
public T headerFragment(Object model,
                        String mapperName)
```
    Expect this message header data as model 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:
  - headerFragment
```
public T headerFragment(Object model,
                        org.springframework.oxm.Marshaller marshaller)
```
    Expect this message header data as model object which is marshalled to a character sequence using the default object to xml mapper before validation is performed.
    
    Parameters:
    
    model -
    
    marshaller -
    
    Returns:
  - headerFragment
```
public T headerFragment(Object model,
                        com.fasterxml.jackson.databind.ObjectMapper objectMapper)
```
    Expect this message header data as model object which is mapped to a character sequence using the default object to json mapper before validation is performed.
    
    Parameters:
    
    model -
    
    objectMapper -
    
    Returns:
  - header
```
public T header(org.springframework.core.io.Resource resource)
```
    Expect this message header data in received message from file resource. Message header data is used in SOAP messages as XML fragment for instance.
    
    Parameters:
    
    resource -
    
    Returns:
  - header
```
public T header(org.springframework.core.io.Resource resource,
                Charset charset)
```
    Expect this message header data in received message from file resource. Message header data is used in SOAP messages as XML fragment for instance.
    
    Parameters:
    
    resource -
    
    charset -
    
    Returns:
  - headerNameIgnoreCase
```
public T headerNameIgnoreCase(boolean value)
```
    Validate header names with case insensitive keys.
    
    Parameters:
    
    value -
    
    Returns:
  - validateScript
```
public T validateScript(String validationScript)
```
    Adds script validation.
    
    Parameters:
    
    validationScript -
    
    Returns:
  - validateScript
```
public T validateScript(org.springframework.core.io.Resource scriptResource)
```
    Reads validation script file resource and sets content as validation script.
    
    Parameters:
    
    scriptResource -
    
    Returns:
  - validateScript
```
public T validateScript(org.springframework.core.io.Resource scriptResource,
                        Charset charset)
```
    Reads validation script file resource and sets content as validation script.
    
    Parameters:
    
    scriptResource -
    
    charset -
    
    Returns:
  - validateScriptResource
```
public T validateScriptResource(String fileResourcePath)
```
    Adds script validation file resource.
    
    Parameters:
    
    fileResourcePath -
    
    Returns:
  - validateScriptType
```
public T validateScriptType(String type)
```
    Adds custom validation script type.
    
    Parameters:
    
    type -
    
    Returns:
  - messageType
```
public T messageType(MessageType messageType)
```
    Sets a explicit message type for this receive action.
    
    Parameters:
    
    messageType -
    
    Returns:
  - messageType
```
public T messageType(String messageType)
```
    Sets a explicit message type for this receive action.
    
    Parameters:
    
    messageType -
    
    Returns:
  - schemaValidation
```
public T schemaValidation(boolean enabled)
```
    Sets schema validation enabled/disabled for this message.
    
    Parameters:
    
    enabled -
    
    Returns:
  - validateNamespace
```
public T validateNamespace(String prefix,
                           String namespaceUri)
```
    Validates XML namespace with prefix and uri.
    
    Parameters:
    
    prefix -
    
    namespaceUri -
    
    Returns:
  - validate
```
public T validate(String path,
                  Object controlValue)
```
    Adds message element validation.
    
    Parameters:
    
    path -
    
    controlValue -
    
    Returns:
  - ignore
```
public T ignore(String path)
```
    Adds ignore path expression for message element.
    
    Parameters:
    
    path -
    
    Returns:
  - xpath
```
public T xpath(String xPathExpression,
               Object controlValue)
```
    Adds XPath message element validation.
    
    Parameters:
    
    xPathExpression -
    
    controlValue -
    
    Returns:
  - jsonPath
```
public T jsonPath(String jsonPathExpression,
                  Object controlValue)
```
    Adds JsonPath message element validation.
    
    Parameters:
    
    jsonPathExpression -
    
    controlValue -
    
    Returns:
  - xsd
```
public T xsd(String schemaName)
```
    Sets explicit schema instance name to use for schema validation.
    
    Parameters:
    
    schemaName -
    
    Returns:
  - jsonSchema
```
public T jsonSchema(String schemaName)
```
    Sets explicit schema instance name to use for schema validation.
    
    Parameters:
    
    schemaName - The name of the schema bean
  - xsdSchemaRepository
```
public T xsdSchemaRepository(String schemaRepository)
```
    Sets explicit xsd schema repository instance to use for validation.
    
    Parameters:
    
    schemaRepository -
    
    Returns:
  - jsonSchemaRepository
```
public T jsonSchemaRepository(String schemaRepository)
```
    Sets explicit json schema repository instance to use for validation.
    
    Parameters:
    
    schemaRepository - The name of the schema repository bean
    
    Returns:
  - namespace
```
public T namespace(String prefix,
                   String namespaceUri)
```
    Adds explicit namespace declaration for later path validation expressions.
    
    Parameters:
    
    prefix -
    
    namespaceUri -
    
    Returns:
  - namespaces
```
public T namespaces(Map<String,String> namespaceMappings)
```
    Sets default namespace declarations on this action builder.
    
    Parameters:
    
    namespaceMappings -
    
    Returns:
  - selector
```
public T selector(String messageSelector)
```
    Sets message selector string.
    
    Parameters:
    
    messageSelector -
    
    Returns:
  - selector
```
public T selector(Map<String,Object> messageSelector)
```
    Sets message selector elements.
    
    Parameters:
    
    messageSelector -
    
    Returns:
  - validator
```
public T validator(MessageValidator<? extends ValidationContext>... validators)
```
    Sets explicit message validators for this receive action.
    
    Parameters:
    
    validators -
    
    Returns:
  - validator
```
public T validator(String... validatorNames)
```
    Sets explicit message validators by name.
    
    Parameters:
    
    validatorNames -
    
    Returns:
  - headerValidator
```
public T headerValidator(HeaderValidator... validators)
```
    Sets explicit header validator for this receive action.
    
    Parameters:
    
    validators -
    
    Returns:
  - headerValidator
```
public T headerValidator(String... validatorNames)
```
    Sets explicit header validators by name.
    
    Parameters:
    
    validatorNames -
    
    Returns:
  - 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:
  - extractFromHeader
```
public T extractFromHeader(String headerName,
                           String variable)
```
    Extract message header entry as variable.
    
    Parameters:
    
    headerName -
    
    variable -
    
    Returns:
  - extractFromPayload
```
public T extractFromPayload(String path,
                            String variable)
```
    Extract message element via XPath or JSONPath from message payload as new test variable.
    
    Parameters:
    
    path -
    
    variable -
    
    Returns:
  - validationCallback
```
public T validationCallback(ValidationCallback callback)
```
    Adds validation callback to the receive action for validating the received message with Java code.
    
    Parameters:
    
    callback -
    
    Returns:
  - withApplicationContext
```
public T withApplicationContext(org.springframework.context.ApplicationContext applicationContext)
```
    Sets the Spring bean application context.
    
    Parameters:
    
    applicationContext -
  - 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
  - getAction
```
protected ReceiveMessageAction getAction()
```
    Provides access to receive message action delegate.
    
    Returns:
  - setMessageType
```
protected void setMessageType(MessageType messageType)
```
    Sets the message type.
    
    Parameters:
    
    messageType -
  - setMessageType
```
protected void setMessageType(String messageType)
```
    Sets the message type.
    
    Parameters:
    
    messageType -
  - setXpathExtractor
```
protected void setXpathExtractor(XpathPayloadVariableExtractor xpathExtractor)
```
    Sets the xpath extractor.
    
    Parameters:
    
    xpathExtractor -
  - setJsonPathExtractor
```
protected void setJsonPathExtractor(JsonPathVariableExtractor jsonPathExtractor)
```
    Sets the jsonPath extractor.
    
    Parameters:
    
    jsonPathExtractor -
  - setHeaderExtractor
```
protected void setHeaderExtractor(MessageHeaderVariableExtractor headerExtractor)
```
    Sets the header extractor.
    
    Parameters:
    
    headerExtractor -
  - setScriptValidationContext
```
protected void setScriptValidationContext(ScriptValidationContext scriptValidationContext)
```
    Sets the script message validator.
    
    Parameters:
    
    scriptValidationContext -
  - setJsonPathValidationContext
```
protected void setJsonPathValidationContext(JsonPathMessageValidationContext jsonPathValidationContext)
```
    Sets the script message validator.
    
    Parameters:
    
    jsonPathValidationContext -
  - setXmlMessageValidationContext
```
protected void setXmlMessageValidationContext(XmlMessageValidationContext validationContext)
```
    Sets the XML validation context.
    
    Parameters:
    
    validationContext -
  - setJsonMessageValidationContext
```
protected void setJsonMessageValidationContext(JsonMessageValidationContext validationContext)
```
    Sets the JSON validation context.
    
    Parameters:
    
    validationContext -
  - setHeaderValidationContext
```
protected void setHeaderValidationContext(HeaderValidationContext validationContext)
```
    Sets the header validation context.
    
    Parameters:
    
    validationContext -

Class ReceiveMessageBuilder<A extends ReceiveMessageAction,T extends ReceiveMessageBuilder>

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ReceiveMessageBuilder

ReceiveMessageBuilder

ReceiveMessageBuilder

Method Detail

endpoint

endpoint

timeout

message

setPayload

name

payload

payload

payload

payload

payload

payloadModel

payload

header

headers

header

headerFragment

headerFragment

headerFragment

headerFragment

header

header

headerNameIgnoreCase

validateScript

validateScript

validateScript

validateScriptResource

validateScriptType

messageType

messageType

schemaValidation

validateNamespace

validate

ignore

xpath

jsonPath

xsd

jsonSchema

xsdSchemaRepository

jsonSchemaRepository

namespace

namespaces

selector

selector

validator

validator

headerValidator

headerValidator

dictionary

dictionary

extractFromHeader

extractFromPayload

validationCallback

withApplicationContext

getMessageContentBuilder

getAction

setMessageType

setMessageType

setXpathExtractor

setJsonPathExtractor

setHeaderExtractor

setScriptValidationContext

setJsonPathValidationContext

setXmlMessageValidationContext

setJsonMessageValidationContext

setHeaderValidationContext