org.springframework.integration.annotation

Annotation Type BridgeTo

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

Messaging Annotation to mark a Bean method for a MessageChannel to produce a BridgeHandler and Consumer Endpoint.

The MessageChannel Bean marked with this annotation is used as the inputChannel for the AbstractEndpoint and determines the type of endpoint - EventDrivenConsumer or PollingConsumer.

The value() of this annotation is the outputChannel for the BridgeHandler. If it isn't present, the BridgeHandler sends the message to the reply-channel in its message headers, if present. If no output channel is provided and no reply-channel exists, an exception is thrown.

Since:

4.0

Author:

Artem Bilan

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	autoStartup
String	phase Specify a SmartLifecycle phase option.
Poller[]	poller
String	value

Element Detail

value

public abstract String value

Returns:

the outbound channel name to send the message to BridgeHandler. Optional: when omitted the message is sent to the reply-channel in its headers (if present - an exception is thrown otherwise).

Default:

""

autoStartup

public abstract String autoStartup

Default:

"true"

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:

""

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:

{}