models-tosca/src/main/java/org/onap/policy/models/tosca/simple/concepts/JpaToscaPolicies.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019-2020, 2023 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
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  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.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.models.tosca.simple.concepts;
  23
  24 import jakarta.persistence.Entity;
  25 import jakarta.persistence.Inheritance;
  26 import jakarta.persistence.InheritanceType;
  27 import jakarta.persistence.Table;
  28 import java.io.Serial;
  29 import java.util.List;
  30 import java.util.Map;
  31 import java.util.TreeMap;
  32 import lombok.Data;
  33 import lombok.EqualsAndHashCode;
  34 import lombok.NonNull;
  35 import lombok.ToString;
  36 import org.onap.policy.common.parameters.BeanValidationResult;
  37 import org.onap.policy.models.base.PfAuthorative;
  38 import org.onap.policy.models.base.PfConceptContainer;
  39 import org.onap.policy.models.base.PfConceptKey;
  40 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  41 import org.onap.policy.models.tosca.utils.ToscaUtils;
  42
  43 /**
  44  * This class is a container for TOSCA data types.
  45  *
  46  * @author Liam Fallon (liam.fallon@est.tech)
  47  */
  48 @Entity
  49 @Table(name = "ToscaPolicies")
  50 @Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
  51 @Data
  52 @ToString(callSuper = true)
  53 @EqualsAndHashCode(callSuper = true)
  54 public class JpaToscaPolicies extends PfConceptContainer<JpaToscaPolicy, ToscaPolicy>
  55         implements PfAuthorative<List<Map<String, ToscaPolicy>>> {
  56     @Serial
  57     private static final long serialVersionUID = -7526648702327776101L;
  58
  59     public static final String DEFAULT_NAME = "ToscaPoliciesSimple";
  60     public static final String DEFAULT_VERSION = "1.0.0";
  61
  62     /**
  63      * The Default Constructor creates a {@link JpaToscaPolicies} object with a null artifact key and creates an empty
  64      * concept map.
  65      */
  66     public JpaToscaPolicies() {
  67         super(new PfConceptKey(DEFAULT_NAME, DEFAULT_VERSION));
  68     }
  69
  70     /**
  71      * The Key Constructor creates a {@link JpaToscaPolicies} object with the given artifact key and creates an empty
  72      * concept map.
  73      *
  74      * @param key the concept key
  75      */
  76     public JpaToscaPolicies(final PfConceptKey key) {
  77         super(key, new TreeMap<>());
  78     }
  79
  80     /**
  81      * This Constructor creates an concept container with all of its fields defined.
  82      *
  83      * @param key the concept container key
  84      * @param conceptMap the concepts to be stored in the concept container
  85      */
  86     public JpaToscaPolicies(final PfConceptKey key, final Map<PfConceptKey, JpaToscaPolicy> conceptMap) {
  87         super(key, conceptMap);
  88     }
  89
  90     /**
  91      * Copy constructor.
  92      *
  93      * @param copyConcept the concept to copy from
  94      */
  95     public JpaToscaPolicies(final JpaToscaPolicies copyConcept) {
  96         super(copyConcept);
  97     }
  98
  99     /**
 100      * Authorative constructor.
 101      *
 102      * @param authorativeConceptMapList the authorative concept to copy from
 103      */
 104     public JpaToscaPolicies(final List<Map<String, ToscaPolicy>> authorativeConceptMapList) {
 105         super(new PfConceptKey(DEFAULT_NAME, DEFAULT_VERSION));
 106         this.fromAuthorative(authorativeConceptMapList);
 107     }
 108
 109     @Override
 110     public BeanValidationResult validate(@NonNull String fieldName) {
 111         BeanValidationResult result = super.validate(fieldName);
 112
 113         for (JpaToscaPolicy policy : this.getConceptMap().values()) {
 114             ToscaUtils.getEntityTypeAncestors(this, policy, result);
 115         }
 116
 117         return result;
 118     }
 119 }