Package org.citrusframework.actions

Class ReceiveMessageAction.ReceiveMessageActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>

java.lang.Object

org.citrusframework.AbstractTestActionBuilder<T,B>

org.citrusframework.message.builder.MessageBuilderSupport.MessageActionBuilder<T,M,B>

org.citrusframework.actions.ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>

All Implemented Interfaces:

org.citrusframework.actions.ActionBuilder<T,B>, org.citrusframework.actions.MessageActionBuilder, org.citrusframework.actions.ReceiveActionBuilder<T,M,B>, org.citrusframework.spi.ReferenceResolverAware, org.citrusframework.TestActionBuilder<T>

Direct Known Subclasses:

ReceiveMessageAction.Builder

Enclosing class:

ReceiveMessageAction

public abstract static class ReceiveMessageAction.ReceiveMessageActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>
extends MessageBuilderSupport.MessageActionBuilder<T,M,B>
implements org.citrusframework.actions.ReceiveActionBuilder<T,M,B>

Nested Class Summary

Nested classes/interfaces inherited from interface org.citrusframework.actions.ReceiveActionBuilder

org.citrusframework.actions.ReceiveActionBuilder.BuilderFactory

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

org.citrusframework.TestActionBuilder.DelegatingTestActionBuilder<T extends org.citrusframework.TestAction>

Field Summary

Fields inherited from class org.citrusframework.message.builder.MessageBuilderSupport.MessageActionBuilder

endpoint, endpointUri, messageBuilderSupport, messageProcessors, referenceResolver, variableExtractors

Fields inherited from class org.citrusframework.AbstractTestActionBuilder

self

Fields inherited from interface org.citrusframework.TestActionBuilder

logger, RESOURCE_PATH, TYPE_RESOLVER

Constructor Summary

Constructors

Constructor	Description
ReceiveMessageActionBuilder()

Method Summary

Modifier and Type	Method	Description
final T	build()
org.citrusframework.validation.context.HeaderValidationContext.Builder	getHeaderValidationContext()	Creates new header validation context if not done before and gets the header validation context.
protected Optional<String>	getMessagePayload()	Gets message payload String representation from configured message builder.
protected Optional<String>	getMessageResource()	Gets message resource file path from configured message builder.
List<org.citrusframework.validation.context.ValidationContext.Builder<?,?>>	getValidationContextBuilders()
List<org.citrusframework.validation.context.ValidationContext>	getValidationContexts()
B	process(org.citrusframework.message.MessageProcessor processor)	Adds message processor on the message.
protected void	reconcileValidationContexts()	Revisit configured validation context list and automatically add context based on message payload and path expression contexts if any.
B	selector(String messageSelector)
B	selector(Map<String,String> messageSelector)
B	timeout(long receiveTimeout)
B	validate(List<org.citrusframework.validation.context.ValidationContext.Builder<?,?>> validationContexts)
B	validate(org.citrusframework.validation.context.ValidationContext validationContext)
B	validate(org.citrusframework.validation.context.ValidationContext.Builder<?,?> validationContext)
B	validate(org.citrusframework.validation.context.ValidationContext.Builder<?,?>... validationContexts)
B	validate(org.citrusframework.validation.ValidationContextAdapter adapter)
B	validate(org.citrusframework.validation.ValidationProcessor processor)
B	validator(String validatorName)
B	validator(org.citrusframework.validation.HeaderValidator validators)
B	validator(org.citrusframework.validation.MessageValidator<? extends org.citrusframework.validation.context.ValidationContext> validator)
final B	validators(String... validators)
B	validators(List<org.citrusframework.validation.MessageValidator<? extends org.citrusframework.validation.context.ValidationContext>> validators)
final B	validators(org.citrusframework.validation.HeaderValidator... validators)
final B	validators(org.citrusframework.validation.MessageValidator<? extends org.citrusframework.validation.context.ValidationContext>... validators)

Methods inherited from class org.citrusframework.message.builder.MessageBuilderSupport.MessageActionBuilder

doBuild, endpoint, endpoint, extract, getEndpoint, getEndpointUri, getMessageBuilderSupport, getMessageProcessors, getVariableExtractors, message, message, message, process, process, setReferenceResolver, transform, transform, transform, withReferenceResolver

Methods inherited from class org.citrusframework.AbstractTestActionBuilder

actor, description, getActor, getDescription, getName, name

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.citrusframework.actions.ActionBuilder

actor, description, name

