Class PollingConsumer

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.endpoint.AbstractEndpoint

org.springframework.integration.endpoint.AbstractPollingEndpoint

org.springframework.integration.endpoint.PollingConsumer

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, ComponentSourceAware, ExpressionCapable, IntegrationConsumer, NamedComponent, ManageableLifecycle, ManageableSmartLifecycle

public class PollingConsumer
extends AbstractPollingEndpoint
implements IntegrationConsumer

Message Endpoint that connects any MessageHandler implementation to a PollableChannel.

Author:

Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_RECEIVE_TIMEOUT	A default receive timeout as 1000L milliseconds.

Fields inherited from class org.springframework.integration.endpoint.AbstractPollingEndpoint

DEFAULT_POLLING_PERIOD

Fields inherited from class org.springframework.integration.endpoint.AbstractEndpoint

lifecycleLock

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

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
PollingConsumer(PollableChannel inputChannel, MessageHandler handler)

Method Summary

Modifier and Type	Method	Description
protected void	doStart()	Subclasses must implement this method with the start behavior.
protected void	doStop()	Subclasses must implement this method with the stop behavior.
MessageHandler	getHandler()	Return the consumer's handler.
MessageChannel	getInputChannel()	Return the input channel.
MessageChannel	getOutputChannel()	Return the output channel (maybe null).
protected Object	getReceiveMessageSource()
protected String	getResourceKey()	Return the key under which the resource will be made available as an attribute on the IntegrationResourceHolder.
protected Object	getResourceToBind()	Return a resource (MessageSource etc.) to bind when using transaction synchronization.
protected void	handleMessage(Message<?> message)	Handle a message.
protected boolean	isReactive()
protected Message<?>	receiveMessage()	Obtain the next message (if one is available).
protected void	setReceiveMessageSource(Object source)
void	setReceiveTimeout(long receiveTimeout)

Methods inherited from class org.springframework.integration.endpoint.AbstractPollingEndpoint

applyReceiveOnlyAdviceChain, donePollingTask, getBeanClassLoader, getDefaultErrorChannel, getMaxMessagesPerPoll, getPollingFlux, getTaskExecutor, isReceiveOnlyAdvice, isSyncExecutor, messageReceived, onInit, setAdviceChain, setBeanClassLoader, setErrorHandler, setMaxMessagesPerPoll, setTaskExecutor, setTransactionSynchronizationFactory, setTrigger

Methods inherited from class org.springframework.integration.endpoint.AbstractEndpoint

destroy, doStop, getPhase, getRole, isActive, isAutoStartup, isRunning, setAutoStartup, setPhase, setRole, start, stop, stop

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

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, getComponentType, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, 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.context.NamedComponent

getBeanName, getComponentName, getComponentType

Field Details

DEFAULT_RECEIVE_TIMEOUT

public static final long DEFAULT_RECEIVE_TIMEOUT

A default receive timeout as 1000L milliseconds.

See Also:

• Constant Field Values

Constructor Details

PollingConsumer

public PollingConsumer(PollableChannel inputChannel,
 MessageHandler handler)

Method Details

setReceiveTimeout

public void setReceiveTimeout(long receiveTimeout)

getInputChannel

public MessageChannel getInputChannel()

Description copied from interface: IntegrationConsumer

Return the input channel.

Specified by:

getInputChannel in interface IntegrationConsumer

Returns:

the input channel.

getOutputChannel

public MessageChannel getOutputChannel()

Description copied from interface: IntegrationConsumer

Return the output channel (maybe null).

Specified by:

getOutputChannel in interface IntegrationConsumer

Returns:

the output channel.

getHandler

public MessageHandler getHandler()

Description copied from interface: IntegrationConsumer

Return the consumer's handler.

Specified by:

getHandler in interface IntegrationConsumer

Returns:

the handler.

getReceiveMessageSource

protected Object getReceiveMessageSource()

Overrides:

getReceiveMessageSource in class AbstractPollingEndpoint

setReceiveMessageSource

protected void setReceiveMessageSource(Object source)

Overrides:

setReceiveMessageSource in class AbstractPollingEndpoint

isReactive

protected boolean isReactive()

Overrides:

isReactive in class AbstractPollingEndpoint

doStart

protected void doStart()

Description copied from class: AbstractEndpoint

Subclasses must implement this method with the start behavior. This method will be invoked while holding the AbstractEndpoint.lifecycleLock.

Overrides:

doStart in class AbstractPollingEndpoint

doStop

protected void doStop()

Description copied from class: AbstractEndpoint

Subclasses must implement this method with the stop behavior. This method will be invoked while holding the AbstractEndpoint.lifecycleLock.

Overrides:

doStop in class AbstractPollingEndpoint

handleMessage

protected void handleMessage(Message<?> message)

Description copied from class: AbstractPollingEndpoint

Handle a message.

Specified by:

handleMessage in class AbstractPollingEndpoint

Parameters:

message - The message.

receiveMessage

protected Message<?> receiveMessage()

Description copied from class: AbstractPollingEndpoint

Obtain the next message (if one is available). MAY return null if no message is immediately available.

Specified by:

receiveMessage in class AbstractPollingEndpoint

Returns:

The message or null.

getResourceToBind

protected Object getResourceToBind()

Description copied from class: AbstractPollingEndpoint

Return a resource (MessageSource etc.) to bind when using transaction synchronization.

Overrides:

getResourceToBind in class AbstractPollingEndpoint

Returns:

The resource, or null if transaction synchronization is not required.

getResourceKey

protected String getResourceKey()

Description copied from class: AbstractPollingEndpoint

Return the key under which the resource will be made available as an attribute on the IntegrationResourceHolder. The default ExpressionEvaluatingTransactionSynchronizationProcessor makes this attribute available as a variable in SpEL expressions.

Overrides:

getResourceKey in class AbstractPollingEndpoint

Returns:

The key, or null (default) if the resource shouldn't be made available as a attribute.