- /**
- * REST service that retrieves BPMN for a CLDS model name from the database.
- * This is subset of the json getModel. This is only expected to be used for
- * testing purposes, not by the UI.
- *
- * @param modelName the model name
- * @return bpmn xml text - content of bpmn given name
- */
- public String getBpmnXml(String modelName) {
- util.entering(request, "CldsService: GET model bpmn");
- Date startTime = new Date();
- isAuthorized(permissionReadCl);
- logger.info("GET bpmnText for modelName={}", modelName);
- final CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
- // audit log
- LoggingUtils.setTimeContext(startTime, new Date());
- auditLogger.info("GET model bpmn completed");
- util.exiting("200", "Get model bpmn success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
- return model.getBpmnText();
- }
-
- /**
- * REST service that retrieves image for a CLDS model name from the database.
- * This is subset of the json getModel. This is only expected to be used for
- * testing purposes, not by the UI.
- *
- * @param modelName the model name
- * @return image xml text - content of image given name
- */
- public String getImageXml(String modelName) {
- util.entering(request, "CldsService: GET model image");
- Date startTime = new Date();
- isAuthorized(permissionReadCl);
- logger.info("GET imageText for modelName={}", modelName);
- final CldsModel model = CldsModel.retrieve(cldsDao, modelName, false);
- // audit log
- LoggingUtils.setTimeContext(startTime, new Date());
- auditLogger.info("GET model image completed");
- util.exiting("200", "Get model image success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
- return model.getImageText();
- }
-
- /**
- * REST service that retrieves a CLDS model by name from the database.
- *
- * @param modelName the model name
- * @return clds model - clds model for the given model name
- */
- public CldsModel getModel(String modelName) {
- util.entering(request, "CldsService: GET model");
- final Date startTime = new Date();
- isAuthorized(permissionReadCl);
- logger.debug("GET model for modelName={}", modelName);
- CldsModel cldsModel = CldsModel.retrieve(cldsDao, modelName, false);
- isAuthorizedForVf(cldsModel);
- // Try an update for DCAE status
- // Checking condition whether our CLDS model can call Inventory Method
- try {
- // Method to call dcae inventory and invoke insert event method
- if (cldsModel.canDcaeInventoryCall()
- && !cldsModel.getTemplateName().startsWith(CsarInstaller.TEMPLATE_NAME_PREFIX)) {
- dcaeInventoryServices.setEventInventory(cldsModel, getUserId());
- }
- // This is a blocking call
- if (cldsModel.getEvent().isActionCd(CldsEvent.ACTION_DEPLOY)
- && !CldsModel.STATUS_ACTIVE.equals(cldsModel.getStatus()) && cldsModel.getDeploymentId() != null
- && cldsModel.getDeploymentStatusUrl() != null) {
- checkDcaeDeploymentStatus(cldsModel, CldsEvent.ACTION_DEPLOY, false);
- // Refresh the model object in any cases for new event
- cldsModel = CldsModel.retrieve(cldsDao, cldsModel.getName(), false);
- }
- } catch (Exception e) {
- LoggingUtils.setErrorContext("900", "Set event inventory error");
- logger.error("getModel set event Inventory error:" + e);
- }
- // audit log
- LoggingUtils.setTimeContext(startTime, new Date());
- auditLogger.info("GET model completed");
- util.exiting("200", "Get model success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
- return cldsModel;
- }
-
- /**
- * REST service that saves a CLDS model by name in the database.
- *
- * @param modelName the model name
- * @param cldsModel the clds model
- * @return the clds model
- */
- public CldsModel putModel(String modelName, CldsModel cldsModel) {
- util.entering(request, "CldsService: PUT model");
- final Date startTime = new Date();
- isAuthorized(permissionUpdateCl);
- isAuthorizedForVf(cldsModel);
- logger.info("PUT model for modelName={}", modelName);
- logger.info("PUT bpmnText={}", cldsModel.getBpmnText());
- logger.info("PUT propText={}", cldsModel.getPropText());
- logger.info("PUT imageText={}", cldsModel.getImageText());
- fillInCldsModel(cldsModel);
- cldsModel.save(cldsDao, getUserId());
-
- // audit log
- LoggingUtils.setTimeContext(startTime, new Date());
- auditLogger.info("PUT model completed");
- util.exiting("200", "Put model success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
- return cldsModel;
- }
-
- /**
- * REST service that retrieves a list of CLDS model names.
- *
- * @return model names in JSON
- */
- public List<ValueItem> getModelNames() {
- util.entering(request, "CldsService: GET model names");
- Date startTime = new Date();
- isAuthorized(permissionReadCl);
- logger.info("GET list of model names");
- final List<ValueItem> names = cldsDao.getModelNames();
- // audit log
- LoggingUtils.setTimeContext(startTime, new Date());
- auditLogger.info("GET model names completed");
- util.exiting("200", "Get model names success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
- return names;
- }
-
- private void fillInCldsModel(CldsModel model) {
- if (model.getTemplateName() != null) {
- CldsTemplate template = cldsDao.getTemplate(model.getTemplateName());
- if (template != null) {
- model.setTemplateId(template.getId());
- model.setDocText(template.getPropText());
- // This is to provide the Bpmn XML when Template part in UI
- // is
- // disabled
- model.setBpmnText(template.getBpmnText());
- }
- }
- }
-
- /**
- * REST service that saves and processes an action for a CLDS model by name.
- *
- * @param action the action
- * @param modelName the model name
- * @param test the test
- * @param model the model
- * @return response entity
- * @throws TransformerException In case of issues when doing the XSLT of the BPMN flow
- * @throws ParseException In case of issues when parsing the JSON
- */
- public ResponseEntity<?> putModelAndProcessAction(String action, String modelName, String test, CldsModel model)
- throws TransformerException, ParseException {
- util.entering(request, "CldsService: Process model action");
- Date startTime = new Date();
- String errorMessage = "";
- String actionCd = "";
- try {
- actionCd = action.toUpperCase();
- SecureServicePermission permisionManage = SecureServicePermission.create(cldsPermissionTypeClManage,
- cldsPermissionInstance, actionCd);
- isAuthorized(permisionManage);
- isAuthorizedForVf(model);
- String userId = getUserId();
- logger.info("PUT actionCd={}", actionCd);
- logger.info("PUT modelName={}", modelName);
- logger.info("PUT test={}", test);
- logger.info("PUT bpmnText={}", model.getBpmnText());
- logger.info("PUT propText={}", model.getPropText());
- logger.info("PUT userId={}", userId);
- logger.info("PUT getTypeId={}", model.getTypeId());
- logger.info("PUT deploymentId={}", model.getDeploymentId());
- this.fillInCldsModel(model);
- // save model to db just in case
- model.save(cldsDao, getUserId());
-
- // get vars and format if necessary
- final String prop = model.getPropText();
- final String bpmn = model.getBpmnText();
- final String docText = model.getDocText();
- final String controlName = model.getControlName();
- final String bpmnJson = cldsBpmnTransformer.doXslTransformToString(bpmn);
- logger.info("PUT bpmnJson={}", bpmnJson);
- // Test flag coming from UI or from Clamp config
- boolean isTest = Boolean.parseBoolean(test)
- || Boolean.parseBoolean(refProp.getStringValue("action.test.override"));
- logger.info("PUT isTest={}", isTest);
- boolean isInsertTestEvent = Boolean.parseBoolean(refProp.getStringValue("action.insert.test.event"));
- logger.info("PUT isInsertTestEvent={}", isInsertTestEvent);
- // determine if requested action is permitted
- model.validateAction(actionCd);
- logger.info("modelProp - " + prop);
- logger.info("docText - " + docText);
- try {
- String result = camelProxy.executeAction(actionCd, prop, bpmnJson, modelName, controlName, docText,
- isTest, userId, isInsertTestEvent, model.getEvent().getActionCd());
- logger.info("Starting Camel flow on request, result is: ", result);
- } catch (SdcCommunicationException | PolicyClientException | BadRequestException e) {
- logger.error("Exception occured during invoking Camel process", e);
- errorMessage = e.getMessage();
- }
- // audit log
- LoggingUtils.setTimeContext(startTime, new Date());
- auditLogger.info("Process model action completed");
- } catch (Exception e) {
- logger.error("Exception occured during putModelAndProcessAction", e);
- errorMessage = e.getMessage();
- }
-
- if (null == errorMessage || (null != errorMessage && !errorMessage.isEmpty())) {
- CldsEvent.insEvent(cldsDao, model.getControlName(), getUserId(), actionCd, CldsEvent.ACTION_STATE_ERROR,
- null);
- // Need a refresh as new events have been inserted
- model = CldsModel.retrieve(cldsDao, modelName, false);
- if (null == errorMessage) {
- errorMessage = "No response from Policy";
- }
- model.setErrorMessageForUi(errorMessage);
- util.exiting(HttpStatus.INTERNAL_SERVER_ERROR.toString(), "putModelAndProcessAction failed", Level.INFO,
- ONAPLogConstants.ResponseStatus.ERROR);
- return new ResponseEntity<>(model, HttpStatus.INTERNAL_SERVER_ERROR);
- } else {
- // Need a refresh as new events have been inserted, could have been deleted so
- // not blocking call
- model = CldsModel.retrieve(cldsDao, modelName, true);
- util.exiting(HttpStatus.OK.toString(), "Successful", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
- return new ResponseEntity<>(model, HttpStatus.OK);
- }
- }
-
- /**
- * REST service that accepts events for a model.
- *
- * @param test the test
- * @param dcaeEvent the dcae event
- * @return the string
- */
- public String postDcaeEvent(String test, DcaeEvent dcaeEvent) {
- util.entering(request, "CldsService: Post dcae event");
- final Date startTime = new Date();
- String userid = null;
- // TODO: allow auth checking to be turned off by removing the permission
- // type property
- if (cldsPermissionTypeClEvent != null && cldsPermissionTypeClEvent.length() > 0) {
- SecureServicePermission permissionEvent = SecureServicePermission.create(cldsPermissionTypeClEvent,
- cldsPermissionInstance, dcaeEvent.getEvent());
- isAuthorized(permissionEvent);
- userid = getUserId();
- }
- // Flag indicates whether it is triggered by Validation Test button from
- // UI
- boolean isTest = Boolean.parseBoolean(test);
- int instanceCount = 0;
- if (dcaeEvent.getInstances() != null) {
- instanceCount = dcaeEvent.getInstances().size();
- }
- String msgInfo = "event=" + dcaeEvent.getEvent() + " serviceUUID=" + dcaeEvent.getServiceUUID()
- + " resourceUUID=" + dcaeEvent.getResourceUUID() + " artifactName=" + dcaeEvent.getArtifactName()
- + " instance count=" + instanceCount + " isTest=" + isTest;
- logger.info("POST dcae event {}", msgInfo);
- if (isTest) {
- logger.warn("Ignorning test event from DCAE");
- } else {
- if (DcaeEvent.EVENT_DEPLOYMENT.equalsIgnoreCase(dcaeEvent.getEvent())) {
- CldsModel.insertModelInstance(cldsDao, dcaeEvent, userid);
- } else {
- CldsEvent.insEvent(cldsDao, dcaeEvent.getControlName(), userid, dcaeEvent.getCldsActionCd(),
- CldsEvent.ACTION_STATE_RECEIVED, null);
- }
- }
- // audit log
- LoggingUtils.setTimeContext(startTime, new Date());
- auditLogger.info("Post dcae event completed");
- util.exiting("200", "Post dcae event success", Level.INFO, ONAPLogConstants.ResponseStatus.COMPLETED);
- return msgInfo;
- }
-
- /**
- * REST service that retrieves total properties required by UI.
- *
- * @return the sdc properties
- * @throws IOException In case of issues
- */
- public String getSdcProperties() throws IOException {
- return refProp.getJsonTemplate(GLOBAL_PROPERTIES_KEY).toString();
- }
-
-