Package 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<RabbitConsumerProperties>,ExtendedProducerProperties<RabbitProducerProperties>,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<RabbitConsumerProperties>,ExtendedProducerProperties<RabbitProducerProperties>>, ExtendedBindingProperties<RabbitConsumerProperties,RabbitProducerProperties>, ExtendedPropertiesBinder<org.springframework.messaging.MessageChannel,RabbitConsumerProperties,RabbitProducerProperties>, PollableConsumerBinder<org.springframework.messaging.MessageHandler,ExtendedConsumerProperties<RabbitConsumerProperties>>, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationEventPublisherAware

public class RabbitMessageChannelBinder
extends AbstractMessageChannelBinder<ExtendedConsumerProperties<RabbitConsumerProperties>,ExtendedProducerProperties<RabbitProducerProperties>,RabbitExchangeQueueProvisioner>
implements ExtendedPropertiesBinder<org.springframework.messaging.MessageChannel,RabbitConsumerProperties,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, Soby Chacko, Oleg Zhurakousky, Christian Tzolov

Nested Class Summary

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

AbstractMessageChannelBinder.ErrorInfrastructure, AbstractMessageChannelBinder.PolledConsumerResources

Field Summary

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

provisioningProvider

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

logger

Constructor Summary

Constructors

Constructor	Description
RabbitMessageChannelBinder(org.springframework.amqp.rabbit.connection.ConnectionFactory connectionFactory, org.springframework.boot.autoconfigure.amqp.RabbitProperties rabbitProperties, RabbitExchangeQueueProvisioner provisioningProvider)
RabbitMessageChannelBinder(org.springframework.amqp.rabbit.connection.ConnectionFactory connectionFactory, org.springframework.boot.autoconfigure.amqp.RabbitProperties rabbitProperties, RabbitExchangeQueueProvisioner provisioningProvider, ListenerContainerCustomizer<org.springframework.amqp.rabbit.listener.MessageListenerContainer> containerCustomizer)
RabbitMessageChannelBinder(org.springframework.amqp.rabbit.connection.ConnectionFactory connectionFactory, org.springframework.boot.autoconfigure.amqp.RabbitProperties rabbitProperties, RabbitExchangeQueueProvisioner provisioningProvider, ListenerContainerCustomizer<org.springframework.amqp.rabbit.listener.MessageListenerContainer> containerCustomizer, MessageSourceCustomizer<org.springframework.integration.amqp.inbound.AmqpMessageSource> sourceCustomizer)

Method Summary

Modifier and Type	Method	Description
protected void	afterUnbindConsumer(ConsumerDestination consumerDestination, String group, ExtendedConsumerProperties<RabbitConsumerProperties> consumerProperties)
protected void	afterUnbindProducer(ProducerDestination destination, ExtendedProducerProperties<RabbitProducerProperties> producerProperties)
protected org.springframework.integration.core.MessageProducer	createConsumerEndpoint(ConsumerDestination consumerDestination, String group, ExtendedConsumerProperties<RabbitConsumerProperties> properties)
protected AbstractMessageChannelBinder.PolledConsumerResources	createPolledConsumerResources(String name, String group, ConsumerDestination destination, ExtendedConsumerProperties<RabbitConsumerProperties> consumerProperties)
protected org.springframework.messaging.MessageHandler	createProducerMessageHandler(ProducerDestination producerDestination, ExtendedProducerProperties<RabbitProducerProperties> producerProperties, org.springframework.messaging.MessageChannel errorChannel)
void	destroy()
protected String	errorsBaseName(ConsumerDestination destination, String group, ExtendedConsumerProperties<RabbitConsumerProperties> consumerProperties)
org.springframework.amqp.rabbit.connection.ConnectionFactory	getConnectionFactory()	Get the underlying ConnectionFactory instance to allow manually altering the connection lifecycle.
String	getDefaultsPrefix()
protected org.springframework.messaging.MessageHandler	getErrorMessageHandler(ConsumerDestination destination, String group, ExtendedConsumerProperties<RabbitConsumerProperties> properties)
protected org.springframework.integration.support.ErrorMessageStrategy	getErrorMessageStrategy()
RabbitConsumerProperties	getExtendedConsumerProperties(String channelName)
RabbitProducerProperties	getExtendedProducerProperties(String channelName)
Class<? extends BinderSpecificPropertiesProvider>	getExtendedPropertiesEntryClass()
protected org.springframework.messaging.MessageHandler	getPolledConsumerErrorMessageHandler(ConsumerDestination destination, String group, ExtendedConsumerProperties<RabbitConsumerProperties> properties)
void	onInit()
protected void	postProcessOutputChannel(org.springframework.messaging.MessageChannel outputChannel, ExtendedProducerProperties<RabbitProducerProperties> producerProperties)
protected void	postProcessPollableSource(DefaultPollableMessageSource bindingTarget)
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(RabbitExtendedBindingProperties extendedBindingProperties)
void	setNodes(String[] nodes)

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

