org.springframework.xd.dirt.integration.rabbit

Class RabbitMessageBus

java.lang.Object

org.springframework.xd.dirt.integration.bus.MessageBusSupport

org.springframework.xd.dirt.integration.rabbit.RabbitMessageBus

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, MessageBus

public class RabbitMessageBus
extends MessageBusSupport
implements org.springframework.beans.factory.DisposableBean

A MessageBus implementation backed by RabbitMQ.

Author:

Mark Fisher, Gary Russell, Jennifer Hickey, Gunnar Hillert, Ilayaperumal Gopinathan, David Turanski

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.xd.dirt.integration.bus.MessageBusSupport

MessageBusSupport.DirectHandler, MessageBusSupport.PartitioningMetadata, MessageBusSupport.SetBuilder, MessageBusSupport.SharedChannelProvider<T extends org.springframework.messaging.MessageChannel>

Nested classes/interfaces inherited from interface org.springframework.xd.dirt.integration.bus.MessageBus

MessageBus.Capability

Field Summary

Fields inherited from class org.springframework.xd.dirt.integration.bus.MessageBusSupport

CONSUMER_RETRY_PROPERTIES, CONSUMER_STANDARD_PROPERTIES, defaultBackOffInitialInterval, defaultBackOffMaxInterval, defaultBackOffMultiplier, defaultBatchBufferLimit, defaultBatchingEnabled, defaultBatchSize, defaultBatchTimeout, defaultCompress, defaultConcurrency, defaultDurableSubscription, defaultMaxAttempts, directChannelProvider, evaluationContext, JOB_CHANNEL_TYPE_PREFIX, MEDIATYPES_MEDIATYPE_ALL, P2P_NAMED_CHANNEL_TYPE_PREFIX, PARTITION_HEADER, PRODUCER_BATCHING_ADVANCED_PROPERTIES, PRODUCER_BATCHING_BASIC_PROPERTIES, PRODUCER_PARTITIONING_PROPERTIES, PRODUCER_STANDARD_PROPERTIES, PUBSUB_NAMED_CHANNEL_TYPE_PREFIX, TAP_TYPE_PREFIX

Constructor Summary

Constructors

Constructor and Description
RabbitMessageBus(org.springframework.amqp.rabbit.connection.ConnectionFactory connectionFactory, org.springframework.integration.codec.Codec codec)

Method Summary

Methods

