2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2019-2021 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.LinkedHashMap;
27 import java.util.List;
29 import javax.persistence.AttributeOverride;
30 import javax.persistence.AttributeOverrides;
31 import javax.persistence.Column;
32 import javax.persistence.ElementCollection;
33 import javax.persistence.Entity;
34 import javax.persistence.Inheritance;
35 import javax.persistence.InheritanceType;
36 import javax.persistence.Lob;
37 import javax.persistence.Table;
38 import javax.ws.rs.core.Response;
40 import lombok.EqualsAndHashCode;
41 import lombok.NonNull;
42 import org.onap.policy.common.parameters.BeanValidationResult;
43 import org.onap.policy.common.parameters.annotations.NotBlank;
44 import org.onap.policy.common.parameters.annotations.NotNull;
45 import org.onap.policy.common.parameters.annotations.Valid;
46 import org.onap.policy.common.utils.coder.CoderException;
47 import org.onap.policy.common.utils.coder.StandardCoder;
48 import org.onap.policy.models.base.PfAuthorative;
49 import org.onap.policy.models.base.PfConcept;
50 import org.onap.policy.models.base.PfConceptKey;
51 import org.onap.policy.models.base.PfKey;
52 import org.onap.policy.models.base.PfModelRuntimeException;
53 import org.onap.policy.models.base.PfUtils;
54 import org.onap.policy.models.base.validation.annotations.VerifyKey;
55 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
58 * Class to represent the policy in TOSCA definition.
60 * @author Chenfei Gao (cgao@research.att.com)
61 * @author Liam Fallon (liam.fallon@est.tech)
64 @Table(name = "ToscaPolicy")
65 @Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
67 @EqualsAndHashCode(callSuper = true)
68 public class JpaToscaPolicy extends JpaToscaEntityType<ToscaPolicy> implements PfAuthorative<ToscaPolicy> {
69 private static final long serialVersionUID = 3265174757061982805L;
72 private static final String METADATA_POLICY_ID_TAG = "policy-id";
73 private static final String METADATA_POLICY_VERSION_TAG = "policy-version";
75 private static final StandardCoder STANDARD_CODER = new StandardCoder();
80 @AttributeOverride(name = "name",
81 column = @Column(name = "type_name")),
82 @AttributeOverride(name = "version",
83 column = @Column(name = "type_version"))
87 private PfConceptKey type;
91 private Map<@NotNull @NotBlank String, @NotNull String> properties;
94 private List<@NotNull @Valid PfConceptKey> targets;
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 toscaPolicy.setProperties(PfUtils.mapMap(properties, property -> {
163 return STANDARD_CODER.decode(property, Object.class);
164 } catch (CoderException ce) {
165 String errorMessage = "error decoding property JSON value read from database: " + property;
166 throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, errorMessage, ce);
174 public void fromAuthorative(@NonNull final ToscaPolicy toscaPolicy) {
175 super.fromAuthorative(toscaPolicy);
177 if (toscaPolicy.getType() != null) {
178 type.setName(toscaPolicy.getType());
180 throw new PfModelRuntimeException(Response.Status.BAD_REQUEST,
181 "PolicyType type not specified, the type of the PolicyType for this policy must be specified in "
185 if (toscaPolicy.getTypeVersion() != null) {
186 type.setVersion(toscaPolicy.getTypeVersion());
188 throw new PfModelRuntimeException(Response.Status.BAD_REQUEST,
189 "PolicyType version not specified, the version of the PolicyType for this policy must be specified"
190 + " in the type_version field");
193 properties = PfUtils.mapMap(toscaPolicy.getProperties(), property -> {
195 return STANDARD_CODER.encode(property);
196 } catch (CoderException ce) {
197 String errorMessage = "error encoding property JSON value for database: " + property;
198 throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, errorMessage, ce);
202 // Add the property metadata if it doesn't exist already
203 if (toscaPolicy.getMetadata() == null) {
204 setMetadata(new LinkedHashMap<>());
207 // Add the policy name and version fields to the metadata
208 getMetadata().put(METADATA_POLICY_ID_TAG, getKey().getName());
209 getMetadata().put(METADATA_POLICY_VERSION_TAG, getKey().getVersion());
213 public List<PfKey> getKeys() {
214 final List<PfKey> keyList = super.getKeys();
216 keyList.addAll(type.getKeys());
218 if (targets != null) {
219 keyList.addAll(targets);
226 public void clean() {
231 if (targets != null) {
232 for (PfConceptKey target : targets) {
239 public BeanValidationResult validate(String fieldName) {
240 BeanValidationResult result = super.validate(fieldName);
242 validateKeyVersionNotNull(result, "key", getKey());
248 public int compareTo(final PfConcept otherConcept) {
249 if (otherConcept == null) {
253 if (this == otherConcept) {
257 if (getClass() != otherConcept.getClass()) {
258 return getClass().getName().compareTo(otherConcept.getClass().getName());
261 final JpaToscaPolicy other = (JpaToscaPolicy) otherConcept;
262 int result = super.compareTo(other);
267 result = type.compareTo(other.type);
272 result = PfUtils.compareMaps(properties, other.properties);
277 return PfUtils.compareCollections(targets, other.targets);