2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved.
6 * Modifications Copyright (C) 2019-2020 Nordix Foundation.
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
20 * SPDX-License-Identifier: Apache-2.0
21 * ============LICENSE_END=========================================================
24 package org.onap.policy.models.tosca.simple.concepts;
26 import java.util.ArrayList;
27 import java.util.LinkedHashMap;
28 import java.util.List;
30 import java.util.Map.Entry;
32 import javax.persistence.AttributeOverride;
33 import javax.persistence.AttributeOverrides;
34 import javax.persistence.Column;
35 import javax.persistence.ElementCollection;
36 import javax.persistence.Entity;
37 import javax.persistence.Inheritance;
38 import javax.persistence.InheritanceType;
39 import javax.persistence.Lob;
40 import javax.persistence.Table;
41 import javax.ws.rs.core.Response;
44 import lombok.EqualsAndHashCode;
45 import lombok.NonNull;
47 import org.onap.policy.common.utils.coder.CoderException;
48 import org.onap.policy.common.utils.coder.StandardCoder;
49 import org.onap.policy.common.utils.validation.ParameterValidationUtils;
50 import org.onap.policy.models.base.PfAuthorative;
51 import org.onap.policy.models.base.PfConcept;
52 import org.onap.policy.models.base.PfConceptKey;
53 import org.onap.policy.models.base.PfKey;
54 import org.onap.policy.models.base.PfModelRuntimeException;
55 import org.onap.policy.models.base.PfUtils;
56 import org.onap.policy.models.base.PfValidationMessage;
57 import org.onap.policy.models.base.PfValidationResult;
58 import org.onap.policy.models.base.PfValidationResult.ValidationResult;
59 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
62 * Class to represent the policy in TOSCA definition.
64 * @author Chenfei Gao (cgao@research.att.com)
65 * @author Liam Fallon (liam.fallon@est.tech)
68 @Table(name = "ToscaPolicy")
69 @Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
71 @EqualsAndHashCode(callSuper = true)
72 public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements PfAuthorative<ToscaPolicy> {
73 private static final long serialVersionUID = 3265174757061982805L;
76 private static final String METADATA_POLICY_ID_TAG = "policy-id";
77 private static final String METADATA_POLICY_VERSION_TAG = "policy-version";
82 @AttributeOverride(name = "name",
83 column = @Column(name = "type_name")),
84 @AttributeOverride(name = "version",
85 column = @Column(name = "type_version"))
87 private PfConceptKey type;
91 private Map<String, String> properties = new LinkedHashMap<>();
94 private List<PfConceptKey> targets = new ArrayList<>();
98 * The Default Constructor creates a {@link JpaToscaPolicy} object with a null key.
100 public JpaToscaPolicy() {
101 this(new PfConceptKey());
105 * The Key Constructor creates a {@link JpaToscaPolicy} object with the given concept key.
109 public JpaToscaPolicy(@NonNull final PfConceptKey key) {
110 this(key, new PfConceptKey());
114 * The full Constructor creates a {@link JpaToscaPolicy} object with all mandatory fields.
117 * @param type the type of the policy
119 public JpaToscaPolicy(@NonNull final PfConceptKey key, @NonNull final PfConceptKey type) {
127 * @param copyConcept the concept to copy from
129 public JpaToscaPolicy(@NonNull final JpaToscaPolicy copyConcept) {
131 this.type = new PfConceptKey(copyConcept.type);
132 this.properties = (copyConcept.properties != null ? new LinkedHashMap<>(copyConcept.properties) : null);
133 this.targets = PfUtils.mapList(copyConcept.targets, PfConceptKey::new);
137 * Authorative constructor.
139 * @param authorativeConcept the authorative concept to copy from
141 public JpaToscaPolicy(final ToscaPolicy authorativeConcept) {
142 super(new PfConceptKey());
143 type = new PfConceptKey();
144 this.fromAuthorative(authorativeConcept);
148 public ToscaPolicy toAuthorative() {
149 ToscaPolicy toscaPolicy = new ToscaPolicy();
150 super.setToscaEntity(toscaPolicy);
151 super.toAuthorative();
153 toscaPolicy.setType(type.getName());
155 if (!PfKey.NULL_KEY_VERSION.equals(type.getVersion())) {
156 toscaPolicy.setTypeVersion(type.getVersion());
158 toscaPolicy.setTypeVersion(null);
161 if (properties != null) {
162 Map<String, Object> propertyMap = new LinkedHashMap<>();
164 final StandardCoder coder = new StandardCoder();
166 for (Entry<String, String> entry : properties.entrySet()) {
168 // TODO: This is a HACK, we need to validate the properties against their
169 // TODO: their data type in their policy type definition in TOSCA, which means reading
170 // TODO: the policy type from the database and parsing the property value object correctly
171 // TODO: Here we are simply reading a JSON string from the database and deserializing the
172 // TODO: property value from JSON
173 propertyMap.put(entry.getKey(), coder.decode(entry.getValue(), Object.class));
174 } catch (CoderException ce) {
175 String errorMessage = "error decoding property JSON value read from database: key=" + entry.getKey()
176 + ", value=" + entry.getValue();
177 throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, errorMessage, ce);
181 toscaPolicy.setProperties(propertyMap);
188 public void fromAuthorative(@NonNull final ToscaPolicy toscaPolicy) {
189 super.fromAuthorative(toscaPolicy);
191 if (toscaPolicy.getType() != null) {
192 type.setName(toscaPolicy.getType());
194 throw new PfModelRuntimeException(Response.Status.BAD_REQUEST,
195 "PolicyType type not specified, the type of the PolicyType for this policy must be specified in "
199 if (toscaPolicy.getTypeVersion() != null) {
200 type.setVersion(toscaPolicy.getTypeVersion());
202 throw new PfModelRuntimeException(Response.Status.BAD_REQUEST,
203 "PolicyType version not specified, the version of the PolicyType for this policy must be specified in "
204 + "the type_version field");
207 if (toscaPolicy.getProperties() != null) {
208 properties = new LinkedHashMap<>();
210 final StandardCoder coder = new StandardCoder();
212 for (Entry<String, Object> propertyEntry : toscaPolicy.getProperties().entrySet()) {
213 // TODO: This is a HACK, we need to validate the properties against their
214 // TODO: their data type in their policy type definition in TOSCA, which means reading
215 // TODO: the policy type from the database and parsing the property value object correctly
216 // TODO: Here we are simply serializing the property value into a string and storing it
217 // TODO: unvalidated into the database
219 properties.put(propertyEntry.getKey(), coder.encode(propertyEntry.getValue()));
220 } catch (CoderException ce) {
221 String errorMessage = "error encoding property JSON value for database: key="
222 + propertyEntry.getKey() + ", value=" + propertyEntry.getValue();
223 throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, errorMessage, ce);
228 // Add the property metadata if it doesn't exist already
229 if (toscaPolicy.getMetadata() == null) {
230 setMetadata(new LinkedHashMap<>());
233 // Add the policy name and version fields to the metadata
234 getMetadata().put(METADATA_POLICY_ID_TAG, getKey().getName());
235 getMetadata().put(METADATA_POLICY_VERSION_TAG, getKey().getVersion());
239 public List<PfKey> getKeys() {
240 final List<PfKey> keyList = super.getKeys();
242 keyList.addAll(type.getKeys());
244 if (targets != null) {
245 keyList.addAll(targets);
252 public void clean() {
257 if (targets != null) {
258 for (PfConceptKey target : targets) {
265 public PfValidationResult validate(@NonNull final PfValidationResult resultIn) {
266 PfValidationResult result = super.validate(resultIn);
268 if (PfKey.NULL_KEY_VERSION.equals(getKey().getVersion())) {
269 result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
270 "key version is a null version"));
273 if (type == null || type.isNullKey()) {
274 result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
275 "type is null or a null key"));
277 result = type.validate(result);
280 if (properties != null) {
281 validateProperties(result);
284 if (targets != null) {
285 result = validateTargets(result);
292 * Validate the policy properties.
294 * @param result where to put the validation results
296 private void validateProperties(final PfValidationResult result) {
298 for (Entry<String, String> propertyEntry : properties.entrySet()) {
299 if (!ParameterValidationUtils.validateStringParameter(propertyEntry.getKey())) {
300 result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
301 "policy property key may not be null "));
302 } else if (propertyEntry.getValue() == null) {
303 result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
304 "policy property value may not be null "));
310 * Validate the policy targets.
312 * @param result The result of validations up to now
313 * @return the validation result
315 private PfValidationResult validateTargets(final PfValidationResult resultIn) {
316 PfValidationResult result = resultIn;
318 for (PfConceptKey target : targets) {
319 if (target == null) {
320 result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
321 "policy target may not be null "));
323 result = target.validate(result);
330 public int compareTo(final PfConcept otherConcept) {
331 if (otherConcept == null) {
335 if (this == otherConcept) {
339 if (getClass() != otherConcept.getClass()) {
340 return getClass().getName().compareTo(otherConcept.getClass().getName());
343 final JpaToscaPolicy other = (JpaToscaPolicy) otherConcept;
344 if (!super.equals(other)) {
345 return super.compareTo(other);
348 if (!type.equals(other.type)) {
349 return type.compareTo(other.type);
352 int retVal = PfUtils.compareObjects(properties, other.properties);
357 return PfUtils.compareObjects(targets, other.targets);