2 * ============LICENSE_START=======================================================
3 * Copyright (C) 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.distribution.main.startstop;
24 import java.io.PrintWriter;
25 import java.io.StringWriter;
27 import java.util.Arrays;
29 import org.apache.commons.cli.CommandLine;
30 import org.apache.commons.cli.DefaultParser;
31 import org.apache.commons.cli.HelpFormatter;
32 import org.apache.commons.cli.Option;
33 import org.apache.commons.cli.Options;
34 import org.apache.commons.cli.ParseException;
35 import org.onap.policy.common.utils.resources.ResourceUtils;
36 import org.onap.policy.distribution.main.PolicyDistributionException;
37 import org.onap.policy.distribution.main.PolicyDistributionRuntimeException;
40 * This class reads and handles command line parameters for the policy distribution main program.
42 public class DistributionCommandLineArguments {
43 private static final String FILE_MESSAGE_PREAMBLE = " file \"";
44 private static final int HELP_LINE_LENGTH = 120;
46 // Apache Commons CLI options
47 private final Options options;
49 // The command line options
50 private String configurationFilePath = null;
53 * Construct the options for the CLI editor.
55 public DistributionCommandLineArguments() {
57 options = new Options();
58 options.addOption(Option.builder("h")
60 .desc("outputs the usage of this command")
64 options.addOption(Option.builder("v")
66 .desc("outputs the version of policy distribution")
70 options.addOption(Option.builder("c")
71 .longOpt("config-file")
72 .desc("the full path to the configuration file to use, "
73 + "the configuration file must be a Json file containing the policy distribution parameters")
75 .argName("CONFIG_FILE")
83 * Construct the options for the CLI editor and parse in the given arguments.
85 * @param args The command line arguments
87 public DistributionCommandLineArguments(final String[] args) {
88 // Set up the options with the default constructor
91 // Parse the arguments
94 } catch (final PolicyDistributionException e) {
95 throw new PolicyDistributionRuntimeException("parse error on policy distribution parameters", e);
100 * Parse the command line options.
102 * @param args The command line arguments
103 * @return a string with a message for help and version, or null if there is no message
104 * @throws PolicyDistributionException on command argument errors
106 public String parse(final String[] args) throws PolicyDistributionException {
107 // Clear all our arguments
108 setConfigurationFilePath(null);
110 CommandLine commandLine = null;
112 commandLine = new DefaultParser().parse(options, args);
113 } catch (final ParseException e) {
114 throw new PolicyDistributionException("invalid command line arguments specified : " + e.getMessage());
117 // Arguments left over after Commons CLI does its stuff
118 final String[] remainingArgs = commandLine.getArgs();
120 if (remainingArgs.length > 0 && commandLine.hasOption('c') || remainingArgs.length > 0) {
121 throw new PolicyDistributionException(
122 "too many command line arguments specified : " + Arrays.toString(args));
125 if (remainingArgs.length == 1) {
126 configurationFilePath = remainingArgs[0];
129 if (commandLine.hasOption('h')) {
130 return help(Main.class.getCanonicalName());
133 if (commandLine.hasOption('v')) {
137 if (commandLine.hasOption('c')) {
138 setConfigurationFilePath(commandLine.getOptionValue('c'));
145 * Validate the command line options.
147 * @throws PolicyDistributionException on command argument validation errors
149 public void validate() throws PolicyDistributionException {
150 validateReadableFile("policy distribution configuration", configurationFilePath);
154 * Print version information for policy distribution.
156 * @return the version string
158 public String version() {
159 return ResourceUtils.getResourceAsString("version.txt");
163 * Print help information for policy distribution.
165 * @param mainClassName the main class name
166 * @return the help string
168 public String help(final String mainClassName) {
169 final HelpFormatter helpFormatter = new HelpFormatter();
170 final StringWriter stringWriter = new StringWriter();
171 final PrintWriter printWriter = new PrintWriter(stringWriter);
173 helpFormatter.printHelp(printWriter, HELP_LINE_LENGTH, mainClassName + " [options...]", "options", options, 0,
176 return stringWriter.toString();
180 * Gets the configuration file path.
182 * @return the configuration file path
184 public String getConfigurationFilePath() {
185 return configurationFilePath;
189 * Gets the full expanded configuration file path.
191 * @return the configuration file path
193 public String getFullConfigurationFilePath() {
194 return ResourceUtils.getFilePath4Resource(getConfigurationFilePath());
198 * Sets the configuration file path.
200 * @param configurationFilePath the configuration file path
202 public void setConfigurationFilePath(final String configurationFilePath) {
203 this.configurationFilePath = configurationFilePath;
208 * Check set configuration file path.
210 * @return true, if check set configuration file path
212 public boolean checkSetConfigurationFilePath() {
213 return configurationFilePath != null && configurationFilePath.length() > 0;
217 * Validate readable file.
219 * @param fileTag the file tag
220 * @param fileName the file name
221 * @throws PolicyDistributionException on the file name passed as a parameter
223 private void validateReadableFile(final String fileTag, final String fileName) throws PolicyDistributionException {
224 if (fileName == null || fileName.length() == 0) {
225 throw new PolicyDistributionException(fileTag + " file was not specified as an argument");
228 // The file name refers to a resource on the local file system
229 final URL fileUrl = ResourceUtils.getUrl4Resource(fileName);
230 if (fileUrl == null) {
231 throw new PolicyDistributionException(fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" does not exist");
234 final File theFile = new File(fileUrl.getPath());
235 if (!theFile.exists()) {
236 throw new PolicyDistributionException(fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" does not exist");
238 if (!theFile.isFile()) {
239 throw new PolicyDistributionException(
240 fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" is not a normal file");
242 if (!theFile.canRead()) {
243 throw new PolicyDistributionException(fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" is ureadable");