2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2019 AT&T Intellectual Property. All rights
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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 * ===================================================================
24 package org.onap.clamp.loop;
26 import com.att.eelf.configuration.EELFLogger;
27 import com.att.eelf.configuration.EELFManager;
28 import com.google.gson.JsonObject;
29 import com.google.gson.annotations.Expose;
30 import java.io.Serializable;
31 import java.util.HashMap;
32 import java.util.HashSet;
35 import java.util.SortedSet;
36 import java.util.TreeSet;
37 import javax.persistence.CascadeType;
38 import javax.persistence.Column;
39 import javax.persistence.Entity;
40 import javax.persistence.EnumType;
41 import javax.persistence.Enumerated;
42 import javax.persistence.FetchType;
43 import javax.persistence.Id;
44 import javax.persistence.JoinColumn;
45 import javax.persistence.JoinTable;
46 import javax.persistence.ManyToMany;
47 import javax.persistence.ManyToOne;
48 import javax.persistence.OneToMany;
49 import javax.persistence.Table;
50 import javax.persistence.Transient;
51 import org.apache.commons.lang3.RandomStringUtils;
52 import org.hibernate.annotations.SortNatural;
53 import org.hibernate.annotations.Type;
54 import org.hibernate.annotations.TypeDef;
55 import org.hibernate.annotations.TypeDefs;
56 import org.onap.clamp.clds.util.drawing.SvgLoopGenerator;
57 import org.onap.clamp.dao.model.jsontype.StringJsonUserType;
58 import org.onap.clamp.loop.common.AuditEntity;
59 import org.onap.clamp.loop.components.external.DcaeComponent;
60 import org.onap.clamp.loop.components.external.ExternalComponent;
61 import org.onap.clamp.loop.components.external.PolicyComponent;
62 import org.onap.clamp.loop.log.LoopLog;
63 import org.onap.clamp.loop.service.Service;
64 import org.onap.clamp.loop.template.LoopElementModel;
65 import org.onap.clamp.loop.template.LoopTemplate;
66 import org.onap.clamp.policy.Policy;
67 import org.onap.clamp.policy.microservice.MicroServicePolicy;
68 import org.onap.clamp.policy.operational.OperationalPolicy;
71 @Table(name = "loops")
72 @TypeDefs({@TypeDef(name = "json", typeClass = StringJsonUserType.class)})
73 public class Loop extends AuditEntity implements Serializable {
76 * The serial version id.
78 private static final long serialVersionUID = -286522707701388642L;
81 private static final EELFLogger logger = EELFManager.getInstance().getLogger(Loop.class);
85 @Column(nullable = false, name = "name", unique = true)
89 @Column(name = "dcae_deployment_id")
90 private String dcaeDeploymentId;
93 @Column(name = "dcae_deployment_status_url")
94 private String dcaeDeploymentStatusUrl;
96 @Column(columnDefinition = "MEDIUMTEXT", name = "svg_representation")
97 private String svgRepresentation;
101 @Column(columnDefinition = "json", name = "global_properties_json")
102 private JsonObject globalPropertiesJson;
105 @ManyToOne(fetch = FetchType.EAGER, cascade = {CascadeType.PERSIST, CascadeType.MERGE, CascadeType.REFRESH})
106 @JoinColumn(name = "service_uuid")
107 private Service modelService;
110 @Column(nullable = false, name = "last_computed_state")
111 @Enumerated(EnumType.STRING)
112 private LoopState lastComputedState;
116 private final Map<String, ExternalComponent> components = new HashMap<>();
119 @OneToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER, mappedBy = "loop", orphanRemoval = true)
120 private Set<OperationalPolicy> operationalPolicies = new HashSet<>();
123 @ManyToMany(cascade = {CascadeType.PERSIST, CascadeType.MERGE, CascadeType.REFRESH}, fetch = FetchType.EAGER)
124 @JoinTable(name = "loops_to_microservicepolicies", joinColumns = @JoinColumn(name = "loop_name"),
125 inverseJoinColumns = @JoinColumn(name = "microservicepolicy_name"))
126 private Set<MicroServicePolicy> microServicePolicies = new HashSet<>();
129 @OneToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER, mappedBy = "loop", orphanRemoval = true)
131 private SortedSet<LoopLog> loopLogs = new TreeSet<>();
134 @ManyToOne(cascade = {CascadeType.PERSIST, CascadeType.MERGE, CascadeType.REFRESH}, fetch = FetchType.EAGER)
135 @JoinColumn(name = "loop_template_name", nullable = false)
136 private LoopTemplate loopTemplate;
138 private void initializeExternalComponents() {
139 this.addComponent(new PolicyComponent());
140 this.addComponent(new DcaeComponent());
144 * Public constructor.
147 initializeExternalComponents();
153 public Loop(String name, String svgRepresentation) {
155 this.svgRepresentation = svgRepresentation;
156 this.lastComputedState = LoopState.DESIGN;
157 this.globalPropertiesJson = new JsonObject();
158 initializeExternalComponents();
162 * This constructor creates a loop from a loop template.
164 * @param name The loop name
165 * @param loopTemplate The loop template from which a new loop instance must be created
167 public Loop(String name, LoopTemplate loopTemplate) {
169 this.setLoopTemplate(loopTemplate);
170 this.setModelService(loopTemplate.getModelService());
171 loopTemplate.getLoopElementModelsUsed().forEach(element -> {
172 if (LoopElementModel.MICRO_SERVICE_TYPE.equals(element.getLoopElementModel().getLoopElementType())) {
173 this.addMicroServicePolicy(new MicroServicePolicy(Policy.generatePolicyName("MICROSERVICE_",
174 loopTemplate.getModelService().getName(),loopTemplate.getModelService().getVersion(),
175 RandomStringUtils.randomAlphanumeric(3),RandomStringUtils.randomAlphanumeric(3)),
176 element.getLoopElementModel().getPolicyModels().first(), false, element.getLoopElementModel()));
177 } else if (LoopElementModel.OPERATIONAL_POLICY_TYPE
178 .equals(element.getLoopElementModel().getLoopElementType())) {
179 this.addOperationalPolicy(new OperationalPolicy(Policy.generatePolicyName("OPERATIONAL_",
180 loopTemplate.getModelService().getName(),loopTemplate.getModelService().getVersion(),
181 RandomStringUtils.randomAlphanumeric(3),RandomStringUtils.randomAlphanumeric(3)), null,
183 element.getLoopElementModel().getPolicyModels().first(), element.getLoopElementModel(),
189 public String getName() {
193 void setName(String name) {
197 public String getDcaeDeploymentId() {
198 return dcaeDeploymentId;
201 void setDcaeDeploymentId(String dcaeDeploymentId) {
202 this.dcaeDeploymentId = dcaeDeploymentId;
205 public String getDcaeDeploymentStatusUrl() {
206 return dcaeDeploymentStatusUrl;
209 void setDcaeDeploymentStatusUrl(String dcaeDeploymentStatusUrl) {
210 this.dcaeDeploymentStatusUrl = dcaeDeploymentStatusUrl;
213 public String getSvgRepresentation() {
214 return svgRepresentation;
217 void setSvgRepresentation(String svgRepresentation) {
218 this.svgRepresentation = svgRepresentation;
221 public LoopState getLastComputedState() {
222 return lastComputedState;
225 void setLastComputedState(LoopState lastComputedState) {
226 this.lastComputedState = lastComputedState;
229 public Set<OperationalPolicy> getOperationalPolicies() {
230 return operationalPolicies;
233 void setOperationalPolicies(Set<OperationalPolicy> operationalPolicies) {
234 this.operationalPolicies = operationalPolicies;
237 public Set<MicroServicePolicy> getMicroServicePolicies() {
238 return microServicePolicies;
241 void setMicroServicePolicies(Set<MicroServicePolicy> microServicePolicies) {
242 this.microServicePolicies = microServicePolicies;
245 public JsonObject getGlobalPropertiesJson() {
246 return globalPropertiesJson;
249 void setGlobalPropertiesJson(JsonObject globalPropertiesJson) {
250 this.globalPropertiesJson = globalPropertiesJson;
253 public Set<LoopLog> getLoopLogs() {
257 void setLoopLogs(SortedSet<LoopLog> loopLogs) {
258 this.loopLogs = loopLogs;
262 * This method adds an operational policy to the loop.
263 * It re-computes the Svg as well.
265 * @param opPolicy the operationalPolicy to add
267 public void addOperationalPolicy(OperationalPolicy opPolicy) {
268 operationalPolicies.add(opPolicy);
269 opPolicy.setLoop(this);
270 this.setSvgRepresentation(SvgLoopGenerator.getSvgImage(this));
274 * This method adds an micro service policy to the loop.
275 * It re-computes the Svg as well.
277 * @param microServicePolicy the micro service to add
279 public void addMicroServicePolicy(MicroServicePolicy microServicePolicy) {
280 microServicePolicies.add(microServicePolicy);
281 microServicePolicy.getUsedByLoops().add(this);
282 this.setSvgRepresentation(SvgLoopGenerator.getSvgImage(this));
285 public void addLog(LoopLog log) {
287 this.loopLogs.add(log);
290 public Service getModelService() {
294 void setModelService(Service modelService) {
295 this.modelService = modelService;
298 public Map<String, ExternalComponent> getComponents() {
299 refreshDcaeComponents();
303 public ExternalComponent getComponent(String componentName) {
304 refreshDcaeComponents();
305 return this.components.get(componentName);
308 public void addComponent(ExternalComponent component) {
309 this.components.put(component.getComponentName(), component);
312 public LoopTemplate getLoopTemplate() {
316 public void setLoopTemplate(LoopTemplate loopTemplate) {
317 this.loopTemplate = loopTemplate;
320 private void refreshDcaeComponents() {
321 if (!this.loopTemplate.getUniqueBlueprint()) {
322 this.components.remove("DCAE");
323 for (MicroServicePolicy policy : this.microServicePolicies) {
324 if (!this.components.containsKey("DCAE_" + policy.getName())) {
325 this.addComponent(new DcaeComponent(policy.getName()));
332 * Generate the loop name.
334 * @param serviceName The service name
335 * @param serviceVersion The service version
336 * @param resourceName The resource name
337 * @param blueprintFileName The blueprint file name
338 * @return The generated loop name
340 public static String generateLoopName(String serviceName, String serviceVersion, String resourceName,
341 String blueprintFileName) {
342 StringBuilder buffer = new StringBuilder("LOOP_").append(serviceName).append("_v").append(serviceVersion)
343 .append("_").append(resourceName).append("_").append(blueprintFileName.replaceAll(".yaml", ""));
344 return buffer.toString().replace('.', '_').replaceAll(" ", "");
348 public int hashCode() {
349 final int prime = 31;
351 result = prime * result + ((name == null) ? 0 : name.hashCode());
356 public boolean equals(Object obj) {
363 if (getClass() != obj.getClass()) {
366 Loop other = (Loop) obj;
368 if (other.name != null) {
371 } else if (!name.equals(other.name)) {