[jboss-cvs] JBoss Messaging SVN: r6849 - trunk/docs/user-manual/en/modules.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Mon May 18 12:37:13 EDT 2009
Author: jmesnil
Date: 2009-05-18 12:37:13 -0400 (Mon, 18 May 2009)
New Revision: 6849
Modified:
trunk/docs/user-manual/en/modules/management.xml
Log:
user manual
* added sections for Core management API description
* skeleton for JMS management API description
Modified: trunk/docs/user-manual/en/modules/management.xml
===================================================================
--- trunk/docs/user-manual/en/modules/management.xml 2009-05-18 16:28:02 UTC (rev 6848)
+++ trunk/docs/user-manual/en/modules/management.xml 2009-05-18 16:37:13 UTC (rev 6849)
@@ -39,165 +39,254 @@
<section>
<title>Core Management API</title>
<para>JBoss Messaging defines a Core Management API to manage Core resources.</para>
- <itemizedlist>
- <listitem>
- <para>Creating and destroying queues</para>
- <para>Core queues can be created (resp. destroyed) using the management operations
- <literal>createQueue()</literal> or <literal>deployQueue()</literal> (resp. <literal>destroyQueue()</literal>)
- on the <literal>MessagingServerControlMBean</literal> (with the ObjectName <literal>org.jboss.messaging:module=Core,type=Server</literal>
- or the resource name <literal>core.server</literal>)</para>
- <para><literal>deployQueue</literal> will fail if the queue already exists while <literal>createQueue</literal> will do nothing.</para>
- </listitem>
- <listitem>
- <para>Listing and closing remote connections</para>
- <para>Client's remote addresses can be retrieved using <literal>listRemoteAddresses()</literal>. It is also possible
- to close the connections associated with a remote address using the <literal>closeConnectionsForAddress()</literal> method.</para>
- <para>Alternatively, connection IDs can be listed using <literal>listConnectionIDs()</literal> and all the
- sessions for a given connection ID can be listed using <literal>listSessions()</literal>.</para>
- </listitem>
- <listitem>
- <para>Transaction heuristic operations</para>
- <para>In case of a server crash, when the server restarts, it it possible that some transaction
- requires an manual intervention. The <literal>listPreparedTransactions()</literal> method
- lists the transactions which are in the prepared states (the transactions are represented as opaque
- Base64 Strings.) To commit (resp. rollback) a given prepared transaction,
- the <literal>commitPreparedTransaction</literal>() (resp. <literal>rollbackPreparedTransaction()</literal>)
- method can be used to resolve heuristic transactions.</para>
- </listitem>
- <listitem>
- <para>Enabling and resetting Message counters</para>
- <para>Message counters can be enabled (resp. disabled) using the <literal>enableMessageCounters()</literal>
- (resp. <literal>disableMessageCounters()</literal>) method. To reset message counters, it is possible to invoke
- <literal>resetAllMessageCounters()</literal> and <literal>resetAllMessageCounterHistories()</literal> methods.</para>
- </listitem>
- <listitem>
- <para>Retrieving the server configuration and attributes</para>
- <para>The <literal>MessagingServerControlMBean</literal> exposes JBoss Messaging server configuration
- through all its attributes (e.g. <literal>getVersion()</literal> method to retrieve the server's version, etc.)</para>
- </listitem>
- <listitem>
- <para>Modifying roles and permissions for an address</para>
- <para>You can add (resp. remove) roles associated to a queue using the
- <literal>addRole()</literal> (resp. <literal>removeRole()</literal>) method on the <literal>AddressControlMBean</literal>
- class (with the ObjectName <literal>org.jboss.messaging:module=Core,type=Address,name=<the address name></literal>
- or the resource name <literal>core.address.<the address name></literal>). You can list all the roles
- associated to the queue with the <literal>getRoles()</literal> method</para>
- </listitem>
- </itemizedlist>
- <para>The bulk of the Core management API deals with Core queues. The <literal>QueueControlMBean</literal> class
- defines the Core queue management operations (with the ObjectName <literal>org.jboss.messaging:module=Core,type=Queue,address=<the bound address>,name=<the queue name></literal>
- or the resource name <literal>core.queue.<the queue name></literal>).</para>
- <para>Most of the management operations on the queues
- takes either a single message ID (e.g. to remove a single message) or a filter (e.g. to expire all messages
- with a given property.)</para>
+ <section>
+ <title>Core Server Management</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>Creating and destroying queues</para>
+ <para>Core queues can be created (resp. destroyed) using the management operations
+ <literal>createQueue()</literal> or <literal>deployQueue()</literal> (resp. <literal>destroyQueue()</literal>)
+ on the <literal>MessagingServerControlMBean</literal> (with the ObjectName <literal>org.jboss.messaging:module=Core,type=Server</literal>
+ or the resource name <literal>core.server</literal>)</para>
+ <para><literal>deployQueue</literal> will fail if the queue already exists while <literal>createQueue</literal> will do nothing.</para>
+ </listitem>
+ <listitem>
+ <para>Listing and closing remote connections</para>
+ <para>Client's remote addresses can be retrieved using <literal>listRemoteAddresses()</literal>. It is also possible
+ to close the connections associated with a remote address using the <literal>closeConnectionsForAddress()</literal> method.</para>
+ <para>Alternatively, connection IDs can be listed using <literal>listConnectionIDs()</literal> and all the
+ sessions for a given connection ID can be listed using <literal>listSessions()</literal>.</para>
+ </listitem>
+ <listitem>
+ <para>Transaction heuristic operations</para>
+ <para>In case of a server crash, when the server restarts, it it possible that some transaction
+ requires an manual intervention. The <literal>listPreparedTransactions()</literal> method
+ lists the transactions which are in the prepared states (the transactions are represented as opaque
+ Base64 Strings.) To commit (resp. rollback) a given prepared transaction,
+ the <literal>commitPreparedTransaction</literal>() (resp. <literal>rollbackPreparedTransaction()</literal>)
+ method can be used to resolve heuristic transactions.</para>
+ </listitem>
+ <listitem>
+ <para>Enabling and resetting Message counters</para>
+ <para>Message counters can be enabled (resp. disabled) using the <literal>enableMessageCounters()</literal>
+ (resp. <literal>disableMessageCounters()</literal>) method. To reset message counters, it is possible to invoke
+ <literal>resetAllMessageCounters()</literal> and <literal>resetAllMessageCounterHistories()</literal> methods.</para>
+ </listitem>
+ <listitem>
+ <para>Retrieving the server configuration and attributes</para>
+ <para>The <literal>MessagingServerControlMBean</literal> exposes JBoss Messaging server configuration
+ through all its attributes (e.g. <literal>getVersion()</literal> method to retrieve the server's version, etc.)</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section>
+ <title>Core Address Management</title>
+ <para><para>Core addresses can be managed using the
+ <literal>AddressControlMBean</literal> class (with the ObjectName <literal>org.jboss.messaging:module=Core,type=Address,name="<the address name>"</literal>
+ or the resource name <literal>core.address.<the address name></literal>).</para>
+ </para>
- <itemizedlist>
- <listitem>
- <para>Expiring, sending to a dead letter address and moving messages</para>
- <para>Messages can be expired from a queue by using the <literal>expireMessages()</literal> method.
- If an expiry address is defined, messages will be be sent to it, otherwise they are discarded.
- The queue's expiry address can be set with the <literal>setExpiryAddress()</literal> method.</para>
- <para>Messages can also be sent to a dead letter address with the <literal>sendMessagesToDeadLetterAddress()</literal> method. It returns
- the number of messages which are sent to the dead letter address. If a dead letter address is not defined, message are removed from the queue
- and discarded.
- The queue's dead letter address can be set with the <literal>setDeadLetterAddress()</literal> method.</para>
- <para>Messages can also be moved from a queue to another queue by using the <literal>moveMatchingMessages()</literal> method.</para>
- </listitem>
- <listitem>
- <para>Listing and removing messages</para>
- <para>Messages can be listed from a queue by using the <literal>listMessages()</literal> method which
- returns an array of <literal>Map</literal>, one <literal>Map</literal> for each message.</para>
- <para>Messages can also be removed from the queue by using the <literal>removeMatchingMessages()</literal> method
- which returns a <literal>boolean</literal> for the single message ID variant or the number of removed
- messages for the filter variant.</para>
- </listitem>
- <listitem>
- <para>Counting messages</para>
- <para>The number of messages in a queue is returned by the <literal>getMessageCount()</literal> method.
- Alternatively, the <literal>countMessages()</literal> will return the number of messages in the queue
- which <emphasis>match a given filter</emphasis></para>
- </listitem>
- <listitem>
- <para>Changing message priority</para>
- <para>The message priority can be changed by using the <literal>changeMessagesPriority()</literal> method
- which returns a <literal>boolean</literal> for the single message ID variant or the number of updated
- messages for the filter variant.</para>
- </listitem>
- <listitem>
- <para>Message counters</para>
- <para>Message counters can be listed for a queue with the <literal>listMessageCounter()</literal>
- and <literal>listMessageCounterHistory()</literal> methods (see <xref linkend="management.message-counters" />).
- The message counters can also be reset for a single queue using the <literal>resetMessageCounter()</literal>
- method.</para>
- </listitem>
- <listitem>
- <para>Retrieving the queue attributes</para>
- <para>The <literal>QueueControlMBean</literal> exposes Core queue settings
- through its attributes (e.g. <literal>getFilter()</literal> to retrieve the queue's filter
- if it was created with one, <literal>isDurable()</literal> to know wether the queue is durable or not, etc.)</para>
- </listitem>
- </itemizedlist>
+ <itemizedlist>
+ <listitem>
+ <para>Modifying roles and permissions for an address</para>
+ <para>You can add (resp. remove) roles associated to a queue using the
+ <literal>addRole()</literal> (resp. <literal>removeRole()</literal>) method.
+ You can list all the roles
+ associated to the queue with the <literal>getRoles()</literal> method</para>
+ </listitem>
+ </itemizedlist>
+ </section>
- <para>JBoss Messaging allow to start and stop its remote resources (acceptors, diverts, bridges, etc.)
- so that a server can be made off line for a given period of time without stopping it completely (e.g. if other
- management operations must be performed such as resolving heuristic transactions). These resources
- are:</para>
+ <section>
+ <title>Core Queue Management</title>
+
+ <para>The bulk of the Core management API deals with Core queues. The <literal>QueueControlMBean</literal> class
+ defines the Core queue management operations (with the ObjectName <literal>org.jboss.messaging:module=Core,type=Queue,address="<the bound address>",name="<the queue name>"</literal>
+ or the resource name <literal>core.queue.<the queue name></literal>).</para>
+ <para>Most of the management operations on the queues
+ takes either a single message ID (e.g. to remove a single message) or a filter (e.g. to expire all messages
+ with a given property.)</para>
- <itemizedlist>
- <listitem>
- <para>Acceptors</para>
- <para>They can be started (resp. stopped) using the <literal>start()</literal> (resp. <literal>stop()</literal>) method
- on the <literal>AcceptorControlMBean</literal> class (with the ObjectName <literal>org.jboss.messaging:module=Core,type=Acceptor,name=<the acceptor name></literal>
- or the resource name <literal>core.acceptor.<the address name></literal>). Acceptor's parameters can be retrieved
- using the <literal>AcceptorControlMBean</literal> attributes (see <xref linkend="configuring-transports.acceptors" />)</para>
- </listitem>
- <listitem>
- <para>Diverts</para>
- <para>They can be started (resp. stopped) using the <literal>start()</literal> (resp. <literal>stop()</literal>) method
- on the <literal>DivertControlMBean</literal> class (with the ObjectName <literal>org.jboss.messaging:module=Core,type=Divert,name=<the divert name></literal>
- or the resource name <literal>core.divert.<the divert name></literal>). Divert's parameters can be retrieved
- using the <literal>DivertControlMBean</literal> attributes (see <xref linkend="diverts" />)</para>
- </listitem>
- <listitem>
- <para>Bridges</para>
- <para>They can be started (resp. stopped) using the <literal>start()</literal> (resp. <literal>stop()</literal>) method
- on the <literal>BridgeControlMBean</literal> class (with the ObjectName <literal>org.jboss.messaging:module=Core,type=Bridge,name=<the bridge name></literal>
- or the resource name <literal>core.bridge.<the bridge name></literal>). Bridge's parameters can be retrieved
- using the <literal>BridgeControlMBean</literal> attributes (see <xref linkend="core-bridges" />)</para>
- </listitem>
- <listitem>
- <para>Broadcast groups</para>
- <para>They can be started (resp. stopped) using the <literal>start()</literal> (resp. <literal>stop()</literal>) method
- on the <literal>BroadcastGroupControlMBean</literal> class (with the ObjectName <literal>org.jboss.messaging:module=Core,type=BroadcastGroup,name=<the broadcast group name></literal>
- or the resource name <literal>core.broadcastgroup.<the broadcast group name></literal>). Broadcast group's parameters can be retrieved
- using the <literal>BroadcastGroupControlMBean</literal> attributes (see <xref linkend="clusters.broadcast-groups" />)</para>
- </listitem>
- <listitem>
- <para>Discovery groups</para>
- <para>They can be started (resp. stopped) using the <literal>start()</literal> (resp. <literal>stop()</literal>) method
- on the <literal>DiscoveryGroupControlMBean</literal> class (with the ObjectName <literal>org.jboss.messaging:module=Core,type=DiscoveryGroup,name=<the discovery group name></literal>
- or the resource name <literal>core.discovery.<the discovery group name></literal>). Discovery group's parameters can be retrieved
- using the <literal>DiscoveryGroupControlMBean</literal> attributes (see <xref linkend="clusters.discovery-groups" />)</para>
- </listitem>
- <listitem>
- <para>Cluster connections</para>
- <para>They can be started (resp. stopped) using the <literal>start()</literal> (resp. <literal>stop()</literal>) method
- on the <literal>ClusterConnectionControlMBean</literal> class (with the ObjectName <literal>org.jboss.messaging:module=Core,type=ClusterConnection,name=<the cluster connection name></literal>
- or the resource name <literal>core.clusterconnection.<the cluster connection name></literal>). Cluster connection's parameters can be retrieved
- using the <literal>ClusterConnectionControlMBean</literal> attributes (see <xref linkend="clusters.cluster-connections" />)</para>
- </listitem>
- </itemizedlist>
+ <itemizedlist>
+ <listitem>
+ <para>Expiring, sending to a dead letter address and moving messages</para>
+ <para>Messages can be expired from a queue by using the <literal>expireMessages()</literal> method.
+ If an expiry address is defined, messages will be be sent to it, otherwise they are discarded.
+ The queue's expiry address can be set with the <literal>setExpiryAddress()</literal> method.</para>
+ <para>Messages can also be sent to a dead letter address with the <literal>sendMessagesToDeadLetterAddress()</literal> method. It returns
+ the number of messages which are sent to the dead letter address. If a dead letter address is not defined, message are removed from the queue
+ and discarded.
+ The queue's dead letter address can be set with the <literal>setDeadLetterAddress()</literal> method.</para>
+ <para>Messages can also be moved from a queue to another queue by using the <literal>moveMatchingMessages()</literal> method.</para>
+ </listitem>
+ <listitem>
+ <para>Listing and removing messages</para>
+ <para>Messages can be listed from a queue by using the <literal>listMessages()</literal> method which
+ returns an array of <literal>Map</literal>, one <literal>Map</literal> for each message.</para>
+ <para>Messages can also be removed from the queue by using the <literal>removeMatchingMessages()</literal> method
+ which returns a <literal>boolean</literal> for the single message ID variant or the number of removed
+ messages for the filter variant.</para>
+ </listitem>
+ <listitem>
+ <para>Counting messages</para>
+ <para>The number of messages in a queue is returned by the <literal>getMessageCount()</literal> method.
+ Alternatively, the <literal>countMessages()</literal> will return the number of messages in the queue
+ which <emphasis>match a given filter</emphasis></para>
+ </listitem>
+ <listitem>
+ <para>Changing message priority</para>
+ <para>The message priority can be changed by using the <literal>changeMessagesPriority()</literal> method
+ which returns a <literal>boolean</literal> for the single message ID variant or the number of updated
+ messages for the filter variant.</para>
+ </listitem>
+ <listitem>
+ <para>Message counters</para>
+ <para>Message counters can be listed for a queue with the <literal>listMessageCounter()</literal>
+ and <literal>listMessageCounterHistory()</literal> methods (see <xref linkend="management.message-counters" />).
+ The message counters can also be reset for a single queue using the <literal>resetMessageCounter()</literal>
+ method.</para>
+ </listitem>
+ <listitem>
+ <para>Retrieving the queue attributes</para>
+ <para>The <literal>QueueControlMBean</literal> exposes Core queue settings
+ through its attributes (e.g. <literal>getFilter()</literal> to retrieve the queue's filter
+ if it was created with one, <literal>isDurable()</literal> to know wether the queue is durable or not, etc.)</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section>
+ <title>Other Core Resources Management</title>
-
+ <para>JBoss Messaging allow to start and stop its remote resources (acceptors, diverts, bridges, etc.)
+ so that a server can be made off line for a given period of time without stopping it completely (e.g. if other
+ management operations must be performed such as resolving heuristic transactions). These resources
+ are:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Acceptors</para>
+ <para>They can be started (resp. stopped) using the <literal>start()</literal> (resp. <literal>stop()</literal>) method
+ on the <literal>AcceptorControlMBean</literal> class (with the ObjectName <literal>org.jboss.messaging:module=Core,type=Acceptor,name="<the acceptor name>"</literal>
+ or the resource name <literal>core.acceptor.<the address name></literal>). Acceptor's parameters can be retrieved
+ using the <literal>AcceptorControlMBean</literal> attributes (see <xref linkend="configuring-transports.acceptors" />)</para>
+ </listitem>
+ <listitem>
+ <para>Diverts</para>
+ <para>They can be started (resp. stopped) using the <literal>start()</literal> (resp. <literal>stop()</literal>) method
+ on the <literal>DivertControlMBean</literal> class (with the ObjectName <literal>org.jboss.messaging:module=Core,type=Divert,name=<the divert name></literal>
+ or the resource name <literal>core.divert.<the divert name></literal>). Divert's parameters can be retrieved
+ using the <literal>DivertControlMBean</literal> attributes (see <xref linkend="diverts" />)</para>
+ </listitem>
+ <listitem>
+ <para>Bridges</para>
+ <para>They can be started (resp. stopped) using the <literal>start()</literal> (resp. <literal>stop()</literal>) method
+ on the <literal>BridgeControlMBean</literal> class (with the ObjectName <literal>org.jboss.messaging:module=Core,type=Bridge,name="<the bridge name>"</literal>
+ or the resource name <literal>core.bridge.<the bridge name></literal>). Bridge's parameters can be retrieved
+ using the <literal>BridgeControlMBean</literal> attributes (see <xref linkend="core-bridges" />)</para>
+ </listitem>
+ <listitem>
+ <para>Broadcast groups</para>
+ <para>They can be started (resp. stopped) using the <literal>start()</literal> (resp. <literal>stop()</literal>) method
+ on the <literal>BroadcastGroupControlMBean</literal> class (with the ObjectName <literal>org.jboss.messaging:module=Core,type=BroadcastGroup,name="<the broadcast group name>"</literal>
+ or the resource name <literal>core.broadcastgroup.<the broadcast group name></literal>). Broadcast group's parameters can be retrieved
+ using the <literal>BroadcastGroupControlMBean</literal> attributes (see <xref linkend="clusters.broadcast-groups" />)</para>
+ </listitem>
+ <listitem>
+ <para>Discovery groups</para>
+ <para>They can be started (resp. stopped) using the <literal>start()</literal> (resp. <literal>stop()</literal>) method
+ on the <literal>DiscoveryGroupControlMBean</literal> class (with the ObjectName <literal>org.jboss.messaging:module=Core,type=DiscoveryGroup,name="<the discovery group name>"</literal>
+ or the resource name <literal>core.discovery.<the discovery group name></literal>). Discovery group's parameters can be retrieved
+ using the <literal>DiscoveryGroupControlMBean</literal> attributes (see <xref linkend="clusters.discovery-groups" />)</para>
+ </listitem>
+ <listitem>
+ <para>Cluster connections</para>
+ <para>They can be started (resp. stopped) using the <literal>start()</literal> (resp. <literal>stop()</literal>) method
+ on the <literal>ClusterConnectionControlMBean</literal> class (with the ObjectName <literal>org.jboss.messaging:module=Core,type=ClusterConnection,name="<the cluster connection name>"</literal>
+ or the resource name <literal>core.clusterconnection.<the cluster connection name></literal>). Cluster connection's parameters can be retrieved
+ using the <literal>ClusterConnectionControlMBean</literal> attributes (see <xref linkend="clusters.cluster-connections" />)</para>
+ </listitem>
+ </itemizedlist>
+ </section>
</section>
<section>
<title>JMS Management API</title>
<para>JBoss Messaging defines a JMS Management API to manage JMS resources.</para>
- <para>TODO</para>
+ <section>
+ <title>JMS Server Management</title>
+ <para>JMS Resources (connection factories and destinations) can be created using the
+ <literal>JMSServerControlMBean</literal> class (with the ObjectName <literal>org.jboss.messaging:module=JMS,type=Server</literal>
+ or the resource name <literal>jms.server</literal>).</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Creating/destroying connection factories</para>
+ <para>TODO</para>
+ </listitem>
+ <listitem>
+ <para>Creating/destroying queues</para>
+ <para>TODO</para>
+ </listitem>
+ <listitem>
+ <para>Creating/destroying topics</para>
+ <para>TODO</para>
+ </listitem>
+ <listitem>
+ <para>listing and closing remote connections</para>
+ <para>TODO</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section>
+ <title>JMS ConnectionFactory Management</title>
+
+ <para>JMS Connection Factories can be managed using the
+ <literal>ConnectionFactoryControlMBean</literal> class (with the ObjectName <literal>org.jboss.messaging:module=JMS,type=ConnectionFactory,name="<the connection factory name>"</literal>
+ or the resource name <literal>jms.connectionfactory.<the connection factory name></literal>).</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>listing and closing remote connections</para>
+ <para>TODO</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section>
+ <title>JMS Queue Management</title>
+
+ <para>JMS Queues can be managed using the
+ <literal>JMSQueueControlMBean</literal> class (with the ObjectName <literal>org.jboss.messaging:module=JMS,type=Queue,name="<the queue name>"</literal>
+ or the resource name <literal>jms.queue.<the queue name></literal>).</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>listing and closing remote connections</para>
+ <para>TODO</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section>
+ <title>JMS Topic Management</title>
+
+ <para>JMS Topics can be managed using the
+ <literal>TopicControlMBean</literal> class (with the ObjectName <literal>org.jboss.messaging:module=JMS,type=Topic,name="<the topic name>"</literal>
+ or the resource name <literal>jms.topic.<the topic name></literal>).</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>listing and closing remote connections</para>
+ <para>TODO</para>
+ </listitem>
+ </itemizedlist>
+ </section>
</section>
</section>
More information about the jboss-cvs-commits
mailing list