client/client-monitoring/src/main/java/org/onap/policy/apex/client/monitoring/rest/ApexMonitoringRestParameterParser.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.apex.client.monitoring.rest;
  22
  23 import java.io.PrintWriter;
  24 import java.io.StringWriter;
  25 import java.util.Arrays;
  26 import org.apache.commons.cli.CommandLine;
  27 import org.apache.commons.cli.DefaultParser;
  28 import org.apache.commons.cli.HelpFormatter;
  29 import org.apache.commons.cli.Option;
  30 import org.apache.commons.cli.Options;
  31 import org.apache.commons.cli.ParseException;
  32
  33 /**
  34  * This class reads and handles command line parameters to the Apex RESTful services.
  35  *
  36  * @author Michael Watkins (michael.watkins@ericsson.com)
  37  */
  38 public class ApexMonitoringRestParameterParser {
  39     // Apache Commons CLI options
  40     private Options options;
  41
  42     /**
  43      * Construct the options for the CLI RESTful services.
  44      */
  45     public ApexMonitoringRestParameterParser() {
  46         options = new Options();
  47         options.addOption("h", "help", false, "outputs the usage of this command");
  48         options.addOption(Option.builder("p").longOpt("port").desc("port to use for the Apex Services REST calls")
  49                 .hasArg().argName("PORT").required(false).type(Number.class).build());
  50         options.addOption(Option.builder("t").longOpt("time-to-live")
  51                 .desc("the amount of time in seconds that the server will run for before terminating").hasArg()
  52                 .argName("TIME_TO_LIVE").required(false).type(Number.class).build());
  53     }
  54
  55     /**
  56      * Parse the command line options.
  57      *
  58      * @param args the arguments
  59      * @return parsed parameters
  60      */
  61     public ApexMonitoringRestParameters parse(final String[] args) {
  62         CommandLine commandLine = null;
  63         try {
  64             commandLine = new DefaultParser().parse(options, args);
  65         } catch (final ParseException e) {
  66             throw new ApexMonitoringRestParameterException(
  67                     "invalid command line arguments specified : " + e.getMessage());
  68         }
  69
  70         final ApexMonitoringRestParameters parameters = new ApexMonitoringRestParameters();
  71         final String[] remainingArgs = commandLine.getArgs();
  72
  73         if (commandLine.getArgs().length > 0) {
  74             throw new ApexMonitoringRestParameterException(
  75                     "too many command line arguments specified : " + Arrays.toString(remainingArgs));
  76         }
  77
  78         if (commandLine.hasOption('h')) {
  79             parameters.setHelp(true);
  80         }
  81         try {
  82             if (commandLine.hasOption('p')) {
  83                 parameters.setRestPort(((Number) commandLine.getParsedOptionValue("port")).intValue());
  84             }
  85         } catch (final ParseException e) {
  86             throw new ApexMonitoringRestParameterException("error parsing argument \"port\" :" + e.getMessage(), e);
  87         }
  88         try {
  89             if (commandLine.hasOption('t')) {
  90                 parameters.setTimeToLive(((Number) commandLine.getParsedOptionValue("time-to-live")).longValue());
  91             }
  92         } catch (final ParseException e) {
  93             throw new ApexMonitoringRestParameterException("error parsing argument \"time-to-live\" :" + e.getMessage(),
  94                     e);
  95         }
  96
  97         return parameters;
  98     }
  99
 100     /**
 101      * Get help information.
 102      *
 103      * @param mainClassName the main class name for the help output
 104      * @return help string
 105      */
 106     public String getHelp(final String mainClassName) {
 107         final StringWriter stringWriter = new StringWriter();
 108         final PrintWriter stringPrintWriter = new PrintWriter(stringWriter);
 109
 110         final HelpFormatter helpFormatter = new HelpFormatter();
 111         helpFormatter.printHelp(stringPrintWriter, 120, mainClassName + " [options...] ", "", options, 0, 0, "");
 112
 113         return stringWriter.toString();
 114     }
 115 }