org.springframework.cloud.stream.binder.rabbit

Class RabbitMessageChannelBinder

java.lang.Object

org.springframework.cloud.stream.binder.AbstractBinder<org.springframework.messaging.MessageChannel,C,P>

org.springframework.cloud.stream.binder.AbstractMessageChannelBinder<ExtendedConsumerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties>,ExtendedProducerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitProducerProperties>,org.springframework.cloud.stream.binder.rabbit.provisioning.RabbitExchangeQueueProvisioner>

org.springframework.cloud.stream.binder.rabbit.RabbitMessageChannelBinder

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, Binder<org.springframework.messaging.MessageChannel,ExtendedConsumerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties>,ExtendedProducerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitProducerProperties>>, ExtendedBindingProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties,org.springframework.cloud.stream.binder.rabbit.properties.RabbitProducerProperties>, ExtendedPropertiesBinder<org.springframework.messaging.MessageChannel,org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties,org.springframework.cloud.stream.binder.rabbit.properties.RabbitProducerProperties>, org.springframework.context.ApplicationContextAware

public class RabbitMessageChannelBinder
extends AbstractMessageChannelBinder<ExtendedConsumerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties>,ExtendedProducerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitProducerProperties>,org.springframework.cloud.stream.binder.rabbit.provisioning.RabbitExchangeQueueProvisioner>
implements ExtendedPropertiesBinder<org.springframework.messaging.MessageChannel,org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties,org.springframework.cloud.stream.binder.rabbit.properties.RabbitProducerProperties>, org.springframework.beans.factory.DisposableBean

A Binder implementation backed by RabbitMQ.

Author:

Mark Fisher, Gary Russell, Jennifer Hickey, Gunnar Hillert, Ilayaperumal Gopinathan, David Turanski, Marius Bogoevici, Artem Bilan

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.cloud.stream.binder.AbstractMessageChannelBinder

AbstractMessageChannelBinder.ErrorInfrastructure

Field Summary

Fields inherited from class org.springframework.cloud.stream.binder.AbstractMessageChannelBinder

EXPRESSION_PARSER, provisioningProvider

Fields inherited from class org.springframework.cloud.stream.binder.AbstractBinder

contentTypeResolver, logger

Constructor Summary

Constructors

Constructor and Description
RabbitMessageChannelBinder(org.springframework.amqp.rabbit.connection.ConnectionFactory connectionFactory, org.springframework.boot.autoconfigure.amqp.RabbitProperties rabbitProperties, org.springframework.cloud.stream.binder.rabbit.provisioning.RabbitExchangeQueueProvisioner provisioningProvider)

Method Summary

Modifier and Type	Method and Description
protected void	afterUnbindConsumer(ConsumerDestination consumerDestination, String group, ExtendedConsumerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties> consumerProperties) Invoked after the unbinding of a consumer.
protected org.springframework.integration.core.MessageProducer	createConsumerEndpoint(ConsumerDestination consumerDestination, String group, ExtendedConsumerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties> properties) Creates MessageProducer that receives data from the consumer destination.
protected org.springframework.messaging.MessageHandler	createProducerMessageHandler(ProducerDestination producerDestination, ExtendedProducerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitProducerProperties> producerProperties, org.springframework.messaging.MessageChannel errorChannel) Creates a MessageHandler with the ability to send data to the target middleware.
void	destroy()
protected String	errorsBaseName(ConsumerDestination destination, String group, ExtendedConsumerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties> consumerProperties)
protected org.springframework.messaging.MessageHandler	getErrorMessageHandler(ConsumerDestination destination, String group, ExtendedConsumerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties> properties) Binders can return a message handler to be subscribed to the error channel.
protected org.springframework.integration.support.ErrorMessageStrategy	getErrorMessageStrategy() Binders can return an ErrorMessageStrategy for building error messages; binder implementations typically might add extra headers to the error message.
org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties	getExtendedConsumerProperties(String channelName)
org.springframework.cloud.stream.binder.rabbit.properties.RabbitProducerProperties	getExtendedProducerProperties(String channelName)
void	onInit() Subclasses may implement this method to perform any necessary initialization.
void	setAdminAddresses(String[] adminAddresses)
void	setCompressingPostProcessor(org.springframework.amqp.core.MessagePostProcessor compressingPostProcessor) Set a MessagePostProcessor to compress messages.
void	setDecompressingPostProcessor(org.springframework.amqp.core.MessagePostProcessor decompressingPostProcessor) Set a MessagePostProcessor to decompress messages.
void	setExtendedBindingProperties(org.springframework.cloud.stream.binder.rabbit.properties.RabbitExtendedBindingProperties extendedBindingProperties)
void	setNodes(String[] nodes)
void	setProducerConnectionFactory(org.springframework.amqp.rabbit.connection.ConnectionFactory producerConnectionFactory) Specify a distinct ConnectionFactory for the non-transactional producers to avoid dead locks on blocked connections.

