gerrit.onap Code Review - policy/clamp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2021-2024 Nordix Foundation.
   4  * ================================================================================
   5  * Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.policy.clamp.models.acm.persistence.concepts;
  24
  25 import jakarta.persistence.AttributeOverride;
  26 import jakarta.persistence.Column;
  27 import jakarta.persistence.Convert;
  28 import jakarta.persistence.Entity;
  29 import jakarta.persistence.Id;
  30 import jakarta.persistence.Inheritance;
  31 import jakarta.persistence.InheritanceType;
  32 import jakarta.persistence.Lob;
  33 import jakarta.persistence.Table;
  34 import java.util.LinkedHashMap;
  35 import java.util.Map;
  36 import java.util.UUID;
  37 import java.util.function.UnaryOperator;
  38 import lombok.Data;
  39 import lombok.EqualsAndHashCode;
  40 import lombok.NonNull;
  41 import org.apache.commons.lang3.ObjectUtils;
  42 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionElement;
  43 import org.onap.policy.clamp.models.acm.concepts.DeployState;
  44 import org.onap.policy.clamp.models.acm.concepts.LockState;
  45 import org.onap.policy.clamp.models.acm.concepts.SubState;
  46 import org.onap.policy.common.parameters.annotations.NotNull;
  47 import org.onap.policy.common.parameters.annotations.Valid;
  48 import org.onap.policy.models.base.PfAuthorative;
  49 import org.onap.policy.models.base.PfConceptKey;
  50 import org.onap.policy.models.base.PfUtils;
  51 import org.onap.policy.models.base.Validated;
  52 import org.onap.policy.models.base.validation.annotations.VerifyKey;
  53 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  54
  55 /**
  56  * Class to represent a participant automation composition element in the database.
  57  *
  58  * @author Liam Fallon (liam.fallon@est.tech)
  59  */
  60 @Entity
  61 @Table(name = "AutomationCompositionElement")
  62 @Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
  63 @Data
  64 @EqualsAndHashCode(callSuper = false)
  65 public class JpaAutomationCompositionElement extends Validated
  66     implements PfAuthorative<AutomationCompositionElement>, Comparable<JpaAutomationCompositionElement> {
  67
  68     @Id
  69     @NotNull
  70     private String elementId;
  71
  72     @Column
  73     @NotNull
  74     private String instanceId;
  75
  76     @VerifyKey
  77     @NotNull
  78     @AttributeOverride(name = "name",    column = @Column(name = "definition_name"))
  79     @AttributeOverride(name = "version", column = @Column(name = "definition_version"))
  80     private PfConceptKey definition;
  81
  82     @Column
  83     @NotNull
  84     private String participantId;
  85
  86     @Column
  87     private Boolean restarting;
  88
  89     @Column
  90     @NotNull
  91     private DeployState deployState;
  92
  93     @Column
  94     @NotNull
  95     private LockState lockState;
  96
  97     @Column
  98     @NotNull
  99     private SubState subState;
 100
 101     @Column
 102     private String operationalState;
 103
 104     @Column
 105     private String useState;
 106
 107     @Column
 108     private String description;
 109
 110     @Column
 111     private String message;
 112
 113     @Lob
 114     @NotNull
 115     @Valid
 116     @Convert(converter = StringToMapConverter.class)
 117     @Column(length = 100000)
 118     private Map<String, Object> properties;
 119
 120     @Lob
 121     @NotNull
 122     @Valid
 123     @Convert(converter = StringToMapConverter.class)
 124     @Column(length = 100000)
 125     private Map<String, Object> outProperties;
 126
 127     /**
 128      * The Default Constructor creates a {@link JpaAutomationCompositionElement} object with a null key.
 129      */
 130     public JpaAutomationCompositionElement() {
 131         this(UUID.randomUUID().toString(), UUID.randomUUID().toString());
 132     }
 133
 134     /**
 135      * The Key Constructor creates a {@link JpaAutomationCompositionElement} object with the given concept key.
 136      *
 137      * @param elementId The id of the automation composition instance Element
 138      * @param instanceId The id of the automation composition instance
 139      */
 140     public JpaAutomationCompositionElement(@NonNull final String elementId, @NonNull final String instanceId) {
 141         this(elementId, instanceId, new PfConceptKey(),
 142             DeployState.UNDEPLOYED, LockState.NONE, SubState.NONE);
 143     }
 144
 145     /**
 146      * The Key Constructor creates a {@link JpaAutomationCompositionElement} object with all mandatory fields.
 147      *
 148      * @param elementId The id of the automation composition instance Element
 149      * @param instanceId The id of the automation composition instance
 150      * @param definition the TOSCA definition of the automation composition element
 151      * @param deployState the Deploy State of the automation composition
 152      * @param lockState the Lock State of the automation composition
 153      * @param subState the Sub State of the automation composition
 154      */
 155     public JpaAutomationCompositionElement(@NonNull final String elementId, @NonNull final String instanceId,
 156             @NonNull final PfConceptKey definition,
 157             @NonNull final DeployState deployState, @NonNull final LockState lockState,
 158             @NonNull final SubState subState) {
 159         this.elementId = elementId;
 160         this.instanceId = instanceId;
 161         this.definition = definition;
 162         this.deployState = deployState;
 163         this.lockState = lockState;
 164         this.subState = subState;
 165     }
 166
 167     /**
 168      * Copy constructor.
 169      *
 170      * @param copyConcept the concept to copy from
 171      */
 172     public JpaAutomationCompositionElement(@NonNull final JpaAutomationCompositionElement copyConcept) {
 173         this.elementId = copyConcept.elementId;
 174         this.instanceId = copyConcept.instanceId;
 175         this.definition = new PfConceptKey(copyConcept.definition);
 176         this.participantId = copyConcept.participantId;
 177         this.description = copyConcept.description;
 178         this.properties = (copyConcept.properties != null ? new LinkedHashMap<>(copyConcept.properties) : null);
 179         this.outProperties =
 180                 (copyConcept.outProperties != null ? new LinkedHashMap<>(copyConcept.outProperties)
 181                         : null);
 182         this.restarting = copyConcept.restarting;
 183         this.deployState = copyConcept.deployState;
 184         this.lockState = copyConcept.lockState;
 185         this.subState = copyConcept.subState;
 186         this.operationalState = copyConcept.operationalState;
 187         this.useState = copyConcept.useState;
 188         this.message = copyConcept.message;
 189     }
 190
 191     /**
 192      * Authorative constructor.
 193      *
 194      * @param authorativeConcept the authorative concept to copy from
 195      */
 196     public JpaAutomationCompositionElement(@NonNull final AutomationCompositionElement authorativeConcept) {
 197         this.fromAuthorative(authorativeConcept);
 198     }
 199
 200     @Override
 201     public AutomationCompositionElement toAuthorative() {
 202         var element = new AutomationCompositionElement();
 203
 204         element.setId(UUID.fromString(elementId));
 205         element.setDefinition(new ToscaConceptIdentifier(definition));
 206         element.setParticipantId(UUID.fromString(participantId));
 207         element.setDescription(description);
 208         element.setProperties(PfUtils.mapMap(properties, UnaryOperator.identity()));
 209         element.setOutProperties(PfUtils.mapMap(outProperties, UnaryOperator.identity()));
 210         element.setRestarting(restarting);
 211         element.setDeployState(deployState);
 212         element.setLockState(lockState);
 213         element.setSubState(subState);
 214         element.setOperationalState(operationalState);
 215         element.setUseState(useState);
 216         element.setMessage(message);
 217
 218         return element;
 219     }
 220
 221     @Override
 222     public void fromAuthorative(@NonNull final AutomationCompositionElement element) {
 223         this.definition = element.getDefinition().asConceptKey();
 224         this.participantId = element.getParticipantId().toString();
 225         this.description = element.getDescription();
 226         this.properties = PfUtils.mapMap(element.getProperties(), UnaryOperator.identity());
 227         this.outProperties = PfUtils.mapMap(element.getOutProperties(), UnaryOperator.identity());
 228         this.restarting = element.getRestarting();
 229         this.deployState = element.getDeployState();
 230         this.lockState = element.getLockState();
 231         this.subState = element.getSubState();
 232         this.operationalState = element.getOperationalState();
 233         this.useState = element.getUseState();
 234         this.message = element.getMessage();
 235     }
 236
 237     @Override
 238     public int compareTo(final JpaAutomationCompositionElement other) {
 239         if (other == null) {
 240             return -1;
 241         }
 242         if (this == other) {
 243             return 0;
 244         }
 245
 246         var result = ObjectUtils.compare(elementId, other.elementId);
 247         if (result != 0) {
 248             return result;
 249         }
 250
 251         result = ObjectUtils.compare(instanceId, other.instanceId);
 252         if (result != 0) {
 253             return result;
 254         }
 255
 256         result = definition.compareTo(other.definition);
 257         if (result != 0) {
 258             return result;
 259         }
 260
 261         result = participantId.compareTo(other.participantId);
 262         if (result != 0) {
 263             return result;
 264         }
 265
 266         result = ObjectUtils.compare(restarting, other.restarting);
 267         if (result != 0) {
 268             return result;
 269         }
 270
 271         result = ObjectUtils.compare(deployState, other.deployState);
 272         if (result != 0) {
 273             return result;
 274         }
 275
 276         result = ObjectUtils.compare(lockState, other.lockState);
 277         if (result != 0) {
 278             return result;
 279         }
 280
 281         result = ObjectUtils.compare(subState, other.subState);
 282         if (result != 0) {
 283             return result;
 284         }
 285
 286         result = ObjectUtils.compare(useState, other.useState);
 287         if (result != 0) {
 288             return result;
 289         }
 290
 291         result = ObjectUtils.compare(operationalState, other.operationalState);
 292         if (result != 0) {
 293             return result;
 294         }
 295
 296         result = ObjectUtils.compare(message, other.message);
 297         if (result != 0) {
 298             return result;
 299         }
 300         return ObjectUtils.compare(description, other.description);
 301     }
 302 }