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 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.models.base.PfAuthorative;
  44 import org.onap.policy.models.base.PfConcept;
  45 import org.onap.policy.models.base.PfConceptKey;
  46 import org.onap.policy.models.base.PfKey;
  47 import org.onap.policy.models.base.PfReferenceKey;
  48 import org.onap.policy.models.base.PfUtils;
  49 import org.onap.policy.models.base.PfValidationMessage;
  50 import org.onap.policy.models.base.PfValidationResult;
  51 import org.onap.policy.models.base.PfValidationResult.ValidationResult;
  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<String, JpaToscaProperty> properties;
  74
  75     @ElementCollection
  76     private List<PfConceptKey> targets;
  77
  78     @ElementCollection
  79     private List<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 PfValidationResult validate(@NonNull final PfValidationResult resultIn) {
 192         PfValidationResult result = super.validate(resultIn);
 193
 194         if (PfKey.NULL_KEY_VERSION.equals(getKey().getVersion())) {
 195             result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
 196                     "key version is a null version"));
 197         }
 198
 199         if (properties != null) {
 200             result = validateProperties(result);
 201         }
 202
 203         if (targets != null) {
 204             result = validateTargets(result);
 205         }
 206
 207         if (triggers != null) {
 208             result = validateTriggers(result);
 209         }
 210
 211         return result;
 212     }
 213
 214     /**
 215      * Validate the policy properties.
 216      *
 217      * @param result The result of validations up to now
 218      * @return the validation result
 219      */
 220     private PfValidationResult validateProperties(final PfValidationResult resultIn) {
 221         PfValidationResult result = resultIn;
 222
 223         for (JpaToscaProperty property : properties.values()) {
 224             if (property == null) {
 225                 result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
 226                         "policy property may not be null "));
 227             } else {
 228                 result = property.validate(result);
 229             }
 230         }
 231         return result;
 232     }
 233
 234     /**
 235      * Validate the policy targets.
 236      *
 237      * @param result The result of validations up to now
 238      * @return the validation result
 239      */
 240     private PfValidationResult validateTargets(final PfValidationResult resultIn) {
 241         PfValidationResult result = resultIn;
 242
 243         for (PfConceptKey target : targets) {
 244             if (target == null) {
 245                 result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
 246                         "policy target may not be null "));
 247             } else {
 248                 result = target.validate(result);
 249             }
 250         }
 251         return result;
 252     }
 253
 254     /**
 255      * Validate the policy triggers.
 256      *
 257      * @param result The result of validations up to now
 258      * @return the validation result
 259      */
 260     private PfValidationResult validateTriggers(final PfValidationResult resultIn) {
 261         PfValidationResult result = resultIn;
 262
 263         for (JpaToscaTrigger trigger : triggers) {
 264             if (trigger == null) {
 265                 result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
 266                         "policy trigger may not be null "));
 267             } else {
 268                 result = trigger.validate(result);
 269             }
 270         }
 271         return result;
 272     }
 273
 274     @Override
 275     public int compareTo(final PfConcept otherConcept) {
 276         if (otherConcept == null) {
 277             return -1;
 278         }
 279         if (this == otherConcept) {
 280             return 0;
 281         }
 282         if (getClass() != otherConcept.getClass()) {
 283             return getClass().getName().compareTo(otherConcept.getClass().getName());
 284         }
 285
 286         final JpaToscaPolicyType other = (JpaToscaPolicyType) otherConcept;
 287         int result = super.compareTo(other);
 288         if (result != 0) {
 289             return result;
 290         }
 291
 292         result = PfUtils.compareMaps(properties, other.properties);
 293         if (result != 0) {
 294             return result;
 295         }
 296
 297         result = PfUtils.compareCollections(targets, other.targets);
 298         if (result != 0) {
 299             return result;
 300         }
 301
 302         return PfUtils.compareCollections(triggers, other.triggers);
 303     }
 304
 305     /**
 306      * Get the data types referenced in a policy type.
 307      *
 308      * @return the data types referenced in a policy type
 309      */
 310     public Collection<PfConceptKey> getReferencedDataTypes() {
 311         if (properties == null) {
 312             return CollectionUtils.emptyCollection();
 313         }
 314
 315         Set<PfConceptKey> referencedDataTypes = new LinkedHashSet<>();
 316
 317         for (JpaToscaProperty property : properties.values()) {
 318             referencedDataTypes.add(property.getType());
 319
 320             if (property.getEntrySchema() != null) {
 321                 referencedDataTypes.add(property.getEntrySchema().getType());
 322             }
 323         }
 324
 325         referencedDataTypes.removeAll(ToscaUtils.getPredefinedDataTypes());
 326
 327         return referencedDataTypes;
 328     }
 329 }