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
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
* Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* 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.model.modelapi.impl;
import java.util.Properties;
import java.util.Set;
import java.util.UUID;
import lombok.AllArgsConstructor;
import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
import org.onap.policy.apex.model.basicmodel.concepts.AxKeyInfo;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.handling.ApexModelStringWriter;
import org.onap.policy.apex.model.modelapi.ApexApiResult;
import org.onap.policy.apex.model.modelapi.ApexModel;
/**
* This class acts as a facade for operations towards a policy model for key information operations.
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
@AllArgsConstructor
public class KeyInformationFacade {
private static final String CONCEPT = "concept ";
private static final String CONCEPT_S = "concept(s) ";
private static final String DOES_NOT_EXIST = " does not exist";
private static final String DO_ES_NOT_EXIST = " do(es) not exist";
private static final String ALREADY_EXISTS = " already exists";
// Apex model we're working towards
private final ApexModel apexModel;
// Properties to use for the model
private final Properties apexProperties;
// JSON output on list/delete if set
private final boolean jsonMode;
/**
* Create key information.
*
* @param name name of the concept for the key information
* @param version version of the concept for the key information, set to null to use the default
* version
* @param uuid key information UUID, set to null to generate a UUID
* @param description key information description, set to null to generate a description
* @return result of the operation
*/
public ApexApiResult createKeyInformation(final String name, final String version, final String uuid,
final String description) {
try {
final AxArtifactKey key = new AxArtifactKey();
key.setName(name);
if (version != null) {
key.setVersion(version);
} else {
key.setVersion(apexProperties.getProperty("DEFAULT_CONCEPT_VERSION"));
}
if (apexModel.getPolicyModel().getKeyInformation().getKeyInfoMap().containsKey(key)) {
return new ApexApiResult(ApexApiResult.Result.CONCEPT_EXISTS, CONCEPT + key.getId() + ALREADY_EXISTS);
}
final AxKeyInfo keyInfo = new AxKeyInfo(key);
if (description != null) {
keyInfo.setDescription(description);
}
if (uuid != null) {
keyInfo.setUuid(UUID.fromString(uuid));
} else {
// generate a reproducible UUID
keyInfo.setUuid(AxKeyInfo.generateReproducibleUuid(keyInfo.getId() + keyInfo.getDescription()));
}
apexModel.getPolicyModel().getKeyInformation().getKeyInfoMap().put(key, keyInfo);
return new ApexApiResult();
} catch (final Exception e) {
return new ApexApiResult(ApexApiResult.Result.FAILED, e);
}
}
/**
* Update key information.
*
* @param name name of the concept for the key information
* @param version version of the concept for the key information, set to null to update the
* latest version
* @param uuid key information UUID, set to null to not update
* @param description key information description, set to null to not update
* @return result of the operation
*/
public ApexApiResult updateKeyInformation(final String name, final String version, final String uuid,
final String description) {
try {
final AxKeyInfo keyInfo = apexModel.getPolicyModel().getKeyInformation().get(name, version);
if (keyInfo == null) {
return new ApexApiResult(ApexApiResult.Result.CONCEPT_DOES_NOT_EXIST,
CONCEPT + name + ":" + version + DOES_NOT_EXIST);
}
if (description != null) {
keyInfo.setDescription(description);
}
if (uuid != null) {
keyInfo.setUuid(UUID.fromString(uuid));
} else {
// generate a reproducible UUID
keyInfo.setUuid(AxKeyInfo.generateReproducibleUuid(keyInfo.getId() + keyInfo.getDescription()));
}
return new ApexApiResult();
} catch (final Exception e) {
return new ApexApiResult(ApexApiResult.Result.FAILED, e);
}
}
/**
* List key information.
*
* @param name name of the concept for the key information, set to null to list all
* @param version starting version of the concept for the key information, set to null to list
* all versions
* @return result of the operation
*/
public ApexApiResult listKeyInformation(final String name, final String version) {
try {
final Set<AxKeyInfo> keyInfoSet = apexModel.getPolicyModel().getKeyInformation().getAll(name, version);
if (name != null && keyInfoSet.isEmpty()) {
return new ApexApiResult(ApexApiResult.Result.CONCEPT_DOES_NOT_EXIST,
CONCEPT_S + name + ':' + version + DO_ES_NOT_EXIST);
}
final ApexApiResult result = new ApexApiResult();
for (final AxKeyInfo keyInfo : keyInfoSet) {
result.addMessage(
new ApexModelStringWriter<AxKeyInfo>(false).writeString(keyInfo, AxKeyInfo.class, jsonMode));
}
return result;
} catch (final Exception e) {
return new ApexApiResult(ApexApiResult.Result.FAILED, e);
}
}
/**
* Delete key information.
*
* @param name name of the concept for the key information
* @param version version of the concept for the key information, set to null to delete all
* versions
* @return result of the operation
*/
public ApexApiResult deleteKeyInformation(final String name, final String version) {
try {
if (version != null) {
final AxArtifactKey key = new AxArtifactKey(name, version);
final AxKeyInfo removedKeyInfo =
apexModel.getPolicyModel().getKeyInformation().getKeyInfoMap().remove(key);
if (removedKeyInfo != null) {
return new ApexApiResult(ApexApiResult.Result.SUCCESS, new ApexModelStringWriter<AxKeyInfo>(false)
.writeString(removedKeyInfo, AxKeyInfo.class, jsonMode));
} else {
return new ApexApiResult(ApexApiResult.Result.CONCEPT_DOES_NOT_EXIST,
CONCEPT + key.getId() + DOES_NOT_EXIST);
}
}
final Set<AxKeyInfo> keyInfoSet = apexModel.getPolicyModel().getKeyInformation().getAll(name, version);
if (keyInfoSet.isEmpty()) {
return new ApexApiResult(ApexApiResult.Result.CONCEPT_DOES_NOT_EXIST,
CONCEPT_S + name + ':' + version + DO_ES_NOT_EXIST);
}
final ApexApiResult result = new ApexApiResult();
for (final AxKeyInfo keyInfo : keyInfoSet) {
result.addMessage(
new ApexModelStringWriter<AxKeyInfo>(false).writeString(keyInfo, AxKeyInfo.class, jsonMode));
apexModel.getPolicyModel().getKeyInformation().getKeyInfoMap().remove(keyInfo.getKey());
}
return result;
} catch (final Exception e) {
return new ApexApiResult(ApexApiResult.Result.FAILED, e);
}
}
/**
* Validate key information.
*
* @param name name of the concept for the key information
* @param version version of the concept for the key information, set to null to validate all
* versions
* @return result of the operation
*/
public ApexApiResult validateKeyInformation(final String name, final String version) {
try {
final Set<AxKeyInfo> keyInfoSet = apexModel.getPolicyModel().getKeyInformation().getAll(name, version);
if (keyInfoSet.isEmpty()) {
return new ApexApiResult(ApexApiResult.Result.CONCEPT_DOES_NOT_EXIST,
CONCEPT_S + name + ':' + version + DO_ES_NOT_EXIST);
}
final ApexApiResult result = new ApexApiResult();
for (final AxKeyInfo keyInfo : keyInfoSet) {
final AxValidationResult validationResult = keyInfo.validate(new AxValidationResult());
result.addMessage(new ApexModelStringWriter<AxArtifactKey>(false).writeString(keyInfo.getKey(),
AxArtifactKey.class, jsonMode));
result.addMessage(validationResult.toString());
}
return result;
} catch (final Exception e) {
return new ApexApiResult(ApexApiResult.Result.FAILED, e);
}
}
}
|
