2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019 Nordix Foundation.
4 * ================================================================================
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.models.base;
23 import java.lang.reflect.ParameterizedType;
24 import java.util.ArrayList;
25 import java.util.LinkedHashMap;
26 import java.util.List;
28 import java.util.Map.Entry;
29 import java.util.NavigableMap;
31 import java.util.TreeMap;
33 import javax.persistence.CascadeType;
34 import javax.persistence.EmbeddedId;
35 import javax.persistence.Entity;
36 import javax.persistence.FetchType;
37 import javax.persistence.ManyToMany;
38 import javax.persistence.Table;
39 import javax.ws.rs.core.Response;
42 import lombok.EqualsAndHashCode;
43 import lombok.NonNull;
45 import org.onap.policy.common.utils.validation.Assertions;
46 import org.onap.policy.models.base.PfValidationResult.ValidationResult;
50 * This class is a concept container and holds a map of concepts. The {@link PfConceptContainer} class implements the
51 * helper methods of the {@link PfConceptGetter} interface to allow {@link PfConceptContainer} instances to be retrieved
52 * by calling methods directly on this class without referencing the contained map.
54 * <p>Validation checks that a container key is not null. An error is issued if no concepts are defined in a container.
55 * Each concept entry is checked to ensure that its key and value are not null and that the key matches the key in the
56 * map value. Each concept entry is then validated individually.
58 * @param C the concept being contained
62 @Table(name = "PfConceptContainer")
64 @EqualsAndHashCode(callSuper = false)
66 public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> extends PfConcept
67 implements PfConceptGetter<C>, PfAuthorative<List<Map<String, A>>> {
68 private static final long serialVersionUID = -324211738823208318L;
71 private PfConceptKey key;
73 @ManyToMany(fetch = FetchType.EAGER, cascade = CascadeType.ALL)
74 private Map<PfConceptKey, C> conceptMap;
77 * The Default Constructor creates a {@link PfConceptContainer} object with a null artifact key and creates an empty
80 public PfConceptContainer() {
81 this(new PfConceptKey());
85 * The Key Constructor creates a {@link PfConceptContainer} object with the given artifact key and creates an empty
88 * @param key the concept key
90 public PfConceptContainer(@NonNull final PfConceptKey key) {
91 this(key, new TreeMap<PfConceptKey, C>());
95 * This Constructor creates an concept container with all of its fields defined.
97 * @param key the concept container key
98 * @param conceptMap the concepts to be stored in the concept container
100 public PfConceptContainer(@NonNull final PfConceptKey key, @NonNull final Map<PfConceptKey, C> conceptMap) {
104 this.conceptMap = new TreeMap<>(conceptMap);
110 * @param copyConcept the concept to copy from
112 public PfConceptContainer(@NonNull final PfConceptContainer<C, A> copyConcept) {
117 public List<PfKey> getKeys() {
118 final List<PfKey> keyList = key.getKeys();
120 for (final C concept : conceptMap.values()) {
121 keyList.addAll(concept.getKeys());
128 public List<Map<String, A>> toAuthorative() {
129 // The returned list is a list of map singletons with one map for each map
130 // entry in the concept container
131 List<Map<String, A>> toscaPolicyMapList = new ArrayList<>();
133 for (Entry<PfConceptKey, C> conceptEntry : getConceptMap().entrySet()) {
134 // Create a map to hold this entry
135 Map<String, A> toscaPolicyMap = new LinkedHashMap<>(1);
137 // Add the concept container entry to the singleton map
138 @SuppressWarnings("unchecked")
139 PfAuthorative<A> authoritiveImpl = (PfAuthorative<A>) conceptEntry.getValue();
140 toscaPolicyMap.put(conceptEntry.getKey().getName(), authoritiveImpl.toAuthorative());
142 // Add the map to the returned list
143 toscaPolicyMapList.add(toscaPolicyMap);
146 return toscaPolicyMapList;
150 public void fromAuthorative(List<Map<String, A>> authorativeList) {
151 // Clear any existing map entries
154 // Concepts are in lists of maps
155 for (Map<String, A> incomingConceptMap : authorativeList) {
156 // Add the map entries one by one
157 for (Entry<String, A> incomingConceptEntry : incomingConceptMap.entrySet()) {
158 C jpaConcept = getConceptNewInstance();
160 // This cast allows us to call the fromAuthorative method
161 @SuppressWarnings("unchecked")
162 PfAuthorative<A> authoritiveImpl = (PfAuthorative<A>) jpaConcept;
164 if (incomingConceptEntry.getValue().getName() == null) {
165 incomingConceptEntry.getValue().setName(incomingConceptEntry.getKey());
168 // Set the key name and the rest of the values on the concept
169 authoritiveImpl.fromAuthorative(incomingConceptEntry.getValue());
171 // This cast gets the key of the concept
172 PfConceptKey conceptKey = (PfConceptKey) jpaConcept.getKey();
174 // Set the concept key of the concept
175 conceptKey.setName(incomingConceptEntry.getValue().getName());
177 if (incomingConceptEntry.getValue().getVersion() != null) {
178 conceptKey.setVersion(incomingConceptEntry.getValue().getVersion());
181 conceptKey.setVersion(PfKey.NULL_KEY_VERSION);
184 // After all that, save the map entry
185 conceptMap.put(conceptKey, jpaConcept);
189 if (conceptMap.isEmpty()) {
190 throw new PfModelRuntimeException(Response.Status.BAD_REQUEST,
191 "An incoming list of concepts must have at least one entry");
196 public void clean() {
198 for (final Entry<PfConceptKey, C> conceptEntry : conceptMap.entrySet()) {
199 conceptEntry.getKey().clean();
200 conceptEntry.getValue().clean();
205 public PfValidationResult validate(@NonNull final PfValidationResult resultIn) {
206 PfValidationResult result = resultIn;
208 if (key.equals(PfConceptKey.getNullKey())) {
209 result.addValidationMessage(
210 new PfValidationMessage(key, this.getClass(), ValidationResult.INVALID, "key is a null key"));
213 result = key.validate(result);
215 if (conceptMap.isEmpty()) {
216 result.addValidationMessage(new PfValidationMessage(key, this.getClass(), ValidationResult.INVALID,
217 "conceptMap may not be empty"));
219 result = validateConceptMap(result);
226 * Validate the concept map of the container.
228 * @param resultIn the incoming validation results so far
229 * @return the validation results with the results of this validation added
231 private PfValidationResult validateConceptMap(final PfValidationResult resultIn) {
232 PfValidationResult result = resultIn;
234 for (final Entry<PfConceptKey, C> conceptEntry : conceptMap.entrySet()) {
235 if (conceptEntry.getKey().equals(PfConceptKey.getNullKey())) {
236 result.addValidationMessage(new PfValidationMessage(key, this.getClass(), ValidationResult.INVALID,
237 "key on concept entry " + conceptEntry.getKey() + " may not be the null key"));
239 if (conceptEntry.getValue() == null) {
240 result.addValidationMessage(new PfValidationMessage(key, this.getClass(), ValidationResult.INVALID,
241 "value on concept entry " + conceptEntry.getKey() + " may not be null"));
243 if (!conceptEntry.getKey().equals(conceptEntry.getValue().getKey())) {
244 result.addValidationMessage(new PfValidationMessage(key, this.getClass(),
245 ValidationResult.INVALID, "key on concept entry key " + conceptEntry.getKey()
246 + " does not equal concept value key " + conceptEntry.getValue().getKey()));
247 result = conceptEntry.getValue().validate(result);
249 result = conceptEntry.getValue().validate(result);
256 public int compareTo(final PfConcept otherConcept) {
257 if (otherConcept == null) {
260 if (this == otherConcept) {
263 if (getClass() != otherConcept.getClass()) {
264 return this.hashCode() - otherConcept.hashCode();
267 @SuppressWarnings("unchecked")
268 final PfConceptContainer<C, A> other = (PfConceptContainer<C, A>) otherConcept;
269 int retVal = key.compareTo(other.key);
274 if (!conceptMap.equals(other.conceptMap)) {
275 return (conceptMap.hashCode() - other.conceptMap.hashCode());
282 public PfConcept copyTo(@NonNull final PfConcept target) {
283 Assertions.instanceOf(target, PfConceptContainer.class);
285 @SuppressWarnings("unchecked")
286 final PfConceptContainer<C, A> copy = (PfConceptContainer<C, A>) target;
287 copy.setKey(new PfConceptKey(key));
288 final Map<PfConceptKey, C> newConceptMap = new TreeMap<>();
289 for (final Entry<PfConceptKey, C> conceptMapEntry : conceptMap.entrySet()) {
290 C newC = getConceptNewInstance();
291 conceptMapEntry.getValue().copyTo(newC);
292 newConceptMap.put(new PfConceptKey(conceptMapEntry.getKey()), newC);
294 copy.setConceptMap(newConceptMap);
300 public C get(final PfConceptKey conceptKey) {
301 return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).get(conceptKey);
305 public C get(final String conceptKeyName) {
306 return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).get(conceptKeyName);
310 public C get(final String conceptKeyName, final String conceptKeyVersion) {
311 return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).get(conceptKeyName,
316 public Set<C> getAll(final String conceptKeyName) {
317 return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).getAll(conceptKeyName);
321 public Set<C> getAll(final String conceptKeyName, final String conceptKeyVersion) {
322 return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).getAll(conceptKeyName,
327 * Get a new empty instance of a concept for this concept map.
329 * @return the new instance
331 @SuppressWarnings("unchecked")
332 private C getConceptNewInstance() {
334 String conceptClassName =
335 ((ParameterizedType) getClass().getGenericSuperclass()).getActualTypeArguments()[0].getTypeName();
336 return (C) Class.forName(conceptClassName).newInstance();
337 } catch (Exception ex) {
338 throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR,
339 "failed to instantiate instance of container concept class", ex);