diff options
Diffstat (limited to 'client/client-deployment/src')
7 files changed, 31 insertions, 26 deletions
diff --git a/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRest.java b/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRest.java index b6ed37d80..1fb7a2259 100644 --- a/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRest.java +++ b/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRest.java @@ -29,7 +29,8 @@ import org.slf4j.ext.XLogger; import org.slf4j.ext.XLoggerFactory; /** - * This class is used to launch the services. It creates a Grizzly embedded web server and runs the services. + * This class is used to launch the services. It creates a Grizzly embedded web server and runs the + * services. */ public class ApexDeploymentRest { // Logger for this class @@ -39,16 +40,17 @@ public class ApexDeploymentRest { private HttpServer server; /** - * Starts the HTTP server for the Apex services client on the default base URI and with the default REST packages + * Starts the HTTP server for the Apex services client on the default base URI and with the + * default REST packages. */ public ApexDeploymentRest() { this(new ApexDeploymentRestParameters()); } /** - * Starts the HTTP server for the Apex services client + * Starts the HTTP server for the Apex services client. * - * @param parameters: The Apex parameters to use to start the server + * @param parameters The Apex parameters to use to start the server */ public ApexDeploymentRest(final ApexDeploymentRestParameters parameters) { Assertions.argumentNotNull(parameters, "parameters may not be null"); @@ -74,7 +76,7 @@ public class ApexDeploymentRest { } /** - * Shut down the web server + * Shut down the web server. */ public void shutdown() { logger.debug("Apex services RESTful client shutting down . . ."); diff --git a/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestMain.java b/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestMain.java index 6e7220487..a0e6641db 100644 --- a/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestMain.java +++ b/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestMain.java @@ -23,13 +23,15 @@ package org.onap.policy.apex.client.deployment.rest; import java.io.PrintStream; /** - * User: ewatkmi Date: 31 Jul 2017 + * The main class for ApexDeploymentRest. + * + * @author Michael Watkins (michael.watkins@ericsson.com) */ public class ApexDeploymentRestMain { // Services state public enum ServicesState { STOPPED, READY, INITIALIZING, RUNNING - }; + } private ServicesState state = ServicesState.STOPPED; @@ -43,7 +45,7 @@ public class ApexDeploymentRestMain { private ApexDeploymentRest apexDeploymentRest = null; /** - * Main method, main entry point for command + * Main method, main entry point for command. * * @param args The command line arguments for the client */ @@ -57,7 +59,7 @@ public class ApexDeploymentRestMain { } /** - * Constructor, kicks off the rest service + * Constructor, kicks off the rest service. * * @param args The command line arguments for the RESTful service * @param outStream The stream for output messages @@ -95,7 +97,7 @@ public class ApexDeploymentRestMain { } /** - * Initialize the rest service + * Initialize the rest service. */ public void init() { outStream.println("Apex Services REST endpoint (" + this.toString() + ") starting at " @@ -161,7 +163,7 @@ public class ApexDeploymentRestMain { } /** - * Explicitly shut down the services + * Explicitly shut down the services. */ public void shutdown() { if (apexDeploymentRest != null) { @@ -173,7 +175,7 @@ public class ApexDeploymentRestMain { } /** - * This class is a shutdown hook for the Apex services command + * This class is a shutdown hook for the Apex services command. */ private class ApexServicesShutdownHook implements Runnable { /* diff --git a/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestParameterException.java b/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestParameterException.java index 87785b7f3..325128dfb 100644 --- a/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestParameterException.java +++ b/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestParameterException.java @@ -23,13 +23,13 @@ package org.onap.policy.apex.client.deployment.rest; /** * A run time exception used to report parsing and parameter input errors. * - * User: ewatkmi Date: 31 Jul 2017 + * @author Michael Watkins (michael.watkins@ericsson.com) */ public class ApexDeploymentRestParameterException extends IllegalArgumentException { private static final long serialVersionUID = 6520231162404452427L; /** - * Create an ApexServicesRestParameterException with a message + * Create an ApexServicesRestParameterException with a message. * * @param message the message */ diff --git a/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestParameterParser.java b/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestParameterParser.java index 35ad9cdde..564be435c 100644 --- a/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestParameterParser.java +++ b/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestParameterParser.java @@ -32,16 +32,16 @@ import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; /** - * This class reads and handles command line parameters to the Apex RESTful services + * This class reads and handles command line parameters to the Apex RESTful services. * - * User: ewatkmi Date: 31 Jul 2017 + * @author Michael Watkins (michael.watkins@ericsson.com) */ public class ApexDeploymentRestParameterParser { // Apache Commons CLI options Options options; /** - * Construct the options for the CLI RESTful services + * Construct the options for the CLI RESTful services. */ public ApexDeploymentRestParameterParser() { options = new Options(); @@ -54,7 +54,7 @@ public class ApexDeploymentRestParameterParser { } /** - * Parse the command line options + * Parse the command line options. * * @param args the arguments * @return the parsed arguments @@ -99,7 +99,7 @@ public class ApexDeploymentRestParameterParser { } /** - * Get help information + * Get help information. * * @param mainClassName the main class name for the help output * @return help string diff --git a/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestParameters.java b/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestParameters.java index 952492f53..af8cc5ab4 100644 --- a/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestParameters.java +++ b/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestParameters.java @@ -23,9 +23,9 @@ package org.onap.policy.apex.client.deployment.rest; import java.net.URI; /** - * This class reads and handles command line parameters to the Apex RESTful services + * This class reads and handles command line parameters to the Apex RESTful services. * - * User: ewatkmi Date: 31 Jul 2017 + * @author Michael Watkins (michael.watkins@ericsson.com) */ public class ApexDeploymentRestParameters { public static final int DEFAULT_REST_PORT = 18989; diff --git a/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestResource.java b/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestResource.java index 810b59cc1..13192aa2a 100644 --- a/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestResource.java +++ b/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ApexDeploymentRestResource.java @@ -42,11 +42,12 @@ import org.slf4j.ext.XLoggerFactory; /** * The class represents the root resource exposed at the base URL<br> - * The url to access this resource would be in the form {@code <baseURL>/rest/....} <br> + * + * <p>The url to access this resource would be in the form {@code <baseURL>/rest/....} <br> * For example: a GET request to the following URL * {@code http://localhost:18989/apexservices/rest/?hostName=localhost&port=12345} * - * <b>Note:</b> An allocated {@code hostName} and {@code port} query parameter must be included in all requests. + * <p><b>Note:</b> An allocated {@code hostName} and {@code port} query parameter must be included in all requests. * Datasets for different {@code hostName} are completely isolated from one another. * */ @@ -64,7 +65,7 @@ public class ApexDeploymentRestResource { public ApexDeploymentRestResource() {} /** - * Query the engine service for data + * Query the engine service for data. * * @param hostName the host name of the engine service to connect to. * @param port the port number of the engine service to connect to. diff --git a/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ParameterCheck.java b/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ParameterCheck.java index 87e76cdf7..50117e52b 100644 --- a/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ParameterCheck.java +++ b/client/client-deployment/src/main/java/org/onap/policy/apex/client/deployment/rest/ParameterCheck.java @@ -40,7 +40,7 @@ public final class ParameterCheck { private ParameterCheck() {} /** - * The Enum StartStop is used to hold . + * The Enum StartStop is used to hold. * * @author Liam Fallon (liam.fallon@ericsson.com) */ @@ -49,7 +49,7 @@ public final class ParameterCheck { START, /** Stop of an Apex engine has been ordered. */ STOP - }; + } private static final XLogger LOGGER = XLoggerFactory.getXLogger(ParameterCheck.class); |