Package org.springframework.integration.jms.dsl

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

java.lang.Object

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

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

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

Type Parameters:

S - the target JmsPollableMessageChannelSpec implementation type.

T - the target channel implementation type.

All Implemented Interfaces:

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

Direct Known Subclasses:

JmsMessageChannelSpec

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

A MessageChannelSpec for an AbstractJmsChannel.

Since:

5.0

Author:

Artem Bilan, Gary Russell, Artem Vozhdayenko

Field Summary

Fields

Modifier and Type	Field	Description
protected final JmsChannelFactoryBean	jmsChannelFactoryBean

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

channel

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JmsPollableMessageChannelSpec(ConnectionFactory connectionFactory)
protected	JmsPollableMessageChannelSpec(JmsChannelFactoryBean jmsChannelFactoryBean, ConnectionFactory connectionFactory)

Method Summary

Modifier and Type	Method	Description
S	deliveryPersistent(boolean deliveryPersistent)
S	destination(Destination destination)	Configure the destination that backs this channel.
S	destination(String destination)	Configure the destination name that backs this channel.
S	destinationResolver(DestinationResolver destinationResolver)
protected T	doGet()
S	explicitQosEnabled(boolean explicitQosEnabled)
protected S	id(String id)	Configure the component identifier.
S	jmsMessageConverter(MessageConverter messageConverter)	Configure the MessageConverter used for both sending and receiving.
S	messageIdEnabled(boolean messageIdEnabled)
S	messageSelector(String messageSelector)	Configure a message selector in the DefaultMessageListenerContainer (when message driven) or the JmsTemplate (when polled).
S	messageTimestampEnabled(boolean messageTimestampEnabled)
S	priority(int priority)	Default priority.
S	receiveTimeout(long receiveTimeout)
S	sessionAcknowledgeMode(int sessionAcknowledgeMode)
S	sessionTransacted(boolean sessionTransacted)	Configure transactional sessions for both the JmsTemplate (sends and polled receives) and DefaultMessageListenerContainer (message-driven receives).
S	timeToLive(long timeToLive)

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

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

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

_this, afterPropertiesSet, destroy, get, getId, getObject, getObjectType, getPhase, 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

Field Details

jmsChannelFactoryBean

protected final JmsChannelFactoryBean jmsChannelFactoryBean

Constructor Details

JmsPollableMessageChannelSpec

protected JmsPollableMessageChannelSpec(ConnectionFactory connectionFactory)

JmsPollableMessageChannelSpec

protected JmsPollableMessageChannelSpec(JmsChannelFactoryBean jmsChannelFactoryBean,
 ConnectionFactory connectionFactory)

Method Details

id

protected S id(@Nullable
 String id)

Description copied from class: IntegrationComponentSpec

Configure the component identifier. Used as the beanName to register the bean in the application context for this component.

Overrides:

id in class IntegrationComponentSpec<S extends JmsPollableMessageChannelSpec<S,T>,T extends AbstractJmsChannel>

Parameters:

id - the id.

Returns:

the spec.

destination

public S destination(String destination)

Configure the destination name that backs this channel.

Parameters:

destination - the destination.

Returns:

the current MessageChannelSpec.

destinationResolver

public S destinationResolver(DestinationResolver destinationResolver)

Parameters:

destinationResolver - the destinationResolver.

Returns:

the current MessageChannelSpec.

See Also:

• JmsDestinationAccessor.setDestinationResolver(DestinationResolver)
• JmsDestinationAccessor.setDestinationResolver(DestinationResolver)

destination

public S destination(Destination destination)

Configure the destination that backs this channel.

Parameters:

destination - the destination.

Returns:

the current MessageChannelSpec.

messageSelector

public S messageSelector(String messageSelector)

Configure a message selector in the DefaultMessageListenerContainer (when message driven) or the JmsTemplate (when polled).

Parameters:

messageSelector - the messageSelector.

Returns:

the current MessageChannelSpec.

See Also:

• AbstractMessageListenerContainer.setMessageSelector(String)
• JmsTemplate.receiveSelectedAndConvert(String)

jmsMessageConverter

public S jmsMessageConverter(MessageConverter messageConverter)

Configure the MessageConverter used for both sending and receiving.

Parameters:

messageConverter - the messageConverter.

Returns:

the current MessageChannelSpec.

See Also:

• JmsTemplate.setMessageConverter(MessageConverter)

deliveryPersistent

public S deliveryPersistent(boolean deliveryPersistent)

Parameters:

deliveryPersistent - the deliveryPersistent.

Returns:

the current MessageChannelSpec.

See Also:

• JmsTemplate.setDeliveryPersistent(boolean)

explicitQosEnabled

public S explicitQosEnabled(boolean explicitQosEnabled)

Parameters:

explicitQosEnabled - the explicitQosEnabled.

Returns:

the current MessageChannelSpec.

See Also:

• JmsTemplate.setExplicitQosEnabled(boolean)

messageIdEnabled

public S messageIdEnabled(boolean messageIdEnabled)

Parameters:

messageIdEnabled - the messageIdEnabled.

Returns:

the current MessageChannelSpec.

See Also:

• JmsTemplate.setMessageIdEnabled(boolean)

messageTimestampEnabled

public S messageTimestampEnabled(boolean messageTimestampEnabled)

Parameters:

messageTimestampEnabled - the messageTimestampEnabled.

Returns:

the current MessageChannelSpec.

See Also:

• JmsTemplate.setMessageTimestampEnabled(boolean)

priority

public S priority(int priority)

Default priority. May be overridden at run time with a message priority header.

Parameters:

priority - the priority.

Returns:

the current MessageChannelSpec.

See Also:

• JmsTemplate.setPriority(int)

timeToLive

public S timeToLive(long timeToLive)

Parameters:

timeToLive - the timeToLive.

Returns:

the current MessageChannelSpec.

See Also:

• JmsTemplate.setTimeToLive(long)

receiveTimeout

public S receiveTimeout(long receiveTimeout)

Parameters:

receiveTimeout - the receiveTimeout.

Returns:

the current MessageChannelSpec.

See Also:

• JmsTemplate.setReceiveTimeout(long)
• AbstractPollingMessageListenerContainer.setReceiveTimeout(long)

sessionAcknowledgeMode

public S sessionAcknowledgeMode(int sessionAcknowledgeMode)

Parameters:

sessionAcknowledgeMode - the acknowledgement mode constant

Returns:

the current MessageChannelSpec.

See Also:

• etc.

sessionTransacted

public S sessionTransacted(boolean sessionTransacted)

Configure transactional sessions for both the JmsTemplate (sends and polled receives) and DefaultMessageListenerContainer (message-driven receives).

Parameters:

sessionTransacted - the sessionTransacted.

Returns:

the current MessageChannelSpec.

doGet

protected T doGet()

Overrides:

doGet in class MessageChannelSpec<S extends JmsPollableMessageChannelSpec<S,T>,T extends AbstractJmsChannel>