Class AmqpBaseInboundGatewaySpec<S extends AmqpBaseInboundGatewaySpec<S>>

java.lang.Object

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

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

org.springframework.integration.amqp.dsl.AmqpBaseInboundGatewaySpec<S>

Type Parameters:

S - the target AmqpBaseInboundGatewaySpec implementation type.

All Implemented Interfaces:

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

Direct Known Subclasses:

AmqpInboundGatewaySpec

public class AmqpBaseInboundGatewaySpec<S extends AmqpBaseInboundGatewaySpec<S>>
extends MessagingGatewaySpec<S, AmqpInboundGateway>

A base MessagingGatewaySpec implementation for AmqpInboundGateway endpoint options. Doesn't allow to specify listenerContainer options.

Since:

5.0

Author:

Artem Bilan

See Also:

• AmqpInboundGateway

Field Summary

Fields

Modifier and Type	Field	Description
protected final DefaultAmqpHeaderMapper	headerMapper

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	AmqpBaseInboundGatewaySpec(AmqpInboundGateway gateway)

Method Summary

Modifier and Type	Method	Description
S	batchingStrategy(BatchingStrategy batchingStrategy)	Set a batching strategy to use when de-batching messages.
S	bindSourceMessage(boolean bindSourceMessage)	Set to true to bind the source message in the headers.
S	defaultReplyTo(String defaultReplyTo)	The defaultReplyTo address with the form
S	headerMapper(AmqpHeaderMapper headerMapper)	Configure the gateway's AmqpHeaderMapper; defaults to DefaultAmqpHeaderMapper.
S	mappedReplyHeaders(String... headers)	Only applies if the default header mapper is used.
S	mappedRequestHeaders(String... headers)	Only applies if the default header mapper is used.
S	messageConverter(MessageConverter messageConverter)	Configure the gateway's MessageConverter; defaults to SimpleMessageConverter.
S	messageRecoverer(MessageRecoverer messageRecoverer)	Set a MessageRecoverer when using retry within the adapter.
S	recoveryCallback(RecoveryCallback<?> recoveryCallback)	Set a RecoveryCallback when using retry within the adapter.
S	replyHeadersMappedLast(boolean replyHeadersMappedLast)	When mapping headers for the outbound (reply) message, determine whether the headers are mapped before the message is converted, or afterwards.
S	retryTemplate(RetryTemplate retryTemplate)	Set a RetryTemplate to use for retrying a message delivery within the adapter.

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

Methods inherited from interface org.springframework.context.SmartLifecycle

isPauseable

Field Details

headerMapper

protected final DefaultAmqpHeaderMapper headerMapper

Constructor Details

AmqpBaseInboundGatewaySpec

protected AmqpBaseInboundGatewaySpec(AmqpInboundGateway gateway)

Method Details

messageConverter

public S messageConverter(MessageConverter messageConverter)

Configure the gateway's MessageConverter; defaults to SimpleMessageConverter.

Parameters:

messageConverter - the messageConverter.

Returns:

the spec.

See Also:

• AmqpInboundGateway.setMessageConverter(org.springframework.amqp.support.converter.MessageConverter)

headerMapper

public S headerMapper(AmqpHeaderMapper headerMapper)

Configure the gateway's AmqpHeaderMapper; defaults to DefaultAmqpHeaderMapper.

Parameters:

headerMapper - the headerMapper.

Returns:

the spec.

See Also:

• AmqpInboundGateway.setHeaderMapper(AmqpHeaderMapper)

mappedRequestHeaders

public S mappedRequestHeaders(String... headers)

Only applies if the default header mapper is used.

Parameters:

headers - the headers.

Returns:

the spec.

See Also:

• AbstractHeaderMapper.setRequestHeaderNames(String[])

mappedReplyHeaders

public S mappedReplyHeaders(String... headers)

Only applies if the default header mapper is used.

Parameters:

headers - the headers.

Returns:

the spec.

See Also:

• AbstractHeaderMapper.setReplyHeaderNames(String[])

defaultReplyTo

public S defaultReplyTo(String defaultReplyTo)

The defaultReplyTo address with the form

 (exchange)/(routingKey)
 

or

 (queueName)
 

if the request message doesn't have a replyTo property. The second form uses the default exchange ("") and the queue name as the routing key.

Parameters:

defaultReplyTo - the default replyTo address to use.

Returns:

the spec.

See Also:

• AmqpInboundGateway.setDefaultReplyTo(java.lang.String)

retryTemplate

public S retryTemplate(RetryTemplate retryTemplate)

Set a RetryTemplate to use for retrying a message delivery within the adapter.

Parameters:

retryTemplate - the template.

Returns:

the spec.

Since:

5.0.2

See Also:

• AmqpInboundGateway.setRetryTemplate(RetryTemplate)

recoveryCallback

public S recoveryCallback(RecoveryCallback<?> recoveryCallback)

Set a RecoveryCallback when using retry within the adapter.

Parameters:

recoveryCallback - the callback.

Returns:

the spec.

Since:

5.0.2

See Also:

• AmqpInboundGateway.setRecoveryCallback(RecoveryCallback)

batchingStrategy

public S batchingStrategy(BatchingStrategy batchingStrategy)

Set a batching strategy to use when de-batching messages.

Parameters:

batchingStrategy - the strategy to use.

Returns:

the spec.

Since:

5.2.1

See Also:

• AmqpInboundGateway.setBatchingStrategy(BatchingStrategy)

bindSourceMessage

public S bindSourceMessage(boolean bindSourceMessage)

Set to true to bind the source message in the headers.

Parameters:

bindSourceMessage - true to bind.

Returns:

the spec.

Since:

5.1.9

See Also:

• AmqpInboundGateway.setBindSourceMessage(boolean)

replyHeadersMappedLast

public S replyHeadersMappedLast(boolean replyHeadersMappedLast)

When mapping headers for the outbound (reply) message, determine whether the headers are mapped before the message is converted, or afterwards.

Parameters:

replyHeadersMappedLast - true if reply headers are mapped after conversion.

Returns:

the spec.

Since:

5.1.9

See Also:

• AmqpInboundGateway.setReplyHeadersMappedLast(boolean)

messageRecoverer

public S messageRecoverer(MessageRecoverer messageRecoverer)

Set a MessageRecoverer when using retry within the adapter.

Parameters:

messageRecoverer - the callback.

Returns:

the spec.

Since:

5.5

See Also:

• AmqpInboundChannelAdapter.setMessageRecoverer(MessageRecoverer)