2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019 Nordix Foundation.
4 * Modifications Copyright (C) 2019 AT&T Intellectual Property.
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.pap.main.startstop;
25 import java.io.PrintWriter;
26 import java.io.StringWriter;
28 import java.util.Arrays;
30 import org.apache.commons.cli.CommandLine;
31 import org.apache.commons.cli.DefaultParser;
32 import org.apache.commons.cli.HelpFormatter;
33 import org.apache.commons.cli.Option;
34 import org.apache.commons.cli.Options;
35 import org.apache.commons.cli.ParseException;
36 import org.onap.policy.common.utils.resources.ResourceUtils;
37 import org.onap.policy.pap.main.PolicyPapException;
38 import org.onap.policy.pap.main.PolicyPapRuntimeException;
42 * This class reads and handles command line parameters for the policy pap service.
44 * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
46 public class PapCommandLineArguments {
47 private static final String FILE_MESSAGE_PREAMBLE = " file \"";
48 private static final int HELP_LINE_LENGTH = 120;
50 private final Options options;
51 private String configurationFilePath = null;
52 private String propertyFilePath = null;
55 * Construct the options for the CLI editor.
57 public PapCommandLineArguments() {
59 options = new Options();
60 options.addOption(Option.builder("h")
62 .desc("outputs the usage of this command")
66 options.addOption(Option.builder("v")
68 .desc("outputs the version of policy pap")
72 options.addOption(Option.builder("c")
73 .longOpt("config-file")
74 .desc("the full path to the configuration file to use, "
75 + "the configuration file must be a Json file containing the policy pap parameters")
77 .argName("CONFIG_FILE")
81 options.addOption(Option.builder("p")
82 .longOpt("property-file")
83 .desc("the full path to the topic property file to use, "
84 + "the property file contains the policy pap topic properties")
94 * Construct the options for the CLI editor and parse in the given arguments.
96 * @param args The command line arguments
98 public PapCommandLineArguments(final String[] args) {
99 // Set up the options with the default constructor
102 // Parse the arguments
105 } catch (final PolicyPapException e) {
106 throw new PolicyPapRuntimeException("parse error on policy pap parameters", e);
111 * Parse the command line options.
113 * @param args The command line arguments
114 * @return a string with a message for help and version, or null if there is no message
115 * @throws PolicyPapException on command argument errors
117 public String parse(final String[] args) throws PolicyPapException {
118 // Clear all our arguments
119 setConfigurationFilePath(null);
120 setPropertyFilePath(null);
122 CommandLine commandLine = null;
124 commandLine = new DefaultParser().parse(options, args);
125 } catch (final ParseException e) {
126 throw new PolicyPapException("invalid command line arguments specified : " + e.getMessage());
129 // Arguments left over after Commons CLI does its stuff
130 final String[] remainingArgs = commandLine.getArgs();
132 if (remainingArgs.length > 0 && commandLine.hasOption('c') || remainingArgs.length > 0) {
133 throw new PolicyPapException("too many command line arguments specified : " + Arrays.toString(args));
136 if (remainingArgs.length == 1) {
137 configurationFilePath = remainingArgs[0];
140 if (commandLine.hasOption('h')) {
141 return help(Main.class.getCanonicalName());
144 if (commandLine.hasOption('v')) {
148 if (commandLine.hasOption('c')) {
149 setConfigurationFilePath(commandLine.getOptionValue('c'));
152 if (commandLine.hasOption('p')) {
153 setPropertyFilePath(commandLine.getOptionValue('p'));
160 * Validate the command line options.
162 * @throws PolicyPapException on command argument validation errors
164 public void validate() throws PolicyPapException {
165 validateReadableFile("policy pap configuration", configurationFilePath);
166 validateReadableFile("policy pap properties", propertyFilePath);
170 * Print version information for policy pap.
172 * @return the version string
174 public String version() {
175 return ResourceUtils.getResourceAsString("version.txt");
179 * Print help information for policy pap.
181 * @param mainClassName the main class name
182 * @return the help string
184 public String help(final String mainClassName) {
185 final HelpFormatter helpFormatter = new HelpFormatter();
186 final StringWriter stringWriter = new StringWriter();
187 final PrintWriter printWriter = new PrintWriter(stringWriter);
189 helpFormatter.printHelp(printWriter, HELP_LINE_LENGTH, mainClassName + " [options...]", "options", options, 0,
192 return stringWriter.toString();
196 * Gets the configuration file path.
198 * @return the configuration file path
200 public String getConfigurationFilePath() {
201 return configurationFilePath;
205 * Gets the full expanded configuration file path.
207 * @return the configuration file path
209 public String getFullConfigurationFilePath() {
210 return ResourceUtils.getFilePath4Resource(getConfigurationFilePath());
214 * Sets the configuration file path.
216 * @param configurationFilePath the configuration file path
218 public void setConfigurationFilePath(final String configurationFilePath) {
219 this.configurationFilePath = configurationFilePath;
224 * Check set configuration file path.
226 * @return true, if check set configuration file path
228 public boolean checkSetConfigurationFilePath() {
229 return configurationFilePath != null && configurationFilePath.length() > 0;
233 * Gets the property file path.
235 * @return the property file path
237 public String getPropertyFilePath() {
238 return propertyFilePath;
242 * Gets the full expanded property file path.
244 * @return the property file path
246 public String getFullPropertyFilePath() {
247 return ResourceUtils.getFilePath4Resource(getPropertyFilePath());
251 * Sets the property file path.
253 * @param propertyFilePath the property file path
255 public void setPropertyFilePath(final String propertyFilePath) {
256 this.propertyFilePath = propertyFilePath;
261 * Check set property file path.
263 * @return true, if check set property file path
265 public boolean checkSetPropertyFilePath() {
266 return propertyFilePath != null && propertyFilePath.length() > 0;
270 * Validate readable file.
272 * @param fileTag the file tag
273 * @param fileName the file name
274 * @throws PolicyPapException on the file name passed as a parameter
276 private void validateReadableFile(final String fileTag, final String fileName) throws PolicyPapException {
277 if (fileName == null || fileName.length() == 0) {
278 throw new PolicyPapException(fileTag + " file was not specified as an argument");
281 // The file name refers to a resource on the local file system
282 final URL fileUrl = ResourceUtils.getUrl4Resource(fileName);
283 if (fileUrl == null) {
284 throw new PolicyPapException(fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" does not exist");
287 final File theFile = new File(fileUrl.getPath());
288 if (!theFile.exists()) {
289 throw new PolicyPapException(fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" does not exist");
291 if (!theFile.isFile()) {
292 throw new PolicyPapException(fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" is not a normal file");
294 if (!theFile.canRead()) {
295 throw new PolicyPapException(fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" is ureadable");