You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by ch...@apache.org on 2013/05/28 19:40:16 UTC

svn commit: r1487016 - in /uima/sandbox/uima-ducc/trunk: ./ uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/ uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/

Author: challngr
Date: Tue May 28 17:40:15 2013
New Revision: 1487016

URL: http://svn.apache.org/r1487016
Log:
Add more javadoc to public classes.

Removed:
    uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccProcessCancel.java
Modified:
    uima/sandbox/uima-ducc/trunk/javadoc.xml
    uima/sandbox/uima-ducc/trunk/pom.xml
    uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccJobSubmit.java
    uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccManagedReservationCancel.java
    uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccManagedReservationSubmit.java
    uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccPerfStats.java
    uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccServiceCancel.java
    uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccServiceSubmit.java
    uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-process-cancel.tex

Modified: uima/sandbox/uima-ducc/trunk/javadoc.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/javadoc.xml?rev=1487016&r1=1487015&r2=1487016&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/javadoc.xml (original)
+++ uima/sandbox/uima-ducc/trunk/javadoc.xml Tue May 28 17:40:15 2013
@@ -59,7 +59,11 @@
             <include name="**/DuccJobCancel.java" />
             <include name="**/DuccReservationCancel.java" />
             <include name="**/DuccReservationSubmit.java" />
+            <include name="**/DuccManagedReservationCancel.java" />
+            <include name="**/DuccManagedReservationSubmit.java" />
             <include name="**/DuccServiceApi.java" />
+            <include name="**/DuccServiceSubmit.java" />
+            <include name="**/DuccServiceCancel.java" />
             <include name="**/IDuccCallback.java" />
             <include name="**/CliBase.java" />
           </fileset>

Modified: uima/sandbox/uima-ducc/trunk/pom.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/pom.xml?rev=1487016&r1=1487015&r2=1487016&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/pom.xml (original)
+++ uima/sandbox/uima-ducc/trunk/pom.xml Tue May 28 17:40:15 2013
@@ -153,6 +153,10 @@
 								uima-ducc-common/src/main/java:uima-ducc-cli/src/main/java
 							</sourcepath>
 
+                            <show>
+                              public
+                            </show>
+
 							<subpackages>org.apache.uima</subpackages>
 
 							<excludePackageNames>
@@ -172,14 +176,9 @@
 								${basedir}/uima-ducc-transport/src/main/java/org/apache/uima/ducc/transport/event/sm/IServiceDescription.java
 
 								${basedir}/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccJobCancel.java
-								${basedir}/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccJobMonitor.java
 								${basedir}/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccJobSubmit.java
 								${basedir}/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccManagedReservationCancel.java
-								${basedir}/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccManagedReservationMonitor.java
 								${basedir}/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccManagedReservationSubmit.java
-								${basedir}/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccMonitor.java
-								${basedir}/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccPerfStats.java
-								${basedir}/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccProcessCancel.java
 								${basedir}/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccReservationCancel.java
 								${basedir}/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccReservationSubmit.java
 								${basedir}/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccServiceApi.java
@@ -187,7 +186,6 @@
 								${basedir}/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccServiceSubmit.java
 								${basedir}/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/IDuccCallback.java
 								${basedir}/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/IDuccMonitor.java
