1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2019 Nordix Foundation.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.policy.apex.services.onappf;
import java.io.File;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.net.URL;
import java.util.Arrays;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.DefaultParser;
import org.apache.commons.cli.HelpFormatter;
import org.apache.commons.cli.Option;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;
import org.apache.log4j.chainsaw.Main;
import org.onap.policy.apex.services.onappf.exception.ApexStarterException;
import org.onap.policy.apex.services.onappf.exception.ApexStarterRunTimeException;
import org.onap.policy.common.utils.resources.ResourceUtils;
/**
* This class reads and handles command line parameters for the apex starter.
*
* @author Ajith Sreekumar (ajith.sreekumar@est.tech)
*/
public class ApexStarterCommandLineArguments {
private static final String FILE_MESSAGE_PREAMBLE = " file \"";
private static final int HELP_LINE_LENGTH = 120;
private final Options options;
private String configurationFilePath = null;
private String propertyFilePath = null;
/**
* Construct the options for the CLI editor.
*/
public ApexStarterCommandLineArguments() {
//@formatter:off
options = new Options();
options.addOption(Option.builder("h")
.longOpt("help")
.desc("outputs the usage of this command")
.required(false)
.type(Boolean.class)
.build());
options.addOption(Option.builder("v")
.longOpt("version")
.desc("outputs the version of apex starter")
.required(false)
.type(Boolean.class)
.build());
options.addOption(Option.builder("c")
.longOpt("config-file")
.desc("the full path to the configuration file to use, "
+ "the configuration file must be a Json file containing the apex starter parameters")
.hasArg()
.argName("CONFIG_FILE")
.required(false)
.type(String.class)
.build());
options.addOption(Option.builder("p")
.longOpt("property-file")
.desc("the full path to the topic property file to use, "
+ "the property file contains the apex starter topic properties")
.hasArg()
.argName("PROP_FILE")
.required(false)
.type(String.class)
.build());
//@formatter:on
}
/**
* Construct the options for the CLI editor and parse in the given arguments.
*
* @param args The command line arguments
*/
public ApexStarterCommandLineArguments(final String[] args) {
// Set up the options with the default constructor
this();
// Parse the arguments
try {
parse(args);
} catch (final ApexStarterException e) {
throw new ApexStarterRunTimeException("parse error on apex starter parameters", e);
}
}
/**
* Parse the command line options.
*
* @param args The command line arguments
* @return a string with a message for help and version, or null if there is no message
* @throws ApexStarterException on command argument errors
*/
public String parse(final String[] args) throws ApexStarterException {
// Clear all our arguments
setConfigurationFilePath(null);
setPropertyFilePath(null);
CommandLine commandLine = null;
try {
commandLine = new DefaultParser().parse(options, args);
} catch (final ParseException e) {
throw new ApexStarterException("invalid command line arguments specified : " + e.getMessage());
}
// Arguments left over after Commons CLI does its stuff
final String[] remainingArgs = commandLine.getArgs();
if (remainingArgs.length > 0 && commandLine.hasOption('c') || remainingArgs.length > 0) {
throw new ApexStarterException("too many command line arguments specified : " + Arrays.toString(args));
}
if (remainingArgs.length == 1) {
configurationFilePath = remainingArgs[0];
}
if (commandLine.hasOption('h')) {
return help(Main.class.getCanonicalName());
}
if (commandLine.hasOption('v')) {
return version();
}
if (commandLine.hasOption('c')) {
setConfigurationFilePath(commandLine.getOptionValue('c'));
}
if (commandLine.hasOption('p')) {
setPropertyFilePath(commandLine.getOptionValue('p'));
}
return null;
}
/**
* Validate the command line options.
*
* @throws ApexStarterException on command argument validation errors
*/
public void validate() throws ApexStarterException {
validateReadableFile("apex starter configuration", configurationFilePath);
validateReadableFile("apex starter properties", propertyFilePath);
}
/**
* Print version information for apex starter.
*
* @return the version string
*/
public String version() {
return ResourceUtils.getResourceAsString("src/main/resources/version.txt");
}
/**
* Print help information for apex starter.
*
* @param mainClassName the main class name
* @return the help string
*/
public String help(final String mainClassName) {
final HelpFormatter helpFormatter = new HelpFormatter();
final StringWriter stringWriter = new StringWriter();
final PrintWriter printWriter = new PrintWriter(stringWriter);
helpFormatter.printHelp(printWriter, HELP_LINE_LENGTH, mainClassName + " [options...]", "options", options, 0,
0, "");
return stringWriter.toString();
}
/**
* Gets the configuration file path.
*
* @return the configuration file path
*/
public String getConfigurationFilePath() {
return configurationFilePath;
}
/**
* Gets the full expanded configuration file path.
*
* @return the configuration file path
*/
public String getFullConfigurationFilePath() {
return ResourceUtils.getFilePath4Resource(getConfigurationFilePath());
}
/**
* Sets the configuration file path.
*
* @param configurationFilePath the configuration file path
*/
public void setConfigurationFilePath(final String configurationFilePath) {
this.configurationFilePath = configurationFilePath;
}
/**
* Check set configuration file path.
*
* @return true, if check set configuration file path
*/
public boolean checkSetConfigurationFilePath() {
return configurationFilePath != null && configurationFilePath.length() > 0;
}
/**
* Gets the property file path.
*
* @return the property file path
*/
public String getPropertyFilePath() {
return propertyFilePath;
}
/**
* Gets the full expanded property file path.
*
* @return the property file path
*/
public String getFullPropertyFilePath() {
return ResourceUtils.getFilePath4Resource(getPropertyFilePath());
}
/**
* Sets the property file path.
*
* @param propertyFilePath the property file path
*/
public void setPropertyFilePath(final String propertyFilePath) {
this.propertyFilePath = propertyFilePath;
}
/**
* Check set property file path.
*
* @return true, if check set property file path
*/
public boolean checkSetPropertyFilePath() {
return propertyFilePath != null && propertyFilePath.length() > 0;
}
/**
* Validate readable file.
*
* @param fileTag the file tag
* @param fileName the file name
* @throws ApexStarterException on the file name passed as a parameter
*/
private void validateReadableFile(final String fileTag, final String fileName) throws ApexStarterException {
if (fileName == null || fileName.length() == 0) {
throw new ApexStarterException(fileTag + " file was not specified as an argument");
}
// The file name refers to a resource on the local file system
final URL fileUrl = ResourceUtils.getUrl4Resource(fileName);
if (fileUrl == null) {
throw new ApexStarterException(fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" does not exist");
}
final File theFile = new File(fileUrl.getPath());
if (!theFile.exists()) {
throw new ApexStarterException(fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" does not exist");
}
if (!theFile.isFile()) {
throw new ApexStarterException(fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" is not a normal file");
}
if (!theFile.canRead()) {
throw new ApexStarterException(fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" is ureadable");
}
}
}
|