Modifier and Type	Method and Description
void	bindConsumer(java.lang.String name, org.springframework.messaging.MessageChannel moduleInputChannel, java.util.Properties properties) Bind a message consumer on a p2p channel
void	bindProducer(java.lang.String name, org.springframework.messaging.MessageChannel moduleOutputChannel, java.util.Properties properties) Bind a message producer on a p2p channel.
void	bindPubSubConsumer(java.lang.String name, org.springframework.messaging.MessageChannel moduleInputChannel, java.util.Properties properties) Bind a message consumer on a pub/sub channel
void	bindPubSubProducer(java.lang.String name, org.springframework.messaging.MessageChannel moduleOutputChannel, java.util.Properties properties) Bind a message producer on a pub/sub channel.
void	bindReplier(java.lang.String name, org.springframework.messaging.MessageChannel requests, org.springframework.messaging.MessageChannel replies, java.util.Properties properties) Bind a consumer that handles requests from a requestor and asynchronously sends replies.
void	bindRequestor(java.lang.String name, org.springframework.messaging.MessageChannel requests, org.springframework.messaging.MessageChannel replies, java.util.Properties properties) Bind a producer that expects async replies.
void	destroy()
void	doManualAck(java.util.LinkedList<org.springframework.messaging.MessageHeaders> messageHeadersList) Perform manual acknowledgement based on the metadata stored in message bus.
boolean	isCapable(MessageBus.Capability capability) Return true if the bus supports the capability.
protected void	onInit()
void	setAddresses(java.lang.String[] addresses)
void	setAdminAddresses(java.lang.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	setDefaultAcknowledgeMode(org.springframework.amqp.core.AcknowledgeMode defaultAcknowledgeMode)
void	setDefaultAutoBindDLQ(boolean defaultAutoBindDLQ)
void	setDefaultChannelTransacted(boolean defaultChannelTransacted)
void	setDefaultDefaultDeliveryMode(org.springframework.amqp.core.MessageDeliveryMode defaultDefaultDeliveryMode)
void	setDefaultDefaultRequeueRejected(boolean defaultDefaultRequeueRejected)
void	setDefaultMaxConcurrency(int defaultMaxConcurrency) Set the bus's default max consumers; can be overridden by consumer.maxConcurrency.
void	setDefaultPrefetchCount(int defaultPrefetchCount)
void	setDefaultPrefix(java.lang.String defaultPrefix)
void	setDefaultReplyHeaderPatterns(java.lang.String[] defaultReplyHeaderPatterns)
void	setDefaultRepublishToDLQ(boolean defaultRepublishToDLQ)
void	setDefaultRequestHeaderPatterns(java.lang.String[] defaultRequestHeaderPatterns)
void	setDefaultTxSize(int defaultTxSize)
void	setKeyStore(java.lang.String keyStore)
void	setKeyStorePassphrase(java.lang.String keyStorePassphrase)
void	setLongStringLimit(int longStringLimit) Set the limit for the lengths of LongString headers.
void	setNodes(java.lang.String[] nodes)
void	setPassword(java.lang.String password)
void	setSslPropertiesLocation(org.springframework.core.io.Resource sslPropertiesLocation)
void	setTrustStore(java.lang.String trustStore)
void	setTrustStorePassphrase(java.lang.String trustStorePassphrase)
void	setUsername(java.lang.String username)
void	setUseSSL(boolean useSSL)
void	setVhost(java.lang.String vhost)
void	unbindConsumer(java.lang.String name, org.springframework.messaging.MessageChannel channel) Unbind a specific p2p or pub/sub message consumer
void	unbindConsumers(java.lang.String name) Unbind an inbound inter-module channel and stop any active components that use the channel.

Methods inherited from class org.springframework.xd.dirt.integration.bus.MessageBusSupport

addBinding, afterPropertiesSet, applyPrefix, applyPubSub, applyRequests, bindDynamicProducer, bindDynamicPubSubProducer, bindExistingProducerDirectlyIfPossible, bindNewProducerDirectlyIfPossible, buildPartitionRoutingExpression, buildRetryTemplateIfRetryEnabled, constructDLQName, deleteBinding, deleteBindings, deserializePayloadIfNecessary, deserializePayloadIfNecessary, determinePartition, doBindDynamicProducer, doBindDynamicPubSubProducer, getApplicationContext, getBeanFactory, getIdGenerator, isNamedChannel, serializePayloadIfNecessary, setApplicationContext, setCodec, setDefaultBackOffInitialInterval, setDefaultBackOffMaxInterval, setDefaultBackOffMultiplier, setDefaultBatchBufferLimit, setDefaultBatchingEnabled, setDefaultBatchSize, setDefaultBatchTimeout, setDefaultCompress, setDefaultConcurrency, setDefaultDurableSubscription, setDefaultMaxAttempts, setIntegrationEvaluationContext, setPartitionSelector, stopBindings, unbindProducer, unbindProducers, validateConsumerProperties, validateProducerProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

RabbitMessageBus

public RabbitMessageBus(org.springframework.amqp.rabbit.connection.ConnectionFactory connectionFactory,
                org.springframework.integration.codec.Codec codec)

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.

setDefaultAcknowledgeMode

public void setDefaultAcknowledgeMode(org.springframework.amqp.core.AcknowledgeMode defaultAcknowledgeMode)

setDefaultChannelTransacted

public void setDefaultChannelTransacted(boolean defaultChannelTransacted)

setDefaultDefaultDeliveryMode

public void setDefaultDefaultDeliveryMode(org.springframework.amqp.core.MessageDeliveryMode defaultDefaultDeliveryMode)

setDefaultDefaultRequeueRejected

public void setDefaultDefaultRequeueRejected(boolean defaultDefaultRequeueRejected)

setDefaultMaxConcurrency

public void setDefaultMaxConcurrency(int defaultMaxConcurrency)

Set the bus's default max consumers; can be overridden by consumer.maxConcurrency. Values less than 'concurrency' will be coerced to be equal to concurrency.

Parameters:

defaultMaxConcurrency - The default max concurrency.

setDefaultPrefetchCount

public void setDefaultPrefetchCount(int defaultPrefetchCount)

setDefaultTxSize

public void setDefaultTxSize(int defaultTxSize)

setDefaultPrefix

public void setDefaultPrefix(java.lang.String defaultPrefix)

setDefaultRequestHeaderPatterns

public void setDefaultRequestHeaderPatterns(java.lang.String[] defaultRequestHeaderPatterns)

setDefaultReplyHeaderPatterns

public void setDefaultReplyHeaderPatterns(java.lang.String[] defaultReplyHeaderPatterns)

setDefaultAutoBindDLQ

public void setDefaultAutoBindDLQ(boolean defaultAutoBindDLQ)

setDefaultRepublishToDLQ

public void setDefaultRepublishToDLQ(boolean defaultRepublishToDLQ)

setAddresses

public void setAddresses(java.lang.String[] addresses)

setAdminAddresses

public void setAdminAddresses(java.lang.String[] adminAddresses)

setNodes

public void setNodes(java.lang.String[] nodes)

setUsername

public void setUsername(java.lang.String username)

setPassword

public void setPassword(java.lang.String password)

setVhost

public void setVhost(java.lang.String vhost)

setUseSSL

public void setUseSSL(boolean useSSL)

setSslPropertiesLocation

public void setSslPropertiesLocation(org.springframework.core.io.Resource sslPropertiesLocation)

setKeyStore

public void setKeyStore(java.lang.String keyStore)

setKeyStorePassphrase

public void setKeyStorePassphrase(java.lang.String keyStorePassphrase)

setTrustStore

public void setTrustStore(java.lang.String trustStore)

setTrustStorePassphrase

public void setTrustStorePassphrase(java.lang.String trustStorePassphrase)

setLongStringLimit

public void setLongStringLimit(int longStringLimit)

Set the limit for the lengths of LongString headers. Headers greater than this length are returned as a DataInputStream which requires user code to read. Spring AMQP currently does not handle these when converting back to BasicProperties.

Parameters:

longStringLimit - the limit - defaults to 8192.

onInit

protected void onInit()

Overrides:

onInit in class MessageBusSupport

bindConsumer

public void bindConsumer(java.lang.String name,
                org.springframework.messaging.MessageChannel moduleInputChannel,
                java.util.Properties properties)

Description copied from interface: MessageBus

Bind a message consumer on a p2p channel

Specified by:

bindConsumer in interface MessageBus

Parameters:

name - the logical identity of the message source

moduleInputChannel - the channel bound as a consumer

properties - arbitrary String key/value pairs that will be used in the binding

bindPubSubConsumer

public void bindPubSubConsumer(java.lang.String name,
                      org.springframework.messaging.MessageChannel moduleInputChannel,
                      java.util.Properties properties)

Description copied from interface: MessageBus

Bind a message consumer on a pub/sub channel

Specified by:

bindPubSubConsumer in interface MessageBus

Parameters:

name - the logical identity of the message source

moduleInputChannel - the channel bound as a pub/sub consumer

properties - arbitrary String key/value pairs that will be used in the binding

bindProducer

public void bindProducer(java.lang.String name,
                org.springframework.messaging.MessageChannel moduleOutputChannel,
                java.util.Properties properties)

Description copied from interface: MessageBus

Bind a message producer on a p2p channel.

Specified by:

bindProducer in interface MessageBus

Parameters:

name - the logical identity of the message target

moduleOutputChannel - the channel bound as a producer

properties - arbitrary String key/value pairs that will be used in the binding

bindPubSubProducer

public void bindPubSubProducer(java.lang.String name,
                      org.springframework.messaging.MessageChannel moduleOutputChannel,
                      java.util.Properties properties)

Description copied from interface: MessageBus

Bind a message producer on a pub/sub channel.

Specified by:

bindPubSubProducer in interface MessageBus

Parameters:

name - the logical identity of the message target

moduleOutputChannel - the channel bound as a producer

properties - arbitrary String key/value pairs that will be used in the binding

bindRequestor

public void bindRequestor(java.lang.String name,
                 org.springframework.messaging.MessageChannel requests,
                 org.springframework.messaging.MessageChannel replies,
                 java.util.Properties properties)

Description copied from interface: MessageBus

Bind a producer that expects async replies. To unbind, invoke unbindProducer() and unbindConsumer().

Specified by:

bindRequestor in interface MessageBus

Parameters:

name - The name of the requestor.

requests - The request channel - sends requests.

replies - The reply channel - receives replies.

properties - arbitrary String key/value pairs that will be used in the binding.

bindReplier

public void bindReplier(java.lang.String name,
               org.springframework.messaging.MessageChannel requests,
               org.springframework.messaging.MessageChannel replies,
               java.util.Properties properties)

Description copied from interface: MessageBus

Bind a consumer that handles requests from a requestor and asynchronously sends replies. To unbind, invoke unbindProducer() and unbindConsumer().

Specified by:

bindReplier in interface MessageBus

Parameters:

name - The name of the requestor for which this replier will handle requests.

requests - The request channel - receives requests.

replies - The reply channel - sends replies.

properties - arbitrary String key/value pairs that will be used in the binding.

unbindConsumer

public void unbindConsumer(java.lang.String name,
                  org.springframework.messaging.MessageChannel channel)

Description copied from interface: MessageBus

Unbind a specific p2p or pub/sub message consumer

Specified by:

unbindConsumer in interface MessageBus

Overrides:

unbindConsumer in class MessageBusSupport

Parameters:

name - The logical identify of a message source

channel - The channel bound as a consumer

unbindConsumers

public void unbindConsumers(java.lang.String name)

Description copied from interface: MessageBus

Unbind an inbound inter-module channel and stop any active components that use the channel.

Specified by:

unbindConsumers in interface MessageBus

Overrides:

unbindConsumers in class MessageBusSupport

Parameters:

name - the channel name

isCapable

public boolean isCapable(MessageBus.Capability capability)

Description copied from interface: MessageBus

Return true if the bus supports the capability.

Specified by:

isCapable in interface MessageBus

Overrides:

isCapable in class MessageBusSupport

Parameters:

capability - the capability.

Returns:

true if the capability is supported.

destroy

public void destroy()

Specified by:

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

doManualAck

public void doManualAck(java.util.LinkedList<org.springframework.messaging.MessageHeaders> messageHeadersList)

Description copied from class: MessageBusSupport

Perform manual acknowledgement based on the metadata stored in message bus.

Overrides:

doManualAck in class MessageBusSupport