org.springframework.integration.amqp.inbound

Class AmqpMessageSource

java.lang.Object

org.springframework.integration.util.AbstractExpressionEvaluator

org.springframework.integration.endpoint.AbstractMessageSource<Object>

org.springframework.integration.amqp.inbound.AmqpMessageSource

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, MessageSource<Object>, NamedComponent, BaseSourceMetrics, IntegrationManagement, MessageSourceMetrics

public class AmqpMessageSource
extends AbstractMessageSource<Object>

A pollable MessageSource for RabbitMQ.

Since:

5.0.1

Author:

Gary Russell

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AmqpMessageSource.AmqpAckCallback
static class	AmqpMessageSource.AmqpAckCallbackFactory
static class	AmqpMessageSource.AmqpAckInfo Information for building an AmqpAckCallback.

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.util.AbstractExpressionEvaluator

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Constructor Summary

Constructors

Constructor and Description
AmqpMessageSource(ConnectionFactory connectionFactory, AmqpMessageSource.AmqpAckCallbackFactory ackCallbackFactory, String queue)
AmqpMessageSource(ConnectionFactory connectionFactory, String queue)

Method Summary

Modifier and Type	Method and Description
protected AbstractIntegrationMessageBuilder<Object>	doReceive() Subclasses must implement this method.
protected org.springframework.amqp.rabbit.batch.BatchingStrategy	getBatchingStrategy()
String	getComponentType()
protected AmqpHeaderMapper	getHeaderMapper()
protected MessageConverter	getMessageConverter()
protected MessagePropertiesConverter	getPropertiesConverter()
protected boolean	isRawMessageHeader()
protected boolean	isTransacted()
void	setBatchingStrategy(org.springframework.amqp.rabbit.batch.BatchingStrategy batchingStrategy) Set a batching strategy to use when de-batching messages.
void	setHeaderMapper(AmqpHeaderMapper headerMapper) Set a custom AmqpHeaderMapper to replace the default DefaultAmqpHeaderMapper.inboundMapper().
void	setMessageConverter(MessageConverter messageConverter) Set a custom MessageConverter to replace the default SimpleMessageConverter.
void	setPropertiesConverter(MessagePropertiesConverter propertiesConverter) Set a custom MessagePropertiesConverter to replace the default DefaultMessagePropertiesConverter.
void	setRawMessageHeader(boolean rawMessageHeader) Set to true to include the raw spring-amqp message as a header with key AmqpMessageHeaderErrorMessageStrategy.AMQP_RAW_MESSAGE, enabling callers to have access to the message to process errors.
void	setTransacted(boolean transacted) Set to true to use a transacted channel for the ack.

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

buildMessage, destroy, getBeanName, getComponentName, getManagedName, getManagedType, getMessageCount, getMessageCountLong, getOverrides, isCountsEnabled, isLoggingEnabled, receive, registerMetricsCaptor, reset, setBeanName, setCountsEnabled, setHeaderExpressions, setLoggingEnabled, setManagedName, setManagedType

Methods inherited from class org.springframework.integration.util.AbstractExpressionEvaluator

afterPropertiesSet, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, getBeanFactory, getEvaluationContext, getEvaluationContext, getMessageBuilderFactory, onInit, setBeanFactory, setConversionService

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.integration.support.management.MessageSourceMetrics

messageCount

Constructor Detail

AmqpMessageSource

public AmqpMessageSource(ConnectionFactory connectionFactory,
                         String queue)

AmqpMessageSource

public AmqpMessageSource(ConnectionFactory connectionFactory,
                         AmqpMessageSource.AmqpAckCallbackFactory ackCallbackFactory,
                         String queue)

Method Detail

isTransacted

protected boolean isTransacted()

setTransacted

public void setTransacted(boolean transacted)

Set to true to use a transacted channel for the ack.

Parameters:

transacted - true for transacted.

getPropertiesConverter

protected MessagePropertiesConverter getPropertiesConverter()

setPropertiesConverter

public void setPropertiesConverter(MessagePropertiesConverter propertiesConverter)

Set a custom MessagePropertiesConverter to replace the default DefaultMessagePropertiesConverter.

Parameters:

propertiesConverter - the converter.

getHeaderMapper

protected AmqpHeaderMapper getHeaderMapper()

setHeaderMapper

public void setHeaderMapper(AmqpHeaderMapper headerMapper)

Set a custom AmqpHeaderMapper to replace the default DefaultAmqpHeaderMapper.inboundMapper().

Parameters:

headerMapper - the header mapper.

getMessageConverter

protected MessageConverter getMessageConverter()

setMessageConverter

public void setMessageConverter(MessageConverter messageConverter)

Set a custom MessageConverter to replace the default SimpleMessageConverter.

Parameters:

messageConverter - the converter.

isRawMessageHeader

protected boolean isRawMessageHeader()

setRawMessageHeader

public void setRawMessageHeader(boolean rawMessageHeader)

Set to true to include the raw spring-amqp message as a header with key AmqpMessageHeaderErrorMessageStrategy.AMQP_RAW_MESSAGE, enabling callers to have access to the message to process errors. The raw message is also added to the common header IntegrationMessageHeaderAccessor.SOURCE_DATA.

Parameters:

rawMessageHeader - true to include the headers.

getBatchingStrategy

protected org.springframework.amqp.rabbit.batch.BatchingStrategy getBatchingStrategy()

setBatchingStrategy

public void setBatchingStrategy(org.springframework.amqp.rabbit.batch.BatchingStrategy batchingStrategy)

Set a batching strategy to use when de-batching messages. Default is SimpleBatchingStrategy.

Parameters:

batchingStrategy - the strategy.

Since:

5.2

getComponentType

public String getComponentType()

doReceive

protected AbstractIntegrationMessageBuilder<Object> doReceive()

Description copied from class: AbstractMessageSource

Subclasses must implement this method. Typically the returned value will be the payload of type T, but the returned value may also be a Message instance whose payload is of type T; also can be AbstractIntegrationMessageBuilder which is used for additional headers population.

Specified by:

doReceive in class AbstractMessageSource<Object>

Returns:

The value returned.