Package org.springframework.integration.jms.dsl

Class JmsMessageDrivenChannelAdapterSpec<S extends JmsMessageDrivenChannelAdapterSpec<S>>

java.lang.Object

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

org.springframework.integration.dsl.MessageProducerSpec<S,JmsMessageDrivenEndpoint>

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

Type Parameters:

S - the target JmsMessageDrivenChannelAdapterSpec implementation type.

All Implemented Interfaces:

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

Direct Known Subclasses:

JmsMessageDrivenChannelAdapterSpec.JmsMessageDrivenChannelAdapterListenerContainerSpec

public class JmsMessageDrivenChannelAdapterSpec<S extends JmsMessageDrivenChannelAdapterSpec<S>>
extends MessageProducerSpec<S,JmsMessageDrivenEndpoint>

A MessageProducerSpec for JmsMessageDrivenEndpoints.

Since:

5.0

Author:

Artem Bilan, Gary Russell

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JmsMessageDrivenChannelAdapterSpec.JmsMessageDrivenChannelAdapterListenerContainerSpec<S extends JmsListenerContainerSpec<S,C>,C extends AbstractMessageListenerContainer>

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	JmsMessageDrivenChannelAdapterSpec(AbstractMessageListenerContainer listenerContainer)

Method Summary

Modifier and Type	Method	Description
S	extractPayload(boolean extractRequestPayload)
S	headerMapper(JmsHeaderMapper headerMapper)
S	jmsMessageConverter(MessageConverter messageConverter)
S	recoveryCallback(org.springframework.retry.RecoveryCallback<Message<?>> recoveryCallback)	Set a RecoveryCallback when using retry within the adapter.
S	retryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate)	Set a RetryTemplate to use for retrying a message delivery within the adapter.
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.MessageProducerSpec

autoStartup, errorChannel, errorChannel, errorMessageStrategy, id, observationConvention, outputChannel, outputChannel, phase, sendTimeout, 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

JmsMessageDrivenChannelAdapterSpec

protected JmsMessageDrivenChannelAdapterSpec(AbstractMessageListenerContainer listenerContainer)

Method Details

jmsMessageConverter

public S jmsMessageConverter(MessageConverter messageConverter)

Parameters:

messageConverter - the messageConverter.

Returns:

the spec.

See Also:

• ChannelPublishingJmsMessageListener.setMessageConverter(MessageConverter)

headerMapper

public S headerMapper(JmsHeaderMapper headerMapper)

Parameters:

headerMapper - the headerMapper.

Returns:

the spec.

See Also:

• ChannelPublishingJmsMessageListener.setHeaderMapper(JmsHeaderMapper)

extractPayload

public S extractPayload(boolean extractRequestPayload)

Parameters:

extractRequestPayload - the extractRequestPayload.

Returns:

the spec.

See Also:

• ChannelPublishingJmsMessageListener.setExtractRequestPayload(boolean)

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

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)