Package org.springframework.integration.jms.dsl

Class JmsOutboundGatewaySpec

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<T>

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

org.springframework.integration.dsl.MessageHandlerSpec<JmsOutboundGatewaySpec,JmsOutboundGateway>

org.springframework.integration.jms.dsl.JmsOutboundGatewaySpec

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean<JmsOutboundGateway>, InitializingBean, Lifecycle, Phased, SmartLifecycle

public class JmsOutboundGatewaySpec
extends MessageHandlerSpec<JmsOutboundGatewaySpec,JmsOutboundGateway>

A MessageHandlerSpec for a JmsOutboundGateway.

Since:

5.0

Author:

Artem Bilan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	JmsOutboundGatewaySpec.ReplyContainerSpec	An IntegrationComponentSpec for JmsOutboundGateway.ReplyContainerProperties.

Field Summary

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

PARSER, target

Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

logger

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	JmsOutboundGatewaySpec(javax.jms.ConnectionFactory connectionFactory)

Method Summary

Modifier and Type	Method	Description
JmsOutboundGatewaySpec	correlationKey(String correlationKey)
JmsOutboundGatewaySpec	deliveryPersistent(boolean deliveryPersistent)
JmsOutboundGatewaySpec	destinationResolver(DestinationResolver destinationResolver)
JmsOutboundGatewaySpec	explicitQosEnabled(boolean explicitQosEnabled)
JmsOutboundGatewaySpec	extractReplyPayload(boolean extractPayload)
JmsOutboundGatewaySpec	extractRequestPayload(boolean extractPayload)
JmsOutboundGatewaySpec	headerMapper(JmsHeaderMapper headerMapper)
JmsOutboundGatewaySpec	jmsMessageConverter(MessageConverter messageConverter)
JmsOutboundGatewaySpec	priority(int priority)	Default priority.
JmsOutboundGatewaySpec	receiveTimeout(long receiveTimeout)
JmsOutboundGatewaySpec	replyContainer()	Configure a reply container with default properties.
JmsOutboundGatewaySpec	replyContainer(Consumer<JmsOutboundGatewaySpec.ReplyContainerSpec> configurer)	Configure a reply container with a reply container specification determined by invoking the Consumer callback with a JmsOutboundGatewaySpec.ReplyContainerSpec.
JmsOutboundGatewaySpec	replyDestination(String destination)
<P> JmsOutboundGatewaySpec	replyDestination(Function<Message<P>,?> destinationFunction)	Configure a Function that will be invoked at run time to determine the destination from which a reply will be received.
JmsOutboundGatewaySpec	replyDestination(javax.jms.Destination destination)
JmsOutboundGatewaySpec	replyDestinationExpression(String destination)
JmsOutboundGatewaySpec	replyPubSubDomain(boolean pubSubDomain)
JmsOutboundGatewaySpec	requestDestination(String destination)
<P> JmsOutboundGatewaySpec	requestDestination(Function<Message<P>,?> destinationFunction)	Configure a Function that will be invoked at runtime to determine the destination to which a message will be sent.
JmsOutboundGatewaySpec	requestDestination(javax.jms.Destination destination)
JmsOutboundGatewaySpec	requestDestinationExpression(String destination)
JmsOutboundGatewaySpec	requestPubSubDomain(boolean pubSubDomain)
JmsOutboundGatewaySpec	timeToLive(long timeToLive)

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

_this, createInstance, destroyInstance, doGet, get, getId, getObjectType, getPhase, id, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class java.lang.Object

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

Constructor Details

JmsOutboundGatewaySpec

protected JmsOutboundGatewaySpec(javax.jms.ConnectionFactory connectionFactory)

Method Details

extractRequestPayload

public JmsOutboundGatewaySpec extractRequestPayload(boolean extractPayload)

Parameters:

extractPayload - the extractPayload.

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setExtractRequestPayload(boolean)

extractReplyPayload

public JmsOutboundGatewaySpec extractReplyPayload(boolean extractPayload)

Parameters:

extractPayload - the extractPayload.

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setExtractReplyPayload(boolean)

headerMapper

public JmsOutboundGatewaySpec headerMapper(JmsHeaderMapper headerMapper)

Parameters:

headerMapper - the headerMapper.

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setHeaderMapper(JmsHeaderMapper)