Methods inherited from interface org.citrusframework.actions.ReceiveActionBuilder

endpoint, endpoint, extract, message, message, message, process, process, transform, transform, transform

Constructor Details

ReceiveMessageActionBuilder

public ReceiveMessageActionBuilder()

Method Details

timeout

public B timeout(long receiveTimeout)

Specified by:

timeout in interface org.citrusframework.actions.ReceiveActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>

validate

public B validate(org.citrusframework.validation.context.ValidationContext.Builder<?,?> validationContext)

Specified by:

validate in interface org.citrusframework.actions.ReceiveActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>

validate

public B validate(org.citrusframework.validation.context.ValidationContext validationContext)

Specified by:

validate in interface org.citrusframework.actions.ReceiveActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>

validate

public B validate(org.citrusframework.validation.ValidationContextAdapter adapter)

Specified by:

validate in interface org.citrusframework.actions.ReceiveActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>

validate

public B validate(List<org.citrusframework.validation.context.ValidationContext.Builder<?,?>> validationContexts)

Specified by:

validate in interface org.citrusframework.actions.ReceiveActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>

validate

public B validate(org.citrusframework.validation.context.ValidationContext.Builder<?,?>... validationContexts)

Specified by:

validate in interface org.citrusframework.actions.ReceiveActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>

selector

public B selector(String messageSelector)

Specified by:

selector in interface org.citrusframework.actions.ReceiveActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>

selector

public B selector(Map<String,String> messageSelector)

Specified by:

selector in interface org.citrusframework.actions.ReceiveActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>

validator

public B validator(org.citrusframework.validation.MessageValidator<? extends org.citrusframework.validation.context.ValidationContext> validator)

Specified by:

validator in interface org.citrusframework.actions.ReceiveActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>

validators

public final B validators(String... validators)

Specified by:

validators in interface org.citrusframework.actions.ReceiveActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>

validators

@SafeVarargs
public final B validators(org.citrusframework.validation.MessageValidator<? extends org.citrusframework.validation.context.ValidationContext>... validators)

Specified by:

validators in interface org.citrusframework.actions.ReceiveActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>

validators

public B validators(List<org.citrusframework.validation.MessageValidator<? extends org.citrusframework.validation.context.ValidationContext>> validators)

Specified by:

validators in interface org.citrusframework.actions.ReceiveActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>

validators

public final B validators(org.citrusframework.validation.HeaderValidator... validators)

Specified by:

validators in interface org.citrusframework.actions.ReceiveActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>

validator

public B validator(String validatorName)

Specified by:

validator in interface org.citrusframework.actions.ReceiveActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>

validator

public B validator(org.citrusframework.validation.HeaderValidator validators)

Specified by:

validator in interface org.citrusframework.actions.ReceiveActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>

validate

public B validate(org.citrusframework.validation.ValidationProcessor processor)

Specified by:

validate in interface org.citrusframework.actions.ReceiveActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>

process

public B process(org.citrusframework.message.MessageProcessor processor)

Description copied from class: MessageBuilderSupport.MessageActionBuilder

Adds message processor on the message.

Specified by:

process in interface org.citrusframework.actions.ReceiveActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>

Overrides:

process in class MessageBuilderSupport.MessageActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>

build

public final T build()

Specified by:

build in interface org.citrusframework.TestActionBuilder<T extends ReceiveMessageAction>

getHeaderValidationContext

public org.citrusframework.validation.context.HeaderValidationContext.Builder getHeaderValidationContext()

Creates new header validation context if not done before and gets the header validation context.

reconcileValidationContexts

protected void reconcileValidationContexts()

Revisit configured validation context list and automatically add context based on message payload and path expression contexts if any.

This method makes sure that validation contexts are configured. If no validation context has been set yet the method automatically adds proper validation contexts for Json and XML message payloads.

In case a path expression (JsonPath, XPath) context is set but no proper message validation context (Json, Xml) the method automatically adds the proper message validation context.

Only when validation contexts are set properly according to the message type and content the message validation steps will execute later on.

getMessagePayload

protected Optional<String> getMessagePayload()

Gets message payload String representation from configured message builder.

getMessageResource

protected Optional<String> getMessageResource()

Gets message resource file path from configured message builder.

getValidationContexts

public List<org.citrusframework.validation.context.ValidationContext> getValidationContexts()

getValidationContextBuilders

public List<org.citrusframework.validation.context.ValidationContext.Builder<?,?>> getValidationContextBuilders()