bindPollableConsumer, createProducerMessageHandler, doBindConsumer, doBindProducer, errorsBaseName, getApplicationEventPublisher, getContainerCustomizer, getDefaultErrorMessageHandler, getErrorBridgeName, getErrorBridgeName, getErrorMessageHandlerName, getErrorRecovererName, getMessageSourceCustomizer, getPolledConsumerRecoveryCallback, registerErrorInfrastructure, registerErrorInfrastructure, setApplicationEventPublisher, setConsumerEndpointCustomizer, setProducerMessageHandlerCustomizer, useNativeEncoding

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

afterPropertiesSet, applyPrefix, bindConsumer, bindProducer, buildRetryTemplate, constructDLQName, getApplicationContext, getBeanFactory, getEvaluationContext, groupedName, setApplicationContext

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

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

getBindings

Constructor Detail

RabbitMessageChannelBinder

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

RabbitMessageChannelBinder

public RabbitMessageChannelBinder(org.springframework.amqp.rabbit.connection.ConnectionFactory connectionFactory,
                                  org.springframework.boot.autoconfigure.amqp.RabbitProperties rabbitProperties,
                                  RabbitExchangeQueueProvisioner provisioningProvider,
                                  ListenerContainerCustomizer<org.springframework.amqp.rabbit.listener.MessageListenerContainer> containerCustomizer)

RabbitMessageChannelBinder

public RabbitMessageChannelBinder(org.springframework.amqp.rabbit.connection.ConnectionFactory connectionFactory,
                                  org.springframework.boot.autoconfigure.amqp.RabbitProperties rabbitProperties,
                                  RabbitExchangeQueueProvisioner provisioningProvider,
                                  ListenerContainerCustomizer<org.springframework.amqp.rabbit.listener.MessageListenerContainer> containerCustomizer,
                                  MessageSourceCustomizer<org.springframework.integration.amqp.inbound.AmqpMessageSource> sourceCustomizer)

Method Detail

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(RabbitExtendedBindingProperties extendedBindingProperties)

onInit

public void onInit()
            throws Exception

Overrides:

onInit in class AbstractMessageChannelBinder<ExtendedConsumerProperties<RabbitConsumerProperties>,ExtendedProducerProperties<RabbitProducerProperties>,RabbitExchangeQueueProvisioner>

Throws:

Exception

destroy

public void destroy()
             throws Exception

Specified by:

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

Throws:

Exception

getConnectionFactory

public org.springframework.amqp.rabbit.connection.ConnectionFactory getConnectionFactory()

Get the underlying ConnectionFactory instance to allow manually altering the connection lifecycle.

getExtendedConsumerProperties

public RabbitConsumerProperties getExtendedConsumerProperties(String channelName)

Specified by:

getExtendedConsumerProperties in interface ExtendedBindingProperties<RabbitConsumerProperties,RabbitProducerProperties>

getExtendedProducerProperties

public RabbitProducerProperties getExtendedProducerProperties(String channelName)

Specified by:

getExtendedProducerProperties in interface ExtendedBindingProperties<RabbitConsumerProperties,RabbitProducerProperties>

getDefaultsPrefix

public String getDefaultsPrefix()

Specified by:

getDefaultsPrefix in interface ExtendedBindingProperties<RabbitConsumerProperties,RabbitProducerProperties>

getExtendedPropertiesEntryClass

public Class<? extends BinderSpecificPropertiesProvider> getExtendedPropertiesEntryClass()

Specified by:

getExtendedPropertiesEntryClass in interface ExtendedBindingProperties<RabbitConsumerProperties,RabbitProducerProperties>

createProducerMessageHandler

protected org.springframework.messaging.MessageHandler createProducerMessageHandler(ProducerDestination producerDestination,
                                                                                    ExtendedProducerProperties<RabbitProducerProperties> producerProperties,
                                                                                    org.springframework.messaging.MessageChannel errorChannel)

