Package org.springframework.integration.dsl

Class PollerSpec

java.lang.Object

org.springframework.integration.dsl.IntegrationComponentSpec<PollerSpec,PollerMetadata>

org.springframework.integration.dsl.PollerSpec

All Implemented Interfaces:

DisposableBean, FactoryBean<PollerMetadata>, InitializingBean, Lifecycle, Phased, SmartLifecycle, ComponentsRegistration

public final class PollerSpec
extends IntegrationComponentSpec<PollerSpec,PollerMetadata>
implements ComponentsRegistration

An IntegrationComponentSpec for PollerMetadatas.

Since:

5.0

Author:

Artem Bilan, Gary Russell

Field Summary

Fields inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

logger, PARSER, target

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Method Summary

Modifier and Type	Method	Description
PollerSpec	advice(Advice... advice)	Specify AOP Advices for the pollingTask.
PollerSpec	errorChannel(String errorChannelName)	Specify a bean name for the MessageChannel to use for sending error message in case of polling failures.
PollerSpec	errorChannel(MessageChannel errorChannel)	Specify a MessageChannel to use for sending error message in case of polling failures.
PollerSpec	errorHandler(ErrorHandler errorHandler)	Specify the ErrorHandler to wrap a taskExecutor to the ErrorHandlingTaskExecutor.
Map<Object,String>	getComponentsToRegister()
PollerSpec	maxMessagesPerPoll(long maxMessagesPerPoll)
PollerSpec	receiveTimeout(long receiveTimeout)	Specify a timeout in milliseconds to wait for a message in the MessageChannel.
PollerSpec	sendTimeout(long sendTimeout)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of SourcePollingChannelAdapterSpec.sendTimeout(long)
PollerSpec	taskExecutor(Executor taskExecutor)	Specify an Executor to perform the pollingTask.
PollerSpec	transactional()	Specify a TransactionInterceptor Advice with default PlatformTransactionManager and DefaultTransactionAttribute for the pollingTask.
PollerSpec	transactional(TransactionInterceptor transactionInterceptor)	Specify a TransactionInterceptor Advice for the pollingTask.
PollerSpec	transactional(TransactionManager transactionManager)	Specify a TransactionInterceptor Advice with the provided PlatformTransactionManager and default DefaultTransactionAttribute for the pollingTask.
PollerSpec	transactionSynchronizationFactory(TransactionSynchronizationFactory transactionSynchronizationFactory)	Specify the TransactionSynchronizationFactory to attach a TransactionSynchronization to the transaction around poll operation.

Methods inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

_this, afterPropertiesSet, destroy, doGet, getId, getObject, getObjectType, getPhase, id, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.FactoryBean

isSingleton

Method Details

transactionSynchronizationFactory

public PollerSpec transactionSynchronizationFactory(TransactionSynchronizationFactory transactionSynchronizationFactory)

Specify the TransactionSynchronizationFactory to attach a TransactionSynchronization to the transaction around poll operation.

Parameters:

transactionSynchronizationFactory - the TransactionSynchronizationFactory to use.

Returns:

the spec.

errorHandler

public PollerSpec errorHandler(ErrorHandler errorHandler)

Specify the ErrorHandler to wrap a taskExecutor to the ErrorHandlingTaskExecutor.

Parameters:

errorHandler - the ErrorHandler to use.

Returns:

the spec.

See Also:

• taskExecutor(Executor)

errorChannel

public PollerSpec errorChannel(MessageChannel errorChannel)

Specify a MessageChannel to use for sending error message in case of polling failures.

Parameters:

errorChannel - the MessageChannel to use.

Returns:

the spec.

See Also:

• MessagePublishingErrorHandler

errorChannel

public PollerSpec errorChannel(String errorChannelName)

Specify a bean name for the MessageChannel to use for sending error message in case of polling failures.

Parameters:

errorChannelName - the bean name for MessageChannel to use.

Returns:

the spec.

See Also:

• MessagePublishingErrorHandler

maxMessagesPerPoll

public PollerSpec maxMessagesPerPoll(long maxMessagesPerPoll)

Parameters:

maxMessagesPerPoll - the maxMessagesPerPoll to set.

Returns:

the spec.

See Also:

• PollerMetadata.setMaxMessagesPerPoll(long)

receiveTimeout

public PollerSpec receiveTimeout(long receiveTimeout)

Specify a timeout in milliseconds to wait for a message in the MessageChannel. Defaults to 1000.

Parameters:

receiveTimeout - the timeout to use.

Returns:

the spec.

See Also:

• PollableChannel.receive(long)

advice

public PollerSpec advice(Advice... advice)

Specify AOP Advices for the pollingTask.

Parameters:

advice - the Advices to use.

Returns:

the spec.

transactional

public PollerSpec transactional(TransactionManager transactionManager)

Specify a TransactionInterceptor Advice with the provided PlatformTransactionManager and default DefaultTransactionAttribute for the pollingTask.

Parameters:

transactionManager - the TransactionManager to use.

Returns:

the spec.

transactional

public PollerSpec transactional()

Specify a TransactionInterceptor Advice with default PlatformTransactionManager and DefaultTransactionAttribute for the pollingTask.

Returns:

the spec.

transactional

public PollerSpec transactional(TransactionInterceptor transactionInterceptor)

Specify a TransactionInterceptor Advice for the pollingTask.

Parameters:

transactionInterceptor - the TransactionInterceptor to use.

Returns:

the spec.

See Also:

• TransactionInterceptorBuilder

taskExecutor

public PollerSpec taskExecutor(Executor taskExecutor)

Specify an Executor to perform the pollingTask.

Parameters:

taskExecutor - the Executor to use.

Returns:

the spec.

sendTimeout

@Deprecated(forRemoval=true,
            since="6.3.9")
public PollerSpec sendTimeout(long sendTimeout)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of SourcePollingChannelAdapterSpec.sendTimeout(long)

The timeout for blocking send on channels.

Parameters:

sendTimeout - the timeout to use.

Returns:

the spec.

getComponentsToRegister

public Map<Object,String> getComponentsToRegister()

Specified by:

getComponentsToRegister in interface ComponentsRegistration