Package com.consol.citrus.message.builder

Class ReceiveMessageBuilderSupport<T extends ReceiveMessageAction,​B extends ReceiveMessageAction.ReceiveMessageActionBuilder<T,​S,​B>,​S extends ReceiveMessageBuilderSupport<T,​B,​S>>

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface com.consol.citrus.TestActionBuilder

        com.consol.citrus.TestActionBuilder.DelegatingTestActionBuilder<T extends com.consol.citrus.TestAction>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected B delegate  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      S body​(com.consol.citrus.message.MessagePayloadBuilder payloadBuilder)
      Expect this message payload data in received message.
      S body​(com.consol.citrus.message.MessagePayloadBuilder.Builder<?,​?> payloadBuilder)
      Expect this message payload data in received message.
      S body​(String payload)
      Expect this message payload data in received message.
      S body​(org.springframework.core.io.Resource payloadResource)
      Expect this message payload data in received message.
      S body​(org.springframework.core.io.Resource payloadResource, Charset charset)
      Expect this message payload data in received message.
      T build()  
      S dictionary​(com.consol.citrus.variable.dictionary.DataDictionary<?> dictionary)
      Sets explicit data dictionary for this receive action.
      S dictionary​(String dictionaryName)
      Sets explicit data dictionary by name.
      S extract​(com.consol.citrus.variable.VariableExtractor extractor)
      Adds variable extractor on the received message.
      S extract​(com.consol.citrus.variable.VariableExtractor.Builder<?,​?> builder)
      Adds message processor on the received message as fluent builder.
      S extract​(com.consol.citrus.variable.VariableExtractorAdapter adapter)
      Adds message processor on the received message.
      S from​(com.consol.citrus.message.Message controlMessage)
      Build message from given message template.
      S from​(com.consol.citrus.message.MessageBuilder messageBuilder)
      Build message from given message builder.
      List<com.consol.citrus.message.MessageProcessor> getControlMessageProcessors()  
      com.consol.citrus.variable.dictionary.DataDictionary<?> getDataDictionary()  
      String getDataDictionaryName()  
      com.consol.citrus.message.MessageBuilder getMessageBuilder()  
      String getMessageType()  
      S header​(com.consol.citrus.message.MessageHeaderDataBuilder headerDataBuilder)
      Expect this message header data in received message.
      S header​(String data)
      Expect this message header data in received message.
      S header​(String name, Object value)
      Expect this message header entry in received message.
      S header​(org.springframework.core.io.Resource resource)
      Expect this message header data in received message from file resource.
      S header​(org.springframework.core.io.Resource resource, Charset charset)
      Expect this message header data in received message from file resource.
      S headerNameIgnoreCase​(boolean value)
      Validate header names with case insensitive keys.
      S headers​(Map<String,​Object> headers)
      Expect this message header entries in received message.
      boolean isHeaderNameIgnoreCase()  
      S name​(String name)
      Sets the message name.
      S process​(com.consol.citrus.message.MessageProcessor processor)
      Adds message processor on the control message.
      S process​(com.consol.citrus.message.MessageProcessor.Builder<?,​?> builder)
      Adds message processor on the control message as fluent builder.
      S process​(com.consol.citrus.message.MessageProcessorAdapter adapter)
      Adds message processor on the control message as fluent builder.
      S selector​(String messageSelector)
      Sets message selector string.
      S selector​(Map<String,​String> messageSelector)
      Sets message selector elements.
      void setReferenceResolver​(com.consol.citrus.spi.ReferenceResolver referenceResolver)  
      S timeout​(long receiveTimeout)
      Adds a custom timeout to this message receiving action.
      S type​(com.consol.citrus.message.MessageType messageType)
      Sets a explicit message type for this receive action.
      S type​(String messageType)
      Sets a explicit message type for this receive action.
      S validate​(com.consol.citrus.validation.context.ValidationContext validationContext)
      Adds a validation context.
      S validate​(com.consol.citrus.validation.context.ValidationContext.Builder<?,​?> validationContext)
      Adds a validation context.
      S validate​(com.consol.citrus.validation.context.ValidationContext.Builder<?,​?>... validationContexts)
      Sets validation contexts.
      S validate​(com.consol.citrus.validation.ValidationContextAdapter adapter)
      Adds a validation context.
      B validate​(com.consol.citrus.validation.ValidationProcessor processor)
      Adds validation processor to the receive action for validating the received message with Java code.
      S validate​(List<com.consol.citrus.validation.context.ValidationContext.Builder<?,​?>> validationContexts)
      Sets validation contexts.
      S validator​(com.consol.citrus.validation.HeaderValidator... validators)
      Sets explicit header validator for this receive action.
      S validator​(com.consol.citrus.validation.MessageValidator<? extends com.consol.citrus.validation.context.ValidationContext> validator)
      Sets explicit message validators for this receive action.
      S validator​(String... validatorNames)
      Sets explicit message validators by name.
      S validators​(com.consol.citrus.validation.MessageValidator<? extends com.consol.citrus.validation.context.ValidationContext>... validators)
      Sets explicit message validators for this receive action.
      S validators​(List<com.consol.citrus.validation.MessageValidator<? extends com.consol.citrus.validation.context.ValidationContext>> validators)
      Sets explicit message validators for this receive action.
      S withReferenceResolver​(com.consol.citrus.spi.ReferenceResolver referenceResolver)
      Sets the bean reference resolver.

    • Constructor Detail

      • ReceiveMessageBuilderSupport

        protected ReceiveMessageBuilderSupport​(B delegate)

    • Method Detail

      • timeout

        public S timeout​(long receiveTimeout)
        Adds a custom timeout to this message receiving action.
        Parameters:
        receiveTimeout -
        Returns:
        The modified receive message action builder

      • from

        public S from​(com.consol.citrus.message.MessageBuilder messageBuilder)
        Build message from given message builder.
        Parameters:
        messageBuilder -
        Returns:
        The modified receive message action builder

      • from

        public S from​(com.consol.citrus.message.Message controlMessage)
        Build message from given message template.
        Parameters:
        controlMessage -
        Returns:
        The modified receive message action builder

      • name

        public S name​(String name)
        Sets the message name.
        Parameters:
        name -
        Returns:
        The modified receive message action builder

      • body

        public S body​(com.consol.citrus.message.MessagePayloadBuilder.Builder<?,​?> payloadBuilder)
        Expect this message payload data in received message.
        Parameters:
        payloadBuilder -
        Returns:
        The modified receive message action builder

      • body

        public S body​(com.consol.citrus.message.MessagePayloadBuilder payloadBuilder)
        Expect this message payload data in received message.
        Parameters:
        payloadBuilder -
        Returns:
        The modified receive message action builder

      • body

        public S body​(String payload)
        Expect this message payload data in received message.
        Parameters:
        payload -
        Returns:
        The modified receive message action builder

      • body

        public S body​(org.springframework.core.io.Resource payloadResource)
        Expect this message payload data in received message.
        Parameters:
        payloadResource -
        Returns:
        The modified receive message action builder

      • body

        public S body​(org.springframework.core.io.Resource payloadResource,
              Charset charset)
        Expect this message payload data in received message.
        Parameters:
        payloadResource -
        charset -
        Returns:
        The modified receive message action builder

      • header

        public S header​(String name,
                Object value)
        Expect this message header entry in received message.
        Parameters:
        name -
        value -
        Returns:
        The modified receive message action builder

      • headers

        public S headers​(Map<String,​Object> headers)
        Expect this message header entries in received message.
        Parameters:
        headers -
        Returns:
        The modified receive message action builder

      • header

        public S 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:
        The modified receive message action builder

      • header

        public S header​(com.consol.citrus.message.MessageHeaderDataBuilder headerDataBuilder)
        Expect this message header data in received message. Message header data is used in SOAP messages as XML fragment for instance.
        Parameters:
        headerDataBuilder -
        Returns:
        The modified receive message action builder

      • header

        public S 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:
        The modified receive message action builder

      • header

        public S 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:
        The modified receive message action builder

      • headerNameIgnoreCase

        public S headerNameIgnoreCase​(boolean value)
        Validate header names with case insensitive keys.
        Parameters:
        value -
        Returns:
        The modified receive message action builder

      • type

        public S type​(com.consol.citrus.message.MessageType messageType)
        Sets a explicit message type for this receive action.
        Parameters:
        messageType -
        Returns:
        The modified receive message action builder

      • type

        public S type​(String messageType)
        Sets a explicit message type for this receive action.
        Parameters:
        messageType - the type of the message indicates the content type (e.g. Xml, Json, binary).
        Returns:
        The modified receive message action builder

      • validate

        public S validate​(com.consol.citrus.validation.context.ValidationContext.Builder<?,​?> validationContext)
        Adds a validation context.
        Parameters:
        validationContext -
        Returns:
        The modified receive message action builder

      • validate

        public S validate​(com.consol.citrus.validation.context.ValidationContext validationContext)
        Adds a validation context.
        Parameters:
        validationContext -
        Returns:
        The modified receive message action builder

      • validate

        public S validate​(com.consol.citrus.validation.ValidationContextAdapter adapter)
        Adds a validation context.
        Parameters:
        adapter -
        Returns:
        The modified receive message action builder

      • validate

        public S validate​(List<com.consol.citrus.validation.context.ValidationContext.Builder<?,​?>> validationContexts)
        Sets validation contexts.
        Parameters:
        validationContexts -
        Returns:
        The modified receive message action builder

      • validate

        public S validate​(com.consol.citrus.validation.context.ValidationContext.Builder<?,​?>... validationContexts)
        Sets validation contexts.
        Parameters:
        validationContexts -
        Returns:
        The modified receive message action builder

      • selector

        public S selector​(String messageSelector)
        Sets message selector string.
        Parameters:
        messageSelector -
        Returns:
        The modified receive message action builder

      • selector

        public S selector​(Map<String,​String> messageSelector)
        Sets message selector elements.
        Parameters:
        messageSelector -
        Returns:
        The modified receive message action builder

      • validator

        public S validator​(com.consol.citrus.validation.MessageValidator<? extends com.consol.citrus.validation.context.ValidationContext> validator)
        Sets explicit message validators for this receive action.
        Parameters:
        validator -
        Returns:
        The modified receive message action builder

      • validators

        @SafeVarargs