Specified by:

createProducerMessageHandler in class AbstractMessageChannelBinder<ExtendedConsumerProperties<RabbitConsumerProperties>,ExtendedProducerProperties<RabbitProducerProperties>,RabbitExchangeQueueProvisioner>

postProcessOutputChannel

protected void postProcessOutputChannel(org.springframework.messaging.MessageChannel outputChannel,
                                        ExtendedProducerProperties<RabbitProducerProperties> producerProperties)

Overrides:

postProcessOutputChannel in class AbstractMessageChannelBinder<ExtendedConsumerProperties<RabbitConsumerProperties>,ExtendedProducerProperties<RabbitProducerProperties>,RabbitExchangeQueueProvisioner>

createConsumerEndpoint

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

Specified by:

createConsumerEndpoint in class AbstractMessageChannelBinder<ExtendedConsumerProperties<RabbitConsumerProperties>,ExtendedProducerProperties<RabbitProducerProperties>,RabbitExchangeQueueProvisioner>

createPolledConsumerResources

protected AbstractMessageChannelBinder.PolledConsumerResources createPolledConsumerResources(String name,
                                                                                             String group,
                                                                                             ConsumerDestination destination,
                                                                                             ExtendedConsumerProperties<RabbitConsumerProperties> consumerProperties)

Overrides:

createPolledConsumerResources in class AbstractMessageChannelBinder<ExtendedConsumerProperties<RabbitConsumerProperties>,ExtendedProducerProperties<RabbitProducerProperties>,RabbitExchangeQueueProvisioner>

postProcessPollableSource

protected void postProcessPollableSource(DefaultPollableMessageSource bindingTarget)

Overrides:

postProcessPollableSource in class AbstractMessageChannelBinder<ExtendedConsumerProperties<RabbitConsumerProperties>,ExtendedProducerProperties<RabbitProducerProperties>,RabbitExchangeQueueProvisioner>

getErrorMessageStrategy

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

Overrides:

getErrorMessageStrategy in class AbstractMessageChannelBinder<ExtendedConsumerProperties<RabbitConsumerProperties>,ExtendedProducerProperties<RabbitProducerProperties>,RabbitExchangeQueueProvisioner>

getErrorMessageHandler

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

Overrides:

getErrorMessageHandler in class AbstractMessageChannelBinder<ExtendedConsumerProperties<RabbitConsumerProperties>,ExtendedProducerProperties<RabbitProducerProperties>,RabbitExchangeQueueProvisioner>

getPolledConsumerErrorMessageHandler

protected org.springframework.messaging.MessageHandler getPolledConsumerErrorMessageHandler(ConsumerDestination destination,
                                                                                            String group,
                                                                                            ExtendedConsumerProperties<RabbitConsumerProperties> properties)

Overrides:

getPolledConsumerErrorMessageHandler in class AbstractMessageChannelBinder<ExtendedConsumerProperties<RabbitConsumerProperties>,ExtendedProducerProperties<RabbitProducerProperties>,RabbitExchangeQueueProvisioner>

errorsBaseName

protected String errorsBaseName(ConsumerDestination destination,
                                String group,
                                ExtendedConsumerProperties<RabbitConsumerProperties> consumerProperties)

Overrides:

errorsBaseName in class AbstractMessageChannelBinder<ExtendedConsumerProperties<RabbitConsumerProperties>,ExtendedProducerProperties<RabbitProducerProperties>,RabbitExchangeQueueProvisioner>

afterUnbindConsumer

protected void afterUnbindConsumer(ConsumerDestination consumerDestination,
                                   String group,
                                   ExtendedConsumerProperties<RabbitConsumerProperties> consumerProperties)

Overrides:

afterUnbindConsumer in class AbstractMessageChannelBinder<ExtendedConsumerProperties<RabbitConsumerProperties>,ExtendedProducerProperties<RabbitProducerProperties>,RabbitExchangeQueueProvisioner>

afterUnbindProducer

protected void afterUnbindProducer(ProducerDestination destination,
                                   ExtendedProducerProperties<RabbitProducerProperties> producerProperties)

Overrides:

afterUnbindProducer in class AbstractMessageChannelBinder<ExtendedConsumerProperties<RabbitConsumerProperties>,ExtendedProducerProperties<RabbitProducerProperties>,RabbitExchangeQueueProvisioner>