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.JoinColumn;
39 import javax.persistence.JoinTable;
40 import javax.persistence.ManyToMany;
41 import javax.persistence.MappedSuperclass;
42 import javax.persistence.Table;
43 import javax.ws.rs.core.Response;
45 import lombok.EqualsAndHashCode;
46 import lombok.NonNull;
47 import org.apache.commons.lang3.StringUtils;
48 import org.onap.policy.common.parameters.BeanValidationResult;
49 import org.onap.policy.common.parameters.ValidationResult;
50 import org.onap.policy.common.parameters.annotations.NotNull;
51 import org.onap.policy.models.base.validation.annotations.VerifyKey;
55 * This class is a concept container and holds a map of concepts. The {@link PfConceptContainer} class implements the
56 * helper methods of the {@link PfConceptGetter} interface to allow {@link PfConceptContainer} instances to be retrieved
57 * by calling methods directly on this class without referencing the contained map.
59 * <p>Validation checks that a container key is not null. An error is issued if no concepts are defined in a container.
60 * Each concept entry is checked to ensure that its key and value are not null and that the key matches the key in the
61 * map value. Each concept entry is then validated individually.
63 * @param C the concept being contained
67 @Table(name = "PfConceptContainer")
69 @EqualsAndHashCode(callSuper = false)
71 public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> extends PfConcept
72 implements PfConceptGetter<C>, PfAuthorative<List<Map<String, A>>> {
73 private static final long serialVersionUID = -324211738823208318L;
75 private static final Pattern KEY_ID_PATTERN = Pattern.compile(PfKey.KEY_ID_REGEXP);
80 private PfConceptKey key;
82 @ManyToMany(cascade = CascadeType.ALL)
86 @JoinColumn(name = "conceptContainerMapName", referencedColumnName = "name"),
87 @JoinColumn(name = "concpetContainerMapVersion", referencedColumnName = "version")
89 inverseJoinColumns = {
90 @JoinColumn(name = "conceptContainerName", referencedColumnName = "name"),
91 @JoinColumn(name = "conceptContainerVersion", referencedColumnName = "version")
95 private Map<PfConceptKey, C> conceptMap;
98 * The Default Constructor creates a {@link PfConceptContainer} object with a null artifact key and creates an empty
101 public PfConceptContainer() {
102 this(new PfConceptKey());
106 * The Key Constructor creates a {@link PfConceptContainer} object with the given artifact key and creates an empty
109 * @param key the concept key
111 public PfConceptContainer(@NonNull final PfConceptKey key) {
112 this(key, new TreeMap<>());
116 * This Constructor creates an concept container with all of its fields defined.
118 * @param key the concept container key
119 * @param conceptMap the concepts to be stored in the concept container
121 public PfConceptContainer(@NonNull final PfConceptKey key, @NonNull final Map<PfConceptKey, C> conceptMap) {
125 this.conceptMap = new TreeMap<>(conceptMap);
131 * @param copyConcept the concept to copy from
133 public PfConceptContainer(@NonNull final PfConceptContainer<C, A> copyConcept) {
135 this.key = new PfConceptKey(copyConcept.key);
137 this.conceptMap = new TreeMap<>();
138 for (final Entry<PfConceptKey, C> conceptMapEntry : copyConcept.conceptMap.entrySet()) {
139 PfConceptKey newK = new PfConceptKey(conceptMapEntry.getKey());
140 C newC = PfUtils.makeCopy(conceptMapEntry.getValue());
141 this.conceptMap.put(newK, newC);
146 public List<PfKey> getKeys() {
147 final List<PfKey> keyList = key.getKeys();
149 for (final C concept : conceptMap.values()) {
150 keyList.addAll(concept.getKeys());
157 public List<Map<String, A>> toAuthorative() {
158 // The returned list is a list of map singletons with one map for each map
159 // entry in the concept container
160 List<Map<String, A>> toscaConceptMapList = new ArrayList<>();
162 for (Entry<PfConceptKey, C> conceptEntry : getConceptMap().entrySet()) {
163 // Create a map to hold this entry
164 Map<String, A> toscaPolicyMap = new LinkedHashMap<>(1);
166 // Add the concept container entry to the singleton map
167 @SuppressWarnings("unchecked")
168 PfAuthorative<A> authoritiveImpl = (PfAuthorative<A>) conceptEntry.getValue();
169 toscaPolicyMap.put(conceptEntry.getKey().getName(), authoritiveImpl.toAuthorative());
171 // Add the map to the returned list
172 toscaConceptMapList.add(toscaPolicyMap);
175 return toscaConceptMapList;
179 public void fromAuthorative(List<Map<String, A>> authorativeList) {
180 // Clear any existing map entries
183 // Concepts are in lists of maps
184 for (Map<String, A> incomingConceptMap : authorativeList) {
185 // Add the map entries one by one
186 for (Entry<String, A> incomingConceptEntry : incomingConceptMap.entrySet()) {
188 PfConceptKey conceptKey = new PfConceptKey();
189 if (KEY_ID_PATTERN.matches(incomingConceptEntry.getKey())) {
190 conceptKey = new PfConceptKey(incomingConceptEntry.getKey());
192 conceptKey.setName(incomingConceptEntry.getKey());
193 if (incomingConceptEntry.getValue().getVersion() != null) {
194 conceptKey.setVersion(incomingConceptEntry.getValue().getVersion());
196 conceptKey.setVersion(PfKey.NULL_KEY_VERSION);
200 incomingConceptEntry.getValue().setName(findConceptField(conceptKey, conceptKey.getName(),
201 incomingConceptEntry.getValue(), PfNameVersion::getDefinedName));
202 incomingConceptEntry.getValue().setVersion(findConceptField(conceptKey, conceptKey.getVersion(),
203 incomingConceptEntry.getValue(), PfNameVersion::getDefinedVersion));
205 C jpaConcept = getConceptNewInstance();
206 // This cast allows us to call the fromAuthorative method
207 @SuppressWarnings("unchecked")
208 PfAuthorative<A> authoritiveImpl = (PfAuthorative<A>) jpaConcept;
210 // Set the key name and the rest of the values on the concept
211 authoritiveImpl.fromAuthorative(incomingConceptEntry.getValue());
213 // After all that, save the map entry
214 conceptMap.put(conceptKey, jpaConcept);
218 if (conceptMap.isEmpty()) {
219 throw new PfModelRuntimeException(Response.Status.BAD_REQUEST,
220 "An incoming list of concepts must have at least one entry");
225 * Get an authorative list of the concepts in this container.
227 * @return the authorative list of concepts
229 public List<A> toAuthorativeList() {
230 List<A> toscaConceptList = new ArrayList<>();
232 for (Map<String, A> toscaConceptMap : toAuthorative()) {
233 toscaConceptList.addAll(toscaConceptMap.values());
236 return toscaConceptList;
240 public void clean() {
242 for (final Entry<PfConceptKey, C> conceptEntry : conceptMap.entrySet()) {
243 conceptEntry.getKey().clean();
244 conceptEntry.getValue().clean();
249 public BeanValidationResult validate(@NonNull String fieldName) {
250 BeanValidationResult result = new PfValidator().validateTop(fieldName, this);
251 result.addResult(validateConceptMap());
257 * Validate the concept map of the container.
259 * @return the validation result
261 private ValidationResult validateConceptMap() {
262 BeanValidationResult result = new BeanValidationResult("conceptMap", conceptMap);
264 for (final Entry<PfConceptKey, C> conceptEntry : conceptMap.entrySet()) {
265 BeanValidationResult result2 = null;
267 if (conceptEntry.getKey().equals(PfConceptKey.getNullKey())) {
268 addResult(result, "key on concept entry", conceptEntry.getKey(), IS_A_NULL_KEY);
269 } else if (conceptEntry.getValue() == null) {
270 result2 = new BeanValidationResult(conceptEntry.getKey().getId(), conceptEntry.getKey());
271 addResult(result2, "value", conceptEntry.getValue(), IS_NULL);
272 } else if (!conceptEntry.getKey().equals(conceptEntry.getValue().getKey())) {
273 result2 = new BeanValidationResult(conceptEntry.getKey().getId(), conceptEntry.getKey());
274 addResult(result2, "value", conceptEntry.getValue(), "does not equal concept key");
275 result2.addResult(conceptEntry.getValue().validate("value"));
277 result2 = new BeanValidationResult(conceptEntry.getKey().getId(), conceptEntry.getKey());
278 result2.addResult(conceptEntry.getValue().validate("value"));
281 result.addResult(result2);
283 return (result.isClean() ? null : result);
287 public int compareTo(final PfConcept otherConcept) {
288 if (otherConcept == null) {
291 if (this == otherConcept) {
294 if (getClass() != otherConcept.getClass()) {
295 return getClass().getName().compareTo(otherConcept.getClass().getName());
298 @SuppressWarnings("unchecked")
299 final PfConceptContainer<C, A> other = (PfConceptContainer<C, A>) otherConcept;
300 int retVal = key.compareTo(other.key);
305 return PfUtils.compareMaps(conceptMap, other.conceptMap);
309 * Get all the concepts that match the given name and version.
311 * @param conceptKeyName the name of the concept, if null, return all names
312 * @param conceptKeyVersion the version of the concept, if null, return all versions
313 * @return conceptKeyVersion
315 public Set<C> getAllNamesAndVersions(final String conceptKeyName, final String conceptKeyVersion) {
316 if (conceptKeyName == null || conceptKeyVersion == null || PfKey.NULL_KEY_VERSION.equals(conceptKeyVersion)) {
317 return getAll(conceptKeyName, conceptKeyVersion);
319 final Set<C> returnSet = new TreeSet<>();
320 C foundConcept = get(conceptKeyName, conceptKeyVersion);
321 if (foundConcept != null) {
322 returnSet.add(foundConcept);
329 public C get(final PfConceptKey conceptKey) {
330 if (conceptKey.isNullVersion()) {
331 return get(conceptKey.getName());
333 return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).get(conceptKey);
338 public C get(final String conceptKeyName) {
339 return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).get(conceptKeyName);
343 public C get(final String conceptKeyName, final String conceptKeyVersion) {
344 return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).get(conceptKeyName,
349 public Set<C> getAll(final String conceptKeyName) {
350 return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).getAll(conceptKeyName);
354 public Set<C> getAll(final String conceptKeyName, final String conceptKeyVersion) {
355 return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).getAll(conceptKeyName,
360 * Get a new empty instance of a concept for this concept map.
362 * @return the new instance
364 @SuppressWarnings("unchecked")
365 private C getConceptNewInstance() {
367 String conceptClassName =
368 ((ParameterizedType) getClass().getGenericSuperclass()).getActualTypeArguments()[0].getTypeName();
369 return (C) Class.forName(conceptClassName).getDeclaredConstructor().newInstance();
370 } catch (Exception ex) {
371 throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR,
372 "failed to instantiate instance of container concept class", ex);
376 private String findConceptField(final PfConceptKey conceptKey, final String keyFieldValue,
377 final PfNameVersion concept, final Function<PfNameVersion, String> fieldGetterFunction) {
379 String conceptField = fieldGetterFunction.apply(concept);
381 if (StringUtils.isBlank(conceptField) || keyFieldValue.equals(conceptField)) {
382 return keyFieldValue;
384 throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, "Key " + conceptKey.getId() + " field "
385 + keyFieldValue + " does not match the value " + conceptField + " in the concept field");