javadoc for command line client

modules/cli/src/main/java/sap/prd/cmintegration/cli/CMCommandLineException.java

@@ -1,5 +1,9 @@
 package sap.prd.cmintegration.cli;
 
+/**
+ * Root for all exceptions related to the command line client in the
+ * narrower sense.
+ */
 class CMCommandLineException extends RuntimeException {
 
     private static final long serialVersionUID = 5251372712902531523L;

modules/cli/src/main/java/sap/prd/cmintegration/cli/ClientFactory.java

@@ -2,6 +2,9 @@
 
 import sap.ai.st.cm.plugins.ciintegration.odataclient.CMODataClient;
 
+/**
+ * Provides {@link CMODataClient} instances.
+ */
 class ClientFactory {
 
     private static ClientFactory instance;
@@ -16,6 +19,13 @@ static synchronized ClientFactory getInstance() {
         return instance;
     }
 
+    /**
+     * Provides a new instance of {@link CMODataClient}
+     * @param serviceUrl The OData endpoint of the SAP Solution Manager
+     * @param serviceUser The service user.
+     * @param servicePassword The password for authenticating.
+     * @return A new instance of {@link CMODataClient}
+     */
     CMODataClient newClient(String serviceUrl, String serviceUser, String servicePassword) {
         return new CMODataClient(serviceUrl, serviceUser,  servicePassword);
     }

modules/cli/src/main/java/sap/prd/cmintegration/cli/Command.java

@@ -1,5 +1,8 @@
 package sap.prd.cmintegration.cli;
 
+/**
+ * Root class for all commands.
+ */
 abstract class Command {
 
     protected final String host, user, password;
@@ -10,5 +13,11 @@ protected Command(String host, String user, String password) {
         this.password = password;
     }
 
+    /**
+     * Contains the command specific logic. E.g. performs a
+     * call to SAP Solution Manager, parses the result and
+     * provides it via System.out to the caller of the command line.
+     * @throws Exception In case of trouble.
+     */
     abstract void execute() throws Exception;
 }

modules/cli/src/main/java/sap/prd/cmintegration/cli/CommandDescriptor.java

@@ -5,6 +5,9 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/**
+ * Contains the name of the command as it is used from the command line.
+ */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 @interface CommandDescriptor {

modules/cli/src/main/java/sap/prd/cmintegration/cli/Commands.java

@@ -31,12 +31,18 @@
 
 import sap.ai.st.cm.plugins.ciintegration.odataclient.CMODataClient;
 
+/**
+ * Helpers for using/calling commands.
+ */
 class Commands {
 
     final static private Logger logger = LoggerFactory.getLogger(Commands.class);
     private final static String DASH = "-";
     private final static String TWO_DASHES = DASH+DASH;
 
+    /**
+     * The common command line options used by all commands.
+     */
     static class CMOptions {
 
         static Option USER = new Option("u", "user", true, "Service user."),
@@ -58,6 +64,9 @@ static Option clone(Option o) {
         }
     }
 
+    /**
+     * Common helper methods.
+     */
     static class Helpers {
 
         static Options getStandardOptions() {
@@ -138,7 +147,7 @@ static String getArgsLogString(String[] args) {
         }
 
         /**
-         * 
+         * @param args The <code>args</code> array handed over to the command.
          * @return A copy of <code>args</code>. The password parameter, identified by a preceding
          *         <code>-p</code> is replaced by asterisks.
          */

modules/cli/src/main/java/sap/prd/cmintegration/cli/CreateTransport.java

@@ -20,6 +20,9 @@
 import sap.ai.st.cm.plugins.ciintegration.odataclient.CMODataClient;
 import sap.ai.st.cm.plugins.ciintegration.odataclient.CMODataTransport;
 
+/**
+ * Command for creating a transport for a change in SAP Solution Manager.
+ */
 @CommandDescriptor(name = "create-transport")
 class CreateTransport extends Command {
 

modules/cli/src/main/java/sap/prd/cmintegration/cli/ExitException.java

@@ -1,5 +1,11 @@
 package sap.prd.cmintegration.cli;
 
+/**
+ * Used in case a status is encounter where any further processing inside
+ * the command line client does not make sense. The exit code transported
+ * alongside with this exception is used as exit code of the Java Virtual
+ * Machine.
+ */
 class ExitException extends CMCommandLineException {
 
     private static final long serialVersionUID = -3269137608207801150L;

modules/cli/src/main/java/sap/prd/cmintegration/cli/ExitWrapper.java

@@ -3,6 +3,11 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * Launcher class which launches another class and handels {@link ExitException}s. In case
+ * an ExitExcpetion is encountered the exit code contained in that exception is used
+ * as return code when exiting the Java Virtual Machine.
+ */
 class ExitWrapper {
     final static private Logger logger = LoggerFactory.getLogger(ExitWrapper.class);
     public final static void main(String[] args) throws Exception {

modules/cli/src/main/java/sap/prd/cmintegration/cli/GetChangeStatus.java

@@ -18,6 +18,9 @@
 import sap.ai.st.cm.plugins.ciintegration.odataclient.CMODataChange;
 import sap.ai.st.cm.plugins.ciintegration.odataclient.CMODataClient;
 
+/**
+ * Command for retrieving the status of a change.
+ */
 @CommandDescriptor(name = "is-change-in-development")
 class GetChangeStatus extends Command {
 

modules/cli/src/main/java/sap/prd/cmintegration/cli/GetChangeTransports.java

@@ -22,6 +22,11 @@
 import sap.ai.st.cm.plugins.ciintegration.odataclient.CMODataClient;
 import sap.ai.st.cm.plugins.ciintegration.odataclient.CMODataTransport;
 
+/**
+ * Command for for retrieving the transport of a change. Depending on the options
+ * handed over to that command only the mofifiable transports are
+ * returned.
+ */
 @CommandDescriptor(name="get-transports")
 class GetChangeTransports extends Command {
 

modules/cli/src/main/java/sap/prd/cmintegration/cli/GetTransportDescription.java

@@ -11,6 +11,9 @@
 
 import sap.ai.st.cm.plugins.ciintegration.odataclient.CMODataTransport;
 
+/**
+ * Command for retrieving the description of a transport.
+ */
 @CommandDescriptor(name="get-transport-description")
 class GetTransportDescription extends TransportRelated {
 

modules/cli/src/main/java/sap/prd/cmintegration/cli/GetTransportModifiable.java

@@ -10,6 +10,9 @@
 
 import sap.ai.st.cm.plugins.ciintegration.odataclient.CMODataTransport;
 
+/**
+ *  Checks if a transport is modifiable.
+ */
 @CommandDescriptor(name="is-transport-modifiable")
 class GetTransportModifiable extends TransportRelated {
 

modules/cli/src/main/java/sap/prd/cmintegration/cli/GetTransportOwner.java

@@ -11,6 +11,9 @@
 
 import sap.ai.st.cm.plugins.ciintegration.odataclient.CMODataTransport;
 
+/**
+ * Command for retrieving the owner of a transport.
+ */
 @CommandDescriptor(name="get-transport-owner")
 class GetTransportOwner extends TransportRelated {
 

modules/cli/src/main/java/sap/prd/cmintegration/cli/ReleaseTransport.java

@@ -17,6 +17,9 @@
 
 import sap.ai.st.cm.plugins.ciintegration.odataclient.CMODataClient;
 
+/**
+ * Command for releasing a transport.
+ */
 @CommandDescriptor(name="release-transport")
 class ReleaseTransport extends Command {
 

modules/cli/src/main/java/sap/prd/cmintegration/cli/TransportRelated.java

@@ -21,6 +21,9 @@
 import sap.ai.st.cm.plugins.ciintegration.odataclient.CMODataClient;
 import sap.ai.st.cm.plugins.ciintegration.odataclient.CMODataTransport;
 
+/**
+ * Base class for all transport related commands.
+ */
 abstract class TransportRelated extends Command {
 
     final static private Logger logger = LoggerFactory.getLogger(TransportRelated.class);

modules/cli/src/main/java/sap/prd/cmintegration/cli/UploadFileToTransport.java

@@ -20,6 +20,9 @@
 
 import sap.ai.st.cm.plugins.ciintegration.odataclient.CMODataClient;
 
+/**
+ * Command for uploading a file into a transport.
+ */
 @CommandDescriptor(name="upload-file-to-transport")
 class UploadFileToTransport extends Command {
 

modules/cli/src/main/java/sap/prd/cmintegration/cli/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * Contains a command line client for connecting to SAP Solution
+ * Manager. The classes contained in this package are not
+ * intended for being reused as an API.<br>
+ * For more details how to use the command line client use
+ * <code>&lt;CLIENT_HOME&gt;/bin/cmclient --help</code>
+ */
+package sap.prd.cmintegration.cli;