org.springframework.amqp.rabbit.core

Class RabbitAdmin

java.lang.Object

org.springframework.amqp.rabbit.core.RabbitAdmin

All Implemented Interfaces:

AmqpAdmin, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class RabbitAdmin
extends java.lang.Object
implements AmqpAdmin, org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean

RabbitMQ implementation of portable AMQP administrative operations for AMQP >= 0.9.1

Field Summary

Fields

Modifier and Type	Field and Description
private org.springframework.context.ApplicationContext	applicationContext
private boolean	autoStartup
private ConnectionFactory	connectionFactory
protected static java.lang.String	DEFAULT_EXCHANGE_NAME
private boolean	ignoreDeclarationExceptions
private java.lang.Object	lifecycleMonitor
protected org.apache.commons.logging.Log	logger Logger available to subclasses
protected static java.lang.Object	QUEUE_CONSUMER_COUNT
protected static java.lang.Object	QUEUE_MESSAGE_COUNT
protected static java.lang.Object	QUEUE_NAME
private RabbitTemplate	rabbitTemplate
private boolean	running

Constructor Summary

Constructors

Constructor and Description
RabbitAdmin(ConnectionFactory connectionFactory)

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() If autoStartup is set to true, registers a callback on the ConnectionFactory to declare all exchanges and queues in the enclosing application context.
void	declareBinding(Binding binding) Declare a binding of a queue to an exchange.
private void	declareBindings(com.rabbitmq.client.Channel channel, Binding... bindings)
void	declareExchange(Exchange exchange) Declare an exchange
private void	declareExchanges(com.rabbitmq.client.Channel channel, Exchange... exchanges)
Queue	declareQueue() Declares a server-named exclusive, autodelete, non-durable queue.
java.lang.String	declareQueue(Queue queue) Declare the given queue.
private com.rabbitmq.client.AMQP.Queue.DeclareOk[]	declareQueues(com.rabbitmq.client.Channel channel, Queue... queues)
boolean	deleteExchange(java.lang.String exchangeName) Delete an exchange.
boolean	deleteQueue(java.lang.String queueName) Delete a queue, without regard for whether it is in use or has messages on it
void	deleteQueue(java.lang.String queueName, boolean unused, boolean empty) Delete a queue
private <T extends Declarable> java.util.Collection<T>	filterDeclarables(java.util.Collection<T> declarables) Remove any instances that should not be declared by this admin.
java.util.Properties	getQueueProperties(java.lang.String queueName) Returns 3 properties QUEUE_NAME, QUEUE_MESSAGE_COUNT, QUEUE_CONSUMER_COUNT, or null if the queue doesn't exist.
RabbitTemplate	getRabbitTemplate()
void	initialize() Declares all the exchanges, queues and bindings in the enclosing application context, if any.
boolean	isAutoStartup()
private boolean	isDeclaringDefaultExchange(Exchange exchange)
private boolean	isDeclaringImplicitQueueBinding(Binding binding)
private boolean	isDefaultExchange(java.lang.String exchangeName)
private boolean	isDeletingDefaultExchange(java.lang.String exchangeName)
private boolean	isImplicitQueueBinding(Binding binding)
private boolean	isRemovingImplicitQueueBinding(Binding binding)
void	purgeQueue(java.lang.String queueName, boolean noWait) Purges the contents of the given queue.
void	removeBinding(Binding binding) Remove a binding of a queue to an exchange.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setAutoStartup(boolean autoStartup)
void	setIgnoreDeclarationExceptions(boolean ignoreDeclarationExceptions)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EXCHANGE_NAME

protected static final java.lang.String DEFAULT_EXCHANGE_NAME

See Also:

Constant Field Values

QUEUE_NAME

protected static final java.lang.Object QUEUE_NAME

QUEUE_MESSAGE_COUNT

protected static final java.lang.Object QUEUE_MESSAGE_COUNT

QUEUE_CONSUMER_COUNT

protected static final java.lang.Object QUEUE_CONSUMER_COUNT

logger

protected final org.apache.commons.logging.Log logger

Logger available to subclasses

rabbitTemplate

private final RabbitTemplate rabbitTemplate

running

private volatile boolean running

autoStartup

private volatile boolean autoStartup

applicationContext

private volatile org.springframework.context.ApplicationContext applicationContext

ignoreDeclarationExceptions

private volatile boolean ignoreDeclarationExceptions

lifecycleMonitor

private final java.lang.Object lifecycleMonitor

connectionFactory

private final ConnectionFactory connectionFactory

Constructor Detail

RabbitAdmin

public RabbitAdmin(ConnectionFactory connectionFactory)

Method Detail

setAutoStartup

public void setAutoStartup(boolean autoStartup)

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

setIgnoreDeclarationExceptions

public void setIgnoreDeclarationExceptions(boolean ignoreDeclarationExceptions)

getRabbitTemplate

public RabbitTemplate getRabbitTemplate()

declareExchange

public void declareExchange(Exchange exchange)

Description copied from interface: AmqpAdmin

Declare an exchange

Specified by:

declareExchange in interface AmqpAdmin

Parameters:

exchange - the exchange to declare.

deleteExchange

