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
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
* Modifications 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.model.modelapi.impl;
import java.util.Properties;
import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
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;
import org.onap.policy.apex.model.policymodel.concepts.AxPolicyModel;
import org.onap.policy.common.utils.validation.Assertions;
/**
* This class acts as a facade for operations towards a policy model.
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
public class ModelFacade {
private static final String CONCEPT = "concept ";
private static final String DOES_NOT_EXIST = " does not exist";
private static final String ALREADY_CREATED = " already created";
private static final String NO_VERSION_SPECIFIED = ", no version specified";
// Apex model we're working towards
private final ApexModel apexModel;
// Properties to use for the model
private final Properties apexProperties;
// Facade classes for working towards the real Apex model
private final KeyInformationFacade keyInformationFacade;
// JSON output on list/delete if set
private final boolean jsonMode;
/**
* Constructor to create a model facade for the Apex model.
*
* @param apexModel the apex model
* @param apexProperties Properties for the model
* @param jsonMode set to true to return JSON strings in list and delete operations, otherwise
* set to false
*/
public ModelFacade(final ApexModel apexModel, final Properties apexProperties, final boolean jsonMode) {
Assertions.argumentNotNull(apexModel, "apexModel may not be null");
Assertions.argumentNotNull(apexProperties, "apexProperties may not be null");
this.apexModel = apexModel;
this.apexProperties = apexProperties;
this.jsonMode = jsonMode;
keyInformationFacade = new KeyInformationFacade(apexModel, apexProperties, jsonMode);
}
/**
* Create model.
*
* @param name name of the model
* @param version version of the model, set to null to use the default version
* @param uuid model UUID, set to null to generate a UUID
* @param description model description, set to null to generate a description
* @return result of the operation
*/
public ApexApiResult createModel(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 {
final String defaultVersion = apexProperties.getProperty("DEFAULT_CONCEPT_VERSION");
if (defaultVersion != null) {
key.setVersion(defaultVersion);
} else {
return new ApexApiResult(ApexApiResult.Result.FAILED, CONCEPT + name + NO_VERSION_SPECIFIED);
}
}
if (!apexModel.getPolicyModel().getKey().equals(AxArtifactKey.getNullKey())) {
return new ApexApiResult(ApexApiResult.Result.CONCEPT_EXISTS,
CONCEPT + apexModel.getPolicyModel().getKey().getId() + ALREADY_CREATED);
}
apexModel.setPolicyModel(new AxPolicyModel(key));
ApexApiResult result;
result = keyInformationFacade.createKeyInformation(name, version, uuid, description);
if (result.getResult().equals(ApexApiResult.Result.SUCCESS)) {
apexModel.getPolicyModel().getKeyInformation().generateKeyInfo(apexModel.getPolicyModel());
}
return result;
} catch (final Exception e) {
return new ApexApiResult(ApexApiResult.Result.FAILED, e);
}
}
/**
* Update model.
*
* @param name name of the model
* @param version version of the model, set to null to update the latest version
* @param uuid key information UUID, set to null to not update
* @param description policy description, set to null to not update
* @return result of the operation
*/
public ApexApiResult updateModel(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 {
final String defaultVersion = apexProperties.getProperty("DEFAULT_CONCEPT_VERSION");
if (defaultVersion != null) {
key.setVersion(defaultVersion);
} else {
return new ApexApiResult(ApexApiResult.Result.FAILED,
CONCEPT + apexModel.getPolicyModel().getKey().getId() + NO_VERSION_SPECIFIED);
}
}
if (apexModel.getPolicyModel().getKey().equals(AxArtifactKey.getNullKey())) {
return new ApexApiResult(ApexApiResult.Result.CONCEPT_DOES_NOT_EXIST,
CONCEPT + apexModel.getPolicyModel().getKey().getId() + DOES_NOT_EXIST);
}
return keyInformationFacade.updateKeyInformation(name, version, uuid, description);
} catch (final Exception e) {
return new ApexApiResult(ApexApiResult.Result.FAILED, e);
}
}
/**
* Get the key of an Apex model.
*
* @return the result of the operation
*/
public ApexApiResult getModelKey() {
try {
final ApexApiResult result = new ApexApiResult();
final AxArtifactKey modelkey = apexModel.getPolicyModel().getKey();
result.addMessage(new ApexModelStringWriter<AxArtifactKey>(false).writeString(modelkey, AxArtifactKey.class,
jsonMode));
return result;
} catch (final Exception e) {
return new ApexApiResult(ApexApiResult.Result.FAILED, e);
}
}
/**
* List an Apex model.
*
* @return the result of the operation
*/
public ApexApiResult listModel() {
try {
final ApexApiResult result = new ApexApiResult();
result.addMessage(new ApexModelStringWriter<AxPolicyModel>(false).writeString(apexModel.getPolicyModel(),
AxPolicyModel.class, jsonMode));
return result;
} catch (final Exception e) {
return new ApexApiResult(ApexApiResult.Result.FAILED, e);
}
}
/**
* Delete an Apex model, clear all the concepts in the model.
*
* @return the result of the operation
*/
public ApexApiResult deleteModel() {
// @formatter:off
apexModel.getPolicyModel().getSchemas().getSchemasMap().clear();
apexModel.getPolicyModel().getEvents().getEventMap().clear();
apexModel.getPolicyModel().getAlbums().getAlbumsMap().clear();
apexModel.getPolicyModel().getTasks().getTaskMap().clear();
apexModel.getPolicyModel().getPolicies().getPolicyMap().clear();
apexModel.getPolicyModel().getKeyInformation().getKeyInfoMap().clear();
// @formatter:on
apexModel.setPolicyModel(new AxPolicyModel());
return new ApexApiResult();
}
}
|
