org.springframework.integration.channel

Class AbstractPollableChannel

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.channel.AbstractMessageChannel

org.springframework.integration.channel.AbstractPollableChannel

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, ExecutorChannelInterceptorAware, ExpressionCapable, IntegrationPattern, NamedComponent, BaseChannelMetrics, ConfigurableMetricsAware<AbstractMessageChannelMetrics>, IntegrationManagement, IntegrationStatsManagement, MessageChannelMetrics, PollableChannelManagement, PollableChannelMetrics, TrackableComponent, MessageChannel, PollableChannel, InterceptableChannel

Direct Known Subclasses:

QueueChannel

public abstract class AbstractPollableChannel
extends AbstractMessageChannel
implements PollableChannel, PollableChannelManagement, ExecutorChannelInterceptorAware

Base class for all pollable channels.

Author:

Mark Fisher, Artem Bilan, Gary Russell, Artem Bilan

Nested Class Summary

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 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.messaging.MessageChannel

INDEFINITE_TIMEOUT

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

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractPollableChannel()

Method Summary

Modifier and Type	Method and Description
void	addInterceptor(ChannelInterceptor interceptor) Add a channel interceptor to the end of the list.
void	addInterceptor(int index, ChannelInterceptor interceptor) Add a channel interceptor to the specified index of the list.
protected abstract Message<?>	doReceive(long timeout) Subclasses must implement this method.
IntegrationPatternType	getIntegrationPatternType() Return a pattern type this component implements.
int	getReceiveCount() Deprecated. in favor of Micrometer metrics.
long	getReceiveCountLong() Deprecated. in favor of Micrometer metrics.
int	getReceiveErrorCount() Deprecated. in favor of Micrometer metrics.
long	getReceiveErrorCountLong() Deprecated. in favor of Micrometer metrics.
boolean	hasExecutorInterceptors()
Message<?>	receive() Receive the first available message from this channel.
Message<?>	receive(long timeout) Receive the first available message from this channel.
boolean	removeInterceptor(ChannelInterceptor interceptor)
ChannelInterceptor	removeInterceptor(int index)
void	setInterceptors(List<ChannelInterceptor> interceptors) Set the list of channel interceptors.

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

configureMetrics, destroy, doSend, getComponentType, getErrorRate, getFullChannelName, getIChannelInterceptorList, getInterceptors, getMaxSendDuration, getMeanErrorRate, getMeanErrorRatio, getMeanSendDuration, getMeanSendRate, getMetrics, getMetricsCaptor, getMinSendDuration, getOverrides, getSendCount, getSendCountLong, getSendDuration, getSendErrorCount, getSendErrorCountLong, getSendRate, getStandardDeviationSendDuration, getTimeSinceLastSend, isCountsEnabled, isLoggingEnabled, isStatsEnabled, onInit, registerMetricsCaptor, reset, send, send, setCountsEnabled, setDatatypes, setLoggingEnabled, setMessageConverter, setShouldTrack, setStatsEnabled

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.messaging.MessageChannel

send, send

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

receiveCount, receiveErrorCount

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

isStatsEnabled, setStatsEnabled

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

destroy, getOverrides, isCountsEnabled, isLoggingEnabled, registerMetricsCaptor, reset, setCountsEnabled, setLoggingEnabled

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

getInterceptors

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

getBeanName, getComponentName

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

sendCount, sendErrorCount

Constructor Detail

AbstractPollableChannel

public AbstractPollableChannel()

Method Detail

getReceiveCount

@Deprecated
public int getReceiveCount()

Deprecated. in favor of Micrometer metrics.

Deprecated.

Specified by:

getReceiveCount in interface PollableChannelManagement

Returns:

receive count

getReceiveCountLong

@Deprecated
public long getReceiveCountLong()

Deprecated. in favor of Micrometer metrics.

Deprecated.

Specified by:

getReceiveCountLong in interface PollableChannelManagement

Returns:

receive count

getReceiveErrorCount

@Deprecated
public int getReceiveErrorCount()

Deprecated. in favor of Micrometer metrics.

Deprecated.

Specified by:

getReceiveErrorCount in interface PollableChannelManagement

Returns:

error count

getReceiveErrorCountLong

@Deprecated
public long getReceiveErrorCountLong()

Deprecated. in favor of Micrometer metrics.

Deprecated.

Specified by:

getReceiveErrorCountLong in interface PollableChannelManagement

Returns:

error count

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.

receive

@Nullable
public Message<?> receive()

Receive the first available message from this channel. If the channel contains no messages, this method will block.

Specified by:

receive in interface PollableChannel

Returns:

the first available message or null if the receiving thread is interrupted.

receive

@Nullable
public Message<?> receive(long timeout)

Receive the first available message from this channel. If the channel contains no messages, this method will block until the allotted timeout elapses. If the specified timeout is 0, the method will return immediately. If less than zero, it will block indefinitely (see receive()).

Specified by:

receive in interface PollableChannel

Parameters:

timeout - the timeout in milliseconds

Returns:

the first available message or null if no message is available within the allotted time or the receiving thread is interrupted.

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

doReceive

@Nullable
protected abstract Message<?> doReceive(long timeout)

Subclasses must implement this method. A non-negative timeout indicates how long to wait if the channel is empty (if the value is 0, it must return immediately with or without success). A negative timeout value indicates that the method should block until either a message is available or the blocking thread is interrupted.

Parameters:

timeout - The timeout.

Returns:

The message, or null.