+++ /dev/null
-/*-
- * ============LICENSE_START=======================================================
- * ONAP CLAMP
- * ================================================================================
- * Copyright (C) 2017-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.clds.model;
-
-import com.google.gson.annotations.Expose;
-
-import java.util.ArrayList;
-import java.util.List;
-
-import javax.ws.rs.BadRequestException;
-import javax.ws.rs.NotFoundException;
-
-import org.onap.clamp.clds.dao.CldsDao;
-import org.onap.clamp.clds.model.actions.ActionsHandler;
-import org.onap.clamp.clds.model.actions.ActionsHandlerImpl;
-import org.onap.clamp.clds.model.status.StatusHandler;
-import org.onap.clamp.clds.model.status.StatusHandlerImpl;
-
-/**
- * Represent a CLDS Model.
- */
-public class CldsModel {
-
- private static final int UUID_LENGTH = 36;
- /**
- * The constant STATUS_DESIGN.
- */
- public static final String STATUS_DESIGN = "DESIGN";
- /**
- * The constant STATUS_DISTRIBUTED.
- */
- public static final String STATUS_DISTRIBUTED = "DISTRIBUTED";
- /**
- * The constant STATUS_ACTIVE.
- */
- public static final String STATUS_ACTIVE = "ACTIVE";
- /**
- * The constant STATUS_STOPPED.
- */
- public static final String STATUS_STOPPED = "STOPPED";
- /**
- * The constant STATUS_DELETING.
- */
- public static final String STATUS_DELETING = "DELETING";
- /**
- * The constant STATUS_ERROR.
- */
- public static final String STATUS_ERROR = "ERROR";
- /**
- * The constant STATUS_UNKNOWN.
- */
- public static final String STATUS_UNKNOWN = "UNKNOWN";
-
- @Expose
- private String id;
- @Expose
- private String templateId;
- @Expose
- private String templateName;
- @Expose
- private String name;
- @Expose
- private String controlNamePrefix;
- @Expose
- private String controlNameUuid;
- @Expose
- private String bpmnText;
- @Expose
- private String propText;
- @Expose
- private String imageText;
- @Expose
- private String docText;
- @Expose
- private String blueprintText;
- @Expose
- private CldsEvent event;
- @Expose
- private String status;
- @Expose
- private List<String> permittedActionCd;
- @Expose
- private List<CldsModelInstance> cldsModelInstanceList;
- // This is a transient value used to return the failure message to UI
- @Expose
- private String errorMessageForUi;
- /**
- * The service type Id received from DCAE by querying it.
- */
- @Expose
- private String typeId;
- @Expose
- private String typeName;
- @Expose
- private String deploymentId;
- @Expose
- private String deploymentStatusUrl;
-
- // Set default handlers but this can be changed if needed.
- private static StatusHandler statusHandler = new StatusHandlerImpl();
- private static ActionsHandler actionsHandler = new ActionsHandlerImpl();
-
- /**
- * Sets status handler.
- *
- * @param statHandler the stat handler
- */
- public static synchronized void setStatusHandler(StatusHandler statHandler) {
- statusHandler = statHandler;
- }
-
- /**
- * Sets actions handler.
- *
- * @param cdHandler the cd handler
- */
- public static synchronized void setActionsHandler(ActionsHandler cdHandler) {
- actionsHandler = cdHandler;
- }
-
- /**
- * Construct empty model.
- */
- public CldsModel() {
- event = new CldsEvent();
- }
-
- /**
- * Retrieve from DB.
- *
- * @param cldsDao the clds dao
- * @param name the name
- * @param okIfNotFound the ok if not found
- * @return the clds model
- */
- public static CldsModel retrieve(CldsDao cldsDao, String name, boolean okIfNotFound) {
- // get from db
- CldsModel model = cldsDao.getModelTemplate(name);
- if (model.getId() == null && !okIfNotFound) {
- throw new NotFoundException();
- }
- model.determineStatus();
- model.determinePermittedActionCd();
- return model;
- }
-
- /**
- * Can dcae inventory call boolean.
- *
- * @return the boolean
- */
- public boolean canDcaeInventoryCall() {
- boolean canCall = false;
- /* Below checks the clds event is submit/resubmit/distribute */
- if (event.isActionCd(CldsEvent.ACTION_SUBMIT) || event.isActionCd(CldsEvent.ACTION_RESUBMIT)
- || event.isActionCd(CldsEvent.ACTION_DISTRIBUTE) || event.isActionCd(CldsEvent.ACTION_SUBMITDCAE)) {
- canCall = true;
- }
- return canCall;
- }
-
- /**
- * Save model to DB.
- *
- * @param cldsDao the clds dao
- * @param userid the userid
- * @return the clds model
- */
- public CldsModel save(CldsDao cldsDao, String userid) {
- CldsModel cldsModel = cldsDao.setModel(this, userid);
- determineStatus();
- determinePermittedActionCd();
- return cldsModel;
- }
-
- /**
- * set the status in the model.
- */
- public void determineStatus() {
- status = statusHandler.determineStatusOnLastEvent(event);
- }
-
- /**
- * Determine permittedActionCd list using the actionCd from the current event.
- * It's a states graph, given the next action that can be executed from the one
- * that has been executed (described in the event object). ACTION_CREATE being
- * the first one.
- */
- public void determinePermittedActionCd() {
- permittedActionCd = actionsHandler.determinePermittedActionsOnLastEvent(event, propText);
- }
-
- /**
- * Validate requestedActionCd - determine permittedActionCd and then check if
- * contained in permittedActionCd Throw IllegalArgumentException if requested
- * actionCd is not permitted.
- *
- * @param requestedActionCd the requested action cd
- */
- public void validateAction(String requestedActionCd) {
- determinePermittedActionCd();
- if (!permittedActionCd.contains(requestedActionCd)) {
- throw new IllegalArgumentException("Invalid requestedActionCd: " + requestedActionCd
- + ". Given current actionCd: " + actionsHandler.getCurrentActionCd(event)
- + ", the permittedActionCd: " + permittedActionCd);
- }
- }
-
- /**
- * Extract the UUID portion of a given full control name (controlNamePrefix +
- * controlNameUuid). No fields are populated other than controlNamePrefix and
- * controlNameUuid. Throws BadRequestException if length of given control name
- * is less than UUID_LENGTH.
- *
- * @param fullControlName the full control name
- * @return the clds model
- */
- public static CldsModel createUsingControlName(String fullControlName) {
- if (fullControlName == null || fullControlName.length() < UUID_LENGTH) {
- throw new BadRequestException(
- "closed loop id / control name length, " + (fullControlName != null ? fullControlName.length() : 0)
- + ", less than the minimum of: " + UUID_LENGTH);
- }
- CldsModel model = new CldsModel();
- model.setControlNamePrefix(fullControlName.substring(0, fullControlName.length() - UUID_LENGTH));
- model.setControlNameUuid(fullControlName.substring(fullControlName.length() - UUID_LENGTH));
- return model;
- }
-
- /**
- * Gets control name.
- *
- * @return the controlName (controlNamePrefix + controlNameUuid)
- */
- public String getControlName() {
- return controlNamePrefix + controlNameUuid;
- }
-
- /**
- * To insert modelInstance to the database.
- *
- * @param cldsDao the clds dao
- * @param dcaeEvent the dcae event
- * @param userid the userid
- * @return the clds model
- */
- public static CldsModel insertModelInstance(CldsDao cldsDao, DcaeEvent dcaeEvent, String userid) {
- String controlName = dcaeEvent.getControlName();
- CldsModel cldsModel = createUsingControlName(controlName);
- cldsModel = cldsDao.getModelByUuid(cldsModel.getControlNameUuid());
- cldsModel.determineStatus();
- if (dcaeEvent.getCldsActionCd().equals(CldsEvent.ACTION_UNDEPLOY) || (dcaeEvent.getCldsActionCd()
- .equals(CldsEvent.ACTION_DEPLOY)
- && (cldsModel.getStatus().equals(STATUS_DISTRIBUTED) || cldsModel.getStatus().equals(STATUS_DESIGN)))) {
- CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userid, dcaeEvent.getCldsActionCd(),
- CldsEvent.ACTION_STATE_RECEIVED, null);
- }
- cldsDao.insModelInstance(cldsModel, dcaeEvent.getInstances());
- return cldsModel;
- }
-
- /**
- * Gets name.
- *
- * @return the name
- */
- public String getName() {
- return name;
- }
-
- /**
- * Sets name.
- *
- * @param name the name to set
- */
- public void setName(String name) {
- this.name = name;
- }
-
- /**
- * Gets type name.
- *
- * @return the typeName
- */
- public String getTypeName() {
- return typeName;
- }
-
- /**
- * Sets type name.
- *
- * @param typeName the type name
- */
- public void setTypeName(String typeName) {
- this.typeName = typeName;
- }
-
- /**
- * Gets template id.
- *
- * @return the template id
- */
- public String getTemplateId() {
- return templateId;
- }
-
- /**
- * Sets template id.
- *
- * @param templateId the template id
- */
- public void setTemplateId(String templateId) {
- this.templateId = templateId;
- }
-
- /**
- * Gets control name prefix.
- *
- * @return the controlNamePrefix
- */
- public String getControlNamePrefix() {
- return controlNamePrefix;
- }
-
- /**
- * Sets control name prefix.
- *
- * @param controlNamePrefix the controlNamePrefix to set
- */
- public void setControlNamePrefix(String controlNamePrefix) {
- this.controlNamePrefix = controlNamePrefix;
- }
-
- /**
- * Gets control name uuid.
- *
- * @return the controlNameUuid
- */
- public String getControlNameUuid() {
- return controlNameUuid;
- }
-
- /**
- * Sets control name uuid.
- *
- * @param controlNameUuid the controlNameUuid to set
- */
- public void setControlNameUuid(String controlNameUuid) {
- this.controlNameUuid = controlNameUuid;
- }
-
- /**
- * Gets prop text.
- *
- * @return the propText
- */
- public String getPropText() {
- return propText;
- }
-
- /**
- * Sets prop text.
- *
- * @param propText the propText to set
- */
- public void setPropText(String propText) {
- this.propText = propText;
- }
-
- /**
- * Gets event.
- *
- * @return the event
- */
- public CldsEvent getEvent() {
- return event;
- }
-
- /**
- * Gets id.
- *
- * @return the id
- */
- public String getId() {
- return id;
- }
-
- /**
- * Sets id.
- *
- * @param id the id
- */
- public void setId(String id) {
- this.id = id;
- }
-
- /**
- * Gets template name.
- *
- * @return the template name
- */
- public String getTemplateName() {
- return templateName;
- }
-
- /**
- * Sets template name.
- *
- * @param templateName the template name
- */
- public void setTemplateName(String templateName) {
- this.templateName = templateName;
- }
-
- /**
- * Sets event.
- *
- * @param event the event to set
- */
- public void setEvent(CldsEvent event) {
- this.event = event;
- }
-
- /**
- * Gets status.
- *
- * @return the status
- */
- public String getStatus() {
- return status;
- }
-
- /**
- * Sets status.
- *
- * @param status the status to set
- */
- public void setStatus(String status) {
- this.status = status;
- }
-
- /**
- * Gets blueprint text.
- *
- * @return the blueprint text
- */
- public String getBlueprintText() {
- return blueprintText;
- }
-
- /**
- * Sets blueprint text.
- *
- * @param blueprintText the blueprint text
- */
- public void setBlueprintText(String blueprintText) {
- this.blueprintText = blueprintText;
- }
-
- /**
- * Gets bpmn text.
- *
- * @return the bpmn text
- */
- public String getBpmnText() {
- return bpmnText;
- }
-
- /**
- * Sets bpmn text.
- *
- * @param bpmnText the bpmn text
- */
- public void setBpmnText(String bpmnText) {
- this.bpmnText = bpmnText;
- }
-
- /**
- * Gets image text.
- *
- * @return the image text
- */
- public String getImageText() {
- return imageText;
- }
-
- /**
- * Sets image text.
- *
- * @param imageText the image text
- */
- public void setImageText(String imageText) {
- this.imageText = imageText;
- }
-
- /**
- * Gets doc text.
- *
- * @return the doc text
- */
- public String getDocText() {
- return docText;
- }
-
- /**
- * Sets doc text.
- *
- * @param docText the doc text
- */
- public void setDocText(String docText) {
- this.docText = docText;
- }
-
- /**
- * Gets type id.
- *
- * @return the type id
- */
- public String getTypeId() {
- return typeId;
- }
-
- /**
- * Sets type id.
- *
- * @param typeId the type id
- */
- public void setTypeId(String typeId) {
- this.typeId = typeId;
- }
-
- /**
- * Gets clds model instance list.
- *
- * @return the clds model instance list
- */
- public List<CldsModelInstance> getCldsModelInstanceList() {
- if (cldsModelInstanceList == null) {
- cldsModelInstanceList = new ArrayList<>();
- }
- return cldsModelInstanceList;
- }
-
- /**
- * Gets deployment id.
- *
- * @return the deployment id
- */
- public String getDeploymentId() {
- return deploymentId;
- }
-
- /**
- * Sets deployment id.
- *
- * @param deploymentId the deployment id
- */
- public void setDeploymentId(String deploymentId) {
- this.deploymentId = deploymentId;
- }
-
- /**
- * Gets permitted action cd.
- *
- * @return the permitted action cd
- */
- public List<String> getPermittedActionCd() {
- return permittedActionCd;
- }
-
- /**
- * Gets error message for ui.
- *
- * @return the error message for ui
- */
- public String getErrorMessageForUi() {
- return errorMessageForUi;
- }
-
- /**
- * Sets error message for ui.
- *
- * @param errorMessageForUi the error message for ui
- */
- public void setErrorMessageForUi(String errorMessageForUi) {
- this.errorMessageForUi = errorMessageForUi;
- }
-
- /**
- * Gets deployment status url.
- *
- * @return the deployment status url
- */
- public String getDeploymentStatusUrl() {
- return deploymentStatusUrl;
- }
-
- /**
- * Sets deployment status url.
- *
- * @param deploymentStatusUrl the deployment status url
- */
- public void setDeploymentStatusUrl(String deploymentStatusUrl) {
- this.deploymentStatusUrl = deploymentStatusUrl;
- }
-}
Code Review / clamp.git / blobdiff