src/main/java/org/onap/clamp/clds/dao/CldsDao.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP CLAMP
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights
   6  *                             reserved.
   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
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  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.
  22  */
  23
  24 package org.onap.clamp.clds.dao;
  25
  26 import com.att.eelf.configuration.EELFLogger;
  27 import com.att.eelf.configuration.EELFManager;
  28
  29 import java.io.InputStream;
  30 import java.util.ArrayList;
  31 import java.util.HashMap;
  32 import java.util.List;
  33 import java.util.Map;
  34
  35 import javax.sql.DataSource;
  36
  37 import org.onap.clamp.clds.model.CldsDBServiceCache;
  38 import org.onap.clamp.clds.model.CldsEvent;
  39 import org.onap.clamp.clds.model.CldsModel;
  40 import org.onap.clamp.clds.model.CldsModelInstance;
  41 import org.onap.clamp.clds.model.CldsModelProp;
  42 import org.onap.clamp.clds.model.CldsServiceData;
  43 import org.onap.clamp.clds.model.CldsTemplate;
  44 import org.onap.clamp.clds.model.ValueItem;
  45 import org.springframework.dao.EmptyResultDataAccessException;
  46 import org.springframework.jdbc.core.JdbcTemplate;
  47 import org.springframework.jdbc.core.namedparam.MapSqlParameterSource;
  48 import org.springframework.jdbc.core.namedparam.SqlParameterSource;
  49 import org.springframework.jdbc.core.simple.SimpleJdbcCall;
  50 import org.springframework.stereotype.Repository;
  51
  52 /**
  53  * Data Access for CLDS Model tables.
  54  */
  55 @Repository("cldsDao")
  56 public class CldsDao {
  57
  58     protected static final EELFLogger logger = EELFManager.getInstance().getLogger(CldsDao.class);
  59     protected static final EELFLogger metricsLogger = EELFManager.getInstance().getMetricsLogger();
  60     private JdbcTemplate jdbcTemplateObject;
  61     private SimpleJdbcCall procGetModel;
  62     private SimpleJdbcCall procGetModelTemplate;
  63     private SimpleJdbcCall procSetModel;
  64     private SimpleJdbcCall procInsEvent;
  65     private SimpleJdbcCall procUpdEvent;
  66     private SimpleJdbcCall procSetTemplate;
  67     private SimpleJdbcCall procGetTemplate;
  68     private SimpleJdbcCall procDelAllModelInstances;
  69     private SimpleJdbcCall procInsModelInstance;
  70     private SimpleJdbcCall procDelModelInstance;
  71     private static final String HEALTHCHECK = "Select 1";
  72
  73     /**
  74      * Log message when instantiating
  75      */
  76     public CldsDao() {
  77         logger.info("CldsDao instantiating...");
  78     }
  79
  80     /**
  81      * When dataSource is provided, instantiate spring jdbc objects.
  82      *
  83      * @param dataSource
  84      */
  85     public void setDataSource(DataSource dataSource) {
  86         this.jdbcTemplateObject = new JdbcTemplate(dataSource);
  87         this.procGetModel = new SimpleJdbcCall(dataSource).withProcedureName("get_model");
  88         this.procGetModelTemplate = new SimpleJdbcCall(dataSource).withProcedureName("get_model_template");
  89         this.procSetModel = new SimpleJdbcCall(dataSource).withProcedureName("set_model");
  90         this.procInsEvent = new SimpleJdbcCall(dataSource).withProcedureName("ins_event");
  91         this.procUpdEvent = new SimpleJdbcCall(dataSource).withProcedureName("upd_event");
  92         this.procGetTemplate = new SimpleJdbcCall(dataSource).withProcedureName("get_template");
  93         this.procSetTemplate = new SimpleJdbcCall(dataSource).withProcedureName("set_template");
  94         this.procInsModelInstance = new SimpleJdbcCall(dataSource).withProcedureName("ins_model_instance");
  95         this.procDelModelInstance = new SimpleJdbcCall(dataSource).withProcedureName("del_model_instance");
  96         this.procDelAllModelInstances = new SimpleJdbcCall(dataSource).withProcedureName("del_all_model_instances");
  97     }
  98
  99     /**
 100      * Get a model from the database given the model name.
 101      *
 102      * @param modelName
 103      * @return model
 104      */
 105     public CldsModel getModel(String modelName) {
 106         return getModel(modelName, null);
 107     }
 108
 109     /**
 110      * Get a model from the database given the controlNameUuid.
 111      *
 112      * @param controlNameUuid
 113      * @return model
 114      */
 115     public CldsModel getModelByUuid(String controlNameUuid) {
 116         return getModel(null, controlNameUuid);
 117     }
 118
 119     /**
 120      * Get a model from the database given the model name or a controlNameUuid.
 121      *
 122      * @param modelName
 123      * @return model
 124      */
 125     private CldsModel getModel(String modelName, String controlNameUuid) {
 126         CldsModel model = new CldsModel();
 127         model.setName(modelName);
 128         SqlParameterSource in = new MapSqlParameterSource().addValue("v_model_name", modelName)
 129                 .addValue("v_control_name_uuid", controlNameUuid);
 130         Map<String, Object> out = logSqlExecution(procGetModel, in);
 131         model.setControlNamePrefix((String) out.get("v_control_name_prefix"));
 132         model.setControlNameUuid((String) out.get("v_control_name_uuid"));
 133         model.setId((String) (out.get("v_model_id")));
 134         model.setTemplateId((String) (out.get("v_template_id")));
 135         model.setTemplateName((String) (out.get("v_template_name")));
 136         model.setBpmnId((String) (out.get("v_template_bpmn_id")));
 137         model.setBpmnUserid((String) out.get("v_template_bpmn_user_id"));
 138         model.setBpmnText((String) out.get("v_template_bpmn_text"));
 139         model.setPropId((String) (out.get("v_model_prop_id")));
 140         model.setPropUserid((String) out.get("v_model_prop_user_id"));
 141         model.setPropText((String) out.get("v_model_prop_text"));
 142         model.setImageId((String) (out.get("v_template_image_id")));
 143         model.setImageUserid((String) out.get("v_template_image_user_id"));
 144         model.setImageText((String) out.get("v_template_image_text"));
 145         model.setDocId((String) (out.get("v_template_doc_id")));
 146         model.setDocUserid((String) out.get("v_template_doc_user_id"));
 147         model.setDocText((String) out.get("v_template_doc_text"));
 148         model.setBlueprintText((String) out.get("v_model_blueprint_text"));
 149         model.getEvent().setId((String) (out.get("v_event_id")));
 150         model.getEvent().setActionCd((String) out.get("v_action_cd"));
 151         model.getEvent().setActionStateCd((String) out.get("v_action_state_cd"));
 152         model.getEvent().setProcessInstanceId((String) out.get("v_event_process_instance_id"));
 153         model.getEvent().setUserid((String) out.get("v_event_user_id"));
 154         model.setTypeId((String) out.get("v_service_type_id"));
 155         model.setDeploymentId((String) out.get("v_deployment_id"));
 156         return model;
 157     }
 158
 159     /**
 160      * Get a model and template information from the database given the model
 161      * name.
 162      *
 163      * @param modelName
 164      * @return model
 165      */
 166     public CldsModel getModelTemplate(String modelName) {
 167         CldsModel model = new CldsModel();
 168         model.setName(modelName);
 169         SqlParameterSource in = new MapSqlParameterSource().addValue("v_model_name", modelName);
 170         Map<String, Object> out = logSqlExecution(procGetModelTemplate, in);
 171         // todo : rationalize
 172         model.setControlNamePrefix((String) out.get("v_control_name_prefix"));
 173         model.setControlNameUuid((String) out.get("v_control_name_uuid"));
 174         model.setId((String) (out.get("v_model_id")));
 175         model.setTemplateId((String) (out.get("v_template_id")));
 176         model.setTemplateName((String) (out.get("v_template_name")));
 177         model.setBpmnId((String) (out.get("v_template_bpmn_id")));
 178         model.setBpmnUserid((String) out.get("v_template_bpmn_user_id"));
 179         model.setBpmnText((String) out.get("v_template_bpmn_text"));
 180         model.setPropId((String) (out.get("v_model_prop_id")));
 181         model.setPropUserid((String) out.get("v_model_prop_user_id"));
 182         model.setPropText((String) out.get("v_model_prop_text"));
 183         model.setImageId((String) (out.get("v_template_image_id")));
 184         model.setImageUserid((String) out.get("v_template_image_user_id"));
 185         model.setImageText((String) out.get("v_template_image_text"));
 186         model.setDocId((String) (out.get("v_template_doc_id")));
 187         model.setDocUserid((String) out.get("v_template_doc_user_id"));
 188         model.setDocText((String) out.get("v_template_doc_text"));
 189         model.setBlueprintText((String) out.get("v_model_blueprint_text"));
 190         model.getEvent().setId((String) (out.get("v_event_id")));
 191         model.getEvent().setActionCd((String) out.get("v_action_cd"));
 192         model.getEvent().setActionStateCd((String) out.get("v_action_state_cd"));
 193         model.getEvent().setProcessInstanceId((String) out.get("v_event_process_instance_id"));
 194         model.getEvent().setUserid((String) out.get("v_event_user_id"));
 195         model.setTypeId((String) out.get("v_service_type_id"));
 196         model.setDeploymentId((String) out.get("v_deployment_id"));
 197         Map<String, Object> modelResults = logSqlExecution(procGetModel, in);
 198         Object modelResultObject = modelResults.get("#result-set-1");
 199         if (modelResultObject != null && modelResultObject instanceof ArrayList) {
 200             List<Object> modelInstanceRs = (List<Object>) modelResultObject;
 201             for (Object currModelInstance : modelInstanceRs) {
 202                 if (currModelInstance != null && currModelInstance instanceof HashMap) {
 203                     HashMap<String, String> modelInstanceMap = (HashMap<String, String>) currModelInstance;
 204                     CldsModelInstance modelInstance = new CldsModelInstance();
 205                     modelInstance.setModelInstanceId(modelInstanceMap.get("model_instance_id"));
 206                     modelInstance.setVmName(modelInstanceMap.get("vm_name"));
 207                     modelInstance.setLocation(modelInstanceMap.get("location"));
 208                     model.getCldsModelInstanceList().add(modelInstance);
 209                     logger.info("value of currModel: {}", currModelInstance);
 210                 }
 211             }
 212         }
 213         return model;
 214     }
 215
 216     /**
 217      * Update model in the database using parameter values and return updated
 218      * model object.
 219      *
 220      * @param model
 221      * @param userid
 222      * @return
 223      */
 224     public CldsModel setModel(CldsModel model, String userid) {
 225         SqlParameterSource in = new MapSqlParameterSource().addValue("v_model_name", model.getName())
 226                 .addValue("v_template_id", model.getTemplateId()).addValue("v_user_id", userid)
 227                 .addValue("v_model_prop_text", model.getPropText())
 228                 .addValue("v_model_blueprint_text", model.getBlueprintText())
 229                 .addValue("v_service_type_id", model.getTypeId()).addValue("v_deployment_id", model.getDeploymentId())
 230                 .addValue("v_control_name_prefix", model.getControlNamePrefix())
 231                 .addValue("v_control_name_uuid", model.getControlNameUuid());
 232         Map<String, Object> out = logSqlExecution(procSetModel, in);
 233         model.setControlNamePrefix((String) out.get("v_control_name_prefix"));
 234         model.setControlNameUuid((String) out.get("v_control_name_uuid"));
 235         model.setId((String) (out.get("v_model_id")));
 236         model.setPropId((String) (out.get("v_model_prop_id")));
 237         model.setPropUserid((String) (out.get("v_model_prop_user_id")));
 238         model.setBlueprintId((String) (out.get("v_model_blueprint_id")));
 239         model.setBlueprintUserid((String) out.get("v_model_blueprint_user_id"));
 240         model.getEvent().setId((String) (out.get("v_event_id")));
 241         model.getEvent().setActionCd((String) out.get("v_action_cd"));
 242         model.getEvent().setActionStateCd((String) out.get("v_action_state_cd"));
 243         model.getEvent().setProcessInstanceId((String) out.get("v_event_process_instance_id"));
 244         model.getEvent().setUserid((String) out.get("v_event_user_id"));
 245         return model;
 246     }
 247
 248     /**
 249      * Inserts new modelInstance in the database using parameter values and
 250      * return updated model object.
 251      *
 252      * @param model
 253      * @param modelInstancesList
 254      * @return
 255      */
 256     public void insModelInstance(CldsModel model, List<CldsModelInstance> modelInstancesList) {
 257         // Delete all existing model instances for given controlNameUUID
 258         logger.debug("deleting instances for: {}", model.getControlNameUuid());
 259         delAllModelInstances(model.getControlNameUuid());
 260         if (modelInstancesList == null) {
 261             logger.debug("modelInstancesList == null");
 262         } else {
 263             for (CldsModelInstance currModelInstance : modelInstancesList) {
 264                 logger.debug("v_control_name_uuid={}", model.getControlNameUuid());
 265                 logger.debug("v_vm_name={}", currModelInstance.getVmName());
 266                 logger.debug("v_location={}", currModelInstance.getLocation());
 267                 SqlParameterSource in = new MapSqlParameterSource()
 268                         .addValue("v_control_name_uuid", model.getControlNameUuid())
 269                         .addValue("v_vm_name", currModelInstance.getVmName())
 270                         .addValue("v_location", currModelInstance.getLocation());
 271                 Map<String, Object> out = logSqlExecution(procInsModelInstance, in);
 272                 model.setId((String) (out.get("v_model_id")));
 273                 CldsModelInstance modelInstance = new CldsModelInstance();
 274                 modelInstance.setLocation(currModelInstance.getLocation());
 275                 modelInstance.setVmName(currModelInstance.getVmName());
 276                 modelInstance.setModelInstanceId((String) (out.get("v_model_instance_id")));
 277                 model.getCldsModelInstanceList().add(modelInstance);
 278             }
 279         }
 280     }
 281
 282     /**
 283      * Delete a list of modelInstance from the database using parameter values
 284      * and returns updated model object. This method is defunct - DCAE Proxy
 285      * will not undeploy individual instances. It will send an empty list of
 286      * deployed instances to indicate all have been removed. Or it will send an
 287      * updated list to indicate those that are still deployed with any not on
 288      * the list considered undeployed.
 289      *
 290      * @param controlNameUUid
 291      * @param modelInstancesList
 292      * @return
 293      */
 294     private CldsModel delModelInstance(String controlNameUUid, List<CldsModelInstance> modelInstancesList) {
 295         CldsModel model = new CldsModel();
 296         for (CldsModelInstance currModelInstance : modelInstancesList) {
 297             SqlParameterSource in = new MapSqlParameterSource().addValue("v_control_name_uuid", controlNameUUid)
 298                     .addValue("v_vm_name", currModelInstance.getVmName());
 299             Map<String, Object> out = logSqlExecution(procDelModelInstance, in);
 300             model.setId((String) (out.get("v_model_id")));
 301         }
 302         return model;
 303     }
 304
 305     /**
 306      * Insert an event in the database - require either modelName or
 307      * controlNamePrefix/controlNameUuid.
 308      *
 309      * @param modelName
 310      * @param controlNamePrefix
 311      * @param controlNameUuid
 312      * @param cldsEvent
 313      * @return
 314      */
 315     public CldsEvent insEvent(String modelName, String controlNamePrefix, String controlNameUuid, CldsEvent cldsEvent) {
 316         CldsEvent event = new CldsEvent();
 317         SqlParameterSource in = new MapSqlParameterSource().addValue("v_model_name", modelName)
 318                 .addValue("v_control_name_prefix", controlNamePrefix).addValue("v_control_name_uuid", controlNameUuid)
 319                 .addValue("v_user_id", cldsEvent.getUserid()).addValue("v_action_cd", cldsEvent.getActionCd())
 320                 .addValue("v_action_state_cd", cldsEvent.getActionStateCd())
 321                 .addValue("v_process_instance_id", cldsEvent.getProcessInstanceId());
 322         Map<String, Object> out = logSqlExecution(procInsEvent, in);
 323         event.setId((String) (out.get("v_event_id")));
 324         return event;
 325     }
 326
 327     /**
 328      * Method to delete all model instances based on controlNameUUID
 329      *
 330      * @param controlNameUUid
 331      * @return
 332      */
 333     private String delAllModelInstances(String controlNameUUid) {
 334         SqlParameterSource in = new MapSqlParameterSource().addValue("v_control_name_uuid", controlNameUUid);
 335         Map<String, Object> out = logSqlExecution(procDelAllModelInstances, in);
 336         return (String) (out.get("v_model_id"));
 337     }
 338
 339     /**
 340      * Update event with process instance id.
 341      *
 342      * @param eventId
 343      * @param processInstanceId
 344      */
 345     public void updEvent(String eventId, String processInstanceId) {
 346         SqlParameterSource in = new MapSqlParameterSource().addValue("v_event_id", eventId)
 347                 .addValue("v_process_instance_id", processInstanceId);
 348         logSqlExecution(procUpdEvent, in);
 349     }
 350
 351     /**
 352      * Return list of model names
 353      *
 354      * @return model names
 355      */
 356     public List<ValueItem> getBpmnNames() {
 357         String sql = "SELECT model_name FROM model ORDER BY 1;";
 358         return jdbcTemplateObject.query(sql, new ValueItemMapper());
 359     }
 360
 361     /**
 362      * Update template in the database using parameter values and return updated
 363      * template object.
 364      *
 365      * @param template
 366      * @param userid
 367      */
 368     public void setTemplate(CldsTemplate template, String userid) {
 369         SqlParameterSource in = new MapSqlParameterSource().addValue("v_template_name", template.getName())
 370                 .addValue("v_user_id", userid).addValue("v_template_bpmn_text", template.getBpmnText())
 371                 .addValue("v_template_image_text", template.getImageText())
 372                 .addValue("v_template_doc_text", template.getPropText());
 373         Map<String, Object> out = logSqlExecution(procSetTemplate, in);
 374         template.setId((String) (out.get("v_template_id")));
 375         template.setBpmnUserid((String) (out.get("v_template_bpmn_user_id")));
 376         template.setBpmnId((String) (out.get("v_template_bpmn_id")));
 377         template.setBpmnText((String) (out.get("v_template_bpmn_text")));
 378         template.setImageId((String) (out.get("v_template_image_id")));
 379         template.setImageUserid((String) out.get("v_template_image_user_id"));
 380         template.setImageText((String) out.get("v_template_image_text"));
 381         template.setPropId((String) (out.get("v_template_doc_id")));
 382         template.setPropUserid((String) out.get("v_template_doc_user_id"));
 383         template.setPropText((String) out.get("v_template_doc_text"));
 384     }
 385
 386     /**
 387      * Return list of template names
 388      *
 389      * @return template names
 390      */
 391     public List<ValueItem> getTemplateNames() {
 392         String sql = "SELECT template_name FROM template ORDER BY 1;";
 393         return jdbcTemplateObject.query(sql, new ValueItemMapper());
 394     }
 395
 396     /**
 397      * Get a template from the database given the model name.
 398      *
 399      * @param templateName
 400      * @return model
 401      */
 402     public CldsTemplate getTemplate(String templateName) {
 403         CldsTemplate template = new CldsTemplate();
 404         template.setName(templateName);
 405         SqlParameterSource in = new MapSqlParameterSource().addValue("v_template_name", templateName);
 406         Map<String, Object> out = logSqlExecution(procGetTemplate, in);
 407         template.setId((String) (out.get("v_template_id")));
 408         template.setBpmnUserid((String) (out.get("v_template_bpmn_user_id")));
 409         template.setBpmnId((String) (out.get("v_template_bpmn_id")));
 410         template.setBpmnText((String) (out.get("v_template_bpmn_text")));
 411         template.setImageId((String) (out.get("v_template_image_id")));
 412         template.setImageUserid((String) out.get("v_template_image_user_id"));
 413         template.setImageText((String) out.get("v_template_image_text"));
 414         template.setPropId((String) (out.get("v_template_doc_id")));
 415         template.setPropUserid((String) out.get("v_template_doc_user_id"));
 416         template.setPropText((String) out.get("v_template_doc_text"));
 417         return template;
 418     }
 419
 420     public CldsServiceData getCldsServiceCache(String invariantUUID) {
 421         CldsServiceData cldsServiceData = null;
 422         List<CldsServiceData> cldsServiceDataList = new ArrayList<>();
 423         try {
 424             String getCldsServiceSQL = "SELECT * , TIMESTAMPDIFF(SECOND, timestamp, CURRENT_TIMESTAMP()) FROM clds_service_cache where invariant_service_id  = ? ";
 425             cldsServiceData = jdbcTemplateObject.queryForObject(getCldsServiceSQL, new Object[] {
 426                     invariantUUID
 427             }, new CldsServiceDataMapper());
 428             logger.info("value of cldsServiceDataList: {}", cldsServiceDataList);
 429         } catch (EmptyResultDataAccessException e) {
 430             logger.warn("cache row not found for invariantUUID: " + invariantUUID, e);
 431         }
 432         return cldsServiceData;
 433     }
 434
 435     public void setCldsServiceCache(CldsDBServiceCache cldsDBServiceCache) {
 436         if (cldsDBServiceCache != null && cldsDBServiceCache.getInvariantId() != null
 437                 && cldsDBServiceCache.getServiceId() != null) {
 438             String invariantUuid = cldsDBServiceCache.getInvariantId();
 439             String serviceUuid = cldsDBServiceCache.getServiceId();
 440             InputStream is = cldsDBServiceCache.getCldsDataInstream();
 441             String insertCldsServiceCacheSql = "INSERT INTO clds_service_cache"
 442                     + "(invariant_service_id,service_id,timestamp,object_data) VALUES"
 443                     + "(?,?,CURRENT_TIMESTAMP,?) ON DUPLICATE KEY UPDATE invariant_service_id = VALUES(invariant_service_id) , timestamp = CURRENT_TIMESTAMP , object_data = VALUES(object_data) ";
 444             jdbcTemplateObject.update(insertCldsServiceCacheSql, invariantUuid, serviceUuid, is);
 445         }
 446     }
 447
 448     private static Map<String, Object> logSqlExecution(SimpleJdbcCall call, SqlParameterSource source) {
 449         try {
 450             return call.execute(source);
 451         } catch (Exception e) {
 452             logger.error("Exception occured in " + source.getClass().getCanonicalName() + ": " + e);
 453             throw e;
 454         }
 455     }
 456
 457     public void doHealthCheck() {
 458         jdbcTemplateObject.execute(HEALTHCHECK);
 459     }
 460
 461     /**
 462      * Method to get deployed/active models with model properties.
 463      *
 464      * @return list of CldsModelProp
 465      */
 466     public List<CldsModelProp> getDeployedModelProperties() {
 467         List<CldsModelProp> cldsModelPropList = new ArrayList<CldsModelProp>();
 468         String modelsSql = "select m.model_id, m.model_name, mp.model_prop_id, mp.model_prop_text FROM model m, model_properties mp, event e "
 469                 + "WHERE m.model_prop_id = mp.model_prop_id and m.event_id = e.event_id and e.action_cd = 'DEPLOY'";
 470         List<Map<String, Object>> rows = jdbcTemplateObject.queryForList(modelsSql);
 471         CldsModelProp cldsModelProp = null;
 472         for (Map<String, Object> row : rows) {
 473             cldsModelProp = new CldsModelProp();
 474             cldsModelProp.setId((String) row.get("model_id"));
 475             cldsModelProp.setName((String) row.get("model_name"));
 476             cldsModelProp.setPropId((String) row.get("model_prop_id"));
 477             cldsModelProp.setPropText((String) row.get("model_prop_text"));
 478             cldsModelPropList.add(cldsModelProp);
 479         }
 480         return cldsModelPropList;
 481     }
 482 }