org.springframework.integration.endpoint

Class SourcePollingChannelAdapter

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.endpoint.AbstractEndpoint

org.springframework.integration.endpoint.AbstractPollingEndpoint

org.springframework.integration.endpoint.SourcePollingChannelAdapter

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, ExpressionCapable, NamedComponent, TrackableComponent

public class SourcePollingChannelAdapter
extends AbstractPollingEndpoint
implements TrackableComponent

A Channel Adapter implementation for connecting a MessageSource to a MessageChannel.

Author:

Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan

Field Summary

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

lifecycleCondition, lifecycleLock

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

EXPRESSION_PARSER, logger

Constructor Summary

Constructors

Constructor and Description
SourcePollingChannelAdapter()

Method Summary

Modifier and Type	Method and Description
protected void	applyReceiveOnlyAdviceChain(Collection<Advice> chain) Add the advice chain to the component that responds to AbstractPollingEndpoint.receiveMessage() calls.
protected void	doStart() Subclasses must implement this method with the start behavior.
protected void	doStop() Subclasses must implement this method with the stop behavior.
String	getComponentType() Subclasses may implement this method to provide component type information.
MessageSource<?>	getMessageSource() Return this endpoint's source.
MessageChannel	getOutputChannel()
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	isReceiveOnlyAdvice(Advice advice) Return true if this advice should be applied only to the AbstractPollingEndpoint.receiveMessage() operation rather than the whole poll.
protected void	onInit() Subclasses may implement this for initialization logic.
protected Message<?>	receiveMessage() Obtain the next message (if one is available).
void	setOutputChannel(MessageChannel outputChannel) Specify the MessageChannel where Messages should be sent.
void	setOutputChannelName(String outputChannelName)
void	setSendTimeout(long sendTimeout) Specify the maximum time to wait for a Message to be sent to the output channel.
void	setShouldTrack(boolean shouldTrack) Specify whether this component should be tracked in the Message History.
void	setSource(MessageSource<?> source) Specify the source to be polled for Messages.

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

getBeanClassLoader, getDefaultErrorChannel, setAdviceChain, setBeanClassLoader, setErrorHandler, setMaxMessagesPerPoll, setTaskExecutor, setTransactionSynchronizationFactory, setTrigger

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

doStop, getPhase, isAutoStartup, isRunning, setAutoStartup, setPhase, setTaskScheduler, start, stop, stop

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

afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, 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

getComponentName

Constructor Detail

SourcePollingChannelAdapter

public SourcePollingChannelAdapter()

Method Detail

setSource

public void setSource(MessageSource<?> source)

Specify the source to be polled for Messages.

Parameters:

source - The message source.

setOutputChannel

public void setOutputChannel(MessageChannel outputChannel)

Specify the MessageChannel where Messages should be sent.

Parameters:

outputChannel - The output channel.

getMessageSource

public MessageSource<?> getMessageSource()

Return this endpoint's source.

Returns:

the source.

Since:

4.3

setOutputChannelName

public void setOutputChannelName(String outputChannelName)

setSendTimeout

public void setSendTimeout(long sendTimeout)

Specify the maximum time to wait for a Message to be sent to the output channel.

Parameters:

sendTimeout - The send timeout.

setShouldTrack

public void setShouldTrack(boolean shouldTrack)

Specify whether this component should be tracked in the Message History.

Specified by:

setShouldTrack in interface TrackableComponent

Parameters:

shouldTrack - true if the component should be tracked.

getComponentType

public String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class IntegrationObjectSupport

isReceiveOnlyAdvice

protected boolean isReceiveOnlyAdvice(Advice advice)

Description copied from class: AbstractPollingEndpoint

Return true if this advice should be applied only to the AbstractPollingEndpoint.receiveMessage() operation rather than the whole poll.

Overrides:

isReceiveOnlyAdvice in class AbstractPollingEndpoint

Parameters:

advice - The advice.

Returns:

true to only advise the receive operation.

applyReceiveOnlyAdviceChain

protected void applyReceiveOnlyAdviceChain(Collection<Advice> chain)

Description copied from class: AbstractPollingEndpoint

Add the advice chain to the component that responds to AbstractPollingEndpoint.receiveMessage() calls.

Overrides:

applyReceiveOnlyAdviceChain in class AbstractPollingEndpoint

Parameters:

chain - the advice chain Collection.

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

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class AbstractPollingEndpoint

getOutputChannel

public MessageChannel getOutputChannel()

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.