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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP Policy Model
   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
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  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.
  19  *
  20  * SPDX-License-Identifier: Apache-2.0
  21  * ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.policy.models.tosca.simple.concepts;
  25
  26 import java.util.Collection;
  27 import java.util.LinkedHashMap;
  28 import java.util.LinkedHashSet;
  29 import java.util.List;
  30 import java.util.Map;
  31 import java.util.Map.Entry;
  32 import java.util.Set;
  33 import javax.persistence.ElementCollection;
  34 import javax.persistence.Entity;
  35 import javax.persistence.Inheritance;
  36 import javax.persistence.InheritanceType;
  37 import javax.persistence.Lob;
  38 import javax.persistence.Table;
  39 import lombok.Data;
  40 import lombok.EqualsAndHashCode;
  41 import lombok.NonNull;
  42 import org.apache.commons.collections4.CollectionUtils;
  43 import org.onap.policy.common.parameters.BeanValidationResult;
  44 import org.onap.policy.common.parameters.annotations.NotNull;
  45 import org.onap.policy.common.parameters.annotations.Valid;
  46 import org.onap.policy.models.base.PfAuthorative;
  47 import org.onap.policy.models.base.PfConcept;
  48 import org.onap.policy.models.base.PfConceptKey;
  49 import org.onap.policy.models.base.PfKey;
  50 import org.onap.policy.models.base.PfReferenceKey;
  51 import org.onap.policy.models.base.PfUtils;
  52 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
  53 import org.onap.policy.models.tosca.authorative.concepts.ToscaProperty;
  54 import org.onap.policy.models.tosca.utils.ToscaUtils;
  55
  56 /**
  57  * Class to represent the policy type in TOSCA definition.
  58  *
  59  * @author Chenfei Gao (cgao@research.att.com)
  60  * @author Liam Fallon (liam.fallon@est.tech)
  61  */
  62
  63 @Entity
  64 @Table(name = "ToscaPolicyType")
  65 @Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
  66 @Data
  67 @EqualsAndHashCode(callSuper = true)
  68 public class JpaToscaPolicyType extends JpaToscaEntityType<ToscaPolicyType> implements PfAuthorative<ToscaPolicyType> {
  69     private static final long serialVersionUID = -563659852901842616L;
  70
  71     @ElementCollection
  72     @Lob
  73     private Map<@NotNull String, @NotNull @Valid JpaToscaProperty> properties;
  74
  75     @ElementCollection
  76     private List<@NotNull @Valid PfConceptKey> targets;
  77
  78     @ElementCollection
  79     private List<@NotNull @Valid JpaToscaTrigger> triggers;
  80
  81     /**
  82      * The Default Constructor creates a {@link JpaToscaPolicyType} object with a null key.
  83      */
  84     public JpaToscaPolicyType() {
  85         this(new PfConceptKey());
  86     }
  87
  88     /**
  89      * The Key Constructor creates a {@link JpaToscaPolicyType} object with the given concept key.
  90      *
  91      * @param key the key
  92      */
  93     public JpaToscaPolicyType(@NonNull final PfConceptKey key) {
  94         super(key);
  95     }
  96
  97     /**
  98      * Copy constructor.
  99      *
 100      * @param copyConcept the concept to copy from
 101      */
 102     public JpaToscaPolicyType(final JpaToscaPolicyType copyConcept) {
 103         super(copyConcept);
 104         this.properties = PfUtils.mapMap(copyConcept.properties, JpaToscaProperty::new);
 105         this.targets = PfUtils.mapList(copyConcept.targets, PfConceptKey::new);
 106         this.triggers = PfUtils.mapList(copyConcept.triggers, JpaToscaTrigger::new);
 107     }
 108
 109     /**
 110      * Authorative constructor.
 111      *
 112      * @param authorativeConcept the authorative concept to copy from
 113      */
 114     public JpaToscaPolicyType(final ToscaPolicyType authorativeConcept) {
 115         this.fromAuthorative(authorativeConcept);
 116     }
 117
 118     @Override
 119     public ToscaPolicyType toAuthorative() {
 120         ToscaPolicyType toscaPolicyType = new ToscaPolicyType();
 121         super.setToscaEntity(toscaPolicyType);
 122         super.toAuthorative();
 123
 124         toscaPolicyType.setProperties(PfUtils.mapMap(properties, JpaToscaProperty::toAuthorative));
 125
 126         return toscaPolicyType;
 127     }
 128
 129     @Override
 130     public void fromAuthorative(final ToscaPolicyType toscaPolicyType) {
 131         super.fromAuthorative(toscaPolicyType);
 132
 133         // Set properties
 134         if (toscaPolicyType.getProperties() != null) {
 135             properties = new LinkedHashMap<>();
 136             for (Entry<String, ToscaProperty> toscaPropertyEntry : toscaPolicyType.getProperties().entrySet()) {
 137                 JpaToscaProperty jpaProperty = new JpaToscaProperty(toscaPropertyEntry.getValue());
 138                 jpaProperty.setKey(new PfReferenceKey(getKey(), toscaPropertyEntry.getKey()));
 139                 properties.put(toscaPropertyEntry.getKey(), jpaProperty);
 140             }
 141         }
 142     }
 143
 144     @Override
 145     public List<PfKey> getKeys() {
 146         final List<PfKey> keyList = super.getKeys();
 147
 148         if (properties != null) {
 149             for (JpaToscaProperty property : properties.values()) {
 150                 keyList.addAll(property.getKeys());
 151             }
 152         }
 153
 154         if (targets != null) {
 155             keyList.addAll(targets);
 156         }
 157
 158         if (triggers != null) {
 159             for (JpaToscaTrigger trigger : triggers) {
 160                 keyList.addAll(trigger.getKeys());
 161             }
 162         }
 163
 164         return keyList;
 165     }
 166
 167     @Override
 168     public void clean() {
 169         super.clean();
 170
 171         if (properties != null) {
 172             for (JpaToscaProperty property : properties.values()) {
 173                 property.clean();
 174             }
 175         }
 176
 177         if (targets != null) {
 178             for (PfConceptKey target : targets) {
 179                 target.clean();
 180             }
 181         }
 182
 183         if (triggers != null) {
 184             for (JpaToscaTrigger trigger : triggers) {
 185                 trigger.clean();
 186             }
 187         }
 188     }
 189
 190     @Override
 191     public BeanValidationResult validate(String fieldName) {
 192         BeanValidationResult result = super.validate(fieldName);
 193
 194         validateKeyVersionNotNull(result, "key", getKey());
 195
 196         return result;
 197     }
 198
 199     @Override
 200     public int compareTo(final PfConcept otherConcept) {
 201         if (otherConcept == null) {
 202             return -1;
 203         }
 204         if (this == otherConcept) {
 205             return 0;
 206         }
 207         if (getClass() != otherConcept.getClass()) {
 208             return getClass().getName().compareTo(otherConcept.getClass().getName());
 209         }
 210
 211         final JpaToscaPolicyType other = (JpaToscaPolicyType) otherConcept;
 212         int result = super.compareTo(other);
 213         if (result != 0) {
 214             return result;
 215         }
 216
 217         result = PfUtils.compareMaps(properties, other.properties);
 218         if (result != 0) {
 219             return result;
 220         }
 221
 222         result = PfUtils.compareCollections(targets, other.targets);
 223         if (result != 0) {
 224             return result;
 225         }
 226
 227         return PfUtils.compareCollections(triggers, other.triggers);
 228     }
 229
 230     /**
 231      * Get the data types referenced in a policy type.
 232      *
 233      * @return the data types referenced in a policy type
 234      */
 235     public Collection<PfConceptKey> getReferencedDataTypes() {
 236         if (properties == null) {
 237             return CollectionUtils.emptyCollection();
 238         }
 239
 240         Set<PfConceptKey> referencedDataTypes = new LinkedHashSet<>();
 241
 242         for (JpaToscaProperty property : properties.values()) {
 243             referencedDataTypes.add(property.getType());
 244
 245             if (property.getEntrySchema() != null) {
 246                 referencedDataTypes.add(property.getEntrySchema().getType());
 247             }
 248         }
 249
 250         referencedDataTypes.removeAll(ToscaUtils.getPredefinedDataTypes());
 251
 252         return referencedDataTypes;
 253     }
 254 }