Methods inherited from class org.springframework.cloud.stream.binder.AbstractMessageChannelBinder

afterUnbindProducer, doBindConsumer, doBindProducer, errorsBaseName, getDefaultErrorMessageHandler, getErrorBridgeName, getErrorBridgeName, getErrorMessageHandlerName, getErrorRecovererName, registerErrorInfrastructure

Methods inherited from class org.springframework.cloud.stream.binder.AbstractBinder

afterPropertiesSet, applyPrefix, bindConsumer, bindProducer, buildPartitionRoutingExpression, buildRetryTemplate, constructDLQName, deserializePayloadIfNecessary, deserializePayloadIfNecessary, getApplicationContext, getBeanFactory, groupedName, serializePayloadIfNecessary, serializePayloadIfNecessary, setApplicationContext, setCodec, setIntegrationEvaluationContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.cloud.stream.binder.Binder

bindConsumer, bindProducer

Constructor Detail

RabbitMessageChannelBinder

public RabbitMessageChannelBinder(org.springframework.amqp.rabbit.connection.ConnectionFactory connectionFactory,
                                  org.springframework.boot.autoconfigure.amqp.RabbitProperties rabbitProperties,
                                  org.springframework.cloud.stream.binder.rabbit.provisioning.RabbitExchangeQueueProvisioner provisioningProvider)

Method Detail

setProducerConnectionFactory

public void setProducerConnectionFactory(org.springframework.amqp.rabbit.connection.ConnectionFactory producerConnectionFactory)

Specify a distinct ConnectionFactory for the non-transactional producers to avoid dead locks on blocked connections.

Parameters:

producerConnectionFactory - the ConnectionFactory to use for non-transactional producers.

setDecompressingPostProcessor

public void setDecompressingPostProcessor(org.springframework.amqp.core.MessagePostProcessor decompressingPostProcessor)

Set a MessagePostProcessor to decompress messages. Defaults to a DelegatingDecompressingPostProcessor with its default delegates.

Parameters:

decompressingPostProcessor - the post processor.

setCompressingPostProcessor

public void setCompressingPostProcessor(org.springframework.amqp.core.MessagePostProcessor compressingPostProcessor)

Set a MessagePostProcessor to compress messages. Defaults to a GZipPostProcessor.

Parameters:

compressingPostProcessor - the post processor.

setAdminAddresses

public void setAdminAddresses(String[] adminAddresses)

setNodes

public void setNodes(String[] nodes)

setExtendedBindingProperties

public void setExtendedBindingProperties(org.springframework.cloud.stream.binder.rabbit.properties.RabbitExtendedBindingProperties extendedBindingProperties)

onInit

public void onInit()
            throws Exception

Description copied from class: AbstractBinder

Subclasses may implement this method to perform any necessary initialization. It will be invoked from AbstractBinder.afterPropertiesSet() which is itself final.

Overrides:

onInit in class AbstractBinder<org.springframework.messaging.MessageChannel,ExtendedConsumerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties>,ExtendedProducerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitProducerProperties>>

Throws:

Exception

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception

getExtendedConsumerProperties

public org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties getExtendedConsumerProperties(String channelName)

Specified by:

getExtendedConsumerProperties in interface ExtendedBindingProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties,org.springframework.cloud.stream.binder.rabbit.properties.RabbitProducerProperties>

getExtendedProducerProperties

public org.springframework.cloud.stream.binder.rabbit.properties.RabbitProducerProperties getExtendedProducerProperties(String channelName)

Specified by:

getExtendedProducerProperties in interface ExtendedBindingProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties,org.springframework.cloud.stream.binder.rabbit.properties.RabbitProducerProperties>

createProducerMessageHandler

protected org.springframework.messaging.MessageHandler createProducerMessageHandler(ProducerDestination producerDestination,
                                                                                    ExtendedProducerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitProducerProperties> producerProperties,
                                                                                    org.springframework.messaging.MessageChannel errorChannel)

