org.springframework.integration.annotation

Annotation Type Aggregator

@Target(value=METHOD)
@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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	discardChannel channel name for sending discarded messages (due to a timeout)
java.lang.String	inputChannel channel name for receiving messages to be aggregated
java.lang.String	outputChannel channel name for sending aggregated result messages
boolean	sendPartialResultsOnExpiry indicates whether to send an incomplete aggregate on expiry of the message group
long	sendTimeout timeout for sending results to the reply target (in milliseconds)

Element Detail

inputChannel

public abstract java.lang.String inputChannel

channel name for receiving messages to be aggregated

Default:

""

outputChannel

public abstract java.lang.String outputChannel

channel name for sending aggregated result messages

Default:

""

discardChannel

public abstract java.lang.String discardChannel

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

Default:

""

sendTimeout

public abstract long sendTimeout

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

Default:

1000L

sendPartialResultsOnExpiry

public abstract boolean sendPartialResultsOnExpiry

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

Default:

false