-								${basedir}/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/IDuccMonitor.java
 								${basedir}/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/CliBase.java
 
 							</additionalparam>

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccJobSubmit.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccJobSubmit.java?rev=1487016&r1=1487015&r2=1487016&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccJobSubmit.java (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccJobSubmit.java Tue May 28 17:40:15 2013
@@ -161,25 +161,26 @@ public class DuccJobSubmit 
     private AllInOneLauncher allInOneLauncher = null;
     
     /**
-     * @param args List of string arguments as described in the 
+     * @param args Array of string arguments as described in the 
      *      <a href="/doc/duccbook.html#DUCC_CLI_SUBMIT">DUCC CLI reference.</a>
      */
-    public DuccJobSubmit(ArrayList<String> args)
+    public DuccJobSubmit(String[] args)
         throws Exception
     {
         this(args, null);
     }
 
     /**
-     * @param args Array of string arguments as described in the 
+     * @param args List of string arguments as described in the 
      *      <a href="/doc/duccbook.html#DUCC_CLI_SUBMIT">DUCC CLI reference.</a>
      */
-    public DuccJobSubmit(String[] args)
+    public DuccJobSubmit(ArrayList<String> args)
         throws Exception
     {
         this(args, null);
     }
 
+
     /**
      * @param props Properties file of arguments, as described in the
      *      <a href="/doc/duccbook.html#DUCC_CLI_SUBMIT">DUCC CLI reference.</a>
@@ -642,7 +643,7 @@ public class DuccJobSubmit 
 
     /**
      * Main method, as used by the executable jar or direct java invocation.
-     * @param args arguments as described in the <a href="/doc/duccbook.html#DUCC_CLI_JOB">DUCC CLI reference.</a>
+     * @param args arguments as described in the <a href="/doc/duccbook.html#DUCC_CLI_SUBMIT">DUCC CLI reference.</a>
      */
     public static void main(String[] args) {
         try {

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccManagedReservationCancel.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccManagedReservationCancel.java?rev=1487016&r1=1487015&r2=1487016&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccManagedReservationCancel.java (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccManagedReservationCancel.java Tue May 28 17:40:15 2013
@@ -26,6 +26,9 @@ import org.apache.uima.ducc.transport.ev
 import org.apache.uima.ducc.transport.event.IDuccContext.DuccContext;
 import org.apache.uima.ducc.transport.event.cli.JobRequestProperties;
 
+/**
+ * Cancel a DUCC Managed Reservation.
+ */
 public class DuccManagedReservationCancel extends CliBase {
 
     JobRequestProperties requestProperties = new JobRequestProperties();
@@ -45,12 +48,20 @@ public class DuccManagedReservationCance
         UiOption.RoleAdministrator,
     };
 
+    /**
+     * @param args Array of string arguments as described in the 
+     *      <a href="/doc/duccbook.html#DUCC_CLI_PROCESS_CANCEL">DUCC CLI reference.</a>
+     */
 	public DuccManagedReservationCancel(String [] args) 
         throws Exception
     {
         init(this.getClass().getName(), opts, args, requestProperties, or_host, or_port, "or");
 	}
 
+    /**
+     * @param args List of string arguments as described in the 
+     *      <a href="/doc/duccbook.html#DUCC_CLI_PROCESS_CANCEL">DUCC CLI reference.</a>
+     */
 	public DuccManagedReservationCancel(List<String> args) 
         throws Exception
     {
@@ -58,6 +69,10 @@ public class DuccManagedReservationCance
         init(this.getClass().getName(), opts, arg_array, requestProperties, or_host, or_port, "or");
 	}
 
+    /**
+     * @param props Properties file of arguments, as described in the
+     *      <a href="/doc/duccbook.html#DUCC_CLI_PROCESS_CANCEL">DUCC CLI reference.</a>
+     */
 	public DuccManagedReservationCancel(Properties props) 
         throws Exception
     {
@@ -68,11 +83,22 @@ public class DuccManagedReservationCance
         init(this.getClass().getName(), opts, null, requestProperties, or_host, or_port, "or");
 	}
 
+    /**
+     * Return the DUCC Orchestrator message, if any, pertaining to the cancelation.
+     *
+     * @return Return any message associated with the cancelation.
+     */
 	public String getResponseMessage()
 	{
 		return responseMessage;
 	}
 
+    /**
+     * Execute collects the parameters for job cancelation and sends them to the DUCC Orchestrator
+     * to effect the cancelation.
+     *
+     * @return True if the orchestrator accepts the job cancelation.
+     */
 	public boolean execute() 
         throws Exception 
     {
@@ -96,6 +122,10 @@ public class DuccManagedReservationCance
 		return rc;
 	}
 	
+    /**
+     * Main method, as used by the executable jar or direct java invocation.
+     * @param args arguments as described in the <a href="/doc/duccbook.html#DUCC_CLI_PROCESS_CANCEL">DUCC CLI reference.</a>
+     */
 	public static void main(String[] args) {
 		try {
 			DuccManagedReservationCancel dsc = new DuccManagedReservationCancel(args);

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccManagedReservationSubmit.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccManagedReservationSubmit.java?rev=1487016&r1=1487015&r2=1487016&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccManagedReservationSubmit.java (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccManagedReservationSubmit.java Tue May 28 17:40:15 2013
@@ -28,7 +28,8 @@ import org.apache.uima.ducc.transport.ev
 
 
 /**
- * Submit a DUCC Managed Reservation
+ * Submit a DUCC Managed Reservation.  A Managed Reservation is a single arbitray process running
+ * in a non-preemptable share.
  */
 
 public class DuccManagedReservationSubmit 
@@ -81,24 +82,45 @@ public class DuccManagedReservationSubmi
     
     private UiOption[] opts = opts_release;
 
+    /**
+     * @param args List of string arguments as described in the 
+     *      <a href="/doc/duccbook.html#DUCC_CLI_PROCESS_SUBMIT">DUCC CLI reference.</a>
+     */
     public DuccManagedReservationSubmit(String[] args)
         throws Exception
     {
         this(args, null);
     }
         
+    /**
+     * @param args Array of string arguments as described in the 
+     *      <a href="/doc/duccbook.html#DUCC_CLI_PROCESS_SUBMIT">DUCC CLI reference.</a>
+     */
     public DuccManagedReservationSubmit(ArrayList<String> args)
         throws Exception
     {
         this(args, null);
     }
         
-    public DuccManagedReservationSubmit(Properties props)
+    /**
+     * @param props Properties file of arguments, as described in the
+     *      <a href="/doc/duccbook.html#DUCC_CLI_PROCESS_SUBMIT">DUCC CLI reference.</a>
+     */ 
+   public DuccManagedReservationSubmit(Properties props)
         throws Exception
     {
         this(props, null);
     }
 
+    /**
+     * This form of the constructor allows the API user to capture
+     * messages, rather than directing them to stdout. 
+     *
+     * @param args Array of string arguments as described in the 
+     *      <a href="/doc/duccbook.html#DUCC_CLI_PROCESS_SUBMIT">DUCC CLI reference.</a>
+     * @param consoleCb If provided, messages are directed to it instead of
+     *        stdout.
+     */
     public DuccManagedReservationSubmit(String[] args, IDuccCallback consoleCb)
         throws Exception
     {
@@ -110,6 +132,15 @@ public class DuccManagedReservationSubmi
         init(this.getClass().getName(), opts, args, serviceRequestProperties, or_host, or_port, "or", consoleCb);
     }
         
+    /**
+     * This form of the constructor allows the API user to capture
+     * messages, rather than directing them to stdout. 
+     *
+     * @param args List of string arguments as described in the 
+     *      <a href="/doc/duccbook.html#DUCC_CLI_PROCESS_SUBMIT">DUCC CLI reference.</a>
+     * @param consoleCb If provided, messages are directed to it instead of
+     *        stdout.
+     */
     public DuccManagedReservationSubmit(ArrayList<String> args, IDuccCallback consoleCb)
         throws Exception
     {
@@ -122,6 +153,15 @@ public class DuccManagedReservationSubmi
         init(this.getClass().getName(), opts, arg_array, serviceRequestProperties, or_host, or_port, "or", consoleCb);
     }
         
+    /**
+     * This form of the constructor allows the API user to capture
+     * messages, rather than directing them to stdout. 
+     *
+     * @param props Properties file contianing string arguments as described in the 
+     *      <a href="/doc/duccbook.html#DUCC_CLI_PROCESS_SUBMIT">DUCC CLI reference.</a>
+     * @param consoleCb If provided, messages are directed to it instead of
+     *        stdout.
+     */
     public DuccManagedReservationSubmit(Properties props, IDuccCallback consoleCb) 
         throws Exception
     {
@@ -140,6 +180,12 @@ public class DuccManagedReservationSubmi
     }
 
                         
+    /**
+     * Execute collects the job parameters, does basic error and correctness checking, and sends
+     * the job properties to the DUCC orchestrator for execution.
+     *
+     * @return True if the orchestrator accepts the job; false otherwise.
+     */
     public boolean execute() throws Exception 
     {
 
@@ -223,6 +269,10 @@ public class DuccManagedReservationSubmi
         return retval;
     }
         
+    /**
+     * Main method, as used by the executable jar or direct java invocation.
+     * @param args arguments as described in the <a href="/doc/duccbook.html#DUCC_CLI_PROCESS_SUBMIT">DUCC CLI reference.</a>
+     */
     public static void main(String[] args) 
     {
         int code = 1; // Assume the worst

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccPerfStats.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccPerfStats.java?rev=1487016&r1=1487015&r2=1487016&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccPerfStats.java (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccPerfStats.java Tue May 28 17:40:15 2013
@@ -50,7 +50,11 @@ import org.apache.uima.ducc.transport.ev
 import org.apache.uima.ducc.transport.event.jd.PerformanceSummaryReader;
 
 
-
+/**
+ * Format performance statistics to the console in human-readable form and CSV for post-analysis.
+ * The CSV format uses TABS, not commas, because the AE names may have commas, making parsing
+ * difficult.
+ */
 public class DuccPerfStats 
 {     
     boolean csv = false;
@@ -65,7 +69,7 @@ public class DuccPerfStats 
     SummarySort  summarySort = SummarySort.TotalTime;
     WorkItemSort workItemSort = WorkItemSort.Seq;
 
-    public enum ClOptions
+    enum ClOptions
     {
         //
         // I want to expose these things to the API with the ugly upper-case notation but don't
@@ -126,7 +130,7 @@ public class DuccPerfStats 
     }
     ;
 
-    public enum SummarySort
+    enum SummarySort
     {
         Name    { 
             public String decode()      { return "name"; } 
@@ -169,7 +173,7 @@ public class DuccPerfStats 
     }
     ;
 
-    public enum WorkItemSort
+    enum WorkItemSort
     {
         //
         // I want to expose these things to the API with the ugly upper-case notation but don't
@@ -226,6 +230,9 @@ public class DuccPerfStats 
         }
     };
 
+    /**
+     * Constructor - initialize a DuccPerfStats object.
+     */
     public DuccPerfStats()
     {
 //         if ( csvstr.equals("csv") ) csv = true;
@@ -521,7 +528,7 @@ public class DuccPerfStats 
         }
     }
 
-    public void run(String[] args)
+    void run(String[] args)
     {
         Options options = new Options();
         addOptions(options);
@@ -602,11 +609,9 @@ public class DuccPerfStats 
         }
     }
 
-    /** 
-     * Options:
-     *   -csv
-     *      Print as CSV
-     */  
+    /**
+     * Main - see the CLI reference or Help screen for details.
+     */
     public static void main(String[] args)
     {
         // args - we assume a script front-end will parse args and pass them in in the following format

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccServiceCancel.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccServiceCancel.java?rev=1487016&r1=1487015&r2=1487016&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccServiceCancel.java (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccServiceCancel.java Tue May 28 17:40:15 2013
@@ -27,7 +27,7 @@ import org.apache.uima.ducc.transport.ev
 import org.apache.uima.ducc.transport.event.cli.JobRequestProperties;
 
 /**
- * Cancel a DUCC service instance
+ * Cancel a DUCC service instance.
  */
 
 public class DuccServiceCancel 
@@ -51,12 +51,20 @@ public class DuccServiceCancel 
     };
 
 	
+    /**
+     * @param args Array of string arguments as described in the 
+     *      <a href="/doc/duccbook.html#DUCC_CLI_SERVICE_CANCEL">DUCC CLI reference.</a>
+     */
 	public DuccServiceCancel(String [] args) 
         throws Exception
     {
         init(this.getClass().getName(), opts, args, requestProperties, or_host, or_port, "or");
 	}
 
+    /**
+     * @param args List of string arguments as described in the 
+     *      <a href="/doc/duccbook.html#DUCC_CLI_SERVICE_CANCEL">DUCC CLI reference.</a>
+     */
 	public DuccServiceCancel(List<String> args) 
         throws Exception
     {
@@ -64,6 +72,10 @@ public class DuccServiceCancel 
         init(this.getClass().getName(), opts, arg_array, requestProperties, or_host, or_port, "or");
 	}
 
+    /**
+     * @param props Properties file of arguments, as described in the
+     *      <a href="/doc/duccbook.html#DUCC_CLI_SERVICE_CANCEL">DUCC CLI reference.</a>
+     */
 	public DuccServiceCancel(Properties props) 
         throws Exception
     {
@@ -74,20 +86,27 @@ public class DuccServiceCancel 
         init(this.getClass().getName(), opts, null, requestProperties, or_host, or_port, "or");
 	}
 
+    /**
+     * Return the DUCC Orchestrator message, if any, pertaining to the cancelation.
+     *
+     * @return Return any message associated with the cancelation.
+     */
 	public String getResponseMessage()
 	{
 		return responseMessage;
 	}
 
+    // public boolean isService()
+//     {
+//         return true;
+//     }
+
     /**
-     * Services and processes share 99% of their code.  This particular module (ServiceCancel) is identical with
-     * DuccProcessCancel but CLI and API uses of it may want to know which context it was executed in.  This tells you ...
+     * Execute collects the parameters for job cancelation and sends them to the DUCC Orchestrator
+     * to effect the cancelation.
+     *
+     * @return True if the orchestrator accepts the job cancelation.
      */
-    public boolean isService()
-    {
-        return true;
-    }
-
 	public boolean execute() 
         throws Exception 
     {
@@ -116,6 +135,10 @@ public class DuccServiceCancel 
 		return rc;
 	}
 	
+    /**
+     * Main method, as used by the executable jar or direct java invocation.
+     * @param args arguments as described in the <a href="/doc/duccbook.html#DUCC_CLI_SERVICE_CANCEL">DUCC CLI reference.</a>
+     */
 	public static void main(String[] args) {
 		try {
 			DuccServiceCancel dsc = new DuccServiceCancel(args);
@@ -123,8 +146,7 @@ public class DuccServiceCancel 
 
             long id = dsc.getDuccId();
             String msg = dsc.getResponseMessage();
-            String dtype = dsc.isService() ? "Service " : "Process ";
-            System.out.println(dtype + id + " " + msg);
+            System.out.println("Process " + id + " " + msg);
             System.exit(rc ? 0 : 1);
 
 		} catch (Exception e) {

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccServiceSubmit.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccServiceSubmit.java?rev=1487016&r1=1487015&r2=1487016&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccServiceSubmit.java (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-cli/src/main/java/org/apache/uima/ducc/cli/DuccServiceSubmit.java Tue May 28 17:40:15 2013
@@ -29,7 +29,9 @@ import org.apache.uima.ducc.transport.ev
 
 
 /**
- * Submit a DUCC service
+ * Submit a DUCC service.  This is usually called by the DUCC Service Manager but is
+ * made public to enable developer-driven management and testing of services without
+ * formal service registration.
  */
 
 public class DuccServiceSubmit 
@@ -102,13 +104,11 @@ public class DuccServiceSubmit 
     };
     
     UiOption[] opts = opts_release;
-    
-    public DuccServiceSubmit(ArrayList<String> args)
-        throws Exception
-    {
-        this(args.toArray(new String[args.size()]));
-    }
 
+    /**
+     * @param args Array of string arguments as described in the 
+     *      <a href="/doc/duccbook.html#DUCC_CLI_SERVICE_SUBMIT">DUCC CLI reference.</a>
+     */
     public DuccServiceSubmit(String[] args)
         throws Exception
     {
@@ -118,7 +118,21 @@ public class DuccServiceSubmit 
         }
         init(this.getClass().getName(), opts, args, requestProperties, or_host, or_port, "or", null, null);
     }
+    
+    /**
+     * @param args List of string arguments as described in the 
+     *      <a href="/doc/duccbook.html#DUCC_CLI_SERVICE_SUBMIT">DUCC CLI reference.</a>
+     */
+    public DuccServiceSubmit(ArrayList<String> args)
+        throws Exception
+    {
+        this(args.toArray(new String[args.size()]));
+    }
 
+    /**
+     * @param props Properties file of arguments, as described in the
+     *      <a href="/doc/duccbook.html#DUCC_CLI_SERVICE_SUBMIT">DUCC CLI reference.</a>
+     */
     public DuccServiceSubmit(Properties props)
         throws Exception
     {
@@ -133,6 +147,12 @@ public class DuccServiceSubmit 
         init(this.getClass().getName(), opts, null, requestProperties, or_host, or_port, "or", null, null);
     }
     
+    /**
+     * Execute collects the service parameters, does basic error and correctness checking, and sends
+     * the job properties to the DUCC orchestrator for execution.
+     *
+     * @return True if the orchestrator accepts the service; false otherwise.
+     */
     public boolean execute() 
         throws Exception 
     {
@@ -239,6 +259,10 @@ public class DuccServiceSubmit 
         return rc;
     }
         
+    /**
+     * Main method, as used by the executable jar or direct java invocation.
+     * @param args arguments as described in the <a href="/doc/duccbook.html#DUCC_CLI_SERVICE_SUBMIT">DUCC CLI reference.</a>
+     */
     public static void main(String[] args) {
         try {
             // Instantiate the object with args similar to the CLI, or a pre-built properties file

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-process-cancel.tex
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-process-cancel.tex?rev=1487016&r1=1487015&r2=1487016&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-process-cancel.tex (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-duccdocs/src/site/tex/duccbook/part2/cli/ducc-process-cancel.tex Tue May 28 17:40:15 2013
@@ -1,7 +1,7 @@
 % Create well-known link to this spot for HTML version
 \ifpdf
 \else
-\HCode{<a name='DUCC_CLI_PRLCESS_CANCEL'></a>}
+\HCode{<a name='DUCC_CLI_PROCESS_CANCEL'></a>}
 \fi
     \section{ducc\_process\_cancel}