org.springframework.integration.endpoint
Class AbstractPollingEndpoint

java.lang.Object
  org.springframework.integration.context.IntegrationObjectSupport
      org.springframework.integration.endpoint.AbstractEndpoint
          org.springframework.integration.endpoint.AbstractPollingEndpoint

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, NamedComponent

Direct Known Subclasses:

PollingConsumer, SourcePollingChannelAdapter

public abstract class AbstractPollingEndpoint
extends AbstractEndpoint
implements org.springframework.beans.factory.BeanClassLoaderAware

Author:

Mark Fisher, Oleg Zhurakousky, Gary Russell

Field Summary

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

logger

Constructor Summary

AbstractPollingEndpoint()

Method Summary

protected boolean	doPoll() Deprecated. Starting with Spring Integration 3.0, subclasses will not be able to override this method. Use receiveMessage() and handleMessage(Message) instead, to separate the concerns of retrieving and processing a message. Consider refactoring now rather than waiting for 3.0.
protected void	doStart() Subclasses must implement this method with the start behavior.
protected void	doStop() Subclasses must implement this method with the stop behavior.
protected void	handleMessage(Message<?> message) Handle a message.
protected void	onInit() Subclasses may implement this for initialization logic.
protected Message<?>	receiveMessage() Obtain the next message (if one is available).
void	setAdviceChain(java.util.List<org.aopalliance.aop.Advice> adviceChain)
void	setBeanClassLoader(java.lang.ClassLoader classLoader)
void	setErrorHandler(org.springframework.util.ErrorHandler errorHandler)
void	setMaxMessagesPerPoll(long maxMessagesPerPoll)
void	setPollerMetadata(PollerMetadata pollerMetadata) Deprecated. As of release 2.0.2, use individual setters
void	setTaskExecutor(java.util.concurrent.Executor taskExecutor)
void	setTrigger(org.springframework.scheduling.Trigger trigger)

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

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

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

afterPropertiesSet, getBeanFactory, getComponentName, getComponentType, getConversionService, getTaskScheduler, setBeanFactory, setBeanName, setComponentName, setConversionService, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPollingEndpoint

public AbstractPollingEndpoint()

Method Detail

setPollerMetadata

@Deprecated
public void setPollerMetadata(PollerMetadata pollerMetadata)

Deprecated. As of release 2.0.2, use individual setters

setTaskExecutor

public void setTaskExecutor(java.util.concurrent.Executor taskExecutor)

setTrigger

public void setTrigger(org.springframework.scheduling.Trigger trigger)

setAdviceChain

public void setAdviceChain(java.util.List<org.aopalliance.aop.Advice> adviceChain)

setMaxMessagesPerPoll

public void setMaxMessagesPerPoll(long maxMessagesPerPoll)

setErrorHandler

public void setErrorHandler(org.springframework.util.ErrorHandler errorHandler)

setBeanClassLoader

public void setBeanClassLoader(java.lang.ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface org.springframework.beans.factory.BeanClassLoaderAware

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

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.

Specified by:

doStart in class AbstractEndpoint

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.

Specified by:

doStop in class AbstractEndpoint

doPoll

@Deprecated
protected boolean doPoll()

Deprecated. Starting with Spring Integration 3.0, subclasses will not be able to override this method. Use receiveMessage() and handleMessage(Message) instead, to separate the concerns of retrieving and processing a message. Consider refactoring now rather than waiting for 3.0.

Returns:

true if a message was processed.

receiveMessage

protected Message<?> receiveMessage()

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

Returns:

The message or null.

handleMessage

protected void handleMessage(Message<?> message)

Handle a message.

Parameters:

message - The message.