2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019-2020 Nordix Foundation.
4 * Modifications Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved.
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.models.base;
24 import com.google.re2j.Pattern;
25 import java.lang.reflect.ParameterizedType;
26 import java.util.ArrayList;
27 import java.util.LinkedHashMap;
28 import java.util.List;
30 import java.util.Map.Entry;
31 import java.util.NavigableMap;
33 import java.util.TreeMap;
34 import java.util.TreeSet;
35 import java.util.function.Function;
36 import javax.persistence.CascadeType;
37 import javax.persistence.EmbeddedId;
38 import javax.persistence.Entity;
39 import javax.persistence.JoinColumn;
40 import javax.persistence.JoinTable;
41 import javax.persistence.ManyToMany;
42 import javax.persistence.MappedSuperclass;
43 import javax.persistence.Table;
44 import javax.ws.rs.core.Response;
46 import lombok.EqualsAndHashCode;
47 import lombok.NonNull;
48 import org.apache.commons.lang3.StringUtils;
49 import org.onap.policy.models.base.PfValidationResult.ValidationResult;
53 * This class is a concept container and holds a map of concepts. The {@link PfConceptContainer} class implements the
54 * helper methods of the {@link PfConceptGetter} interface to allow {@link PfConceptContainer} instances to be retrieved
55 * by calling methods directly on this class without referencing the contained map.
57 * <p>Validation checks that a container key is not null. An error is issued if no concepts are defined in a container.
58 * Each concept entry is checked to ensure that its key and value are not null and that the key matches the key in the
59 * map value. Each concept entry is then validated individually.
61 * @param C the concept being contained
65 @Table(name = "PfConceptContainer")
67 @EqualsAndHashCode(callSuper = false)
69 public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> extends PfConcept
70 implements PfConceptGetter<C>, PfAuthorative<List<Map<String, A>>> {
71 private static final long serialVersionUID = -324211738823208318L;
73 private static final Pattern KEY_ID_PATTERN = Pattern.compile(PfKey.KEY_ID_REGEXP);
76 private PfConceptKey key;
78 @ManyToMany(cascade = CascadeType.ALL)
82 @JoinColumn(name = "conceptContainerMapName", referencedColumnName = "name"),
83 @JoinColumn(name = "concpetContainerMapVersion", referencedColumnName = "version")
85 inverseJoinColumns = {
86 @JoinColumn(name = "conceptContainerName", referencedColumnName = "name"),
87 @JoinColumn(name = "conceptContainerVersion", referencedColumnName = "version")
91 private Map<PfConceptKey, C> conceptMap;
94 * The Default Constructor creates a {@link PfConceptContainer} object with a null artifact key and creates an empty
97 public PfConceptContainer() {
98 this(new PfConceptKey());
102 * The Key Constructor creates a {@link PfConceptContainer} object with the given artifact key and creates an empty
105 * @param key the concept key
107 public PfConceptContainer(@NonNull final PfConceptKey key) {
108 this(key, new TreeMap<>());
112 * This Constructor creates an concept container with all of its fields defined.
114 * @param key the concept container key
115 * @param conceptMap the concepts to be stored in the concept container
117 public PfConceptContainer(@NonNull final PfConceptKey key, @NonNull final Map<PfConceptKey, C> conceptMap) {
121 this.conceptMap = new TreeMap<>(conceptMap);
127 * @param copyConcept the concept to copy from
129 public PfConceptContainer(@NonNull final PfConceptContainer<C, A> copyConcept) {
131 this.key = new PfConceptKey(copyConcept.key);
133 this.conceptMap = new TreeMap<>();
134 for (final Entry<PfConceptKey, C> conceptMapEntry : copyConcept.conceptMap.entrySet()) {
135 PfConceptKey newK = new PfConceptKey(conceptMapEntry.getKey());
136 C newC = PfUtils.makeCopy(conceptMapEntry.getValue());
137 this.conceptMap.put(newK, newC);
142 public List<PfKey> getKeys() {
143 final List<PfKey> keyList = key.getKeys();
145 for (final C concept : conceptMap.values()) {
146 keyList.addAll(concept.getKeys());
153 public List<Map<String, A>> toAuthorative() {
154 // The returned list is a list of map singletons with one map for each map
155 // entry in the concept container
156 List<Map<String, A>> toscaConceptMapList = new ArrayList<>();
158 for (Entry<PfConceptKey, C> conceptEntry : getConceptMap().entrySet()) {
159 // Create a map to hold this entry
160 Map<String, A> toscaPolicyMap = new LinkedHashMap<>(1);
162 // Add the concept container entry to the singleton map
163 @SuppressWarnings("unchecked")
164 PfAuthorative<A> authoritiveImpl = (PfAuthorative<A>) conceptEntry.getValue();
165 toscaPolicyMap.put(conceptEntry.getKey().getName(), authoritiveImpl.toAuthorative());
167 // Add the map to the returned list
168 toscaConceptMapList.add(toscaPolicyMap);
171 return toscaConceptMapList;
175 public void fromAuthorative(List<Map<String, A>> authorativeList) {
176 // Clear any existing map entries
179 // Concepts are in lists of maps
180 for (Map<String, A> incomingConceptMap : authorativeList) {
181 // Add the map entries one by one
182 for (Entry<String, A> incomingConceptEntry : incomingConceptMap.entrySet()) {
184 PfConceptKey conceptKey = new PfConceptKey();
185 if (KEY_ID_PATTERN.matches(incomingConceptEntry.getKey())) {
186 conceptKey = new PfConceptKey(incomingConceptEntry.getKey());
188 conceptKey.setName(incomingConceptEntry.getKey());
189 if (incomingConceptEntry.getValue().getVersion() != null) {
190 conceptKey.setVersion(incomingConceptEntry.getValue().getVersion());
192 conceptKey.setVersion(PfKey.NULL_KEY_VERSION);
196 incomingConceptEntry.getValue().setName(findConceptField(conceptKey, conceptKey.getName(),
197 incomingConceptEntry.getValue(), PfNameVersion::getName));
198 incomingConceptEntry.getValue().setVersion(findConceptField(conceptKey, conceptKey.getVersion(),
199 incomingConceptEntry.getValue(), PfNameVersion::getVersion));
201 C jpaConcept = getConceptNewInstance();
202 // This cast allows us to call the fromAuthorative method
203 @SuppressWarnings("unchecked")
204 PfAuthorative<A> authoritiveImpl = (PfAuthorative<A>) jpaConcept;
206 // Set the key name and the rest of the values on the concept
207 authoritiveImpl.fromAuthorative(incomingConceptEntry.getValue());
209 // After all that, save the map entry
210 conceptMap.put(conceptKey, jpaConcept);
214 if (conceptMap.isEmpty()) {
215 throw new PfModelRuntimeException(Response.Status.BAD_REQUEST,
216 "An incoming list of concepts must have at least one entry");
221 * Get an authorative list of the concepts in this container.
223 * @return the authorative list of concepts
225 public List<A> toAuthorativeList() {
226 List<A> toscaConceptList = new ArrayList<>();
228 for (Map<String, A> toscaConceptMap : toAuthorative()) {
229 toscaConceptList.addAll(toscaConceptMap.values());
232 return toscaConceptList;
236 public void clean() {
238 for (final Entry<PfConceptKey, C> conceptEntry : conceptMap.entrySet()) {
239 conceptEntry.getKey().clean();
240 conceptEntry.getValue().clean();
245 public PfValidationResult validate(@NonNull final PfValidationResult resultIn) {
246 PfValidationResult result = resultIn;
248 if (key.equals(PfConceptKey.getNullKey())) {
249 result.addValidationMessage(
250 new PfValidationMessage(key, this.getClass(), ValidationResult.INVALID, "key is a null key"));
253 result = key.validate(result);
255 if (!conceptMap.isEmpty()) {
256 result = validateConceptMap(result);
263 * Validate the concept map of the container.
265 * @param resultIn the incoming validation results so far
266 * @return the validation results with the results of this validation added
268 private PfValidationResult validateConceptMap(final PfValidationResult resultIn) {
269 PfValidationResult result = resultIn;
271 for (final Entry<PfConceptKey, C> conceptEntry : conceptMap.entrySet()) {
272 if (conceptEntry.getKey().equals(PfConceptKey.getNullKey())) {
273 result.addValidationMessage(new PfValidationMessage(key, this.getClass(), ValidationResult.INVALID,
274 "key on concept entry " + conceptEntry.getKey() + " may not be the null key"));
275 } else if (conceptEntry.getValue() == null) {
276 result.addValidationMessage(new PfValidationMessage(key, this.getClass(), ValidationResult.INVALID,
277 "value on concept entry " + conceptEntry.getKey() + " may not be null"));
278 } else if (!conceptEntry.getKey().equals(conceptEntry.getValue().getKey())) {
279 result.addValidationMessage(new PfValidationMessage(key, this.getClass(), ValidationResult.INVALID,
280 "key on concept entry key " + conceptEntry.getKey() + " does not equal concept value key "
281 + conceptEntry.getValue().getKey()));
282 result = conceptEntry.getValue().validate(result);
284 result = conceptEntry.getValue().validate(result);
291 public int compareTo(final PfConcept otherConcept) {
292 if (otherConcept == null) {
295 if (this == otherConcept) {
298 if (getClass() != otherConcept.getClass()) {
299 return getClass().getName().compareTo(otherConcept.getClass().getName());
302 @SuppressWarnings("unchecked")
303 final PfConceptContainer<C, A> other = (PfConceptContainer<C, A>) otherConcept;
304 int retVal = key.compareTo(other.key);
309 if (!conceptMap.equals(other.conceptMap)) {
310 return (conceptMap.hashCode() - other.conceptMap.hashCode());
317 * Get all the concepts that match the given name and version.
319 * @param conceptKeyName the name of the concept, if null, return all names
320 * @param conceptKeyVersion the version of the concept, if null, return all versions
321 * @return conceptKeyVersion
323 public Set<C> getAllNamesAndVersions(final String conceptKeyName, final String conceptKeyVersion) {
324 if (conceptKeyName == null || conceptKeyVersion == null || PfKey.NULL_KEY_VERSION.equals(conceptKeyVersion)) {
325 return getAll(conceptKeyName, conceptKeyVersion);
327 final Set<C> returnSet = new TreeSet<>();
328 C foundConcept = get(conceptKeyName, conceptKeyVersion);
329 if (foundConcept != null) {
330 returnSet.add(foundConcept);
337 public C get(final PfConceptKey conceptKey) {
338 if (conceptKey.isNullVersion()) {
339 return get(conceptKey.getName());
341 return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).get(conceptKey);
346 public C get(final String conceptKeyName) {
347 return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).get(conceptKeyName);
351 public C get(final String conceptKeyName, final String conceptKeyVersion) {
352 return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).get(conceptKeyName,
357 public Set<C> getAll(final String conceptKeyName) {
358 return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).getAll(conceptKeyName);
362 public Set<C> getAll(final String conceptKeyName, final String conceptKeyVersion) {
363 return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).getAll(conceptKeyName,
368 * Get a new empty instance of a concept for this concept map.
370 * @return the new instance
372 @SuppressWarnings("unchecked")
373 private C getConceptNewInstance() {
375 String conceptClassName =
376 ((ParameterizedType) getClass().getGenericSuperclass()).getActualTypeArguments()[0].getTypeName();
377 return (C) Class.forName(conceptClassName).getDeclaredConstructor().newInstance();
378 } catch (Exception ex) {
379 throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR,
380 "failed to instantiate instance of container concept class", ex);
384 private String findConceptField(final PfConceptKey conceptKey, final String keyFieldValue,
385 final PfNameVersion concept, final Function<PfNameVersion, String> fieldGetterFunction) {
387 String conceptField = fieldGetterFunction.apply(concept);
389 if (StringUtils.isBlank(conceptField) || keyFieldValue.equals(conceptField)) {
390 return keyFieldValue;
392 throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, "Key " + conceptKey.getId() + " field "
393 + keyFieldValue + " does not match the value " + conceptField + " in the concept field");