From jboss-remoting-commits at lists.jboss.org Tue Jun 15 04:37:06 2010
Content-Type: multipart/mixed; boundary="===============2397839031000357522=="
MIME-Version: 1.0
From: jboss-remoting-commits at lists.jboss.org
To: jboss-remoting-commits at lists.jboss.org
Subject: [jboss-remoting-commits] JBoss Remoting SVN: r5869 -
 remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/management.
Date: Tue, 15 Jun 2010 04:37:06 -0400
Message-ID: <201006150837.o5F8b6Ic018785@svn01.web.mwc.hst.phx2.redhat.com>

--===============2397839031000357522==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: trustin
Date: 2010-06-15 04:37:05 -0400 (Tue, 15 Jun 2010)
New Revision: 5869

Modified:
   remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/managem=
ent/ConnectionMXBean.java
   remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/managem=
ent/Counters.java
   remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/managem=
ent/EndpointMXBean.java
   remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/managem=
ent/ServiceMXBean.java
Log:
* Javadoc (forgot to check in last week)
* Renamed getRequestCounters() to getInboundRequestCounters() or getOutboun=
dRequestCounters()
* Split EndpointMXBean.getRequestCounters() into the inbound version and th=
e outbound version

Modified: remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/=
management/ConnectionMXBean.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/manage=
ment/ConnectionMXBean.java	2010-05-28 15:52:52 UTC (rev 5868)
+++ remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/manage=
ment/ConnectionMXBean.java	2010-06-15 08:37:05 UTC (rev 5869)
@@ -23,13 +23,42 @@
 =

 import javax.management.ObjectName;
 =

+import org.jboss.remoting3.Client;
+import org.jboss.remoting3.Connection;
+
+/**
+ * Statistics and management information for a {@link Connection}.
+ *
+ * @author <a href=3D"http://gleamynode.net/>Trustin Lee</a>
+ * @version $Rev$, $Date$
+ */
 public interface ConnectionMXBean {
 =

+    /**
+     * Returns the {@link ObjectName} of the {@link EndpointMXBean} which
+     * created the {@link Connection}.
+     */
     ObjectName getEndpoint();
 =

-    Counters getRequestCounters();
+    /**
+     * Returns the statistics information of the outbound requests handled
+     * (or being handled) by the {@link Connection}.
+     */
+    Counters getOutboundRequestCounters();
+
+    /**
+     * Returns the statistics information of the {@link Client}s created b=
y the
+     * the {@link Connection}.
+     */
     Counters getClientCounters();
 =

+    /**
+     * Closes all open {@link Client}s created by the {@link Connection}.
+     */
     void close();
+
+    /**
+     * Closes all open {@link Client}s created by the {@link Connection} f=
orcibly.
+     */
     void forceClose();
 }

Modified: remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/=
management/Counters.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/manage=
ment/Counters.java	2010-05-28 15:52:52 UTC (rev 5868)
+++ remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/manage=
ment/Counters.java	2010-06-15 08:37:05 UTC (rev 5869)
@@ -23,11 +23,25 @@
 =

 import java.beans.ConstructorProperties;
 =

