1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
|
/*-
* ============LICENSE_START=======================================================
* ONAP CLAMP
* ================================================================================
* Copyright (C) 2019 AT&T Intellectual Property. All rights
* reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END============================================
* ===================================================================
*
*/
package org.onap.clamp.loop;
import com.att.eelf.configuration.EELFLogger;
import com.att.eelf.configuration.EELFManager;
import com.google.gson.JsonObject;
import com.google.gson.annotations.Expose;
import java.io.Serializable;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EnumType;
import javax.persistence.Enumerated;
import javax.persistence.FetchType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.JoinTable;
import javax.persistence.ManyToMany;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.Table;
import javax.persistence.Transient;
import org.apache.commons.lang3.RandomStringUtils;
import org.hibernate.annotations.SortNatural;
import org.hibernate.annotations.Type;
import org.hibernate.annotations.TypeDef;
import org.hibernate.annotations.TypeDefs;
import org.onap.clamp.clds.util.drawing.SvgLoopGenerator;
import org.onap.clamp.dao.model.jsontype.StringJsonUserType;
import org.onap.clamp.loop.common.AuditEntity;
import org.onap.clamp.loop.components.external.DcaeComponent;
import org.onap.clamp.loop.components.external.ExternalComponent;
import org.onap.clamp.loop.components.external.PolicyComponent;
import org.onap.clamp.loop.log.LoopLog;
import org.onap.clamp.loop.service.Service;
import org.onap.clamp.loop.template.LoopElementModel;
import org.onap.clamp.loop.template.LoopTemplate;
import org.onap.clamp.policy.Policy;
import org.onap.clamp.policy.microservice.MicroServicePolicy;
import org.onap.clamp.policy.operational.OperationalPolicy;
@Entity
@Table(name = "loops")
@TypeDefs({@TypeDef(name = "json", typeClass = StringJsonUserType.class)})
public class Loop extends AuditEntity implements Serializable {
/**
* The serial version id.
*/
private static final long serialVersionUID = -286522707701388642L;
@Transient
private static final EELFLogger logger = EELFManager.getInstance().getLogger(Loop.class);
@Id
@Expose
@Column(nullable = false, name = "name", unique = true)
private String name;
@Expose
@Column(name = "dcae_deployment_id")
private String dcaeDeploymentId;
@Expose
@Column(name = "dcae_deployment_status_url")
private String dcaeDeploymentStatusUrl;
@Column(columnDefinition = "MEDIUMTEXT", name = "svg_representation")
private String svgRepresentation;
@Expose
@Type(type = "json")
@Column(columnDefinition = "json", name = "global_properties_json")
private JsonObject globalPropertiesJson;
@Expose
@ManyToOne(fetch = FetchType.EAGER, cascade = {CascadeType.PERSIST, CascadeType.MERGE, CascadeType.REFRESH})
@JoinColumn(name = "service_uuid")
private Service modelService;
@Expose
@Column(nullable = false, name = "last_computed_state")
@Enumerated(EnumType.STRING)
private LoopState lastComputedState;
@Expose
@Transient
private final Map<String, ExternalComponent> components = new HashMap<>();
@Expose
@OneToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER, mappedBy = "loop", orphanRemoval = true)
private Set<OperationalPolicy> operationalPolicies = new HashSet<>();
@Expose
@ManyToMany(cascade = {CascadeType.PERSIST, CascadeType.MERGE, CascadeType.REFRESH}, fetch = FetchType.EAGER)
@JoinTable(name = "loops_to_microservicepolicies", joinColumns = @JoinColumn(name = "loop_name"),
inverseJoinColumns = @JoinColumn(name = "microservicepolicy_name"))
private Set<MicroServicePolicy> microServicePolicies = new HashSet<>();
@Expose
@OneToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER, mappedBy = "loop", orphanRemoval = true)
@SortNatural
private SortedSet<LoopLog> loopLogs = new TreeSet<>();
@Expose
@ManyToOne(cascade = {CascadeType.PERSIST, CascadeType.MERGE, CascadeType.REFRESH}, fetch = FetchType.EAGER)
@JoinColumn(name = "loop_template_name", nullable = false)
private LoopTemplate loopTemplate;
private void initializeExternalComponents() {
this.addComponent(new PolicyComponent());
this.addComponent(new DcaeComponent());
}
/**
* Public constructor.
*/
public Loop() {
initializeExternalComponents();
}
/**
* Constructor.
*/
public Loop(String name, String svgRepresentation) {
this.name = name;
this.svgRepresentation = svgRepresentation;
this.lastComputedState = LoopState.DESIGN;
this.globalPropertiesJson = new JsonObject();
initializeExternalComponents();
}
/**
* This constructor creates a loop from a loop template.
*
* @param name The loop name
* @param loopTemplate The loop template from which a new loop instance must be created
*/
public Loop(String name, LoopTemplate loopTemplate) {
this(name,"");
this.setLoopTemplate(loopTemplate);
this.setModelService(loopTemplate.getModelService());
loopTemplate.getLoopElementModelsUsed().forEach(element -> {
if (LoopElementModel.MICRO_SERVICE_TYPE.equals(element.getLoopElementModel().getLoopElementType())) {
this.addMicroServicePolicy(new MicroServicePolicy(Policy.generatePolicyName("MICROSERVICE_",
loopTemplate.getModelService().getName(),loopTemplate.getModelService().getVersion(),
RandomStringUtils.randomAlphanumeric(3),RandomStringUtils.randomAlphanumeric(3)),
element.getLoopElementModel().getPolicyModels().first(), false, element.getLoopElementModel()));
} else if (LoopElementModel.OPERATIONAL_POLICY_TYPE
.equals(element.getLoopElementModel().getLoopElementType())) {
this.addOperationalPolicy(new OperationalPolicy(Policy.generatePolicyName("OPERATIONAL_",
loopTemplate.getModelService().getName(),loopTemplate.getModelService().getVersion(),
RandomStringUtils.randomAlphanumeric(3),RandomStringUtils.randomAlphanumeric(3)), null,
new JsonObject(),
element.getLoopElementModel().getPolicyModels().first(), element.getLoopElementModel(),
null,null));
}
});
}
public String getName() {
return name;
}
void setName(String name) {
this.name = name;
}
public String getDcaeDeploymentId() {
return dcaeDeploymentId;
}
void setDcaeDeploymentId(String dcaeDeploymentId) {
this.dcaeDeploymentId = dcaeDeploymentId;
}
public String getDcaeDeploymentStatusUrl() {
return dcaeDeploymentStatusUrl;
}
void setDcaeDeploymentStatusUrl(String dcaeDeploymentStatusUrl) {
this.dcaeDeploymentStatusUrl = dcaeDeploymentStatusUrl;
}
public String getSvgRepresentation() {
return svgRepresentation;
}
void setSvgRepresentation(String svgRepresentation) {
this.svgRepresentation = svgRepresentation;
}
public LoopState getLastComputedState() {
return lastComputedState;
}
void setLastComputedState(LoopState lastComputedState) {
this.lastComputedState = lastComputedState;
}
public Set<OperationalPolicy> getOperationalPolicies() {
return operationalPolicies;
}
void setOperationalPolicies(Set<OperationalPolicy> operationalPolicies) {
this.operationalPolicies = operationalPolicies;
}
public Set<MicroServicePolicy> getMicroServicePolicies() {
return microServicePolicies;
}
void setMicroServicePolicies(Set<MicroServicePolicy> microServicePolicies) {
this.microServicePolicies = microServicePolicies;
}
public JsonObject getGlobalPropertiesJson() {
return globalPropertiesJson;
}
void setGlobalPropertiesJson(JsonObject globalPropertiesJson) {
this.globalPropertiesJson = globalPropertiesJson;
}
public Set<LoopLog> getLoopLogs() {
return loopLogs;
}
void setLoopLogs(SortedSet<LoopLog> loopLogs) {
this.loopLogs = loopLogs;
}
/**
* This method adds an operational policy to the loop.
* It re-computes the Svg as well.
*
* @param opPolicy the operationalPolicy to add
*/
public void addOperationalPolicy(OperationalPolicy opPolicy) {
operationalPolicies.add(opPolicy);
opPolicy.setLoop(this);
this.setSvgRepresentation(SvgLoopGenerator.getSvgImage(this));
}
/**
* This method adds an micro service policy to the loop.
* It re-computes the Svg as well.
*
* @param microServicePolicy the micro service to add
*/
public void addMicroServicePolicy(MicroServicePolicy microServicePolicy) {
microServicePolicies.add(microServicePolicy);
microServicePolicy.getUsedByLoops().add(this);
this.setSvgRepresentation(SvgLoopGenerator.getSvgImage(this));
}
public void addLog(LoopLog log) {
log.setLoop(this);
this.loopLogs.add(log);
}
public Service getModelService() {
return modelService;
}
void setModelService(Service modelService) {
this.modelService = modelService;
}
public Map<String, ExternalComponent> getComponents() {
refreshDcaeComponents();
return components;
}
public ExternalComponent getComponent(String componentName) {
refreshDcaeComponents();
return this.components.get(componentName);
}
public void addComponent(ExternalComponent component) {
this.components.put(component.getComponentName(), component);
}
public LoopTemplate getLoopTemplate() {
return loopTemplate;
}
public void setLoopTemplate(LoopTemplate loopTemplate) {
this.loopTemplate = loopTemplate;
}
private void refreshDcaeComponents() {
if (!this.loopTemplate.getUniqueBlueprint()) {
this.components.remove("DCAE");
for (MicroServicePolicy policy : this.microServicePolicies) {
if (!this.components.containsKey("DCAE_" + policy.getName())) {
this.addComponent(new DcaeComponent(policy.getName()));
}
}
}
}
/**
* Generate the loop name.
*
* @param serviceName The service name
* @param serviceVersion The service version
* @param resourceName The resource name
* @param blueprintFileName The blueprint file name
* @return The generated loop name
*/
public static String generateLoopName(String serviceName, String serviceVersion, String resourceName,
String blueprintFileName) {
StringBuilder buffer = new StringBuilder("LOOP_").append(serviceName).append("_v").append(serviceVersion)
.append("_").append(resourceName).append("_").append(blueprintFileName.replaceAll(".yaml", ""));
return buffer.toString().replace('.', '_').replaceAll(" ", "");
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((name == null) ? 0 : name.hashCode());
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
Loop other = (Loop) obj;
if (name == null) {
if (other.name != null) {
return false;
}
} else if (!name.equals(other.name)) {
return false;
}
return true;
}
}
|