gerrit.onap Code Review - policy/clamp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021 Nordix Foundation.
   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.clamp.controlloop.participant.dcae.main.startstop;
  22
  23 import java.io.File;
  24 import java.io.PrintWriter;
  25 import java.io.StringWriter;
  26 import java.net.URL;
  27 import java.util.Arrays;
  28 import javax.ws.rs.core.Response;
  29 import lombok.Getter;
  30 import lombok.Setter;
  31 import org.apache.commons.cli.CommandLine;
  32 import org.apache.commons.cli.DefaultParser;
  33 import org.apache.commons.cli.HelpFormatter;
  34 import org.apache.commons.cli.Option;
  35 import org.apache.commons.cli.Options;
  36 import org.apache.commons.cli.ParseException;
  37 import org.apache.commons.lang3.StringUtils;
  38 import org.onap.policy.clamp.controlloop.common.exception.ControlLoopException;
  39 import org.onap.policy.clamp.controlloop.common.exception.ControlLoopRuntimeException;
  40 import org.onap.policy.clamp.controlloop.common.startstop.CommonCommandLineArguments;
  41 import org.onap.policy.common.utils.resources.ResourceUtils;
  42
  43 /**
  44  * This class reads and handles command line parameters for the control loop runtime service.
  45  *
  46  */
  47 public class ParticipantDcaeCommandLineArguments {
  48     private static final String FILE_MESSAGE_PREAMBLE = " file \"";
  49     private static final int HELP_LINE_LENGTH = 120;
  50
  51     private final Options options;
  52     private final CommonCommandLineArguments commonCommandLineArguments;
  53
  54     @Getter()
  55     @Setter()
  56     private String configurationFilePath = null;
  57
  58     /**
  59      * Construct the options for the dcae participant.
  60      */
  61     public ParticipantDcaeCommandLineArguments() {
  62         options = new Options();
  63         commonCommandLineArguments = new CommonCommandLineArguments(options);
  64     }
  65
  66     /**
  67      * Construct the options for the CLI editor and parse in the given arguments.
  68      *
  69      * @param args The command line arguments
  70      */
  71     public ParticipantDcaeCommandLineArguments(final String[] args) {
  72         // Set up the options with the default constructor
  73         this();
  74
  75         // Parse the arguments
  76         try {
  77             parse(args);
  78         } catch (final ControlLoopException e) {
  79             throw new ControlLoopRuntimeException(Response.Status.NOT_ACCEPTABLE,
  80                     "parse error on dcae participant parameters", e);
  81         }
  82     }
  83
  84     /**
  85      * Parse the command line options.
  86      *
  87      * @param args The command line arguments
  88      * @return a string with a message for help and version, or null if there is no message
  89      * @throws ControlLoopException on command argument errors
  90      */
  91     public String parse(final String[] args) throws ControlLoopException {
  92         // Clear all our arguments
  93         setConfigurationFilePath(null);
  94         CommandLine commandLine = null;
  95         try {
  96             commandLine = new DefaultParser().parse(options, args);
  97         } catch (final ParseException e) {
  98             throw new ControlLoopException(Response.Status.NOT_ACCEPTABLE,
  99                     "invalid command line arguments specified : " + e.getMessage());
 100         }
 101
 102         // Arguments left over after Commons CLI does its stuff
 103         final String[] remainingArgs = commandLine.getArgs();
 104
 105         if (remainingArgs.length > 0) {
 106             throw new ControlLoopException(Response.Status.NOT_ACCEPTABLE,
 107                     "too many command line arguments specified : " + Arrays.toString(args));
 108         }
 109
 110         if (commandLine.hasOption('h')) {
 111             return commonCommandLineArguments.help(Main.class.getName(), options);
 112         }
 113
 114         if (commandLine.hasOption('v')) {
 115             return commonCommandLineArguments.version();
 116         }
 117
 118         if (commandLine.hasOption('c')) {
 119             setConfigurationFilePath(commandLine.getOptionValue('c'));
 120         }
 121
 122         return null;
 123     }
 124
 125     /**
 126      * Validate the command line options.
 127      *
 128      * @throws ControlLoopException on command argument validation errors
 129      */
 130     public void validate() throws ControlLoopException {
 131         commonCommandLineArguments.validate(configurationFilePath);
 132     }
 133
 134     /**
 135      * Gets the full expanded configuration file path.
 136      *
 137      * @return the configuration file path
 138      */
 139     public String getFullConfigurationFilePath() {
 140         return ResourceUtils.getFilePath4Resource(getConfigurationFilePath());
 141     }
 142
 143     /**
 144      * Check set configuration file path.
 145      *
 146      * @return true, if check set configuration file path
 147      */
 148     public boolean checkSetConfigurationFilePath() {
 149         return !StringUtils.isEmpty(configurationFilePath);
 150     }
 151 }