Package org.citrusframework.actions

Interface MessageBuilderFactory<T extends TestAction,M extends MessageBuilderFactory<T,M>>

All Superinterfaces:
ReferenceResolverAwareBuilder<T,M>, TestActionBuilder<T>
All Known Subinterfaces:
HttpReceiveRequestMessageBuilderFactory<T,M>, HttpReceiveResponseMessageBuilderFactory<T,M>, HttpSendRequestMessageBuilderFactory<T,M>, HttpSendResponseMessageBuilderFactory<T,M>, ReceiveMessageBuilderFactory<T,M>, SendMessageBuilderFactory<T,M>, SoapClientReceiveMessageBuilderFactory<T,M>, SoapSendFaultMessageBuilderFactory<T,M>, SoapSendMessageBuilderFactory<T,M>
public interface MessageBuilderFactory<T extends TestAction,M extends MessageBuilderFactory<T,M>> extends TestActionBuilder<T>, ReferenceResolverAwareBuilder<T,M>

  • Method Details

    • from

      M from(MessageBuilder messageBuilder)
      Build message from given message builder.
      Parameters:
      messageBuilder -
      Returns:
      The modified message action builder

    • from

      M from(Message controlMessage)
      Build message from given message template.
      Parameters:
      controlMessage -
      Returns:
      The modified message action builder

    • type

      M type(MessageType messageType)
      Sets an explicit message type for this message.
      Parameters:
      messageType -
      Returns:
      The modified message action builder

    • type

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

    • body

      M body(MessagePayloadBuilder.Builder<?,?> payloadBuilder)
      Sets the payload data on the message builder implementation.
      Parameters:
      payloadBuilder -
      Returns:
      The modified message action builder

    • body

      M body(MessagePayloadBuilder payloadBuilder)
      Sets the payload data on the message builder implementation.
      Parameters:
      payloadBuilder -
      Returns:
      The modified message action builder

    • body

      M body(String payload)
      Adds message payload data to this builder.
      Parameters:
      payload -
      Returns:
      The modified message action builder

    • body

      M body(Resource payloadResource)
      Adds message payload resource to this builder.
      Parameters:
      payloadResource -
      Returns:
      The modified message action builder

    • body

      M body(Resource payloadResource, Charset charset)
      Adds message payload resource to this builder.
      Parameters:
      payloadResource -
      charset -
      Returns:
      The modified message action builder

    • header

      M header(String name, Object value)
      Adds message header name value pair to this builder's message.
      Parameters:
      name -
      value -
      Returns:
      The modified message action builder

    • headers

      M headers(Map<String,Object> headers)
      Adds message headers to this builder's message.
      Parameters:
      headers -
      Returns:
      The modified message action builder

    • header

      M header(String data)
      Adds message header data to this builder's message. Message header data is used in SOAP messages for instance as header XML fragment.
      Parameters:
      data -
      Returns:
      The modified message action builder

    • header

      M header(MessageHeaderDataBuilder headerDataBuilder)
      Adds message header data builder to this builder's message. Message header data is used in SOAP messages as XML fragment for instance.
      Parameters:
      headerDataBuilder -
      Returns:
      The modified message action builder

    • header

      M header(Resource resource)
      Adds message header data as file resource to this builder's message. Message header data is used in SOAP messages for instance as header XML fragment.
      Parameters:
      resource -
      Returns:
      The modified message action builder

    • header

      M header(Resource resource, Charset charset)
      Adds message header data as file resource to this builder's message. Message header data is used in SOAP messages for instance as header XML fragment.
      Parameters:
      resource -
      charset -
      Returns:
      The modified message action builder

    • name

      M name(String name)
      Sets the message name.
      Parameters:
      name -
      Returns:
      The modified message action builder

    • process

      M process(MessageProcessor processor)
      Adds message processor on the message.
      Parameters:
      processor -
      Returns:
      The modified message action builder

    • process

      M process(MessageProcessor.Builder<?,?> builder)
      Adds message processor on the message as fluent builder.
      Parameters:
      builder -
      Returns:
      The modified message action builder

    • process

      M process(MessageProcessorAdapter adapter)
      Adds message processor on the message as fluent builder.
      Parameters:
      adapter -
      Returns:
      The modified message action builder

    • extract

      M extract(VariableExtractor extractor)
      Adds variable extractor on the message.

    • extract

      M extract(VariableExtractorAdapter adapter)
      Adds message processor on the message.

    • extract

      M extract(VariableExtractor.Builder<?,?> builder)
      Adds message processor on the message as fluent builder.

    • dictionary

      M dictionary(DataDictionary<?> dictionary)
      Sets explicit data dictionary for this action.
      Parameters:
      dictionary -
      Returns:
      The modified message action builder

    • dictionary

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