public class RabbitAdmin extends java.lang.Object implements AmqpAdmin, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationEventPublisherAware, org.springframework.beans.factory.InitializingBean
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_EXCHANGE_NAME
The default exchange name.
|
protected org.apache.commons.logging.Log |
logger
Logger available to subclasses
|
static java.lang.Object |
QUEUE_CONSUMER_COUNT
Property key for the consumer count in the
Properties returned by
getQueueProperties(String) . |
static java.lang.Object |
QUEUE_MESSAGE_COUNT
Property key for the message count in the
Properties returned by
getQueueProperties(String) . |
static java.lang.Object |
QUEUE_NAME
Property key for the queue name in the
Properties returned by
getQueueProperties(String) . |
Constructor and Description |
---|
RabbitAdmin(ConnectionFactory connectionFactory) |
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.
|
void |
declareExchange(Exchange exchange)
Declare an exchange
|
Queue |
declareQueue()
Declares a server-named exclusive, autodelete, non-durable queue.
|
java.lang.String |
declareQueue(Queue queue)
Declare the given queue.
|
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
|
DeclarationExceptionEvent |
getLastDeclarationExceptionEvent() |
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() |
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 |
setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher) |
void |
setAutoStartup(boolean autoStartup) |
void |
setDeclareCollections(boolean declareCollections)
Set to false to disable declaring collections of
Declarable . |
void |
setIgnoreDeclarationExceptions(boolean ignoreDeclarationExceptions) |
void |
setRetryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate)
Set a retry template for auto declarations.
|
public static final java.lang.String DEFAULT_EXCHANGE_NAME
public static final java.lang.Object QUEUE_NAME
Properties
returned by
getQueueProperties(String)
.public static final java.lang.Object QUEUE_MESSAGE_COUNT
Properties
returned by
getQueueProperties(String)
.public static final java.lang.Object QUEUE_CONSUMER_COUNT
Properties
returned by
getQueueProperties(String)
.protected final org.apache.commons.logging.Log logger
public RabbitAdmin(ConnectionFactory connectionFactory)
public void setAutoStartup(boolean autoStartup)
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
setApplicationContext
in interface org.springframework.context.ApplicationContextAware
public void setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)
setApplicationEventPublisher
in interface org.springframework.context.ApplicationEventPublisherAware
public void setIgnoreDeclarationExceptions(boolean ignoreDeclarationExceptions)
public void setDeclareCollections(boolean declareCollections)
Declarable
.
Since the admin has to iterate over all Collection beans, this may
cause undesirable side-effects in some cases. Default true.declareCollections
- set to false to prevent declarations of collections.public DeclarationExceptionEvent getLastDeclarationExceptionEvent()
DeclarationExceptionEvent
that was detected in this admin.public RabbitTemplate getRabbitTemplate()
public void declareExchange(Exchange exchange)
AmqpAdmin
declareExchange
in interface AmqpAdmin
exchange
- the exchange to declare.@ManagedOperation public boolean deleteExchange(java.lang.String exchangeName)
AmqpAdmin
deleteExchange
in interface AmqpAdmin
exchangeName
- the name of the exchange@ManagedOperation public java.lang.String declareQueue(Queue queue)
declareQueue
in interface AmqpAdmin
queue
- the queueignoreDeclarationExceptions
is
true.@ManagedOperation public Queue declareQueue()
declareQueue
in interface AmqpAdmin
ignoreDeclarationExceptions
is true.@ManagedOperation public boolean deleteQueue(java.lang.String queueName)
AmqpAdmin
deleteQueue
in interface AmqpAdmin
queueName
- the name of the queue@ManagedOperation public void deleteQueue(java.lang.String queueName, boolean unused, boolean empty)
AmqpAdmin
deleteQueue
in interface AmqpAdmin
queueName
- the name of the queueunused
- true if the queue should be deleted only if not in useempty
- true if the queue should be deleted only if empty@ManagedOperation public void purgeQueue(java.lang.String queueName, boolean noWait)
AmqpAdmin
purgeQueue
in interface AmqpAdmin
queueName
- the name of the queuenoWait
- true to not await completion of the purge@ManagedOperation public void declareBinding(Binding binding)
AmqpAdmin
declareBinding
in interface AmqpAdmin
binding
- a description of the binding to declare.@ManagedOperation public void removeBinding(Binding binding)
AmqpAdmin
removeBinding
in interface AmqpAdmin
binding
- a description of the binding to remove.public java.util.Properties getQueueProperties(java.lang.String queueName)
QUEUE_NAME
, QUEUE_MESSAGE_COUNT
,
QUEUE_CONSUMER_COUNT
, or null if the queue doesn't exist.getQueueProperties
in interface AmqpAdmin
queueName
- the name of the queue.public void setRetryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate)
null
. Note that this
retry is at the macro level - all declarations will be retried within the scope of
this template. If you supplied a RabbitTemplate
that is configured with a
RetryTemplate
, its template will retry each individual declaration.retryTemplate
- the retry template.public boolean isAutoStartup()
public void afterPropertiesSet()
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.afterPropertiesSet
in interface org.springframework.beans.factory.InitializingBean
InitializingBean.afterPropertiesSet()
,
initialize()
public void initialize()