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:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, ChannelInterceptorAware, ExecutorChannelInterceptorAware, ExpressionCapable, NamedComponent, ConfigurableMetricsAware<AbstractMessageChannelMetrics>, IntegrationManagement, IntegrationStatsManagement, MessageChannelMetrics, PollableChannelManagement, TrackableComponent, org.springframework.messaging.MessageChannel, org.springframework.messaging.PollableChannel

Direct Known Subclasses:

QueueChannel

public abstract class AbstractPollableChannel
extends AbstractMessageChannel
implements org.springframework.messaging.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

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(org.springframework.messaging.support.ChannelInterceptor interceptor) Add a channel interceptor to the end of the list.
void	addInterceptor(int index, org.springframework.messaging.support.ChannelInterceptor interceptor) Add a channel interceptor to the specified index of the list.
protected abstract org.springframework.messaging.Message<?>	doReceive(long timeout) Subclasses must implement this method.
int	getReceiveCount()
long	getReceiveCountLong()
int	getReceiveErrorCount()
long	getReceiveErrorCountLong()
boolean	hasExecutorInterceptors()
org.springframework.messaging.Message<?>	receive() Receive the first available message from this channel.
org.springframework.messaging.Message<?>	receive(long timeout) Receive the first available message from this channel.
boolean	removeInterceptor(org.springframework.messaging.support.ChannelInterceptor interceptor) Remove the provided ChannelInterceptor from the target implementation.
org.springframework.messaging.support.ChannelInterceptor	removeInterceptor(int index) Remove a ChannelInterceptor from the target implementation for specific index.
void	setInterceptors(java.util.List<org.springframework.messaging.support.ChannelInterceptor> interceptors) Set the list of channel interceptors.

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

configureMetrics, doSend, getChannelInterceptors, getComponentType, getErrorRate, getFullChannelName, 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, getApplicationContext, getApplicationContextId, getBeanFactory, 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.MessageChannelMetrics

getErrorRate, getMaxSendDuration, getMeanErrorRate, getMeanErrorRatio, getMeanSendDuration, getMeanSendRate, getMinSendDuration, getSendCount, getSendCountLong, getSendDuration, getSendErrorCount, getSendErrorCountLong, getSendRate, getStandardDeviationSendDuration, getTimeSinceLastSend

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

isStatsEnabled, setStatsEnabled

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

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

Methods inherited from interface org.springframework.integration.channel.ChannelInterceptorAware

getChannelInterceptors

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

getComponentName

Constructor Detail

AbstractPollableChannel

public AbstractPollableChannel()

Method Detail

getReceiveCount

public int getReceiveCount()

Specified by:

getReceiveCount in interface PollableChannelManagement

getReceiveCountLong

public long getReceiveCountLong()

Specified by:

getReceiveCountLong in interface PollableChannelManagement

getReceiveErrorCount

public int getReceiveErrorCount()

Specified by:

getReceiveErrorCount in interface PollableChannelManagement

getReceiveErrorCountLong

public long getReceiveErrorCountLong()

Specified by:

getReceiveErrorCountLong in interface PollableChannelManagement

receive

@Nullable
public org.springframework.messaging.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 org.springframework.messaging.PollableChannel

Returns:

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

receive

@Nullable
public org.springframework.messaging.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 org.springframework.messaging.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(java.util.List<org.springframework.messaging.support.ChannelInterceptor> interceptors)

Description copied from class: AbstractMessageChannel

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

Specified by:

setInterceptors in interface ChannelInterceptorAware

Overrides:

setInterceptors in class AbstractMessageChannel

Parameters:

interceptors - The list of interceptors.

addInterceptor

public void addInterceptor(org.springframework.messaging.support.ChannelInterceptor interceptor)

Description copied from class: AbstractMessageChannel

Add a channel interceptor to the end of the list.

Specified by:

addInterceptor in interface ChannelInterceptorAware

Overrides:

addInterceptor in class AbstractMessageChannel

Parameters:

interceptor - The interceptor.

addInterceptor

public void addInterceptor(int index,
                           org.springframework.messaging.support.ChannelInterceptor interceptor)

Description copied from class: AbstractMessageChannel

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

Specified by:

addInterceptor in interface ChannelInterceptorAware

Overrides:

addInterceptor in class AbstractMessageChannel

Parameters:

index - The index to add interceptor.

interceptor - The interceptor.

removeInterceptor

public boolean removeInterceptor(org.springframework.messaging.support.ChannelInterceptor interceptor)

Description copied from interface: ChannelInterceptorAware

Remove the provided ChannelInterceptor from the target implementation.

Specified by:

removeInterceptor in interface ChannelInterceptorAware

Overrides:

removeInterceptor in class AbstractMessageChannel

Parameters:

interceptor - ChannelInterceptor to remove.

Returns:

the boolean if ChannelInterceptor has been removed.

removeInterceptor

public org.springframework.messaging.support.ChannelInterceptor removeInterceptor(int index)

Description copied from interface: ChannelInterceptorAware

Remove a ChannelInterceptor from the target implementation for specific index.

Specified by:

removeInterceptor in interface ChannelInterceptorAware

Overrides:

removeInterceptor in class AbstractMessageChannel

Parameters:

index - the index for the ChannelInterceptor to remove.

Returns:

the boolean if the ChannelInterceptor has been removed.

hasExecutorInterceptors

public boolean hasExecutorInterceptors()

Specified by:

hasExecutorInterceptors in interface ExecutorChannelInterceptorAware

doReceive

protected abstract org.springframework.messaging.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.