org.springframework.integration.annotation

Annotation Type InboundChannelAdapter

@Target(value={METHOD,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Inherited
 @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 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

Author:

Artem Bilan, Gary Russell

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	autoStartup
String	phase
Poller[]	poller

Element Detail

value

public abstract String value

Returns:

the 'channel' bean name to send the Message.

autoStartup

public abstract String autoStartup

Default:

"true"

phase

public abstract String phase

Default:

"0"

poller

public abstract 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:

{}