org.springframework.integration.amqp.inbound

Class AmqpInboundChannelAdapter

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.endpoint.AbstractEndpoint

org.springframework.integration.endpoint.MessageProducerSupport

org.springframework.integration.amqp.inbound.AmqpInboundChannelAdapter

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.SmartInitializingSingleton, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, ExpressionCapable, OrderlyShutdownCapable, MessageProducer, NamedComponent, TrackableComponent

public class AmqpInboundChannelAdapter
extends MessageProducerSupport
implements OrderlyShutdownCapable

Adapter that receives Messages from an AMQP Queue, converts them into Spring Integration Messages, and sends the results to a Message Channel.

Since:

2.1

Author:

Mark Fisher, Gary Russell, Artem Bilan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AmqpInboundChannelAdapter.Listener

Field Summary

Fields inherited from class org.springframework.integration.endpoint.AbstractEndpoint

lifecycleCondition, lifecycleLock

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Constructor Summary

Constructors

Constructor and Description
AmqpInboundChannelAdapter(org.springframework.amqp.rabbit.listener.AbstractMessageListenerContainer listenerContainer)

Method Summary

Modifier and Type	Method and Description
int	afterShutdown() Called after normal shutdown of schedulers, executors etc, and after the shutdown delay has elapsed, but before any forced shutdown of any remaining active scheduler/executor threads.Can optionally return the number of active messages still in process.
int	beforeShutdown() Called before shutdown begins.
protected void	doStart() Takes no action by default.
protected void	doStop() Takes no action by default.
java.lang.String	getComponentType() Subclasses may implement this method to provide component type information.
protected org.springframework.core.AttributeAccessor	getErrorMessageAttributes(org.springframework.messaging.Message<?> message) Populate an AttributeAccessor to be used when building an error message with the errorMessageStrategy.
protected void	onInit() Subclasses may implement this for initialization logic.
void	setHeaderMapper(AmqpHeaderMapper headerMapper)
void	setMessageConverter(org.springframework.amqp.support.converter.MessageConverter messageConverter)
void	setRecoveryCallback(org.springframework.retry.RecoveryCallback<? extends java.lang.Object> recoveryCallback) Set a RecoveryCallback when using retry within the adapter.
void	setRetryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate) Set a RetryTemplate to use for retrying a message delivery within the adapter.

Methods inherited from class org.springframework.integration.endpoint.MessageProducerSupport

afterSingletonsInstantiated, buildErrorMessage, getErrorChannel, getMessagingTemplate, getOutputChannel, sendErrorMessageIfNecessary, sendMessage, setErrorChannel, setErrorChannelName, setErrorMessageStrategy, setOutputChannel, setOutputChannelName, setSendTimeout, setShouldTrack

Methods inherited from class org.springframework.integration.endpoint.AbstractEndpoint

doStop, getPhase, isAutoStartup, isRunning, setAutoStartup, setPhase, setTaskScheduler, start, stop, stop

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getComponentName

Constructor Detail

AmqpInboundChannelAdapter

public AmqpInboundChannelAdapter(org.springframework.amqp.rabbit.listener.AbstractMessageListenerContainer listenerContainer)

Method Detail

setMessageConverter

public void setMessageConverter(org.springframework.amqp.support.converter.MessageConverter messageConverter)

setHeaderMapper

public void setHeaderMapper(AmqpHeaderMapper headerMapper)

setRetryTemplate

public void setRetryTemplate(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:

4.3.10.

See Also:

setRecoveryCallback(RecoveryCallback)

setRecoveryCallback

public void setRecoveryCallback(org.springframework.retry.RecoveryCallback<? extends java.lang.Object> recoveryCallback)

Set a RecoveryCallback when using retry within the adapter.

Parameters:

recoveryCallback - the callback.

Since:

4.3.10

See Also:

setRetryTemplate(RetryTemplate)

getComponentType

public java.lang.String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class IntegrationObjectSupport

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class MessageProducerSupport

doStart

protected void doStart()

Description copied from class: MessageProducerSupport

Takes no action by default. Subclasses may override this if they need lifecycle-managed behavior. Protected by 'lifecycleLock'.

Overrides:

doStart in class MessageProducerSupport

doStop

protected void doStop()

Description copied from class: MessageProducerSupport

Takes no action by default. Subclasses may override this if they need lifecycle-managed behavior.

Overrides:

doStop in class MessageProducerSupport

beforeShutdown

public int beforeShutdown()

Description copied from interface: OrderlyShutdownCapable

Called before shutdown begins. Implementations should stop accepting new messages. Can optionally return the number of active messages in process.

Specified by:

beforeShutdown in interface OrderlyShutdownCapable

Returns:

The number of active messages if available.

afterShutdown

public int afterShutdown()

Description copied from interface: OrderlyShutdownCapable

Called after normal shutdown of schedulers, executors etc, and after the shutdown delay has elapsed, but before any forced shutdown of any remaining active scheduler/executor threads.Can optionally return the number of active messages still in process.

Specified by:

afterShutdown in interface OrderlyShutdownCapable

Returns:

The number of active messages if available.

getErrorMessageAttributes

protected org.springframework.core.AttributeAccessor getErrorMessageAttributes(org.springframework.messaging.Message<?> message)

Description copied from class: MessageProducerSupport

Populate an AttributeAccessor to be used when building an error message with the errorMessageStrategy.

Overrides:

getErrorMessageAttributes in class MessageProducerSupport

Parameters:

message - the message.

Returns:

the attributes.