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
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2021 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.clamp.controlloop.common.startstop;
import java.io.File;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.net.URL;
import javax.ws.rs.core.Response;
import org.apache.commons.cli.HelpFormatter;
import org.apache.commons.cli.Option;
import org.apache.commons.cli.Options;
import org.apache.commons.lang3.StringUtils;
import org.onap.policy.clamp.controlloop.common.exception.ControlLoopException;
import org.onap.policy.common.utils.resources.ResourceUtils;
/**
* This class reads and handles command line parameters.
*
*/
public class CommonCommandLineArguments {
private static final String FILE_MESSAGE_PREAMBLE = " file \"";
private static final int HELP_LINE_LENGTH = 120;
/**
* Construct the options for the policy participant.
*/
public CommonCommandLineArguments(final Options options) {
//@formatter:off
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 policy participant")
.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 "
+ "policy participant parameters")
.hasArg()
.argName("CONFIG_FILE")
.required(false)
.type(String.class)
.build());
//@formatter:on
}
/**
* Validate the command line options.
*
* @throws ControlLoopException on command argument validation errors
*/
public void validate(final String configurationFilePath) throws ControlLoopException {
validateReadableFile("policy participant configuration", configurationFilePath);
}
/**
* Print version information for policy participant.
*
* @return the version string
*/
public String version() {
return ResourceUtils.getResourceAsString("version.txt");
}
/**
* Print help information for policy participant.
*
* @param mainClassName the main class name
* @return the help string
*/
public String help(final String mainClassName, final Options options) {
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();
}
/**
* Validate readable file.
*
* @param fileTag the file tag
* @param fileName the file name
* @throws ControlLoopException on the file name passed as a parameter
*/
private void validateReadableFile(final String fileTag, final String fileName) throws ControlLoopException {
if (StringUtils.isEmpty(fileName)) {
throw new ControlLoopException(Response.Status.NOT_ACCEPTABLE,
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 ControlLoopException(Response.Status.NOT_ACCEPTABLE,
fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" does not exist");
}
final File theFile = new File(fileUrl.getPath());
if (!theFile.exists()) {
throw new ControlLoopException(Response.Status.NOT_ACCEPTABLE,
fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" does not exist");
}
if (!theFile.isFile()) {
throw new ControlLoopException(Response.Status.NOT_ACCEPTABLE,
fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" is not a normal file");
}
if (!theFile.canRead()) {
throw new ControlLoopException(Response.Status.NOT_ACCEPTABLE,
fileTag + FILE_MESSAGE_PREAMBLE + fileName + "\" is ureadable");
}
}
}
|
