Class JmsOutboundChannelAdapterSpec<S extends JmsOutboundChannelAdapterSpec<S>>

java.lang.Object

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

org.springframework.integration.dsl.MessageHandlerSpec<S,JmsSendingMessageHandler>

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

Type Parameters:

S - the target JmsOutboundChannelAdapterSpec implementation type.

All Implemented Interfaces:

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

Direct Known Subclasses:

JmsOutboundChannelAdapterSpec.JmsOutboundChannelSpecTemplateAware

public class JmsOutboundChannelAdapterSpec<S extends JmsOutboundChannelAdapterSpec<S>>
extends MessageHandlerSpec<S,JmsSendingMessageHandler>

A MessageHandlerSpec for a JmsSendingMessageHandler.

Since:

5.0

Author:

Artem Bilan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JmsOutboundChannelAdapterSpec.JmsOutboundChannelSpecTemplateAware	A JmsTemplate-based JmsOutboundChannelAdapterSpec extension.

Field Summary

Fields

Modifier and Type	Field	Description
protected final JmsTemplateSpec	jmsTemplateSpec

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	JmsOutboundChannelAdapterSpec(JmsTemplate jmsTemplate)

Method Summary

Modifier and Type	Method	Description
S	deliveryModeExpression(String deliveryModeExpression)	Specify a SpEL expression to evaluate a deliveryMode for JMS message to send.
<P> S	deliveryModeFunction(Function<Message<P>,?> deliveryModeFunction)	Specify a Function to resolve a deliveryMode for JMS message to send.
S	destination(Destination destination)	Configure the destination to which this adapter will send messages.
S	destination(String destination)	Configure the name of the destination to which this adapter will send messages.
<P> S	destination(Function<Message<P>,?> destinationFunction)	Configure a Function that will be invoked at run time to determine the destination to which a message will be sent.
S	destinationExpression(String destination)	Configure a SpEL expression that will evaluate, at run time, the destination to which a message will be sent.
S	extractPayload(boolean extractPayload)
S	headerMapper(JmsHeaderMapper headerMapper)
S	timeToLiveExpression(String timeToLiveExpression)	Specify a SpEL expression to evaluate a timeToLive for JMS message to send.
<P> S	timeToLiveFunction(Function<Message<P>,?> timeToLiveFunction)	Specify a Function to resolve a timeToLive for JMS message to send.

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

Field Details

jmsTemplateSpec

protected final JmsTemplateSpec jmsTemplateSpec

Constructor Details

JmsOutboundChannelAdapterSpec

protected JmsOutboundChannelAdapterSpec(JmsTemplate jmsTemplate)

Method Details

extractPayload

public S extractPayload(boolean extractPayload)

Parameters:

extractPayload - the extractPayload flag.

Returns:

the current JmsOutboundChannelAdapterSpec.

See Also:

• JmsSendingMessageHandler.setExtractPayload(boolean)

headerMapper

public S headerMapper(JmsHeaderMapper headerMapper)

Parameters:

headerMapper - the headerMapper.

Returns:

the current JmsOutboundChannelAdapterSpec.

See Also:

• JmsSendingMessageHandler.setHeaderMapper(JmsHeaderMapper)

destination

public S destination(Destination destination)

Configure the destination to which this adapter will send messages.

Parameters:

destination - the destination.

Returns:

the current JmsOutboundChannelAdapterSpec.

See Also:

• JmsSendingMessageHandler.setDestination(Destination)

destination

public S destination(String destination)

Configure the name of the destination to which this adapter will send messages.

Parameters:

destination - the destination name.

Returns:

the current JmsOutboundChannelAdapterSpec.

See Also:

• JmsSendingMessageHandler.setDestinationName(String)

destinationExpression

public S destinationExpression(String destination)

Configure a SpEL expression that will evaluate, at run time, the destination to which a message will be sent.

Parameters:

destination - the destination name.

Returns:

the current JmsOutboundChannelAdapterSpec.

See Also:

• JmsSendingMessageHandler.setDestinationExpression(org.springframework.expression.Expression)

destination

public <P> S destination(Function<Message<P>,?> destinationFunction)

Configure a Function that will be invoked at run time to determine the destination to which a message will be sent. Typically used with a Java 8 Lambda expression:

 
 .<Foo>destination(m -> m.getPayload().getState())
 
 

Type Parameters:

P - the expected payload type.

Parameters:

destinationFunction - the destination function.

Returns:

the current JmsOutboundChannelAdapterSpec.

See Also:

• JmsSendingMessageHandler.setDestinationExpression(org.springframework.expression.Expression)
• FunctionExpression

deliveryModeExpression

public S deliveryModeExpression(String deliveryModeExpression)

Specify a SpEL expression to evaluate a deliveryMode for JMS message to send.

Parameters:

deliveryModeExpression - to use

Returns:

the spec

Since:

5.1

deliveryModeFunction

public <P> S deliveryModeFunction(Function<Message<P>,?> deliveryModeFunction)

Specify a Function to resolve a deliveryMode for JMS message to send.

Type Parameters:

P - the expected payload type.

Parameters:

deliveryModeFunction - to use

Returns:

the spec

Since:

5.1

See Also:

• FunctionExpression

timeToLiveExpression

public S timeToLiveExpression(String timeToLiveExpression)

Specify a SpEL expression to evaluate a timeToLive for JMS message to send.

Parameters:

timeToLiveExpression - to use

Returns:

the spec

Since:

5.1

timeToLiveFunction

public <P> S timeToLiveFunction(Function<Message<P>,?> timeToLiveFunction)

Specify a Function to resolve a timeToLive for JMS message to send.

Type Parameters:

P - the expected payload type.

Parameters:

timeToLiveFunction - to use

Returns:

the spec

Since:

5.1

See Also:

• FunctionExpression