org.springframework.integration.dsl

Class ScatterGatherSpec

java.lang.Object

org.springframework.integration.dsl.core.IntegrationComponentSpec<S,Tuple2<F,H>>

org.springframework.integration.dsl.core.EndpointSpec<S,org.springframework.integration.config.ConsumerEndpointFactoryBean,H>

org.springframework.integration.dsl.core.ConsumerEndpointSpec<ScatterGatherSpec,org.springframework.integration.scattergather.ScatterGatherHandler>

org.springframework.integration.dsl.ScatterGatherSpec

All Implemented Interfaces:

org.springframework.beans.factory.FactoryBean<Tuple2<org.springframework.integration.config.ConsumerEndpointFactoryBean,org.springframework.integration.scattergather.ScatterGatherHandler>>, ComponentsRegistration

public class ScatterGatherSpec
extends ConsumerEndpointSpec<ScatterGatherSpec,org.springframework.integration.scattergather.ScatterGatherHandler>

A GenericEndpointSpec extension for the ScatterGatherHandler.

Since:

1.2

Author:

Artem Bilan

See Also:

ScatterGatherHandler

Field Summary

Fields inherited from class org.springframework.integration.dsl.core.ConsumerEndpointSpec

adviceChain

Fields inherited from class org.springframework.integration.dsl.core.EndpointSpec

componentToRegister, endpointFactoryBean, handler

Fields inherited from class org.springframework.integration.dsl.core.IntegrationComponentSpec

logger, PARSER, target

Method Summary

Modifier and Type	Method and Description
ScatterGatherSpec	gatherChannel(org.springframework.messaging.MessageChannel gatherChannel) Specify a MessageChannel (optional) which is used internally in the ScatterGatherHandler for gathering (aggregate) results for scattered requests.
ScatterGatherSpec	gatherTimeout(long gatherTimeout) Specify a timeout (in milliseconds) for the PollableChannel.receive(long) operation to wait for gathering results to output.

Methods inherited from class org.springframework.integration.dsl.core.ConsumerEndpointSpec

advice, async, autoStartup, order, phase, poller, requiresReply, sendTimeout, transactional, transactional, transactional, transactional, transactional

Methods inherited from class org.springframework.integration.dsl.core.EndpointSpec

assertHandler, doGet, getComponentsToRegister, id, poller, poller

Methods inherited from class org.springframework.integration.dsl.core.IntegrationComponentSpec

_this, get, getId, getObject, getObjectType, isSingleton

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

gatherChannel

public ScatterGatherSpec gatherChannel(org.springframework.messaging.MessageChannel gatherChannel)

Specify a MessageChannel (optional) which is used internally in the ScatterGatherHandler for gathering (aggregate) results for scattered requests.

Parameters:

gatherChannel - the MessageChannel for gathering results.

Returns:

the current ScatterGatherSpec instance.

gatherTimeout

public ScatterGatherSpec gatherTimeout(long gatherTimeout)

Specify a timeout (in milliseconds) for the PollableChannel.receive(long) operation to wait for gathering results to output. Defaults to -1 - to wait indefinitely.

Parameters:

gatherTimeout - the PollableChannel receive timeout.

Returns:

the current ScatterGatherSpec instance.