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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.apex.client.full.rest;
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;
34 * This class reads and handles command line parameters to the Apex RESTful services.
36 * @author Michael Watkins (michael.watkins@ericsson.com)
38 public class ApexServicesRestParameterParser {
39 // Apache Commons CLI options
40 private Options options;
43 * Construct the options for the CLI RESTful services.
45 public ApexServicesRestParameterParser() {
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());
56 * Parse the command line options.
58 * @param args the arguments
59 * @return parsed parameters
61 public ApexServicesRestParameters parse(final String[] args) {
62 CommandLine commandLine = null;
64 commandLine = new DefaultParser().parse(options, args);
65 } catch (final ParseException e) {
66 throw new ApexServicesRestParameterException(
67 "invalid command line arguments specified : " + e.getMessage());
70 final ApexServicesRestParameters parameters = new ApexServicesRestParameters();
71 final String[] remainingArgs = commandLine.getArgs();
73 if (commandLine.getArgs().length > 0) {
74 throw new ApexServicesRestParameterException(
75 "too many command line arguments specified : " + Arrays.toString(remainingArgs));
78 if (commandLine.hasOption('h')) {
79 parameters.setHelp(true);
82 if (commandLine.hasOption('p')) {
83 parameters.setRestPort(((Number) commandLine.getParsedOptionValue("port")).intValue());
85 } catch (final ParseException e) {
86 throw new ApexServicesRestParameterException("error parsing argument \"port\" :" + e.getMessage(), e);
89 if (commandLine.hasOption('t')) {
90 parameters.setTimeToLive(((Number) commandLine.getParsedOptionValue("time-to-live")).longValue());
92 } catch (final ParseException e) {
93 throw new ApexServicesRestParameterException("error parsing argument \"time-to-live\" :" + e.getMessage(),
101 * Get help information.
103 * @param mainClassName the main class name for the help output
104 * @return help string
106 public String getHelp(final String mainClassName) {
107 final StringWriter stringWriter = new StringWriter();
108 final PrintWriter stringPrintWriter = new PrintWriter(stringWriter);
110 final HelpFormatter helpFormatter = new HelpFormatter();
111 helpFormatter.printHelp(stringPrintWriter, 120, mainClassName + " [options...] ", "", options, 0, 0, "");
113 return stringWriter.toString();