src/main/java/org/onap/clamp/policy/microservice/MicroServicePolicy.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP CLAMP
   4  * ================================================================================
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights
   6  *                             reserved.
   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  * ============LICENSE_END============================================
  20  * ===================================================================
  21  *
  22  */
  23
  24 package org.onap.clamp.policy.microservice;
  25
  26 import com.google.gson.JsonObject;
  27 import com.google.gson.annotations.Expose;
  28 import java.io.Serializable;
  29 import java.util.HashSet;
  30 import java.util.Set;
  31 import javax.persistence.Column;
  32 import javax.persistence.Entity;
  33 import javax.persistence.FetchType;
  34 import javax.persistence.Id;
  35 import javax.persistence.ManyToMany;
  36 import javax.persistence.Table;
  37 import org.apache.commons.lang3.RandomStringUtils;
  38 import org.hibernate.annotations.TypeDef;
  39 import org.hibernate.annotations.TypeDefs;
  40 import org.onap.clamp.clds.tosca.update.ToscaConverterWithDictionarySupport;
  41 import org.onap.clamp.dao.model.jsontype.StringJsonUserType;
  42 import org.onap.clamp.loop.Loop;
  43 import org.onap.clamp.loop.service.Service;
  44 import org.onap.clamp.loop.template.LoopElementModel;
  45 import org.onap.clamp.loop.template.PolicyModel;
  46 import org.onap.clamp.policy.Policy;
  47
  48 @Entity
  49 @Table(name = "micro_service_policies")
  50 @TypeDefs({@TypeDef(name = "json", typeClass = StringJsonUserType.class)})
  51 public class MicroServicePolicy extends Policy implements Serializable {
  52     /**
  53      * The serial version ID.
  54      */
  55     private static final long serialVersionUID = 6271238288583332616L;
  56
  57     @Expose
  58     @Id
  59     @Column(nullable = false, name = "name", unique = true)
  60     private String name;
  61
  62     @Expose
  63     @Column(name = "context")
  64     private String context;
  65
  66     @Expose
  67     @Column(name = "device_type_scope")
  68     private String deviceTypeScope;
  69
  70     @Expose
  71     @Column(name = "shared", nullable = false)
  72     private Boolean shared;
  73
  74     @ManyToMany(mappedBy = "microServicePolicies", fetch = FetchType.EAGER)
  75     private Set<Loop> usedByLoops = new HashSet<>();
  76
  77     @Expose
  78     @Column(name = "dcae_deployment_id")
  79     private String dcaeDeploymentId;
  80
  81     @Expose
  82     @Column(name = "dcae_deployment_status_url")
  83     private String dcaeDeploymentStatusUrl;
  84
  85     @Expose
  86     @Column(name = "dcae_blueprint_id")
  87     private String dcaeBlueprintId;
  88
  89     /**
  90      * Constructor for serialization.
  91      */
  92     public MicroServicePolicy() {
  93     }
  94
  95     /**
  96      * The constructor that does not make use of ToscaYamlToJsonConvertor but take
  97      * the jsonRepresentation instead.
  98      *
  99      * @param name               The name of the MicroService
 100      * @param policyModel        The policy model type of the MicroService
 101      * @param shared             The flag indicate whether the MicroService is
 102      *                           shared
 103      * @param jsonRepresentation The UI representation in json format
 104      * @param loopElementModel   The loop element model from which this instance should be created
 105      * @param pdpGroup           The Pdp Group info
 106      * @param pdpSubgroup        The Pdp Subgroup info
 107      */
 108     public MicroServicePolicy(String name, PolicyModel policyModel, Boolean shared,
 109                               JsonObject jsonRepresentation, LoopElementModel loopElementModel, String pdpGroup,
 110                               String pdpSubgroup) {
 111         this.name = name;
 112         this.setPolicyModel(policyModel);
 113         this.shared = shared;
 114         this.setJsonRepresentation(jsonRepresentation);
 115         this.setLoopElementModel(loopElementModel);
 116         this.setPdpGroup(pdpGroup);
 117         this.setPdpSubgroup(pdpSubgroup);
 118     }
 119
 120     /**
 121      * Constructor with tosca converter.
 122      *
 123      * @param loop             The loop instance
 124      * @param service          The service model object
 125      * @param loopElementModel The loop element model from which this microservice instance is created
 126      * @param toscaConverter   The tosca converter that will used to convert the tosca policy model
 127      */
 128     public MicroServicePolicy(Loop loop, Service service, LoopElementModel loopElementModel,
 129                               ToscaConverterWithDictionarySupport toscaConverter) {
 130         this(Policy.generatePolicyName("MICROSERVICE", service.getName(), service.getVersion(),
 131                 loopElementModel.getPolicyModels().first().getPolicyAcronym() + '_'
 132                         + loopElementModel.getPolicyModels().first().getVersion(),
 133                 RandomStringUtils.randomAlphanumeric(3)),
 134                 loopElementModel.getPolicyModels().first(), false, new JsonObject(), loopElementModel, null, null);
 135         this.updateJsonRepresentation(toscaConverter, service);
 136     }
 137
 138     @Override
 139     public String getName() {
 140         return name;
 141     }
 142
 143     /**
 144      * name setter.
 145      *
 146      * @param name the name to set
 147      */
 148     @Override
 149     public void setName(String name) {
 150         this.name = name;
 151     }
 152
 153     @Override
 154     public void updateJsonRepresentation(ToscaConverterWithDictionarySupport toscaConverter, Service serviceModel) {
 155         this.setJsonRepresentation(
 156                 toscaConverter.convertToscaToJsonSchemaObject(this.getPolicyModel().getPolicyModelTosca(),
 157                         this.getPolicyModel().getPolicyModelType(), serviceModel));
 158     }
 159
 160     @Override
 161     public Boolean isLegacy() {
 162         return false;
 163     }
 164
 165     public Boolean getShared() {
 166         return shared;
 167     }
 168
 169     void setShared(Boolean shared) {
 170         this.shared = shared;
 171     }
 172
 173     public Set<Loop> getUsedByLoops() {
 174         return usedByLoops;
 175     }
 176
 177     void setUsedByLoops(Set<Loop> usedBy) {
 178         this.usedByLoops = usedBy;
 179     }
 180
 181     public String getContext() {
 182         return context;
 183     }
 184
 185     public void setContext(String context) {
 186         this.context = context;
 187     }
 188
 189     public String getDeviceTypeScope() {
 190         return deviceTypeScope;
 191     }
 192
 193     public void setDeviceTypeScope(String deviceTypeScope) {
 194         this.deviceTypeScope = deviceTypeScope;
 195     }
 196
 197     /**
 198      * dcaeDeploymentId getter.
 199      *
 200      * @return the dcaeDeploymentId
 201      */
 202     public String getDcaeDeploymentId() {
 203         return dcaeDeploymentId;
 204     }
 205
 206     /**
 207      * dcaeDeploymentId setter.
 208      *
 209      * @param dcaeDeploymentId the dcaeDeploymentId to set
 210      */
 211     public void setDcaeDeploymentId(String dcaeDeploymentId) {
 212         this.dcaeDeploymentId = dcaeDeploymentId;
 213     }
 214
 215     /**
 216      * dcaeDeploymentStatusUrl getter.
 217      *
 218      * @return the dcaeDeploymentStatusUrl
 219      */
 220     public String getDcaeDeploymentStatusUrl() {
 221         return dcaeDeploymentStatusUrl;
 222     }
 223
 224     /**
 225      * dcaeDeploymentStatusUrl setter.
 226      *
 227      * @param dcaeDeploymentStatusUrl the dcaeDeploymentStatusUrl to set
 228      */
 229     public void setDcaeDeploymentStatusUrl(String dcaeDeploymentStatusUrl) {
 230         this.dcaeDeploymentStatusUrl = dcaeDeploymentStatusUrl;
 231     }
 232
 233     /**
 234      * dcaeBlueprintId getter.
 235      *
 236      * @return the dcaeBlueprintId
 237      */
 238     public String getDcaeBlueprintId() {
 239         return dcaeBlueprintId;
 240     }
 241
 242     /**
 243      * dcaeBlueprintId setter.
 244      *
 245      * @param dcaeBlueprintId the dcaeBlueprintId to set
 246      */
 247     void setDcaeBlueprintId(String dcaeBlueprintId) {
 248         this.dcaeBlueprintId = dcaeBlueprintId;
 249     }
 250
 251     @Override
 252     public int hashCode() {
 253         final int prime = 31;
 254         int result = 1;
 255         result = prime * result + ((name == null) ? 0 : name.hashCode());
 256         return result;
 257     }
 258
 259     @Override
 260     public boolean equals(Object obj) {
 261         if (this == obj) {
 262             return true;
 263         }
 264         if (obj == null) {
 265             return false;
 266         }
 267         if (getClass() != obj.getClass()) {
 268             return false;
 269         }
 270         MicroServicePolicy other = (MicroServicePolicy) obj;
 271         if (name == null) {
 272             if (other.name != null) {
 273                 return false;
 274             }
 275         }
 276         else if (!name.equals(other.name)) {
 277             return false;
 278         }
 279         return true;
 280     }
 281 }