org.springframework.integration.annotation

Annotation Type ServiceActivator

@Target(value={METHOD,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Documented
public @interface ServiceActivator

Indicates that a method is capable of handling a message or message payload.

A method annotated with @ServiceActivator may accept a parameter of type Message or of the expected Message payload's type. Any type conversion supported by SimpleTypeConverter will be applied to the Message payload if necessary. Header values can also be passed as Message parameters by using the @Header parameter annotation.

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

Author:

Mark Fisher, Gary Russell, Artem Bilan, Yilin Wei

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	adviceChain Specify a "chain" of Advice beans that will "wrap" the message handler.
String	async Specify whether the service method is async.
String	autoStartup The SmartLifecycle autoStartup option.
String	inputChannel Specify the channel from which this service activator will consume messages.
String	outputChannel Specify the channel to which this service activator will send any replies.
String	phase Specify a SmartLifecycle phase option.
Poller[]	poller
String	requiresReply Specify whether the service method must return a non-null value.
String	sendTimeout Specify the maximum amount of time in milliseconds to wait when sending a reply Message to the outputChannel.

Element Detail

inputChannel

public abstract String inputChannel

Specify the channel from which this service activator 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

public abstract String outputChannel

Specify the channel to which this service activator will send any replies.

Returns:

The channel name.

Default:

""

requiresReply

public abstract String requiresReply

Specify whether the service method must return a non-null value. This value is false by default, but if set to true, a ReplyRequiredException will is thrown when the underlying service method (or expression) returns a null value. Can be specified as 'property placeholder', e.g. ${spring.integration.requiresReply}.

Returns:

the requires reply flag.

Default:

""

adviceChain

public abstract String[] adviceChain

Specify a "chain" of Advice beans that will "wrap" the message handler. Only the handler is advised, not the downstream flow.

Returns:

the advice chain.

Default:

{}

sendTimeout

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

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

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

""

async

public abstract String async

Specify whether the service method is async. This value is false by default.

Returns:

the async flag.

Default:

""

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.

Default:

{}