Class JmsMessageChannelSpec<S extends JmsMessageChannelSpec<S,T>, T extends AbstractJmsChannel>

java.lang.Object

org.springframework.integration.dsl.IntegrationComponentSpec<S,T>

org.springframework.integration.dsl.MessageChannelSpec<S,T>

org.springframework.integration.jms.dsl.JmsPollableMessageChannelSpec<S,T>

org.springframework.integration.jms.dsl.JmsMessageChannelSpec<S,T>

Type Parameters:

S - the target JmsMessageChannelSpec implementation type.

T - the target channel implementation type.

All Implemented Interfaces:

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

Direct Known Subclasses:

JmsPublishSubscribeMessageChannelSpec

public class JmsMessageChannelSpec<S extends JmsMessageChannelSpec<S,T>, T extends AbstractJmsChannel>
extends JmsPollableMessageChannelSpec<S,T>

A JmsMessageChannelSpec for subscribable AbstractJmsChannels.

Since:

5.0

Author:

Artem Bilan, Gary Russell, Artem Vozhdayenko, Glenn Renfro

Field Summary

Fields inherited from class JmsPollableMessageChannelSpec

jmsChannelFactoryBean

Fields inherited from class MessageChannelSpec

channel

Fields inherited from class IntegrationComponentSpec

logger, PARSER, target

Fields inherited from interface FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JmsMessageChannelSpec(ConnectionFactory connectionFactory)
protected	JmsMessageChannelSpec(JmsTemplate jmsTemplate)

Method Summary

Modifier and Type	Method	Description
S	acceptMessagesWhileStopping(boolean acceptMessagesWhileStopping)
S	autoStartup(boolean autoStartup)
S	cacheLevel(Integer cacheLevel)	Only applies if the containerType(Class) is a DefaultMessageListenerContainer.
S	concurrentConsumers(int concurrentConsumers)	Only applies if the containerType(Class) is a DefaultMessageListenerContainer or a SimpleMessageListenerContainer.
S	containerType(Class<? extends AbstractMessageListenerContainer> containerType)	Configure the type of the container.
S	errorHandler(ErrorHandler errorHandler)
S	exposeListenerSession(boolean exposeListenerSession)
S	idleTaskExecutionLimit(int idleTaskExecutionLimit)	Only applies if the containerType(Class) is a DefaultMessageListenerContainer.
S	maxMessagesPerTask(int maxMessagesPerTask)	Only applies if the containerType(Class) is a DefaultMessageListenerContainer.
S	maxSubscribers(int maxSubscribers)
S	phase(int phase)
S	recoveryInterval(long recoveryInterval)	Only applies if the containerType(Class) is a DefaultMessageListenerContainer.
S	subscriptionShared(boolean subscriptionShared)
S	taskExecutor(Executor taskExecutor)	Only applies if the containerType(Class) is a DefaultMessageListenerContainer or a SimpleMessageListenerContainer.
S	transactionManager(PlatformTransactionManager transactionManager)	Only applies if the containerType(Class) is a DefaultMessageListenerContainer.
S	transactionName(String transactionName)	Only applies if the containerType(Class) is a DefaultMessageListenerContainer.
S	transactionTimeout(int transactionTimeout)	Only applies if the containerType(Class) is a DefaultMessageListenerContainer.

Methods inherited from class JmsPollableMessageChannelSpec

deliveryPersistent, destination, destination, destinationResolver, doGet, explicitQosEnabled, id, jmsMessageConverter, messageIdEnabled, messageSelector, messageTimestampEnabled, priority, receiveTimeout, sessionAcknowledgeMode, sessionTransacted, timeToLive

Methods inherited from class MessageChannelSpec

datatype, getComponentsToRegister, interceptor, messageConverter, wireTap, wireTap, wireTap

Methods inherited from class IntegrationComponentSpec

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

Methods inherited from class Object

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

Methods inherited from interface FactoryBean

isSingleton

Methods inherited from interface SmartLifecycle

isPauseable

Constructor Details

JmsMessageChannelSpec

protected JmsMessageChannelSpec(ConnectionFactory connectionFactory)

JmsMessageChannelSpec

protected JmsMessageChannelSpec(JmsTemplate jmsTemplate)

Method Details

containerType

public S containerType(Class<? extends AbstractMessageListenerContainer> containerType)

Configure the type of the container. AbstractMessageListenerContainer. Defaults to DefaultMessageListenerContainer.

Parameters:

containerType - the containerType.

Returns:

the current JmsMessageChannelSpec.

concurrentConsumers

public S concurrentConsumers(int concurrentConsumers)

Only applies if the containerType(Class) is a DefaultMessageListenerContainer or a SimpleMessageListenerContainer.

Parameters:

concurrentConsumers - the concurrentConsumers.

Returns:

the current JmsMessageChannelSpec.

See Also:

• DefaultMessageListenerContainer.setConcurrentConsumers(int)
• SimpleMessageListenerContainer.setConcurrentConsumers(int)

