Package org.springframework.integration.dsl

Class ScatterGatherSpec

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<T>

org.springframework.integration.dsl.IntegrationComponentSpec<S,reactor.util.function.Tuple2<F,H>>

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

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

org.springframework.integration.dsl.ScatterGatherSpec

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<reactor.util.function.Tuple2<ConsumerEndpointFactoryBean,ScatterGatherHandler>>, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, ComponentsRegistration

public class ScatterGatherSpec
extends ConsumerEndpointSpec<ScatterGatherSpec,ScatterGatherHandler>

A GenericEndpointSpec extension for the ScatterGatherHandler.

Since:

5.0

See Also:

ScatterGatherHandler

Field Summary

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

adviceChain

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

componentsToRegister, endpointFactoryBean, handler

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

PARSER, target

Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

logger

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ScatterGatherSpec(ScatterGatherHandler messageHandler)

Method Summary

Modifier and Type	Method	Description
ScatterGatherSpec	errorChannel(java.lang.String errorChannel)	Specify a MessageChannel bean name for async error processing.
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.ConsumerEndpointSpec

advice, async, autoStartup, customizeMonoReply, doGet, handleMessageAdvice, notPropagatedHeaders, order, phase, poller, reactive, reactive, requiresReply, role, sendTimeout, taskScheduler, transactional, transactional, transactional, transactional, transactional

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

assertHandler, getComponentsToRegister, id, obtainInputChannelFromFlow, obtainInputChannelFromFlow, poller, poller

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

_this, createInstance, destroyInstance, get, getId, getObjectType, getPhase, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class java.lang.Object

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

Constructor Details

ScatterGatherSpec

protected ScatterGatherSpec(ScatterGatherHandler messageHandler)

Method Details

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.

errorChannel

public ScatterGatherSpec errorChannel(java.lang.String errorChannel)

Specify a MessageChannel bean name for async error processing. Defaults to IntegrationContextUtils.ERROR_CHANNEL_BEAN_NAME.

Parameters:

errorChannel - the MessageChannel bean name for async error processing.

Returns:

the current ScatterGatherSpec instance.

Since:

5.1.3