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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2021-2023 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 java.util.LinkedHashMap;
  26 import java.util.Map;
  27 import java.util.UUID;
  28 import java.util.function.UnaryOperator;
  29 import javax.persistence.AttributeOverride;
  30 import javax.persistence.AttributeOverrides;
  31 import javax.persistence.Column;
  32 import javax.persistence.Convert;
  33 import javax.persistence.Entity;
  34 import javax.persistence.Id;
  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.lang3.ObjectUtils;
  43 import org.onap.policy.clamp.models.acm.concepts.AutomationCompositionElement;
  44 import org.onap.policy.clamp.models.acm.concepts.DeployState;
  45 import org.onap.policy.clamp.models.acm.concepts.LockState;
  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     @AttributeOverrides({
  79         @AttributeOverride(name = "name",    column = @Column(name = "definition_name")),
  80         @AttributeOverride(name = "version", column = @Column(name = "definition_version"))
  81     })
  82     private PfConceptKey definition;
  83
  84     @NotNull
  85     private String participantId;
  86
  87     @Column
  88     @NotNull
  89     private DeployState deployState;
  90
  91     @Column
  92     @NotNull
  93     private LockState lockState;
  94
  95     @Column
  96     private String operationalState;
  97
  98     @Column
  99     private String useState;
 100
 101     @Column
 102     private String description;
 103
 104     @Column
 105     private String message;
 106
 107     @Lob
 108     @NotNull
 109     @Valid
 110     @Convert(converter = StringToMapConverter.class)
 111     private Map<String, Object> properties;
 112
 113     @Lob
 114     @NotNull
 115     @Valid
 116     @Convert(converter = StringToMapConverter.class)
 117     private Map<String, Object> outProperties;
 118
 119     /**
 120      * The Default Constructor creates a {@link JpaAutomationCompositionElement} object with a null key.
 121      */
 122     public JpaAutomationCompositionElement() {
 123         this(UUID.randomUUID().toString(), UUID.randomUUID().toString());
 124     }
 125
 126     /**
 127      * The Key Constructor creates a {@link JpaAutomationCompositionElement} object with the given concept key.
 128      *
 129      * @param elementId The id of the automation composition instance Element
 130      * @param instanceId The id of the automation composition instance
 131      */
 132     public JpaAutomationCompositionElement(@NonNull final String elementId, @NonNull final String instanceId) {
 133         this(elementId, instanceId, new PfConceptKey(),
 134             DeployState.UNDEPLOYED, LockState.LOCKED);
 135     }
 136
 137     /**
 138      * The Key Constructor creates a {@link JpaAutomationCompositionElement} object with all mandatory fields.
 139      *
 140      * @param elementId The id of the automation composition instance Element
 141      * @param instanceId The id of the automation composition instance
 142      * @param definition the TOSCA definition of the automation composition element
 143      * @param deployState the Deploy State of the automation composition
 144      * @param lockState the Lock State of the automation composition
 145      */
 146     public JpaAutomationCompositionElement(@NonNull final String elementId, @NonNull final String instanceId,
 147             @NonNull final PfConceptKey definition,
 148             @NonNull final DeployState deployState, @NonNull final LockState lockState) {
 149         this.elementId = elementId;
 150         this.instanceId = instanceId;
 151         this.definition = definition;
 152         this.deployState = deployState;
 153         this.lockState = lockState;
 154     }
 155
 156     /**
 157      * Copy constructor.
 158      *
 159      * @param copyConcept the concept to copy from
 160      */
 161     public JpaAutomationCompositionElement(@NonNull final JpaAutomationCompositionElement copyConcept) {
 162         this.elementId = copyConcept.elementId;
 163         this.instanceId = copyConcept.instanceId;
 164         this.definition = new PfConceptKey(copyConcept.definition);
 165         this.participantId = copyConcept.participantId;
 166         this.description = copyConcept.description;
 167         this.properties = (copyConcept.properties != null ? new LinkedHashMap<>(copyConcept.properties) : null);
 168         this.outProperties =
 169                 (copyConcept.outProperties != null ? new LinkedHashMap<>(copyConcept.outProperties)
 170                         : null);
 171         this.deployState = copyConcept.deployState;
 172         this.lockState = copyConcept.lockState;
 173         this.operationalState = copyConcept.operationalState;
 174         this.useState = copyConcept.useState;
 175         this.message = copyConcept.message;
 176     }
 177
 178     /**
 179      * Authorative constructor.
 180      *
 181      * @param authorativeConcept the authorative concept to copy from
 182      */
 183     public JpaAutomationCompositionElement(@NonNull final AutomationCompositionElement authorativeConcept) {
 184         this.fromAuthorative(authorativeConcept);
 185     }
 186
 187     @Override
 188     public AutomationCompositionElement toAuthorative() {
 189         var element = new AutomationCompositionElement();
 190
 191         element.setId(UUID.fromString(elementId));
 192         element.setDefinition(new ToscaConceptIdentifier(definition));
 193         element.setParticipantId(UUID.fromString(participantId));
 194         element.setDescription(description);
 195         element.setProperties(PfUtils.mapMap(properties, UnaryOperator.identity()));
 196         element.setOutProperties(PfUtils.mapMap(outProperties, UnaryOperator.identity()));
 197         element.setDeployState(deployState);
 198         element.setLockState(lockState);
 199         element.setOperationalState(operationalState);
 200         element.setUseState(useState);
 201         element.setMessage(message);
 202
 203         return element;
 204     }
 205
 206     @Override
 207     public void fromAuthorative(@NonNull final AutomationCompositionElement element) {
 208         this.definition = element.getDefinition().asConceptKey();
 209         this.participantId = element.getParticipantId().toString();
 210         this.description = element.getDescription();
 211         this.properties = PfUtils.mapMap(element.getProperties(), UnaryOperator.identity());
 212         this.outProperties = PfUtils.mapMap(element.getOutProperties(), UnaryOperator.identity());
 213         this.deployState = element.getDeployState();
 214         this.lockState = element.getLockState();
 215         this.operationalState = element.getOperationalState();
 216         this.useState = element.getUseState();
 217         this.message = element.getMessage();
 218     }
 219
 220     @Override
 221     public int compareTo(final JpaAutomationCompositionElement other) {
 222         if (other == null) {
 223             return -1;
 224         }
 225         if (this == other) {
 226             return 0;
 227         }
 228
 229         var result = ObjectUtils.compare(elementId, other.elementId);
 230         if (result != 0) {
 231             return result;
 232         }
 233
 234         result = ObjectUtils.compare(instanceId, other.instanceId);
 235         if (result != 0) {
 236             return result;
 237         }
 238
 239         result = definition.compareTo(other.definition);
 240         if (result != 0) {
 241             return result;
 242         }
 243
 244         result = participantId.compareTo(other.participantId);
 245         if (result != 0) {
 246             return result;
 247         }
 248
 249         result = ObjectUtils.compare(deployState, other.deployState);
 250         if (result != 0) {
 251             return result;
 252         }
 253
 254         result = ObjectUtils.compare(lockState, other.lockState);
 255         if (result != 0) {
 256             return result;
 257         }
 258
 259         result = ObjectUtils.compare(useState, other.useState);
 260         if (result != 0) {
 261             return result;
 262         }
 263
 264         result = ObjectUtils.compare(operationalState, other.operationalState);
 265         if (result != 0) {
 266             return result;
 267         }
 268
 269         result = ObjectUtils.compare(message, other.message);
 270         if (result != 0) {
 271             return result;
 272         }
 273         return ObjectUtils.compare(description, other.description);
 274     }
 275 }