Package org.springframework.integration.channel

Class AbstractExecutorChannel

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.channel.AbstractMessageChannel

org.springframework.integration.channel.AbstractSubscribableChannel

org.springframework.integration.channel.AbstractExecutorChannel

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, ExecutorChannelInterceptorAware, ExpressionCapable, IntegrationPattern, NamedComponent, IntegrationManagement, SubscribableChannelManagement, TrackableComponent, MessageChannel, SubscribableChannel, InterceptableChannel

Direct Known Subclasses:

ExecutorChannel, PublishSubscribeChannel

public abstract class AbstractExecutorChannel
extends AbstractSubscribableChannel
implements ExecutorChannelInterceptorAware

The AbstractSubscribableChannel base implementation for those inheritors which logic may be based on the Executor.

Utilizes common operations for the AbstractDispatcher.

Implements the ExecutorChannelInterceptors logic when the message handling is handed to the Executor.execute(Runnable).

Since:

4.2

Author:

Artem Bilan, Gary Russell

See Also:

• ExecutorChannel
• PublishSubscribeChannel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractExecutorChannel.MessageHandlingTask

Nested classes/interfaces inherited from class org.springframework.integration.channel.AbstractMessageChannel

AbstractMessageChannel.ChannelInterceptorList

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractDispatcher	dispatcher
protected Executor	executor
protected int	executorInterceptorsSize
protected Integer	maxSubscribers

Fields inherited from class org.springframework.integration.channel.AbstractMessageChannel

interceptors, meters

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface org.springframework.messaging.MessageChannel

INDEFINITE_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
AbstractExecutorChannel(Executor executor)

Method Summary

Modifier and Type	Method	Description
void	addInterceptor(int index, ChannelInterceptor interceptor)	Add a channel interceptor to the specified index of the list.
void	addInterceptor(ChannelInterceptor interceptor)	Add a channel interceptor to the end of the list.
IntegrationPatternType	getIntegrationPatternType()	Return a pattern type this component implements.
boolean	hasExecutorInterceptors()
ChannelInterceptor	removeInterceptor(int index)
boolean	removeInterceptor(ChannelInterceptor interceptor)
void	setInterceptors(List<ChannelInterceptor> interceptors)	Set the list of channel interceptors.
void	setMaxSubscribers(int maxSubscribers)	Specify the maximum number of subscribers supported by the channel's dispatcher.

Methods inherited from class org.springframework.integration.channel.AbstractSubscribableChannel

doSend, getDispatcher, getSubscriberCount, subscribe, unsubscribe

Methods inherited from class org.springframework.integration.channel.AbstractMessageChannel

destroy, getComponentType, getFullChannelName, getIChannelInterceptorList, getInterceptors, getMetricsCaptor, getOverrides, isLoggingEnabled, isObserved, onInit, registerMetricsCaptor, registerObservationRegistry, send, send, setDatatypes, setLoggingEnabled, setMessageConverter, setObservationConvention, setShouldTrack

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.integration.support.management.IntegrationManagement

getManagedName, getManagedType, getThisAs, setManagedName, setManagedType

Methods inherited from interface org.springframework.messaging.support.InterceptableChannel

getInterceptors

Methods inherited from interface org.springframework.messaging.MessageChannel

send, send

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getBeanName, getComponentName

Field Details

executor

protected Executor executor

dispatcher

protected AbstractDispatcher dispatcher

maxSubscribers

protected Integer maxSubscribers

executorInterceptorsSize

protected int executorInterceptorsSize

Constructor Details

AbstractExecutorChannel

public AbstractExecutorChannel(@Nullable
 Executor executor)

Method Details

setMaxSubscribers

public void setMaxSubscribers(int maxSubscribers)

Specify the maximum number of subscribers supported by the channel's dispatcher.

Parameters:

maxSubscribers - The maximum number of subscribers allowed.

setInterceptors

public void setInterceptors(List<ChannelInterceptor> interceptors)

Description copied from class: AbstractMessageChannel

Set the list of channel interceptors. This will clear any existing interceptors.

Specified by:

setInterceptors in interface InterceptableChannel

Overrides:

setInterceptors in class AbstractMessageChannel

Parameters:

interceptors - The list of interceptors.

addInterceptor

public void addInterceptor(ChannelInterceptor interceptor)

Description copied from class: AbstractMessageChannel

Add a channel interceptor to the end of the list.

Specified by:

addInterceptor in interface InterceptableChannel

Overrides:

addInterceptor in class AbstractMessageChannel

Parameters:

interceptor - The interceptor.

addInterceptor

public void addInterceptor(int index,
 ChannelInterceptor interceptor)

Description copied from class: AbstractMessageChannel

Add a channel interceptor to the specified index of the list.

Specified by:

addInterceptor in interface InterceptableChannel

Overrides:

addInterceptor in class AbstractMessageChannel

Parameters:

index - The index to add interceptor.

interceptor - The interceptor.

removeInterceptor

public boolean removeInterceptor(ChannelInterceptor interceptor)

Specified by:

removeInterceptor in interface InterceptableChannel

Overrides:

removeInterceptor in class AbstractMessageChannel

removeInterceptor

@Nullable
public ChannelInterceptor removeInterceptor(int index)

Specified by:

removeInterceptor in interface InterceptableChannel

Overrides:

removeInterceptor in class AbstractMessageChannel

hasExecutorInterceptors

public boolean hasExecutorInterceptors()

Specified by:

hasExecutorInterceptors in interface ExecutorChannelInterceptorAware

getIntegrationPatternType

public IntegrationPatternType getIntegrationPatternType()

Description copied from interface: IntegrationPattern

Return a pattern type this component implements.

Specified by:

getIntegrationPatternType in interface IntegrationPattern

Overrides:

getIntegrationPatternType in class AbstractMessageChannel

Returns:

the IntegrationPatternType this component implements.