svn commit: r240568 - in /geronimo/trunk/modules: jetty/src/java/org/apache/geronimo/jetty/connector/ management/src/java/org/apache/geronimo/management/geronimo/

[am...@apache.org]

Author: ammulder
Date: Sat Aug 27 15:44:15 2005
New Revision: 240568

URL: http://svn.apache.org/viewcvs?rev=240568&view=rev
Log:
Documentation updates

Modified:
    geronimo/trunk/modules/jetty/src/java/org/apache/geronimo/jetty/connector/JettyConnector.java
    geronimo/trunk/modules/management/src/java/org/apache/geronimo/management/geronimo/JMSBroker.java
    geronimo/trunk/modules/management/src/java/org/apache/geronimo/management/geronimo/JMSManager.java

Modified: geronimo/trunk/modules/jetty/src/java/org/apache/geronimo/jetty/connector/JettyConnector.java
URL: http://svn.apache.org/viewcvs/geronimo/trunk/modules/jetty/src/java/org/apache/geronimo/jetty/connector/JettyConnector.java?rev=240568&r1=240567&r2=240568&view=diff
==============================================================================
--- geronimo/trunk/modules/jetty/src/java/org/apache/geronimo/jetty/connector/JettyConnector.java (original)
+++ geronimo/trunk/modules/jetty/src/java/org/apache/geronimo/jetty/connector/JettyConnector.java Sat Aug 27 15:44:15 2005
@@ -31,6 +31,8 @@
 import org.mortbay.util.ThreadedServer;
 
 /**
+ * Base class for GBeans for Jetty network connectors (HTTP, HTTPS, AJP, etc.).
+ *
  * @version $Rev$ $Date$
  */
 public abstract class JettyConnector implements GBeanLifecycle, JettyWebConnector {

Modified: geronimo/trunk/modules/management/src/java/org/apache/geronimo/management/geronimo/JMSBroker.java
URL: http://svn.apache.org/viewcvs/geronimo/trunk/modules/management/src/java/org/apache/geronimo/management/geronimo/JMSBroker.java?rev=240568&r1=240567&r2=240568&view=diff
==============================================================================
--- geronimo/trunk/modules/management/src/java/org/apache/geronimo/management/geronimo/JMSBroker.java (original)
+++ geronimo/trunk/modules/management/src/java/org/apache/geronimo/management/geronimo/JMSBroker.java Sat Aug 27 15:44:15 2005
@@ -26,7 +26,7 @@
      * Gets the ObjectNames of the network connectors associated with this
      * JMS broker.
      *
-     * @return The ObjectNames of the thread pools, in String form.
+     * @return The ObjectNames of the network connectors, in String form.
      */
     public String[] getConnectors();
 

Modified: geronimo/trunk/modules/management/src/java/org/apache/geronimo/management/geronimo/JMSManager.java
URL: http://svn.apache.org/viewcvs/geronimo/trunk/modules/management/src/java/org/apache/geronimo/management/geronimo/JMSManager.java?rev=240568&r1=240567&r2=240568&view=diff
==============================================================================
--- geronimo/trunk/modules/management/src/java/org/apache/geronimo/management/geronimo/JMSManager.java (original)
+++ geronimo/trunk/modules/management/src/java/org/apache/geronimo/management/geronimo/JMSManager.java Sat Aug 27 15:44:15 2005
@@ -17,7 +17,12 @@
 package org.apache.geronimo.management.geronimo;
 
 /**
- * Main entry point for managing a certain JMS server implementation
+ * Main entry point for managing a particular JMS implementation.  The manager
+ * has features to access JMS brokers (aka servers or containers) as well as
+ * JMS connectors (aka network listeners).  Each manager should handle all
+ * the brokers and connectors for a single JMS implementation; if the Geronimo
+ * server has multiple JMS implementations available then there should be one
+ * JMSManager instance for each.
  *
  * @version $Rev: 46228 $ $Date: 2004-09-16 21:21:04 -0400 (Thu, 16 Sep 2004) $
  */
@@ -25,6 +30,9 @@
     /**
      * Gets the ObjectNames of any JMS servers/brokers running in the current
      * Geronimo instance.
+     *
+     * @return The ObjectName of any brokers available for this JMS
+     *         implementation (in String form).
      */
     public String[] getBrokers();
 
@@ -32,6 +40,8 @@
      * Gets the ObjectNames of any existing connectors for the specified
      * protocol associated with the specified broker.
      *
+     * @param brokerObjectName The ObjectName of the broker to get connectors
+     *        for
      * @param protocol A protocol as returned by getSupportedProtocols
      */
     public String[] getBrokerConnectors(String brokerObjectName, String protocol);
@@ -46,6 +56,15 @@
      * Creates a new connector, and returns the ObjectName for it.  Note that
      * the connector may well require further customization before being fully
      * functional (e.g. SSL settings for a secure connector).
+     *
+     * @param broker     The ObjectName of the broker to add the connector for
+     * @param uniqueName A name fragment that's unique to this connector
+     * @param protocol   The protocol the connector should be configured for
+     * @param host       The listen host/IP for the connector
+     * @param port       The listen port for the connector
+     *
+     * @return The ObjectName of the newly added connector.  It will be valid
+     *         (loaded) but not started.
      */
     public String addConnector(String broker, String uniqueName, String protocol, String host, int port);
 }