maxSubscribers

public S maxSubscribers(int maxSubscribers)

Parameters:

maxSubscribers - the maxSubscribers.

Returns:

the current JmsMessageChannelSpec.

See Also:

• SubscribableJmsChannel.setMaxSubscribers(int)

autoStartup

public S autoStartup(boolean autoStartup)

Parameters:

autoStartup - the autoStartup.

Returns:

the current JmsMessageChannelSpec.

See Also:

• SmartLifecycle

phase

public S phase(int phase)

Parameters:

phase - the phase.

Returns:

the current JmsMessageChannelSpec.

See Also:

• SmartLifecycle

errorHandler

public S errorHandler(ErrorHandler errorHandler)

Parameters:

errorHandler - the errorHandler.

Returns:

the current JmsMessageChannelSpec.

See Also:

• AbstractMessageListenerContainer.setErrorHandler(ErrorHandler)

exposeListenerSession

public S exposeListenerSession(boolean exposeListenerSession)

Parameters:

exposeListenerSession - the exposeListenerSession.

Returns:

the current JmsMessageChannelSpec.

See Also:

• AbstractMessageListenerContainer.setExposeListenerSession(boolean)

acceptMessagesWhileStopping

public S acceptMessagesWhileStopping(boolean acceptMessagesWhileStopping)

Parameters:

acceptMessagesWhileStopping - the acceptMessagesWhileStopping.

Returns:

the current JmsMessageChannelSpec.

See Also:

• AbstractMessageListenerContainer.setAcceptMessagesWhileStopping(boolean)

idleTaskExecutionLimit

public S idleTaskExecutionLimit(int idleTaskExecutionLimit)

Only applies if the containerType(Class) is a DefaultMessageListenerContainer.

Parameters:

idleTaskExecutionLimit - the idleTaskExecutionLimit.

Returns:

the current JmsMessageChannelSpec.

See Also:

• DefaultMessageListenerContainer.setIdleTaskExecutionLimit(int)

maxMessagesPerTask

public S maxMessagesPerTask(int maxMessagesPerTask)

Only applies if the containerType(Class) is a DefaultMessageListenerContainer.

Parameters:

maxMessagesPerTask - the maxMessagesPerTask.

Returns:

the current JmsMessageChannelSpec.

See Also:

• DefaultMessageListenerContainer.setMaxMessagesPerTask(int)

recoveryInterval

public S recoveryInterval(long recoveryInterval)

Only applies if the containerType(Class) is a DefaultMessageListenerContainer.

Parameters:

recoveryInterval - the recoveryInterval.

Returns:

the current JmsMessageChannelSpec.

See Also:

• DefaultMessageListenerContainer.setRecoveryInterval(long)

taskExecutor

public S taskExecutor(Executor taskExecutor)

Only applies if the containerType(Class) is a DefaultMessageListenerContainer or a SimpleMessageListenerContainer.

Parameters:

taskExecutor - the taskExecutor.

Returns:

the current JmsMessageChannelSpec.

See Also:

• DefaultMessageListenerContainer.setTaskExecutor(Executor)
• SimpleMessageListenerContainer.setTaskExecutor(Executor)

transactionManager

public S transactionManager(PlatformTransactionManager transactionManager)

Only applies if the containerType(Class) is a DefaultMessageListenerContainer.

Parameters:

transactionManager - the transactionManager.

Returns:

the current JmsMessageChannelSpec.

See Also:

• AbstractPollingMessageListenerContainer.setTransactionManager(PlatformTransactionManager)

transactionName

public S transactionName(String transactionName)

Only applies if the containerType(Class) is a DefaultMessageListenerContainer.

Parameters:

transactionName - the transactionName.

Returns:

the current JmsMessageChannelSpec.

See Also:

• AbstractPollingMessageListenerContainer.setTransactionName(String)

transactionTimeout

public S transactionTimeout(int transactionTimeout)

Only applies if the containerType(Class) is a DefaultMessageListenerContainer.

Parameters:

transactionTimeout - the transactionTimeout.

Returns:

the current JmsMessageChannelSpec.

See Also:

• AbstractPollingMessageListenerContainer.setTransactionTimeout(int)

cacheLevel

public S cacheLevel(Integer cacheLevel)

Only applies if the containerType(Class) is a DefaultMessageListenerContainer.

Parameters:

cacheLevel - the value for org.springframework.jms.listener.DefaultMessageListenerContainer.cacheLevel

Returns:

the current JmsMessageChannelSpec.

See Also:

• DefaultMessageListenerContainer.setCacheLevel(int)

subscriptionShared

public S subscriptionShared(boolean subscriptionShared)

Parameters:

subscriptionShared - the subscription shared boolean flag.

Returns:

the current JmsMessageChannelSpec.

See Also:

• AbstractMessageListenerContainer.setSubscriptionShared(boolean)