[hornetq-commits] JBoss hornetq SVN: r8668 - trunk/src/main/org/hornetq/core/management.
do-not-reply at jboss.org
do-not-reply at jboss.org
Thu Dec 10 11:28:39 EST 2009
Author: jmesnil
Date: 2009-12-10 11:28:39 -0500 (Thu, 10 Dec 2009)
New Revision: 8668
Added:
trunk/src/main/org/hornetq/core/management/package-info.java
Removed:
trunk/src/main/org/hornetq/core/management/package.html
Log:
HORNETQ-186: fill in Javadocs for core API
* removed management package javadoc (was old, user manual is the reference for more info on management)
Added: trunk/src/main/org/hornetq/core/management/package-info.java
===================================================================
--- trunk/src/main/org/hornetq/core/management/package-info.java (rev 0)
+++ trunk/src/main/org/hornetq/core/management/package-info.java 2009-12-10 16:28:39 UTC (rev 8668)
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2009 Red Hat, Inc.
+ * Red Hat licenses this file to you under the Apache License, version
+ * 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ * implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+/**
+ * API management to manage HornetQ server and its Core resources.
+ * <br>
+ * HornetQ can be managed either using JMX or by sending management messages to the
+ * server's special management address. Please refer to the user manual for more information.
+ */
+package org.hornetq.core.management;
+
Deleted: trunk/src/main/org/hornetq/core/management/package.html
===================================================================
--- trunk/src/main/org/hornetq/core/management/package.html 2009-12-10 16:19:49 UTC (rev 8667)
+++ trunk/src/main/org/hornetq/core/management/package.html 2009-12-10 16:28:39 UTC (rev 8668)
@@ -1,80 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
- <head>
- <!--
-
- JBoss: The OpenSource J2EE WebOS
-
- Distributable under LGPL license.
- See terms of license at gnu.org.
-
- -->
- </head>
- <body>
-
-<p>Provides management for HornetQ</p>
-
-<h2>Usage</h2>
-
-<p>HornetQ can be managed by sending well-formatted <em>messages</em> to a well-known <em>management address</em>.
-The invocation of management operations (and retrieval of management attributes) is based on JMX semantics. Managed resources are identified
-by <code>ObjectNames</code> (defined in <code>ManagementServiceImpl.getXXXObjectName()</code> methods).</p>
-
-<p>To create a well-formatted management message, use the helper methods defined in <code>ManagementHelper</code>.
-A management message corresponds either to one operation invocation or one (or many) attribute retrievals.
-If a reply is expected (when the operation returns a value or when retrieving an attribute), a reply-to address
-<strong>must</strong> be set on the message using the <code>ClientMessageImpl.REPLYTO_HEADER_NAME</code> header.</p>
-
-<h2>Configuration</h2>
-
-<p>Management is configured in <code>hornetq-configuration.xml</code>:</p>
-
-<pre><code>
- <management-address>admin.management</management-address>
- <management-notification-address>admin.notification</management-notification-address>
-
- <!-- true to expose HornetQ resources through JMX -->
- <jmx-management-enabled>true</jmx-management-enabled>
-</code></pre>
-
-<h2>Management using JMX</h2>
-
-<p>In addition to using messages, HornetQ can also be managed using JMX (if the configuration property
-<code>jmx-management-enabled</code> is set to <code>true</code>).<br />
-HornetQ is run in standalone to allow remote JMX management from the same machine (<code>-Dcom.sun.management.jmxremote</code>).
-A JMX client (e.g. <code>jconsole</code>) can be used locally to manage HornetQ.</p>
-
-<h2>Design</h2>
-
-<p>The core of the management support in HornetQ is the ManagementServiceImpl class.<br />
-This class is responsible to:</p>
-
-<ul>
- <li>keep track of the managed resources in a registry (and a MBeanServer when JMX management is enabled)</li>
- <li>handle "management" messages (which are sent to the address configured in <code>management-address</code> property)</li>
-</ul>
-
-<p>Each managed "Resources" (e.g. the server, the queues, the addresses, etc.) is managed through a ControlMBean class
-(the MBean is appended to make them JMX-compliant). The <code>ControlMBean</code> implementation handles user input
-validation, type conversion, etc. and delegates to the real resource.</p>
-
-<p>When the ManagementService handles a management message, it uses the registry to find the corresponding ControlMBean
-(identified by an ObjectName set on the management message) and invoke the operation (or retrieve the attribute value) using Java reflection.</p>
-
-<h2>Management in a clustered environment and JMX</h2>
-
-<p>Using core messages to manage HornetQ also works in a clustered environment: the management messages are
-replicated on the nodes of the cluster, ensuring that the state is replicated on all the nodes.</p>
-
-<p>To allow JMX to work in a clustered environment, the MBean implementation do not delegates directly to the resources
- when a management operation is invoked through JMX.<br />
-Instead, the MBean implementation translates the operation invocation into a management messages which is sent from
-</em>inside</em> the server. In turn, this triggers the replication of the messages to all the nodes
-of the clustered. All the MBean implementations are based on the <code>ReplicationAwareStandardMBeanWrapper</code>
-which provides method to ensure a management operation is correctly replicated.</p>
-
-<p><em>All management operation invocations which alters state are replicated, the operations without side-effect
- (and retrieval of attributes) are delegated directly to the resource control implementation.</em></p>
-
- </body>
-</html>
\ No newline at end of file
More information about the hornetq-commits
mailing list