requestDestination

public JmsOutboundGatewaySpec requestDestination(javax.jms.Destination destination)

Parameters:

destination - the destination.

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setRequestDestination(Destination)

requestDestination

public JmsOutboundGatewaySpec requestDestination(String destination)

Parameters:

destination - the destination name.

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setRequestDestinationName(String)

requestDestinationExpression

public JmsOutboundGatewaySpec requestDestinationExpression(String destination)

Parameters:

destination - the destination expression.

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setRequestDestinationExpression(org.springframework.expression.Expression)

requestDestination

public <P> JmsOutboundGatewaySpec requestDestination(Function<Message<P>,?> destinationFunction)

Configure a Function that will be invoked at runtime 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 JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setRequestDestinationExpression(org.springframework.expression.Expression), FunctionExpression

replyDestination

public JmsOutboundGatewaySpec replyDestination(javax.jms.Destination destination)

Parameters:

destination - the destination.

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setReplyDestination(Destination)

replyDestination

public JmsOutboundGatewaySpec replyDestination(String destination)

Parameters:

destination - the destination name.

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setReplyDestinationName(String)

replyDestinationExpression

public JmsOutboundGatewaySpec replyDestinationExpression(String destination)

Parameters:

destination - the destination expression.

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setReplyDestinationExpression(org.springframework.expression.Expression)

replyDestination

public <P> JmsOutboundGatewaySpec replyDestination(Function<Message<P>,?> destinationFunction)

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

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

Type Parameters:

P - the expected payload type.

Parameters:

destinationFunction - the destination function.

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setReplyDestinationExpression(org.springframework.expression.Expression), FunctionExpression

destinationResolver

public JmsOutboundGatewaySpec destinationResolver(DestinationResolver destinationResolver)

Parameters:

destinationResolver - the destinationResolver.

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setDestinationResolver(DestinationResolver)

jmsMessageConverter

public JmsOutboundGatewaySpec jmsMessageConverter(MessageConverter messageConverter)

Parameters:

messageConverter - the messageConverter.

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setMessageConverter(MessageConverter)

correlationKey

public JmsOutboundGatewaySpec correlationKey(String correlationKey)

Parameters:

correlationKey - the correlationKey

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setCorrelationKey(String)

requestPubSubDomain

public JmsOutboundGatewaySpec requestPubSubDomain(boolean pubSubDomain)

Parameters:

pubSubDomain - the pubSubDomain

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setReplyPubSubDomain(boolean)

replyPubSubDomain

public JmsOutboundGatewaySpec replyPubSubDomain(boolean pubSubDomain)

Parameters:

pubSubDomain - the pubSubDomain

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setRequestPubSubDomain(boolean)

deliveryPersistent

public JmsOutboundGatewaySpec deliveryPersistent(boolean deliveryPersistent)

Parameters:

deliveryPersistent - the deliveryPersistent.

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setDeliveryPersistent(boolean)

priority

public JmsOutboundGatewaySpec priority(int priority)

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

Parameters:

priority - the priority.

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setDefaultPriority(int)

timeToLive

public JmsOutboundGatewaySpec timeToLive(long timeToLive)

Parameters:

timeToLive - the timeToLive.

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setTimeToLive(long)

receiveTimeout

public JmsOutboundGatewaySpec receiveTimeout(long receiveTimeout)

Parameters:

receiveTimeout - the receiveTimeout.

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setReceiveTimeout(long)

explicitQosEnabled

public JmsOutboundGatewaySpec explicitQosEnabled(boolean explicitQosEnabled)

Parameters:

explicitQosEnabled - the explicitQosEnabled.

Returns:

the current JmsOutboundGatewaySpec.

See Also:

JmsOutboundGateway.setExplicitQosEnabled(boolean)

replyContainer

public JmsOutboundGatewaySpec replyContainer()

Configure a reply container with default properties.

Returns:

the current JmsOutboundGatewaySpec.

replyContainer

public JmsOutboundGatewaySpec replyContainer(Consumer<JmsOutboundGatewaySpec.ReplyContainerSpec> configurer)

Configure a reply container with a reply container specification determined by invoking the Consumer callback with a JmsOutboundGatewaySpec.ReplyContainerSpec.

Parameters:

configurer - the configurer.

Returns:

the current JmsOutboundGatewaySpec.