org.springframework.integration.x.bus

Interface MessageBus

All Known Implementing Classes:

LocalMessageBus, MessageBusSupport, RabbitMessageBus, RedisMessageBus

public interface MessageBus

A strategy interface used to bind a MessageChannel to a logical name. The name is intended to identify a logical consumer or producer of messages. This may be a queue, a channel adapter, another message channel, a Spring bean, etc.

Since:

1.0

Author:

Mark Fisher, David Turanski, Gary Russell, Jennifer Hickey

Method Summary

Methods

Modifier and Type	Method and Description
void	bindConsumer(java.lang.String name, org.springframework.messaging.MessageChannel moduleInputChannel, boolean aliasHint) Bind a message consumer on a p2p channel
void	bindProducer(java.lang.String name, org.springframework.messaging.MessageChannel moduleOutputChannel, boolean aliasHint) Bind a message producer on a p2p channel.
void	bindPubSubConsumer(java.lang.String name, org.springframework.messaging.MessageChannel inputChannel) Bind a message consumer on a pub/sub channel
void	bindPubSubProducer(java.lang.String name, org.springframework.messaging.MessageChannel outputChannel) 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) 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) Bind a producer that expects async replies.
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.
void	unbindProducer(java.lang.String name, org.springframework.messaging.MessageChannel channel) Unbind a specific p2p or pub/sub message producer
void	unbindProducers(java.lang.String name) Unbind an outbound inter-module channel and stop any active components that use the channel.

Method Detail

bindConsumer

void bindConsumer(java.lang.String name,
                org.springframework.messaging.MessageChannel moduleInputChannel,
                boolean aliasHint)

Bind a message consumer on a p2p channel

Parameters:

name - the logical identity of the message source

moduleInputChannel - the channel bound as a consumer

aliasHint - whether the provided name represents an alias and thus should support late binding

bindPubSubConsumer

void bindPubSubConsumer(java.lang.String name,
                      org.springframework.messaging.MessageChannel inputChannel)

Bind a message consumer on a pub/sub channel

Parameters:

name - the logical identity of the message source

inputChannel - the channel bound as a pub/sub consumer

bindProducer

void bindProducer(java.lang.String name,
                org.springframework.messaging.MessageChannel moduleOutputChannel,
                boolean aliasHint)

Bind a message producer on a p2p channel.

Parameters:

name - the logical identity of the message target

moduleOutputChannel - the channel bound as a producer

aliasHint - whether the provided name represents an alias and thus should support late binding

bindPubSubProducer

void bindPubSubProducer(java.lang.String name,
                      org.springframework.messaging.MessageChannel outputChannel)

Bind a message producer on a pub/sub channel.

Parameters:

name - the logical identity of the message target

outputChannel - the channel bound as a producer

unbindConsumers

void unbindConsumers(java.lang.String name)

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

Parameters:

name - the channel name

unbindProducers

void unbindProducers(java.lang.String name)

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

Parameters:

name - the channel name

unbindConsumer

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

Unbind a specific p2p or pub/sub message consumer

Parameters:

name - The logical identify of a message source

channel - The channel bound as a consumer

unbindProducer

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

Unbind a specific p2p or pub/sub message producer

Parameters:

name - the logical identity of the message target

channel - the channel bound as a producer

bindRequestor

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

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

Parameters:

name - The name of the requestor.

requests - The request channel - sends requests.

replies - The reply channel - receives replies.

bindReplier

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

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

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.