+/**
+ * Provides the number of the currently running (or in-progress) activitie=
s and
+ * the cumulative number of the succeeded or failed activities so far.
+ *
+ * @author <a href=3D"http://gleamynode.net/>Trustin Lee</a>
+ * @version $Rev$, $Date$
+ */
 public class Counters {
     private final long active;
     private final long success;
     private final long failure;
 =

+    /**
+     * Creates a new instance.
+     *
+     * @param active  the number of the currently running (or in-progress)=
 activities
+     * @param success the cumulative number of the succeeded activities so=
 far
+     * @param failure the cumulative number of the failed activities so far
+     */
     @ConstructorProperties({"active", "success", "failure"})
     public Counters(long active, long success, long failure) {
         this.active =3D active;
@@ -35,14 +49,23 @@
         this.failure =3D failure;
     }
 =

+    /**
+     * Returns the number of the currently running (or in-progress) activi=
ties.
+     */
     public long getActive() {
         return active;
     }
 =

+    /**
+     * Returns the cumulative number of the succeeded activities so far.
+     */
     public long getSuccess() {
         return success;
     }
 =

+    /**
+     * Returns the cumulative number of the failed activities so far.
+     */
     public long getFailure() {
         return failure;
     }

Modified: remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/=
management/EndpointMXBean.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/manage=
ment/EndpointMXBean.java	2010-05-28 15:52:52 UTC (rev 5868)
+++ remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/manage=
ment/EndpointMXBean.java	2010-06-15 08:37:05 UTC (rev 5869)
@@ -25,13 +25,51 @@
 =

 import javax.management.ObjectName;
 =

+import org.jboss.remoting3.Client;
+import org.jboss.remoting3.Connection;
+import org.jboss.remoting3.Endpoint;
 =

+/**
+ * Statistics and management information for an {@link Endpoint}.
+ *
+ * @author <a href=3D"http://gleamynode.net/>Trustin Lee</a>
+ * @version $Rev$, $Date$
+ */
 public interface EndpointMXBean {
 =

+    /**
+     * Returns the {@link ObjectName}s of all {@link ServiceMXBean}s where
+     * the services they represent are registered to the {@link Endpoint}.
+     */
     List<ObjectName> getServices();
+
+    /**
+     * Returns the {@link ObjectName}s of all {@link ConnectionMXBean}s wh=
ere
+     * the {@link Connection}s they represent are created by the {@link En=
dpoint}.
+     */
     List<ObjectName> getConnections();
 =

-    Counters getRequestCounters();
+    /**
+     * Returns the statistics information of the inbound requests handled
+     * (or being handled) by the services registered to the {@link Endpoin=
t}.
+     */
+    Counters getInboundRequestCounters();
+
+    /**
+     * Returns the statistics information of the outbound requests made by
+     * the {@link Connection}s created by the {@link Endpoint}.
+     */
+    Counters getOutboundRequestCounters();
+
+    /**
+     * Returns the statistics information of the {@link Connection}s creat=
ed by
+     * the {@link Endpoint}.
+     */
     Counters getConnectionCounters();
+
+    /**
+     * Returns the statistics information of the {@link Client}s created b=
y the
+     * {@link Endpoint}.
+     */
     Counters getClientCounters();
 }

Modified: remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/=
management/ServiceMXBean.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/manage=
ment/ServiceMXBean.java	2010-05-28 15:52:52 UTC (rev 5868)
+++ remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/manage=
ment/ServiceMXBean.java	2010-06-15 08:37:05 UTC (rev 5869)
@@ -25,15 +25,55 @@
 =

 import javax.management.ObjectName;
 =

+import org.jboss.remoting3.Endpoint;
+
+/**
+ * Statistics and management information for the service registered to an
+ * {@link Endpoint}.
+ *
+ * @author <a href=3D"http://gleamynode.net/>Trustin Lee</a>
+ * @version $Rev$, $Date$
+ */
 public interface ServiceMXBean {
 =

+    /**
+     * Returns the {@link ObjectName} of the {@link EndpointMXBean} where =
the
+     * service is registered to.
+     */
     ObjectName getEndpoint();
 =

+    /**
+     * Returns the instance name of the service.
+     */
     String getInstanceName();
+
+    /**
+     * Returns the service type string which follows the convention for Ja=
va
+     * package names (reversed domain names).
+     */
     String getServiceType();
+
+    /**
+     * Returns the expected fully qualified class name of the request obje=
ct
+     * handled by the service.
+     */
     String getRequestType();
+
+    /**
+     * Returns the expected fully qualified class name of the reply object
+     * returned by the service.
+     */
     String getReplyType();
+
+    /**
+     * Returns the additional configuration options provided when the serv=
ice
+     * was created.
+     */
     Map<String, String> getOptions();
 =

-    Counters getRequestCounters();
+    /**
+     * Returns the statistics information of the inbound requests handled
+     * (or being handled) by the service.
+     */
+    Counters getInboundRequestCounters();
 }


--===============2397839031000357522==--