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:
ReferenceResolverAware, 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>

  • Constructor Details

    • ReceiveMessageActionBuilder

      public ReceiveMessageActionBuilder()

  • Method Details

    • timeout

      public B timeout(long receiveTimeout)
      Adds a custom timeout to this message receiving action.
      Parameters:
      receiveTimeout -
      Returns:

    • validate

      public B validate(ValidationContext.Builder<?,?> validationContext)
      Adds a validation context.
      Parameters:
      validationContext -
      Returns:

    • validate

      public B validate(ValidationContext validationContext)
      Adds a validation context.
      Parameters:
      validationContext -
      Returns:

    • validate

      public B validate(ValidationContextAdapter adapter)
      Adds an expression based validation context.
      Parameters:
      adapter -
      Returns:

    • validate

      public B validate(List<ValidationContext.Builder<?,?>> validationContexts)
      Sets validation contexts.
      Parameters:
      validationContexts -
      Returns:

    • validate

      public B validate(ValidationContext.Builder<?,?>... validationContexts)
      Sets validation contexts.
      Parameters:
      validationContexts -
      Returns:

    • selector

      public B selector(String messageSelector)
      Sets message selector string.
      Parameters:
      messageSelector -
      Returns:

    • selector

      public B selector(Map<String,String> messageSelector)
      Sets message selector elements.
      Parameters:
      messageSelector -
      Returns:

    • validator

      public B validator(MessageValidator<? extends ValidationContext> validator)
      Sets explicit message validators for this receive action.
      Parameters:
      validator -
      Returns:

    • validators

      public final B validators(String... validators)
      Sets explicit message validators for this receive action.
      Parameters:
      validators -
      Returns:

    • validators

      @SafeVarargs public final B validators(MessageValidator<? extends ValidationContext>... validators)
      Sets explicit message validators for this receive action.
      Parameters:
      validators -
      Returns:

    • validators

      public B validators(List<MessageValidator<? extends ValidationContext>> validators)
      Sets explicit message validators for this receive action.
      Parameters:
      validators -
      Returns:

    • validators

      public final B validators(HeaderValidator... validators)
      Sets explicit message validators for this receive action.
      Parameters:
      validators -
      Returns:

    • validator

      public B validator(String validatorName)
      Sets explicit message validator by name.
      Parameters:
      validatorName -
      Returns:

    • validator

      public B validator(HeaderValidator validators)
      Sets explicit header validator for this receive action.
      Parameters:
      validators -
      Returns:

    • validate

      public B validate(ValidationProcessor processor)
      Adds validation processor to the receive action for validating the received message with Java code.
      Parameters:
      processor -
      Returns:

    • process

      public B process(MessageProcessor processor)
      Description copied from class: MessageBuilderSupport.MessageActionBuilder
      Adds message processor on the message.
      Overrides:
      process in class MessageBuilderSupport.MessageActionBuilder<T extends ReceiveMessageAction,M extends ReceiveMessageBuilderSupport<T,B,M>,B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,M,B>>
      Returns:

    • build

      public final T build()

    • getHeaderValidationContext

      public HeaderValidationContext 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.
      Returns:

    • getValidationContexts

      public List<ValidationContext> getValidationContexts()
      Obtains the validationContexts.
      Returns:

    • getValidationContextBuilders

      public List<ValidationContext.Builder<?,?>> getValidationContextBuilders()
      Obtains the validationContext builders.
      Returns: