2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 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 * ===================================================================
21 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
24 package org.onap.clamp.clds.model;
26 import com.att.eelf.configuration.EELFLogger;
27 import com.att.eelf.configuration.EELFManager;
29 import java.util.ArrayList;
30 import java.util.Arrays;
31 import java.util.List;
33 import javax.ws.rs.BadRequestException;
34 import javax.ws.rs.NotFoundException;
36 import org.onap.clamp.clds.dao.CldsDao;
39 * Represent a CLDS Model.
41 public class CldsModel {
42 protected static final EELFLogger logger = EELFManager.getInstance().getLogger(CldsModel.class);
43 protected static final EELFLogger metricsLogger = EELFManager.getInstance().getMetricsLogger();
45 private static final int UUID_LENGTH = 36;
47 public static final String STATUS_DESIGN = "DESIGN";
48 public static final String STATUS_DISTRIBUTED = "DISTRIBUTED";
49 public static final String STATUS_ACTIVE = "ACTIVE";
50 public static final String STATUS_STOPPED = "STOPPED";
51 public static final String STATUS_DELETING = "DELETING";
52 public static final String STATUS_ERROR = "ERROR"; // manual
55 public static final String STATUS_UNKNOWN = "UNKNOWN";
58 private String templateId;
59 private String templateName;
61 private String controlNamePrefix;
62 private String controlNameUuid;
63 private String bpmnId;
64 private String bpmnUserid;
65 private String bpmnText;
66 private String propId;
67 private String propUserid;
68 private String propText;
69 private String imageId;
70 private String imageUserid;
71 private String imageText;
73 private String docUserid;
74 private String docText;
75 private String blueprintId;
76 private String blueprintUserid;
77 private String blueprintText;
78 private CldsEvent event;
79 private String status;
80 private List<String> permittedActionCd;
81 private List<CldsModelInstance> cldsModelInstanceList;
83 private String typeId;
84 private String typeName;
86 private String dispatcherResponse;
88 private String deploymentId;
90 private boolean userAuthorizedToUpdate;
93 * Construct empty model.
96 event = new CldsEvent();
106 public static CldsModel retrieve(CldsDao cldsDao, String name, boolean okIfNotFound) {
108 CldsModel model = cldsDao.getModelTemplate(name);
109 if (model.getId() == null && !okIfNotFound) {
110 throw new NotFoundException();
112 model.determineStatus();
113 model.determinePermittedActionCd();
117 public boolean canInventoryCall() {
118 boolean canCall = false;
119 /* Below checks the clds ecent is submit/resubmit */
121 if ((event.isActionCd(CldsEvent.ACTION_SUBMIT) || event.isActionCd(CldsEvent.ACTION_RESUBMIT))) {
133 public void save(CldsDao cldsDao, String userid) {
134 cldsDao.setModel(this, userid);
136 determinePermittedActionCd();
140 * Insert a new event for the new action. Throw IllegalArgumentException if
141 * requested actionCd is not permitted.
146 * @param actionStateCd
148 public void insEvent(CldsDao cldsDao, String userid, String actionCd, String actionStateCd) {
149 validateAction(actionCd);
150 event = CldsEvent.insEvent(cldsDao, this, userid, actionCd, actionStateCd, null);
152 determinePermittedActionCd();
156 * Update event with processInstanceId
159 * @param processInstanceId
161 public void updEvent(CldsDao cldsDao, String processInstanceId) {
162 cldsDao.updEvent(event.getId(), processInstanceId);
166 * set the status in the model
168 private void determineStatus() {
170 status = STATUS_UNKNOWN;
171 if (event == null || event.getActionCd() == null) {
172 status = STATUS_DESIGN;
173 } else if (event.isActionStateCd(CldsEvent.ACTION_STATE_ERROR)) {
174 status = STATUS_ERROR;
175 } else if (event.isActionAndStateCd(CldsEvent.ACTION_CREATE, CldsEvent.ACTION_STATE_ANY)
176 || event.isActionAndStateCd(CldsEvent.ACTION_SUBMIT, CldsEvent.ACTION_STATE_ANY)
177 || event.isActionAndStateCd(CldsEvent.ACTION_RESUBMIT, CldsEvent.ACTION_STATE_ANY)
178 || event.isActionAndStateCd(CldsEvent.ACTION_DELETE, CldsEvent.ACTION_STATE_RECEIVED)) {
179 status = STATUS_DESIGN;
180 } else if (event.isActionAndStateCd(CldsEvent.ACTION_DISTRIBUTE, CldsEvent.ACTION_STATE_RECEIVED)
181 || event.isActionAndStateCd(CldsEvent.ACTION_UNDEPLOY, CldsEvent.ACTION_STATE_RECEIVED)) {
182 status = STATUS_DISTRIBUTED;
183 } else if (event.isActionAndStateCd(CldsEvent.ACTION_DELETE, CldsEvent.ACTION_STATE_SENT)) {
184 status = STATUS_DELETING;
185 } else if (event.isActionAndStateCd(CldsEvent.ACTION_DEPLOY, CldsEvent.ACTION_STATE_RECEIVED)
186 || event.isActionAndStateCd(CldsEvent.ACTION_RESTART, CldsEvent.ACTION_STATE_ANY)
187 || event.isActionAndStateCd(CldsEvent.ACTION_UPDATE, CldsEvent.ACTION_STATE_ANY)
188 || event.isActionAndStateCd(CldsEvent.ACTION_DEPLOY, CldsEvent.ACTION_STATE_ANY)) {
189 status = STATUS_ACTIVE;
190 } else if (event.isActionAndStateCd(CldsEvent.ACTION_STOP, CldsEvent.ACTION_STATE_ANY)) {
191 status = STATUS_STOPPED;
197 * Get the actionCd from current event. If none, default value is
198 * CldsEvent.ACTION_CREATE
202 private String getCurrentActionCd() {
203 // current default actionCd is CREATE
204 String actionCd = CldsEvent.ACTION_CREATE;
205 if (event != null && event.getActionCd() != null) {
206 actionCd = event.getActionCd();
212 * Get the actionStateCd from current event. If none, default value is
213 * CldsEvent.ACTION_STATE_COMPLETED
217 private String getCurrentActionStateCd() {
218 // current default actionStateCd is CREATE
219 String actionStateCd = CldsEvent.ACTION_STATE_COMPLETED;
220 if (event != null && event.getActionStateCd() != null) {
221 actionStateCd = event.getActionStateCd();
223 return actionStateCd;
227 * Determine permittedActionCd list using the actionCd from the current
230 private void determinePermittedActionCd() {
231 String actionCd = getCurrentActionCd();
233 case CldsEvent.ACTION_CREATE:
234 permittedActionCd = Arrays.asList(CldsEvent.ACTION_SUBMIT, CldsEvent.ACTION_TEST);
236 case CldsEvent.ACTION_SUBMIT:
237 case CldsEvent.ACTION_RESUBMIT:
238 // for 1702 delete is not currently implemented (and resubmit
239 // requires manually deleting artifact from sdc
240 permittedActionCd = Arrays.asList(CldsEvent.ACTION_RESUBMIT);
242 case CldsEvent.ACTION_DISTRIBUTE:
243 permittedActionCd = Arrays.asList(CldsEvent.ACTION_DEPLOY, CldsEvent.ACTION_RESUBMIT);
245 case CldsEvent.ACTION_UNDEPLOY:
246 permittedActionCd = Arrays.asList(CldsEvent.ACTION_UPDATE, CldsEvent.ACTION_DEPLOY,
247 CldsEvent.ACTION_RESUBMIT);
249 case CldsEvent.ACTION_DEPLOY:
250 permittedActionCd = Arrays.asList(CldsEvent.ACTION_DEPLOY, CldsEvent.ACTION_UNDEPLOY,
251 CldsEvent.ACTION_UPDATE, CldsEvent.ACTION_STOP);
253 case CldsEvent.ACTION_RESTART:
254 case CldsEvent.ACTION_UPDATE:
255 // for 1702 delete is not currently implemented
256 permittedActionCd = Arrays.asList(CldsEvent.ACTION_DEPLOY, CldsEvent.ACTION_UPDATE,
257 CldsEvent.ACTION_STOP, CldsEvent.ACTION_UNDEPLOY);
259 case CldsEvent.ACTION_DELETE:
260 if (getCurrentActionStateCd().equals(CldsEvent.ACTION_STATE_SENT)) {
261 permittedActionCd = Arrays.asList();
263 permittedActionCd = Arrays.asList(CldsEvent.ACTION_SUBMIT);
266 case CldsEvent.ACTION_STOP:
267 // for 1702 delete is not currently implemented
268 permittedActionCd = Arrays.asList(CldsEvent.ACTION_UPDATE, CldsEvent.ACTION_RESTART,
269 CldsEvent.ACTION_UNDEPLOY);
272 logger.warn("Invalid current actionCd: " + actionCd);
277 * Validate requestedActionCd - determine permittedActionCd and then check
278 * if contained in permittedActionCd Throw IllegalArgumentException if
279 * requested actionCd is not permitted.
281 * @param requestedActionCd
283 public void validateAction(String requestedActionCd) {
284 determinePermittedActionCd();
285 if (!permittedActionCd.contains(requestedActionCd)) {
286 throw new IllegalArgumentException(
287 "Invalid requestedActionCd: " + requestedActionCd + ". Given current actionCd: "
288 + getCurrentActionCd() + ", the permittedActionCd: " + permittedActionCd);
293 * Extract the UUID portion of a given full control name (controlNamePrefix
294 * + controlNameUuid). No fields are populated other than controlNamePrefix
295 * and controlNameUuid. Throws BadRequestException if length of given
296 * control name is less than UUID_LENGTH.
298 * @param fullControlName
301 public static CldsModel createUsingControlName(String fullControlName) {
302 if (fullControlName == null || fullControlName.length() < UUID_LENGTH) {
303 throw new BadRequestException(
304 "closed loop id / control name length, " + (fullControlName != null ? fullControlName.length() : 0)
305 + ", less than the minimum of: " + UUID_LENGTH);
307 CldsModel model = new CldsModel();
308 model.setControlNamePrefix(fullControlName.substring(0, fullControlName.length() - UUID_LENGTH));
309 model.setControlNameUuid(fullControlName.substring(fullControlName.length() - UUID_LENGTH));
314 * @return the controlName (controlNamePrefix + controlNameUuid)
316 public String getControlName() {
317 return controlNamePrefix + controlNameUuid;
321 * To insert modelInstance to the database
326 public static CldsModel insertModelInstance(CldsDao cldsDao, DcaeEvent dcaeEvent, String userid) {
327 String controlName = dcaeEvent.getControlName();
328 CldsModel cldsModel = createUsingControlName(controlName);
329 cldsModel = cldsDao.getModelByUuid(cldsModel.getControlNameUuid());
330 cldsModel.determineStatus();
331 if (dcaeEvent.getCldsActionCd().equals(CldsEvent.ACTION_UNDEPLOY) || (dcaeEvent.getCldsActionCd()
332 .equals(CldsEvent.ACTION_DEPLOY)
333 && (cldsModel.getStatus().equals(STATUS_DISTRIBUTED) || cldsModel.getStatus().equals(STATUS_DESIGN)))) {
334 CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userid, dcaeEvent.getCldsActionCd(),
335 CldsEvent.ACTION_STATE_RECEIVED, null);
337 cldsDao.insModelInstance(cldsModel, dcaeEvent.getInstances());
342 * To remove modelInstance from the database This method is defunct - DCAE
343 * Proxy will not undeploy individual instances. It will send an empty list
344 * of deployed instances to indicate all have been removed. Or it will send
345 * an updated list to indicate those that are still deployed with any not on
346 * the list considered undeployed.
351 @SuppressWarnings("unused")
352 private static CldsModel removeModelInstance(CldsDao cldsDao, DcaeEvent dcaeEvent) {
353 String controlName = dcaeEvent.getControlName();
354 // cldsModel = cldsDao.delModelInstance(cldsModel.getControlNameUuid(),
355 // dcaeEvent.getInstances() );
356 return createUsingControlName(controlName);
362 public String getName() {
370 public void setName(String name) {
375 * @return the typeName
377 public String getTypeName() {
383 * the typeName to set
385 public void setTypeName(String typeName) {
386 this.typeName = typeName;
389 public String getTemplateId() {
393 public void setTemplateId(String templateId) {
394 this.templateId = templateId;
398 * @return the controlNamePrefix
400 public String getControlNamePrefix() {
401 return controlNamePrefix;
405 * @param controlNamePrefix
406 * the controlNamePrefix to set
408 public void setControlNamePrefix(String controlNamePrefix) {
409 this.controlNamePrefix = controlNamePrefix;
413 * @return the controlNameUuid
415 public String getControlNameUuid() {
416 return controlNameUuid;
420 * @param controlNameUuid
421 * the controlNameUuid to set
423 public void setControlNameUuid(String controlNameUuid) {
424 this.controlNameUuid = controlNameUuid;
428 * @return the propUserid
430 public String getPropUserid() {
436 * the propUserid to set
438 public void setPropUserid(String propUserid) {
439 this.propUserid = propUserid;
443 * @return the propText
445 public String getPropText() {
451 * the propText to set
453 public void setPropText(String propText) {
454 this.propText = propText;
460 public CldsEvent getEvent() {
464 public String getId() {
468 public void setId(String id) {
472 public String getTemplateName() {
476 public void setTemplateName(String templateName) {
477 this.templateName = templateName;
480 public String getPropId() {
484 public void setPropId(String propId) {
485 this.propId = propId;
492 public void setEvent(CldsEvent event) {
499 public String getStatus() {
507 public void setStatus(String status) {
508 this.status = status;
512 * @return the permittedActionCd
514 public List<String> getPermittedActionCd() {
515 return permittedActionCd;
519 * @param permittedActionCd
520 * the permittedActionCd to set
522 public void setPermittedActionCd(List<String> permittedActionCd) {
523 this.permittedActionCd = permittedActionCd;
526 public String getBlueprintId() {
530 public void setBlueprintId(String blueprintId) {
531 this.blueprintId = blueprintId;
534 public String getBlueprintUserid() {
535 return blueprintUserid;
538 public void setBlueprintUserid(String blueprintUserid) {
539 this.blueprintUserid = blueprintUserid;
542 public String getBlueprintText() {
543 return blueprintText;
546 public void setBlueprintText(String blueprintText) {
547 this.blueprintText = blueprintText;
550 public String getBpmnId() {
554 public void setBpmnId(String bpmnId) {
555 this.bpmnId = bpmnId;
558 public String getBpmnUserid() {
562 public void setBpmnUserid(String bpmnUserid) {
563 this.bpmnUserid = bpmnUserid;
566 public String getBpmnText() {
570 public void setBpmnText(String bpmnText) {
571 this.bpmnText = bpmnText;
574 public String getImageId() {
578 public void setImageId(String imageId) {
579 this.imageId = imageId;
582 public String getImageUserid() {
586 public void setImageUserid(String imageUserid) {
587 this.imageUserid = imageUserid;
590 public String getImageText() {
594 public void setImageText(String imageText) {
595 this.imageText = imageText;
598 public String getDocId() {
602 public void setDocId(String docId) {
606 public String getDocUserid() {
610 public void setDocUserid(String docUserid) {
611 this.docUserid = docUserid;
614 public String getDocText() {
618 public void setDocText(String docText) {
619 this.docText = docText;
622 public String getTypeId() {
626 public void setTypeId(String typeId) {
627 this.typeId = typeId;
630 public List<CldsModelInstance> getCldsModelInstanceList() {
631 if (cldsModelInstanceList == null) {
632 cldsModelInstanceList = new ArrayList<>();
634 return cldsModelInstanceList;
637 public void setCldsModelInstanceList(List<CldsModelInstance> cldsModelInstanceList) {
638 this.cldsModelInstanceList = cldsModelInstanceList;
641 public void setDispatcherResponse(String dispatcherResponse) {
642 this.dispatcherResponse = dispatcherResponse;
646 public String getDispatcherResponse() {
647 return this.dispatcherResponse;
650 public String getDeploymentId() {
654 public void setDeploymentId(String deploymentId) {
655 this.deploymentId = deploymentId;
658 public boolean isUserAuthorizedToUpdate() {
659 return userAuthorizedToUpdate;
662 public void setUserAuthorizedToUpdate(boolean userAuthorizedToUpdate) {
663 this.userAuthorizedToUpdate = userAuthorizedToUpdate;