Description copied from class: AbstractMessageChannelBinder

Creates a MessageHandler with the ability to send data to the target middleware. If the returned instance is also a Lifecycle, it will be stopped automatically by the binder.

In order to be fully compliant, the MessageHandler of the binder must observe the following headers:

• BinderHeaders.PARTITION_HEADER - indicates the target partition where the message must be sent

Specified by:

createProducerMessageHandler in class AbstractMessageChannelBinder<ExtendedConsumerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties>,ExtendedProducerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitProducerProperties>,org.springframework.cloud.stream.binder.rabbit.provisioning.RabbitExchangeQueueProvisioner>

Parameters:

producerDestination - the name of the target destination

producerProperties - the producer properties

errorChannel - the error channel (if enabled, otherwise null). If not null, the binder must wire this channel into the producer endpoint so that errors are forwarded to it.

Returns:

the message handler for sending data to the target middleware

createConsumerEndpoint

protected org.springframework.integration.core.MessageProducer createConsumerEndpoint(ConsumerDestination consumerDestination,
                                                                                      String group,
                                                                                      ExtendedConsumerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties> properties)

Description copied from class: AbstractMessageChannelBinder

Creates MessageProducer that receives data from the consumer destination. will be started and stopped by the binder.

Specified by:

createConsumerEndpoint in class AbstractMessageChannelBinder<ExtendedConsumerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties>,ExtendedProducerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitProducerProperties>,org.springframework.cloud.stream.binder.rabbit.provisioning.RabbitExchangeQueueProvisioner>

Parameters:

consumerDestination - reference to the consumer destination

group - the consumer group

properties - the consumer properties

Returns:

the consumer endpoint.

getErrorMessageStrategy

protected org.springframework.integration.support.ErrorMessageStrategy getErrorMessageStrategy()

Description copied from class: AbstractMessageChannelBinder

Binders can return an ErrorMessageStrategy for building error messages; binder implementations typically might add extra headers to the error message.

Overrides:

getErrorMessageStrategy in class AbstractMessageChannelBinder<ExtendedConsumerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties>,ExtendedProducerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitProducerProperties>,org.springframework.cloud.stream.binder.rabbit.provisioning.RabbitExchangeQueueProvisioner>

Returns:

the implementation - may be null.

getErrorMessageHandler

protected org.springframework.messaging.MessageHandler getErrorMessageHandler(ConsumerDestination destination,
                                                                              String group,
                                                                              ExtendedConsumerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties> properties)

Description copied from class: AbstractMessageChannelBinder

Binders can return a message handler to be subscribed to the error channel. Examples might be if the user wishes to (re)publish messages to a DLQ.

Overrides:

getErrorMessageHandler in class AbstractMessageChannelBinder<ExtendedConsumerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties>,ExtendedProducerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitProducerProperties>,org.springframework.cloud.stream.binder.rabbit.provisioning.RabbitExchangeQueueProvisioner>

Parameters:

destination - the destination.

group - the group.

properties - the properties.

Returns:

the handler (may be null, which is the default, causing the exception to be rethrown).

errorsBaseName

protected String errorsBaseName(ConsumerDestination destination,
                                String group,
                                ExtendedConsumerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties> consumerProperties)

Overrides:

errorsBaseName in class AbstractMessageChannelBinder<ExtendedConsumerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties>,ExtendedProducerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitProducerProperties>,org.springframework.cloud.stream.binder.rabbit.provisioning.RabbitExchangeQueueProvisioner>

afterUnbindConsumer

protected void afterUnbindConsumer(ConsumerDestination consumerDestination,
                                   String group,
                                   ExtendedConsumerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties> consumerProperties)

Description copied from class: AbstractMessageChannelBinder

Invoked after the unbinding of a consumer. The binder implementation can override this method to provide their own logic (e.g. for cleaning up destinations).

Overrides:

afterUnbindConsumer in class AbstractMessageChannelBinder<ExtendedConsumerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitConsumerProperties>,ExtendedProducerProperties<org.springframework.cloud.stream.binder.rabbit.properties.RabbitProducerProperties>,org.springframework.cloud.stream.binder.rabbit.provisioning.RabbitExchangeQueueProvisioner>

Parameters:

consumerDestination - the consumer destination

group - the consumer group

consumerProperties - the consumer properties