@ManagedOperation
public boolean deleteExchange(java.lang.String exchangeName)

Description copied from interface: AmqpAdmin

Delete an exchange. Look at implementation specific subclass for implementation specific behavior, for example for RabbitMQ this will delete the exchange without regard for whether it is in use or not.

Specified by:

deleteExchange in interface AmqpAdmin

Parameters:

exchangeName - the name of the exchange

Returns:

true if the exchange existed and was deleted

declareQueue

@ManagedOperation
public java.lang.String declareQueue(Queue queue)

Declare the given queue. If the queue doesn't have a value for 'name' property, the queue name will be generated by Broker and returned from this method. But the 'name' property of the queue remains as is.

Specified by:

declareQueue in interface AmqpAdmin

Parameters:

queue - the queue to declare

Returns:

the name of the queue.

declareQueue

@ManagedOperation
public Queue declareQueue()

Declares a server-named exclusive, autodelete, non-durable queue.

Specified by:

declareQueue in interface AmqpAdmin

Returns:

The queue.

deleteQueue

@ManagedOperation
public boolean deleteQueue(java.lang.String queueName)

Description copied from interface: AmqpAdmin

Delete a queue, without regard for whether it is in use or has messages on it

Specified by:

deleteQueue in interface AmqpAdmin

Parameters:

queueName - the name of the queue

Returns:

true if the queue existed and was deleted

deleteQueue

@ManagedOperation
public void deleteQueue(java.lang.String queueName,
                                          boolean unused,
                                          boolean empty)

Description copied from interface: AmqpAdmin

Delete a queue

Specified by:

deleteQueue in interface AmqpAdmin

Parameters:

queueName - the name of the queue

unused - true if the queue should be deleted only if not in use

empty - true if the queue should be deleted only if empty

purgeQueue

@ManagedOperation
public void purgeQueue(java.lang.String queueName,
                                         boolean noWait)

Description copied from interface: AmqpAdmin

Purges the contents of the given queue.

Specified by:

purgeQueue in interface AmqpAdmin

Parameters:

queueName - the name of the queue

noWait - true to not await completion of the purge

declareBinding

@ManagedOperation
public void declareBinding(Binding binding)

Description copied from interface: AmqpAdmin

Declare a binding of a queue to an exchange.

Specified by:

declareBinding in interface AmqpAdmin

Parameters:

binding - a description of the binding to declare.

removeBinding

@ManagedOperation
public void removeBinding(Binding binding)

Description copied from interface: AmqpAdmin

Remove a binding of a queue to an exchange. Note unbindQueue/removeBinding was not introduced until 0.9 of the specification.

Specified by:

removeBinding in interface AmqpAdmin

Parameters:

binding - a description of the binding to remove.

getQueueProperties

public java.util.Properties getQueueProperties(java.lang.String queueName)

Returns 3 properties QUEUE_NAME, QUEUE_MESSAGE_COUNT, QUEUE_CONSUMER_COUNT, or null if the queue doesn't exist.

Specified by:

getQueueProperties in interface AmqpAdmin

Parameters:

queueName - the name of the queue.

Returns:

the properties or null if the queue doesn't exist

isAutoStartup

public boolean isAutoStartup()

afterPropertiesSet

public void afterPropertiesSet()

If autoStartup is set to true, registers a callback on the ConnectionFactory to declare all exchanges and queues in the enclosing application context. If the callback fails then it may cause other clients of the connection factory to fail, but since only exchanges, queues and bindings are declared failure is not expected.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

See Also:

InitializingBean.afterPropertiesSet(), initialize()

initialize

public void initialize()

Declares all the exchanges, queues and bindings in the enclosing application context, if any. It should be safe (but unnecessary) to call this method more than once.

filterDeclarables

private <T extends Declarable> java.util.Collection<T> filterDeclarables(java.util.Collection<T> declarables)

Remove any instances that should not be declared by this admin.

Parameters:

declarables - the collection of Declarables.

Returns:

a new collection containing Declarables that should be declared by this admin.

declareExchanges

private void declareExchanges(com.rabbitmq.client.Channel channel,
                              Exchange... exchanges)
                       throws java.io.IOException

Throws:

java.io.IOException

declareQueues

private com.rabbitmq.client.AMQP.Queue.DeclareOk[] declareQueues(com.rabbitmq.client.Channel channel,
                                                                 Queue... queues)
                                                          throws java.io.IOException

Throws:

java.io.IOException

declareBindings

private void declareBindings(com.rabbitmq.client.Channel channel,
                             Binding... bindings)
                      throws java.io.IOException

Throws:

java.io.IOException

isDeclaringDefaultExchange

private boolean isDeclaringDefaultExchange(Exchange exchange)

isDeletingDefaultExchange

private boolean isDeletingDefaultExchange(java.lang.String exchangeName)

isDefaultExchange

private boolean isDefaultExchange(java.lang.String exchangeName)

isDeclaringImplicitQueueBinding

private boolean isDeclaringImplicitQueueBinding(Binding binding)

isRemovingImplicitQueueBinding

private boolean isRemovingImplicitQueueBinding(Binding binding)

isImplicitQueueBinding

private boolean isImplicitQueueBinding(Binding binding)