Package org.springframework.integration.annotation

Annotation Interface Transformer

@Target({METHOD,ANNOTATION_TYPE}) @Retention(RUNTIME) @Documented @Repeatable(Transformers.class) public @interface Transformer
Indicates that a method is capable of transforming a message, message header, or message payload.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    adviceChain
    Specify a "chain" of Advice objects that will "wrap" the message handler.
    String
    autoStartup
    The SmartLifecycle autoStartup option.
    String
    inputChannel
    Specify the channel from which this transformer will consume messages.
    String
    outputChannel
    Specify the channel to which this transformer will send the transformed message.
    String
    phase
    Specify a SmartLifecycle phase option.
    Poller
    poller
     
    Reactive
    reactive
     
    String
    sendTimeout
    Specify the maximum amount of time in milliseconds to wait when sending a reply Message to the outputChannel.

  • Element Details

    • inputChannel

      String inputChannel
      Specify the channel from which this transformer will consume messages. If the channel does not exist, a DirectChannel with this name will be registered in the application context.
      Returns:
      The channel name.
      Default:
      ""

    • outputChannel

      String outputChannel
      Specify the channel to which this transformer will send the transformed message.
      Returns:
      The channel name.
      Default:
      ""

    • adviceChain

      String[] adviceChain
      Specify a "chain" of Advice objects that will "wrap" the message handler. Only the handler is advised, not the downstream flow.
      Returns:
      the advice chain.
      Default:
      {}

    • sendTimeout

      String sendTimeout
      Specify the maximum amount of time in milliseconds to wait when sending a reply Message to the outputChannel. Defaults to -1 - blocking indefinitely. It is applied only if the output channel has some 'sending' limitations, e.g. QueueChannel with fixed a 'capacity'. In this case a MessageDeliveryException is thrown. The 'sendTimeout' is ignored in case of AbstractSubscribableChannel implementations. Can be specified as 'property placeholder', e.g. ${spring.integration.sendTimeout}.
      Returns:
      The timeout for sending results to the reply target (in milliseconds)
      Default:
      ""

    • autoStartup

      String autoStartup
      The SmartLifecycle autoStartup option. Can be specified as 'property placeholder', e.g. ${foo.autoStartup}. Defaults to true.
      Returns:
      the auto startup boolean flag.
      Default:
      ""

    • phase

      String phase
      Specify a SmartLifecycle phase option. Defaults Integer.MAX_VALUE / 2 for PollingConsumer and Integer.MIN_VALUE for EventDrivenConsumer. Can be specified as 'property placeholder', e.g. ${foo.phase}.
      Returns:
      the SmartLifecycle phase.
      Default:
      ""

    • poller

      Poller poller
      Returns:
      the Poller options for a polled endpoint (PollerMetadata). Mutually exclusive with reactive().
      Default:
      @org.springframework.integration.annotation.Poller("\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n")

    • reactive

      Reactive reactive
      Returns:
      the Reactive marker for a consumer endpoint. Mutually exclusive with poller().
      Since:
      5.5
      Default:
      @org.springframework.integration.annotation.Reactive("\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n")