Class JmsInboundGatewaySpec<S extends JmsInboundGatewaySpec<S>>

java.lang.Object

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

org.springframework.integration.dsl.MessagingGatewaySpec<S, JmsInboundGateway>

org.springframework.integration.jms.dsl.JmsInboundGatewaySpec<S>

Type Parameters:

S - the target JmsInboundGatewaySpec implementation type.

All Implemented Interfaces:

DisposableBean, FactoryBean<JmsInboundGateway>, InitializingBean, Lifecycle, Phased, SmartLifecycle

Direct Known Subclasses:

JmsInboundGatewaySpec.JmsInboundGatewayListenerContainerSpec

public class JmsInboundGatewaySpec<S extends JmsInboundGatewaySpec<S>>
extends MessagingGatewaySpec<S, JmsInboundGateway>

A MessagingGatewaySpec for a JmsInboundGateway.

Since:

5.0

Author:

Artem Bilan, Gary Russell

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JmsInboundGatewaySpec.JmsInboundGatewayListenerContainerSpec<S extends JmsListenerContainerSpec<S,C>, C extends AbstractMessageListenerContainer>	An AbstractMessageListenerContainer-based JmsInboundGatewaySpec extension.

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JmsInboundGatewaySpec(AbstractMessageListenerContainer listenerContainer)

Method Summary

Modifier and Type	Method	Description
S	correlationKey(String correlationKey)
S	defaultReplyDestination(Destination defaultReplyDestination)
S	defaultReplyQueueName(String destinationName)
S	defaultReplyTopicName(String destinationName)
S	destinationResolver(DestinationResolver destinationResolver)
S	explicitQosEnabledForReplies(boolean explicitQosEnabledForReplies)
S	extractReplyPayload(boolean extractReplyPayload)
S	extractRequestPayload(boolean extractRequestPayload)
S	jmsMessageConverter(MessageConverter messageConverter)
S	recoveryCallback(org.springframework.retry.RecoveryCallback<Message<?>> recoveryCallback)	Set a RecoveryCallback when using retry within the adapter.
S	replyDeliveryPersistent(boolean replyDeliveryPersistent)
S	replyPriority(int replyPriority)
S	replyTimeToLive(long replyTimeToLive)
S	replyToExpression(String replyToExpression)	Set a SpEL expression to resolve a 'replyTo' destination from a request Message as a root evaluation object if Message.getJMSReplyTo() is null.
S	replyToExpression(Expression replyToExpression)	Set a SpEL expression to resolve a 'replyTo' destination from a request Message as a root evaluation object if Message.getJMSReplyTo() is null.
S	replyToFunction(CheckedFunction<Message, ?, JMSException> replyToFunction)	Set a function to resolve a 'replyTo' destination from a request Message as a root evaluation object if Message.getJMSReplyTo() is null.
S	retryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate)	Set a RetryTemplate to use for retrying a message delivery within the adapter.
S	setHeaderMapper(JmsHeaderMapper headerMapper)
S	shutdownContainerOnStop(boolean shutdown)	Set to false to prevent listener container shutdown when the endpoint is stopped.

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

autoStartup, errorChannel, errorChannel, errorOnTimeout, id, observationConvention, phase, replyChannel, replyChannel, replyMapper, replyTimeout, requestChannel, requestChannel, requestMapper, requestTimeout, shouldTrack

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

_this, afterPropertiesSet, destroy, doGet, 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

Constructor Details

JmsInboundGatewaySpec

protected JmsInboundGatewaySpec(AbstractMessageListenerContainer listenerContainer)

Method Details

defaultReplyDestination

public S defaultReplyDestination(Destination defaultReplyDestination)

Parameters:

defaultReplyDestination - the defaultReplyDestination

Returns:

the spec.

See Also:

• ChannelPublishingJmsMessageListener.setDefaultReplyDestination(Destination)

defaultReplyQueueName

public S defaultReplyQueueName(String destinationName)

Parameters:

destinationName - the destinationName

Returns:

the spec.

See Also:

• ChannelPublishingJmsMessageListener.setDefaultReplyQueueName(String)

defaultReplyTopicName

public S defaultReplyTopicName(String destinationName)

Parameters:

destinationName - the destinationName

Returns:

the spec.

See Also:

• ChannelPublishingJmsMessageListener.setDefaultReplyTopicName(String)

replyTimeToLive

public S replyTimeToLive(long replyTimeToLive)

Parameters:

replyTimeToLive - the replyTimeToLive

Returns:

the spec.

See Also:

• ChannelPublishingJmsMessageListener.setReplyTimeToLive(long)

replyPriority

public S replyPriority(int replyPriority)

Parameters:

replyPriority - the replyPriority

Returns:

the spec.

See Also:

