svn commit: r697349 - in /geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message: CloseShellMessage.java ExecuteMessage.java LoginMessage.java OpenShellMessage.java RshMessage.java

[jd...@apache.org]

Author: jdillon
Date: Sat Sep 20 03:49:31 2008
New Revision: 697349

URL: http://svn.apache.org/viewvc?rev=697349&view=rev
Log:
Javadocs

Modified:
    geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/CloseShellMessage.java
    geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/ExecuteMessage.java
    geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/LoginMessage.java
    geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/OpenShellMessage.java
    geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/RshMessage.java

Modified: geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/CloseShellMessage.java
URL: http://svn.apache.org/viewvc/geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/CloseShellMessage.java?rev=697349&r1=697348&r2=697349&view=diff
==============================================================================
--- geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/CloseShellMessage.java (original)
+++ geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/CloseShellMessage.java Sat Sep 20 03:49:31 2008
@@ -20,8 +20,8 @@
 package org.apache.geronimo.gshell.remote.message;
 
 /**
- * Close the remote shell instance.
- *
+ * Client to server message instructing the remote-shell to be closed.
+ * 
  * @version $Rev$ $Date$
  */
 public class CloseShellMessage

Modified: geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/ExecuteMessage.java
URL: http://svn.apache.org/viewvc/geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/ExecuteMessage.java?rev=697349&r1=697348&r2=697349&view=diff
==============================================================================
--- geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/ExecuteMessage.java (original)
+++ geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/ExecuteMessage.java Sat Sep 20 03:49:31 2008
@@ -22,7 +22,7 @@
 import org.apache.geronimo.gshell.commandline.CommandLineExecutor;
 
 /**
- * Execute a command.  This supports all flavors of the {@link org.apache.geronimo.gshell.commandline.CommandLineExecutor} execution methods.
+ * Client to server message to execute a command.  This supports all flavors of the {@link CommandLineExecutor} execution methods.
  *
  * @version $Rev$ $Date$
  */
@@ -70,10 +70,9 @@
         return flavor.execute(this, executor);
     }
 
-    //
-    // Flavor
-    //
-    
+    /**
+     * Enumeration of the flavors of execution supported by the {@link CommandLineExecutor}.
+     */
     private static enum Flavor
     {
         STRING,         // execute(String)
@@ -105,6 +104,9 @@
         }
     }
 
+    /**
+     * Server to client message to pass a non-failure execution result.
+     */
     public static class Result
         extends RshMessage
     {
@@ -119,6 +121,9 @@
         }
     }
 
+    /**
+     * Server to client message to pase a failure.
+     */
     public static class Fault
         extends Result
     {
@@ -131,6 +136,9 @@
         }
     }
 
+    /**
+     * Serverto client message to pass a notification.
+     */
     public static class Notification
         extends Result
     {

Modified: geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/LoginMessage.java
URL: http://svn.apache.org/viewvc/geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/LoginMessage.java?rev=697349&r1=697348&r2=697349&view=diff
==============================================================================
--- geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/LoginMessage.java (original)
+++ geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/LoginMessage.java Sat Sep 20 03:49:31 2008
@@ -25,7 +25,7 @@
 import org.apache.geronimo.gshell.yarn.ToStringStyle;
 
 /**
- * Contains the user authentication details which the client will pass to the server after the
+ * Client to server message which contains the user authentication details which the client will pass to the server after the
  * authetication of the connection has been established.
  *
  * @version $Rev$ $Date$

Modified: geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/OpenShellMessage.java
URL: http://svn.apache.org/viewvc/geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/OpenShellMessage.java?rev=697349&r1=697348&r2=697349&view=diff
==============================================================================
--- geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/OpenShellMessage.java (original)
+++ geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/OpenShellMessage.java Sat Sep 20 03:49:31 2008
@@ -20,8 +20,8 @@
 package org.apache.geronimo.gshell.remote.message;
 
 /**
- * Open a remote shell instance.
- *
+ * Client to server message instructing a remote-shell to be opened.
+ * 
  * @version $Rev$ $Date$
  */
 public class OpenShellMessage

Modified: geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/RshMessage.java
URL: http://svn.apache.org/viewvc/geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/RshMessage.java?rev=697349&r1=697348&r2=697349&view=diff
==============================================================================
--- geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/RshMessage.java (original)
+++ geronimo/gshell/trunk/gshell-remote/gshell-remote-common/src/main/java/org/apache/geronimo/gshell/remote/message/RshMessage.java Sat Sep 20 03:49:31 2008
@@ -22,7 +22,7 @@
 import org.apache.geronimo.gshell.whisper.message.BaseMessage;
 
 /**
- * ???
+ * Base type for remote-shell related messages.
  *
  * @version $Rev$ $Date$
  */