Package org.springframework.integration.annotation

Annotation Type InboundChannelAdapter

@Target({METHOD,ANNOTATION_TYPE})
@Retention(RUNTIME)
@Documented
public @interface InboundChannelAdapter
Indicates that a method is capable of producing a Message or Message payload.

A method annotated with @InboundChannelAdapter can't accept any parameters.

Return values from the annotated method may be of any type. If the return value is not a Message, a Message will be created with that object as its payload.

The result Message will be sent to the provided value().

@InboundChannelAdapter is an analogue of <int:inbound-channel-adapter/>. With that the PollerMetadata is required to initiate the method invocation. Or poller() should be provided, or the PollerMetadata.DEFAULT_POLLER bean has to be configured in the application context.

Since:
4.0

  • Optional Element Summary

    Optional Elements 
    Modifier and Type Optional Element Description
    java.lang.String autoStartup
    SmartLifecycle options.
    java.lang.String channel  
    java.lang.String phase
    Specify a SmartLifecycle phase option.
    Poller[] poller  
    java.lang.String value
    Alias for the channel() attribute.

  • Element Details

    • value

      @AliasFor("channel") java.lang.String value
      Alias for the channel() attribute.
      Returns:
      the 'channel' bean name to send the Message.
      Default:
      ""

    • channel

      @AliasFor("value") java.lang.String channel
      Returns:
      the 'channel' bean name to send the Message.
      Since:
      4.2.6
      Default:
      ""

    • autoStartup

      java.lang.String autoStartup
      SmartLifecycle options. Can be specified as 'property placeholder', e.g. ${foo.autoStartup}.
      Returns:
      if the channel adapter is started automatically or not.
      Default:
      "true"

    • phase

      java.lang.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). This attribute is an array just to allow an empty default (no poller). Only one Poller element is allowed. NOTE: a Poller here has Poller.maxMessagesPerPoll() set to 1 by default.
      Default:
      {}