• ChannelPublishingJmsMessageListener.setReplyPriority(int)

replyDeliveryPersistent

public S replyDeliveryPersistent(boolean replyDeliveryPersistent)

Parameters:

replyDeliveryPersistent - the replyDeliveryPersistent

Returns:

the spec.

See Also:

• ChannelPublishingJmsMessageListener.setReplyDeliveryPersistent(boolean)

correlationKey

public S correlationKey(String correlationKey)

Parameters:

correlationKey - the correlationKey

Returns:

the spec.

See Also:

• ChannelPublishingJmsMessageListener.setCorrelationKey(String)

explicitQosEnabledForReplies

public S explicitQosEnabledForReplies(boolean explicitQosEnabledForReplies)

Parameters:

explicitQosEnabledForReplies - the explicitQosEnabledForReplies.

Returns:

the spec.

See Also:

• ChannelPublishingJmsMessageListener.setExplicitQosEnabledForReplies(boolean)

destinationResolver

public S destinationResolver(DestinationResolver destinationResolver)

Parameters:

destinationResolver - the destinationResolver.

Returns:

the spec.

See Also:

• ChannelPublishingJmsMessageListener.setDestinationResolver(DestinationResolver)

replyToExpression

public S replyToExpression(String replyToExpression)

Set a SpEL expression to resolve a 'replyTo' destination from a request Message as a root evaluation object if Message.getJMSReplyTo() is null.

Parameters:

replyToExpression - the SpEL expression for 'replyTo' destination.

Returns:

the spec.

Since:

6.1

See Also:

• ChannelPublishingJmsMessageListener.setReplyToExpression(Expression)

replyToFunction

public S replyToFunction(CheckedFunction<Message, ?, JMSException> replyToFunction)

Set a function to resolve a 'replyTo' destination from a request Message as a root evaluation object if Message.getJMSReplyTo() is null.

Parameters:

replyToFunction - the function for 'replyTo' destination.

Returns:

the spec.

Since:

6.1

See Also:

• ChannelPublishingJmsMessageListener.setReplyToExpression(Expression)

replyToExpression

public S replyToExpression(Expression replyToExpression)

Set a SpEL expression to resolve a 'replyTo' destination from a request Message as a root evaluation object if Message.getJMSReplyTo() is null.

Parameters:

replyToExpression - the SpEL expression for 'replyTo' destination.

Returns:

the spec.

Since:

6.1

See Also:

• ChannelPublishingJmsMessageListener.setReplyToExpression(Expression)

jmsMessageConverter

public S jmsMessageConverter(MessageConverter messageConverter)

Parameters:

messageConverter - the messageConverter.

Returns:

the spec.

See Also:

• ChannelPublishingJmsMessageListener.setMessageConverter(MessageConverter)

setHeaderMapper

public S setHeaderMapper(JmsHeaderMapper headerMapper)

Parameters:

headerMapper - the headerMapper.

Returns:

the spec.

See Also:

• ChannelPublishingJmsMessageListener.setHeaderMapper(JmsHeaderMapper)

extractRequestPayload

public S extractRequestPayload(boolean extractRequestPayload)

Parameters:

extractRequestPayload - the extractRequestPayload.

Returns:

the spec.

See Also:

• ChannelPublishingJmsMessageListener.setExtractRequestPayload(boolean)

extractReplyPayload

public S extractReplyPayload(boolean extractReplyPayload)

Parameters:

extractReplyPayload - the extractReplyPayload.

Returns:

the spec.

See Also:

• ChannelPublishingJmsMessageListener.setExtractReplyPayload(boolean)

retryTemplate

public S retryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate)

Set a RetryTemplate to use for retrying a message delivery within the adapter. Unlike adding retry at the container level, this can be used with an ErrorMessageSendingRecoverer RecoveryCallback to publish to the error channel after retries are exhausted. You generally should not configure an error channel when using retry here, use a RecoveryCallback instead.

Parameters:

retryTemplate - the template.

Since:

6.3

See Also:

• recoveryCallback(RecoveryCallback)

recoveryCallback

public S recoveryCallback(org.springframework.retry.RecoveryCallback<Message<?>> recoveryCallback)

Set a RecoveryCallback when using retry within the adapter.

Parameters:

recoveryCallback - the callback.

Since:

6.3

See Also:

• retryTemplate(RetryTemplate)

shutdownContainerOnStop

public S shutdownContainerOnStop(boolean shutdown)

Set to false to prevent listener container shutdown when the endpoint is stopped. Then, if so configured, any cached consumer(s) in the container will remain. Otherwise, the shared connection and will be closed and the listener invokers shut down; this behavior is new starting with version 5.1. Default: true.

Parameters:

shutdown - false to not shutdown.

Returns:

the spec.

Since:

5.1