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
|
/*
* Copyright 2017 Huawei Technologies Co., Ltd.
*
* 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.
*/
package org.onap.cli.fw.cmd;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.onap.cli.fw.conf.OnapCommandConstants;
import org.onap.cli.fw.error.OnapCommandException;
import org.onap.cli.fw.error.OnapCommandHelpFailed;
import org.onap.cli.fw.error.OnapCommandNotInitialized;
import org.onap.cli.fw.info.OnapCommandInfo;
import org.onap.cli.fw.input.OnapCommandParameter;
import org.onap.cli.fw.output.OnapCommandResult;
import org.onap.cli.fw.output.OnapCommandResultAttribute;
import org.onap.cli.fw.output.OnapCommandResultAttributeScope;
import org.onap.cli.fw.output.OnapCommandResultType;
import org.onap.cli.fw.schema.OnapCommandSchemaLoader;
import org.onap.cli.fw.utils.OnapCommandHelperUtils;
import org.onap.cli.fw.utils.OnapCommandUtils;
/**
* Oclip Command.
*
*/
public abstract class OnapCommand {
private String cmdDescription;
private String cmdName;
private String cmdSchemaName;
private OnapCommandInfo info = new OnapCommandInfo();
private Set<OnapCommandParameter> cmdParameters = new HashSet<>();
private OnapCommandResult cmdResult = new OnapCommandResult();
protected boolean isInitialzied = false;
public String getSchemaVersion() {
return OnapCommandConstants.OPEN_CLI_SCHEMA_VERSION_VALUE_1_0;
}
public String getDescription() {
return this.cmdDescription;
}
public void setDescription(String description) {
this.cmdDescription = description;
}
public String getName() {
return this.cmdName;
}
public void setName(String name) {
this.cmdName = name;
}
public OnapCommandInfo getInfo() {
return info;
}
public void setInfo(OnapCommandInfo info) {
this.info = info;
}
public void setParameters(Set<OnapCommandParameter> parameters) {
this.cmdParameters = parameters;
}
public Set<OnapCommandParameter> getParameters() {
return this.cmdParameters;
}
public Map<String, OnapCommandParameter> getParametersMap() {
return OnapCommandUtils.getInputMap(this.getParameters());
}
public OnapCommandResult getResult() {
return this.cmdResult;
}
public void setResult(OnapCommandResult result) {
this.cmdResult = result;
}
public String getSchemaName() {
return cmdSchemaName;
}
protected void setSchemaName(String schemaName) {
this.cmdSchemaName = schemaName;
}
/**
* Initialize this command from command schema and assumes schema is already validated.
*
* @throws OnapCommandException
*
* @return List of error strings
*/
public List<String> initializeSchema(String schema) throws OnapCommandException {
return this.initializeSchema(schema, false);
}
public List<String> initializeSchema(String schema, boolean validate) throws OnapCommandException {
this.setSchemaName(schema);
List<String> errors = OnapCommandSchemaLoader.loadSchema(this, schema, true, validate);
errors.addAll(this.initializeProfileSchema());
this.isInitialzied = true;
return errors;
}
/**
* Any additional profile based such as http schema could be initialized.
*/
protected List<String> initializeProfileSchema() throws OnapCommandException {
return new ArrayList<>();
}
/*
* Validate input parameters. This can be overridden in derived commands
*/
protected void validate() throws OnapCommandException {
for (OnapCommandParameter param : this.getParameters()) {
if (param.isInclude()) {
param.validate();
}
}
}
/**
* Oclip command execute with given parameters on service. Before calling this method, its mandatory to set all
* parameters value.
*
* @throws OnapCommandException
* : General Command Exception
*/
public OnapCommandResult execute() throws OnapCommandException {
if (!this.isInitialzied) {
throw new OnapCommandNotInitialized(this.getClass().getName());
}
Map<String, OnapCommandParameter> paramMap = this.getParametersMap();
// -h or --help is always higher precedence !, user can set this value to get help message
if (OnapCommandConstants.BOOLEAN_TRUE.equals(paramMap.get(OnapCommandConstants.DEFAULT_PARAMETER_HELP).getValue())) {
this.cmdResult.setType(OnapCommandResultType.TEXT);
this.cmdResult.setOutput(this.printHelp());
return this.cmdResult;
}
// -v or --version is next higher precedence !, user can set this value to get help message
if (OnapCommandConstants.BOOLEAN_TRUE.equals(paramMap.get(OnapCommandConstants.DEFAULT_PARAMETER_VERSION).getValue())) {
this.cmdResult.setType(OnapCommandResultType.TEXT);
this.cmdResult.setOutput(this.printVersion());
return this.cmdResult;
}
// validate
this.validate();
// -f or --format
this.cmdResult.setType(
OnapCommandResultType.get(paramMap.get(OnapCommandConstants.DEFAULT_PARAMETER_OUTPUT_FORMAT).getValue().toString()));
if (OnapCommandConstants.BOOLEAN_TRUE.equals(paramMap.get(OnapCommandConstants.DEFAULT_PARAMETER_OUTPUT_ATTR_LONG).getValue())) {
this.cmdResult.setScope(OnapCommandResultAttributeScope.LONG);
}
// --no-title
if (OnapCommandConstants.BOOLEAN_TRUE.equals(paramMap.get(OnapCommandConstants.DEFAULT_PARAMETER_OUTPUT_NO_TITLE).getValue())) {
this.cmdResult.setIncludeTitle(false);
}
// --debug
if (OnapCommandConstants.BOOLEAN_TRUE.equals(paramMap.get(OnapCommandConstants.DEFAULT_PARAMETER_DEBUG).getValue())) {
this.cmdResult.setDebug(true);
}
//pre-process result attributes for spl entries and input parameters
for (OnapCommandResultAttribute attr: this.cmdResult.getRecords()) {
if (!attr.getDefaultValue().isEmpty()) {
attr.setDefaultValue(OnapCommandUtils.replaceLineForSpecialValues(attr.getDefaultValue()));
attr.setDefaultValue(OnapCommandUtils.replaceLineFromInputParameters(
attr.getDefaultValue(), this.getParametersMap()));
}
}
this.run();
return this.cmdResult;
}
/*
* Each command implements run method to executing the command.
*
*/
protected abstract void run() throws OnapCommandException;
/**
* Returns the service service version it supports.
*
* @return version
*/
public String printVersion() {
return this.getInfo().getProduct() + "::" + this.getInfo().getService();
}
/**
* Provides help message for this command.
*
* @return help message
* @throws OnapCommandHelpFailed
* Failed to execute Help command.
*/
public String printHelp() throws OnapCommandHelpFailed {
return OnapCommandHelperUtils.help(this);
}
// (mrkanag) Add toString for all command, parameter, result, etc objects in JSON format
}
|
