ARTEMIS-405 more bits of JMX doc

This commit is contained in:
jbertram 2016-07-28 09:18:13 -05:00 committed by Clebert Suconic
parent 85878513a5
commit 4f95c8a64a
3 changed files with 14 additions and 12 deletions

View File

@ -16,8 +16,6 @@
*/
package org.apache.activemq.artemis.api.core.management;
import javax.management.MBeanOperationInfo;
/**
* An AddressControl is used to manage an address.
*/
@ -44,18 +42,22 @@ public interface AddressControl {
@Attribute(desc = "roles (name and permissions) associated with this address using JSON serialization")
String getRolesAsJSON() throws Exception;
@Operation(desc = "returns the number of estimated bytes being used by the queue, used to control paging and blocking",
impact = MBeanOperationInfo.INFO)
/**
* Returns the number of estimated bytes being used by the queue(s), used to control paging and blocking.
*/
@Attribute(desc = "the number of estimated bytes being used by the queue(s), used to control paging and blocking")
long getAddressSize() throws Exception;
@Operation(desc = "Returns the sum of messages on queues, including messages in delivery",
impact = MBeanOperationInfo.INFO)
/**
* Returns the sum of messages on queue(s), including messages in delivery.
*/
@Attribute(desc = "the sum of messages on queue(s), including messages in delivery")
long getNumberOfMessages() throws Exception;
/**
* Returns the names of the queues bound to this address.
*/
@Attribute(desc = "names of the queues bound to this address")
@Attribute(desc = "names of the queue(s) bound to this address")
String[] getQueueNames() throws Exception;
/**

View File

@ -94,9 +94,9 @@ public interface JMSQueueControl extends DestinationControl {
// Operations ----------------------------------------------------
/**
* Returns the Registry bindings associated to this connection factory.
* Returns the Registry bindings associated with this queue.
*/
@Operation(desc = "Returns the list of Registry bindings associated")
@Attribute(desc = "Returns the list of Registry bindings associated with this queue")
String[] getRegistryBindings();
/**
@ -373,7 +373,7 @@ public interface JMSQueueControl extends DestinationControl {
/**
* Returns whether the queue is paused.
*/
@Operation(desc = "Returns true if the queue is paused.", impact = MBeanOperationInfo.INFO)
@Attribute(desc = "Returns true if the queue is paused.")
boolean isPaused() throws Exception;
/**

View File

@ -60,9 +60,9 @@ public interface TopicControl extends DestinationControl {
int getNonDurableMessageCount();
/**
* Returns the Registry bindings associated to this connection factory.
* Returns the Registry bindings associated with this topic.
*/
@Operation(desc = "Returns the list of Registry bindings associated")
@Attribute(desc = "the list of Registry bindings associated with this topic")
String[] getRegistryBindings();
/**