public final S validators​(com.consol.citrus.validation.MessageValidator<? extends com.consol.citrus.validation.context.ValidationContext>... validators)
        Sets explicit message validators for this receive action.
        Parameters:
        validators -
        Returns:
        The modified receive message action builder

      • validators

        public S validators​(List<com.consol.citrus.validation.MessageValidator<? extends com.consol.citrus.validation.context.ValidationContext>> validators)
        Sets explicit message validators for this receive action.
        Parameters:
        validators -
        Returns:
        The modified receive message action builder

      • validator

        public S validator​(String... validatorNames)
        Sets explicit message validators by name.
        Parameters:
        validatorNames -
        Returns:
        The modified receive message action builder

      • validator

        public S validator​(com.consol.citrus.validation.HeaderValidator... validators)
        Sets explicit header validator for this receive action.
        Parameters:
        validators -
        Returns:
        The modified receive message action builder

      • dictionary

        public S dictionary​(com.consol.citrus.variable.dictionary.DataDictionary<?> dictionary)
        Sets explicit data dictionary for this receive action.
        Parameters:
        dictionary -
        Returns:
        The modified receive message action builder

      • dictionary

        public S dictionary​(String dictionaryName)
        Sets explicit data dictionary by name.
        Parameters:
        dictionaryName -
        Returns:
        The modified receive message action builder

      • validate

        public B validate​(com.consol.citrus.validation.ValidationProcessor processor)
        Adds validation processor to the receive action for validating the received message with Java code.
        Parameters:
        processor -
        Returns:
        The modified receive message action builder

      • process

        public S process​(com.consol.citrus.message.MessageProcessor processor)
        Adds message processor on the control message.
        Parameters:
        processor -
        Returns:
        The modified receive message action builder

      • process

        public S process​(com.consol.citrus.message.MessageProcessor.Builder<?,​?> builder)
        Adds message processor on the control message as fluent builder.
        Parameters:
        builder -
        Returns:
        The modified receive message action builder

      • process

        public S process​(com.consol.citrus.message.MessageProcessorAdapter adapter)
        Adds message processor on the control message as fluent builder.
        Parameters:
        adapter -
        Returns:
        The modified receive message action builder

      • extract

        public S extract​(com.consol.citrus.variable.VariableExtractor extractor)
        Adds variable extractor on the received message.
        Parameters:
        extractor -
        Returns:

      • extract

        public S extract​(com.consol.citrus.variable.VariableExtractorAdapter adapter)
        Adds message processor on the received message.
        Parameters:
        adapter -
        Returns:

      • extract

        public S extract​(com.consol.citrus.variable.VariableExtractor.Builder<?,​?> builder)
        Adds message processor on the received message as fluent builder.
        Parameters:
        builder -
        Returns:

      • withReferenceResolver

        public S withReferenceResolver​(com.consol.citrus.spi.ReferenceResolver referenceResolver)
        Sets the bean reference resolver.
        Parameters:
        referenceResolver -
        Returns:
        The modified receive message action builder

      • build

        public T build()
        Specified by:
        build in interface com.consol.citrus.TestActionBuilder<T extends ReceiveMessageAction>

      • setReferenceResolver

        public void setReferenceResolver​(com.consol.citrus.spi.ReferenceResolver referenceResolver)
        Specified by:
        setReferenceResolver in interface com.consol.citrus.spi.ReferenceResolverAware

      • getDataDictionaryName

        public String getDataDictionaryName()

      • getDataDictionary

        public com.consol.citrus.variable.dictionary.DataDictionary<?> getDataDictionary()

      • getMessageBuilder

        public com.consol.citrus.message.MessageBuilder getMessageBuilder()

      • getControlMessageProcessors

        public List<com.consol.citrus.message.MessageProcessor> getControlMessageProcessors()

      • getMessageType

        public String getMessageType()

      • isHeaderNameIgnoreCase

        public boolean isHeaderNameIgnoreCase()