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.IOException;
31 import java.io.Serializable;
32 import java.util.HashMap;
33 import java.util.HashSet;
36 import java.util.SortedSet;
37 import java.util.TreeSet;
38 import javax.persistence.CascadeType;
39 import javax.persistence.Column;
40 import javax.persistence.Entity;
41 import javax.persistence.EnumType;
42 import javax.persistence.Enumerated;
43 import javax.persistence.FetchType;
44 import javax.persistence.Id;
45 import javax.persistence.JoinColumn;
46 import javax.persistence.JoinTable;
47 import javax.persistence.ManyToMany;
48 import javax.persistence.ManyToOne;
49 import javax.persistence.OneToMany;
50 import javax.persistence.Table;
51 import javax.persistence.Transient;
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.tosca.update.ToscaConverterWithDictionarySupport;
57 import org.onap.clamp.clds.util.drawing.SvgLoopGenerator;
58 import org.onap.clamp.dao.model.jsontype.StringJsonUserType;
59 import org.onap.clamp.loop.common.AuditEntity;
60 import org.onap.clamp.loop.components.external.DcaeComponent;
61 import org.onap.clamp.loop.components.external.ExternalComponent;
62 import org.onap.clamp.loop.components.external.PolicyComponent;
63 import org.onap.clamp.loop.log.LoopLog;
64 import org.onap.clamp.loop.service.Service;
65 import org.onap.clamp.loop.template.LoopElementModel;
66 import org.onap.clamp.loop.template.LoopTemplate;
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, ToscaConverterWithDictionarySupport toscaConverter) {
169 this.setLoopTemplate(loopTemplate);
170 this.setModelService(loopTemplate.getModelService());
171 loopTemplate.getLoopElementModelsUsed().forEach(element -> {
172 if (LoopElementModel.MICRO_SERVICE_TYPE.equals(element.getLoopElementModel().getLoopElementType())) {
174 this.addMicroServicePolicy((MicroServicePolicy) element.getLoopElementModel()
175 .createPolicyInstance(this, toscaConverter));
176 } catch (IOException e) {
177 logger.error("Exception caught when creating the microservice policy instance of the loop "
181 else if (LoopElementModel.OPERATIONAL_POLICY_TYPE
182 .equals(element.getLoopElementModel().getLoopElementType())) {
184 this.addOperationalPolicy((OperationalPolicy) element.getLoopElementModel()
185 .createPolicyInstance(this, toscaConverter));
186 } catch (IOException e) {
187 logger.error("Exception caught when creating the operational policy instance of the loop instance",
194 public String getName() {
198 void setName(String name) {
202 public String getDcaeDeploymentId() {
203 return dcaeDeploymentId;
206 void setDcaeDeploymentId(String dcaeDeploymentId) {
207 this.dcaeDeploymentId = dcaeDeploymentId;
210 public String getDcaeDeploymentStatusUrl() {
211 return dcaeDeploymentStatusUrl;
214 void setDcaeDeploymentStatusUrl(String dcaeDeploymentStatusUrl) {
215 this.dcaeDeploymentStatusUrl = dcaeDeploymentStatusUrl;
218 public String getSvgRepresentation() {
219 return svgRepresentation;
222 void setSvgRepresentation(String svgRepresentation) {
223 this.svgRepresentation = svgRepresentation;
226 public LoopState getLastComputedState() {
227 return lastComputedState;
230 void setLastComputedState(LoopState lastComputedState) {
231 this.lastComputedState = lastComputedState;
234 public Set<OperationalPolicy> getOperationalPolicies() {
235 return operationalPolicies;
238 void setOperationalPolicies(Set<OperationalPolicy> operationalPolicies) {
239 this.operationalPolicies = operationalPolicies;
242 public Set<MicroServicePolicy> getMicroServicePolicies() {
243 return microServicePolicies;
246 void setMicroServicePolicies(Set<MicroServicePolicy> microServicePolicies) {
247 this.microServicePolicies = microServicePolicies;
250 public JsonObject getGlobalPropertiesJson() {
251 return globalPropertiesJson;
254 void setGlobalPropertiesJson(JsonObject globalPropertiesJson) {
255 this.globalPropertiesJson = globalPropertiesJson;
258 public Set<LoopLog> getLoopLogs() {
262 void setLoopLogs(SortedSet<LoopLog> loopLogs) {
263 this.loopLogs = loopLogs;
267 * This method adds an operational policy to the loop.
268 * It re-computes the Svg as well.
270 * @param opPolicy the operationalPolicy to add
272 public void addOperationalPolicy(OperationalPolicy opPolicy) {
273 operationalPolicies.add(opPolicy);
274 opPolicy.setLoop(this);
275 this.setSvgRepresentation(SvgLoopGenerator.getSvgImage(this));
279 * This method removes an operational policy to the loop.
280 * It re-computes the Svg as well.
282 * @param opPolicy the operationalPolicy to add
284 public void removeOperationalPolicy(OperationalPolicy opPolicy) {
285 operationalPolicies.remove(opPolicy);
286 this.setSvgRepresentation(SvgLoopGenerator.getSvgImage(this));
290 * This method adds an micro service policy to the loop.
291 * It re-computes the Svg as well.
293 * @param microServicePolicy the micro service to add
295 public void addMicroServicePolicy(MicroServicePolicy microServicePolicy) {
296 microServicePolicies.add(microServicePolicy);
297 microServicePolicy.getUsedByLoops().add(this);
298 this.setSvgRepresentation(SvgLoopGenerator.getSvgImage(this));
301 public void addLog(LoopLog log) {
303 this.loopLogs.add(log);
306 public Service getModelService() {
310 void setModelService(Service modelService) {
311 this.modelService = modelService;
314 public Map<String, ExternalComponent> getComponents() {
315 refreshDcaeComponents();
319 public ExternalComponent getComponent(String componentName) {
320 refreshDcaeComponents();
321 return this.components.get(componentName);
324 public void addComponent(ExternalComponent component) {
325 this.components.put(component.getComponentName(), component);
328 public LoopTemplate getLoopTemplate() {
332 public void setLoopTemplate(LoopTemplate loopTemplate) {
333 this.loopTemplate = loopTemplate;
336 private void refreshDcaeComponents() {
337 if (!this.loopTemplate.getUniqueBlueprint()) {
338 this.components.remove("DCAE");
339 for (MicroServicePolicy policy : this.microServicePolicies) {
340 if (!this.components.containsKey("DCAE_" + policy.getName())) {
341 this.addComponent(new DcaeComponent(policy.getName()));
348 * Generate the loop name.
350 * @param serviceName The service name
351 * @param serviceVersion The service version
352 * @param resourceName The resource name
353 * @param blueprintFileName The blueprint file name
354 * @return The generated loop name
356 public static String generateLoopName(String serviceName, String serviceVersion, String resourceName,
357 String blueprintFileName) {
358 StringBuilder buffer = new StringBuilder("LOOP_").append(serviceName).append("_v").append(serviceVersion)
359 .append("_").append(resourceName).append("_").append(blueprintFileName.replaceAll(".yaml", ""));
360 return buffer.toString().replace('.', '_').replaceAll(" ", "");
364 public int hashCode() {
365 final int prime = 31;
367 result = prime * result + ((name == null) ? 0 : name.hashCode());
372 public boolean equals(Object obj) {
379 if (getClass() != obj.getClass()) {
382 Loop other = (Loop) obj;
384 if (other.name != null) {
388 else if (!name.equals(other.name)) {