2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019 Nordix Foundation.
4 * Modifications Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
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.models.sim.pdp;
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.apache.log4j.chainsaw.Main;
38 import org.onap.policy.common.utils.resources.ResourceUtils;
39 import org.onap.policy.models.sim.pdp.exception.PdpSimulatorException;
40 import org.onap.policy.models.sim.pdp.exception.PdpSimulatorRunTimeException;
43 * This class reads and handles command line parameters for the pdp simulator.
45 * @author Ajith Sreekumar (ajith.sreekumar@est.tech)
47 public class PdpSimulatorCommandLineArguments {
49 private static final String FILE_MESSAGE_PREAMBLE = " file \"";
50 private static final int HELP_LINE_LENGTH = 120;
52 private final Options options;
53 private String configurationFilePath = null;
54 private String propertyFilePath = null;
57 * Construct the options for the CLI editor.
59 public PdpSimulatorCommandLineArguments() {
61 options = new Options();
62 options.addOption(Option.builder("h")
64 .desc("outputs the usage of this command")
68 options.addOption(Option.builder("v")
70 .desc("outputs the version of pdp simulator")
74 options.addOption(Option.builder("c")
75 .longOpt("config-file")
76 .desc("the full path to the configuration file to use, "
77 + "the configuration file must be a Json file containing the pdp simulator parameters")
79 .argName("CONFIG_FILE")
83 options.addOption(Option.builder("p")
84 .longOpt("property-file")
85 .desc("the full path to the topic property file to use, "
86 + "the property file contains the pdp simulator topic properties")
96 * Construct the options for the CLI editor and parse in the given arguments.
98 * @param args The command line arguments
100 public PdpSimulatorCommandLineArguments(final String[] args) {
101 // Set up the options with the default constructor
104 // Parse the arguments
107 } catch (final PdpSimulatorException e) {
108 throw new PdpSimulatorRunTimeException("parse error on pdp simulator parameters", e);
113 * Parse the command line options.
115 * @param args The command line arguments
116 * @return a string with a message for help and version, or null if there is no message
117 * @throws PdpSimulatorException on command argument errors
119 public String parse(final String[] args) throws PdpSimulatorException {
120 // Clear all our arguments
121 setConfigurationFilePath(null);
122 setPropertyFilePath(null);
124 CommandLine commandLine = null;
126 commandLine = new DefaultParser().parse(options, args);
127 } catch (final ParseException e) {
128 throw new PdpSimulatorException("invalid command line arguments specified : " + e.getMessage());
131 // Arguments left over after Commons CLI does its stuff
132 final String[] remainingArgs = commandLine.getArgs();
134 if (remainingArgs.length > 0 && commandLine.hasOption('c') || remainingArgs.length > 0) {
135 throw new PdpSimulatorException("too many command line arguments specified : " + Arrays.toString(args));
138 if (remainingArgs.length == 1) {
139 configurationFilePath = remainingArgs[0];
142 if (commandLine.hasOption('h')) {
143 return help(Main.class.getName());
146 if (commandLine.hasOption('v')) {
150 if (commandLine.hasOption('c')) {
151 setConfigurationFilePath(commandLine.getOptionValue('c'));
154 if (commandLine.hasOption('p')) {
155 setPropertyFilePath(commandLine.getOptionValue('p'));
162 * Validate the command line options.
164 * @throws PdpSimulatorException on command argument validation errors
166 public void validate() throws PdpSimulatorException {
167 validateReadableFile("pdp simulator configuration", configurationFilePath);
171 * Print version information for pdp simulator.
173 * @return the version string
175 public String version() {
176 return ResourceUtils.getResourceAsString("src/main/resources/version.txt");
180 * Print help information for pdp simulator.
182 * @param mainClassName the main class name
183 * @return the help string
185 public String help(final String mainClassName) {
186 final HelpFormatter helpFormatter = new HelpFormatter();
187 final StringWriter stringWriter = new StringWriter();
188 final PrintWriter printWriter = new PrintWriter(stringWriter);
190 helpFormatter.printHelp(printWriter, HELP_LINE_LENGTH, mainClassName + " [options...]", "options", options, 0,
193 return stringWriter.toString();
197 * Gets the configuration file path.
199 * @return the configuration file path
201 public String getConfigurationFilePath() {
202 return configurationFilePath;
206 * Gets the full expanded configuration file path.
208 * @return the configuration file path
210 public String getFullConfigurationFilePath() {
211 return ResourceUtils.getFilePath4Resource(getConfigurationFilePath());
215 * Sets the configuration file path.
217 * @param configurationFilePath the configuration file path
219 public void setConfigurationFilePath(final String configurationFilePath) {
220 this.configurationFilePath = configurationFilePath;
225 * Check set configuration file path.
227 * @return true, if check set configuration file path
229 public boolean checkSetConfigurationFilePath() {
230 return configurationFilePath != null && configurationFilePath.length() > 0;
234 * Gets the property file path.
236 * @return the property file path
238 public String getPropertyFilePath() {
239 return propertyFilePath;
243 * Gets the full expanded property file path.
245 * @return the property file path
247 public String getFullPropertyFilePath() {
248 return ResourceUtils.getFilePath4Resource(getPropertyFilePath());
252 * Sets the property file path.
254 * @param propertyFilePath the property file path
256 public void setPropertyFilePath(final String propertyFilePath) {
257 this.propertyFilePath = propertyFilePath;
262 * Check set property file path.
264 * @return true, if check set property file path
266 public boolean checkSetPropertyFilePath() {
267 return propertyFilePath != null && propertyFilePath.length() > 0;
271 * Validate readable file.
273 * @param fileTag the file tag
274 * @param fileName the file name
275 * @throws PdpSimulatorException on the file name passed as a parameter
277 private void validateReadableFile(final String fileTag, final String fileName) throws PdpSimulatorException {
278 if (fileName == null || fileName.length() == 0) {
279 throw new PdpSimulatorException(fileTag + " file was not specified as an argument");
282 // The file name refers to a resource on the local file system
283 final URL fileUrl = ResourceUtils.getUrl4Resource(fileName);
284 if (fileUrl == null) {
285 throw new PdpSimulatorException(fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" does not exist");
288 final File theFile = new File(fileUrl.getPath());
289 if (!theFile.exists()) {
290 throw new PdpSimulatorException(fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" does not exist");
292 if (!theFile.isFile()) {
293 throw new PdpSimulatorException(fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" is not a normal file");
295 if (!theFile.canRead()) {
296 throw new PdpSimulatorException(fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" is ureadable");