org.springframework.integration.amqp.channel

Class PublishSubscribeAmqpChannel

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.channel.AbstractMessageChannel

org.springframework.integration.amqp.channel.AbstractAmqpChannel

org.springframework.integration.amqp.channel.PublishSubscribeAmqpChannel

All Implemented Interfaces:

org.springframework.amqp.rabbit.connection.ConnectionListener, Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, BroadcastCapableChannel, ExpressionCapable, IntegrationPattern, NamedComponent, IntegrationManagement, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent, MessageChannel, SubscribableChannel, InterceptableChannel

public class PublishSubscribeAmqpChannel
extends AbstractAmqpChannel
implements BroadcastCapableChannel

The AbstractSubscribableAmqpChannel extension for pub-sub semantics based on the FanoutExchange.

Since:

2.1

Author:

Mark Fisher, Gary Russell, Artem Bilan

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.channel.AbstractMessageChannel

AbstractMessageChannel.ChannelInterceptorList

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

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.channel.AbstractMessageChannel

interceptors, meters

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.messaging.MessageChannel

INDEFINITE_TIMEOUT

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

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

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Constructor Summary

Constructors

Constructor and Description
PublishSubscribeAmqpChannel(String channelName, org.springframework.amqp.rabbit.listener.AbstractMessageListenerContainer container, org.springframework.amqp.core.AmqpTemplate amqpTemplate) Construct an instance with the supplied name, container and template; default header mappers will be used if the message is mapped.
PublishSubscribeAmqpChannel(String channelName, org.springframework.amqp.rabbit.listener.AbstractMessageListenerContainer container, org.springframework.amqp.core.AmqpTemplate amqpTemplate, AmqpHeaderMapper outboundMapper, AmqpHeaderMapper inboundMapper) Construct an instance with the supplied name, container and template; default header mappers will be used if the message is mapped.

Method Summary

Modifier and Type	Method and Description
protected AbstractDispatcher	createDispatcher()
void	destroy()
protected void	doDeclares()
protected String	getExchangeName() Subclasses may override this method to return an Exchange name.
int	getPhase()
boolean	isAutoStartup()
boolean	isRunning()
protected String	obtainQueueName(String channelName)
void	onInit() Subclasses may implement this for initialization logic.
void	setExchange(org.springframework.amqp.core.FanoutExchange exchange) Configure the FanoutExchange instance.
void	setMaxSubscribers(int maxSubscribers) Specify the maximum number of subscribers supported by the channel's dispatcher (if it is an AbstractDispatcher).
void	start()
void	stop()
void	stop(Runnable callback)
boolean	subscribe(MessageHandler handler)
boolean	unsubscribe(MessageHandler handler)

Methods inherited from class org.springframework.integration.amqp.channel.AbstractAmqpChannel

doSend, getAdmin, getAmqpTemplate, getConnectionFactory, getInboundHeaderMapper, getRabbitTemplate, getRoutingKey, isExtractPayload, isLoggingEnabled, onClose, onCreate, setAdmin, setConnectionFactory, setDefaultDeliveryMode, setExtractPayload, setHeadersMappedLast, setLoggingEnabled

Methods inherited from class org.springframework.integration.channel.AbstractMessageChannel

addInterceptor, addInterceptor, getComponentType, getFullChannelName, getIChannelInterceptorList, getIntegrationPatternType, getInterceptors, getMetricsCaptor, getOverrides, registerMetricsCaptor, removeInterceptor, removeInterceptor, send, send, setDatatypes, setInterceptors, setMessageConverter, setShouldTrack

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.integration.channel.BroadcastCapableChannel

isBroadcast

Methods inherited from interface org.springframework.messaging.SubscribableChannel

subscribe, unsubscribe

Methods inherited from interface org.springframework.messaging.MessageChannel

send, send

Methods inherited from interface org.springframework.amqp.rabbit.connection.ConnectionListener

onFailed, onShutDown

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

getManagedName, getManagedType, getThisAs, setManagedName, setManagedType

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getBeanName, getComponentName

Constructor Detail

PublishSubscribeAmqpChannel

public PublishSubscribeAmqpChannel(String channelName,
                                   org.springframework.amqp.rabbit.listener.AbstractMessageListenerContainer container,
                                   org.springframework.amqp.core.AmqpTemplate amqpTemplate)

Construct an instance with the supplied name, container and template; default header mappers will be used if the message is mapped.

Parameters:

channelName - the channel name.

container - the container.

amqpTemplate - the template.

See Also:

AbstractAmqpChannel.setExtractPayload(boolean)

PublishSubscribeAmqpChannel

public PublishSubscribeAmqpChannel(String channelName,
                                   org.springframework.amqp.rabbit.listener.AbstractMessageListenerContainer container,
                                   org.springframework.amqp.core.AmqpTemplate amqpTemplate,
                                   AmqpHeaderMapper outboundMapper,
                                   AmqpHeaderMapper inboundMapper)

Construct an instance with the supplied name, container and template; default header mappers will be used if the message is mapped.

Parameters:

channelName - the channel name.

container - the container.

amqpTemplate - the template

outboundMapper - the outbound mapper.

inboundMapper - the inbound mapper.

Since:

4.3

See Also:

AbstractAmqpChannel.setExtractPayload(boolean)

Method Detail

setExchange

public void setExchange(org.springframework.amqp.core.FanoutExchange exchange)

Configure the FanoutExchange instance. If this is not provided, then a FanoutExchange will be declared implicitly, and its name will be the same as the channel name prefixed by "si.fanout.". In either case, an effectively anonymous Queue will be declared automatically.

Parameters:

exchange - The fanout exchange.

getExchangeName

protected String getExchangeName()

Description copied from class: AbstractAmqpChannel

Subclasses may override this method to return an Exchange name. By default, Messages will be sent to the no-name Direct Exchange.

Overrides:

getExchangeName in class AbstractAmqpChannel

Returns:

The exchange name.

obtainQueueName

protected String obtainQueueName(String channelName)

createDispatcher

protected AbstractDispatcher createDispatcher()

doDeclares

protected void doDeclares()

Specified by:

doDeclares in class AbstractAmqpChannel

setMaxSubscribers

public void setMaxSubscribers(int maxSubscribers)

Specify the maximum number of subscribers supported by the channel's dispatcher (if it is an AbstractDispatcher).

Parameters:

maxSubscribers - The maximum number of subscribers allowed.

subscribe

public boolean subscribe(MessageHandler handler)

Specified by:

subscribe in interface SubscribableChannel

unsubscribe

public boolean unsubscribe(MessageHandler handler)

Specified by:

unsubscribe in interface SubscribableChannel

onInit

public void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class AbstractAmqpChannel

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface SmartLifecycle

getPhase

public int getPhase()

Specified by:

getPhase in interface Phased

Specified by:

getPhase in interface SmartLifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

Specified by:

isRunning in interface ManageableLifecycle

start

public void start()

Specified by:

start in interface Lifecycle

Specified by:

start in interface ManageableLifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

Specified by:

stop in interface ManageableLifecycle

stop

public void stop(Runnable callback)

Specified by:

stop in interface SmartLifecycle

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

Specified by:

destroy in interface IntegrationManagement

Overrides:

destroy in class AbstractAmqpChannel