org.springframework.integration.annotation

Annotation Type Aggregator

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

Indicates that a method is capable of aggregating messages.

A method annotated with @Aggregator may accept a collection of Messages or Message payloads and should return a single Message or a single Object to be used as a Message payload.

Author:

Marius Bogoevici, Oleg Zhurakousky, Artem Bilan

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	autoStartup
String	discardChannel
String	inputChannel
String	outputChannel
String	phase
Poller[]	poller
boolean	sendPartialResultsOnExpiry
long	sendTimeout

Element Detail

inputChannel

public abstract String inputChannel

Returns:

The channel name for receiving messages to be aggregated

Default:

""

outputChannel

public abstract String outputChannel

Returns:

The channel name for sending aggregated result messages

Default:

""

discardChannel

public abstract String discardChannel

Returns:

The channel name for sending discarded messages (due to a timeout)

Default:

""

sendTimeout

public abstract long sendTimeout

Returns:

The timeout for sending results to the reply target (in milliseconds)

Default:

1000L

sendPartialResultsOnExpiry

public abstract boolean sendPartialResultsOnExpiry

Returns:

Indicates whether to send an incomplete aggregate on expiry of the message group

Default:

false

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.

Default:

{}