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.dao;
26 import com.att.eelf.configuration.EELFLogger;
27 import com.att.eelf.configuration.EELFManager;
29 import java.io.IOException;
30 import java.io.InputStream;
31 import java.io.ObjectInputStream;
33 import java.sql.ResultSet;
34 import java.sql.SQLException;
35 import java.util.ArrayList;
36 import java.util.HashMap;
37 import java.util.List;
40 import javax.sql.DataSource;
42 import org.onap.clamp.clds.model.CldsDBServiceCache;
43 import org.onap.clamp.clds.model.CldsEvent;
44 import org.onap.clamp.clds.model.CldsModel;
45 import org.onap.clamp.clds.model.CldsModelInstance;
46 import org.onap.clamp.clds.model.CldsServiceData;
47 import org.onap.clamp.clds.model.CldsTemplate;
48 import org.onap.clamp.clds.model.ValueItem;
49 import org.springframework.jdbc.core.JdbcTemplate;
50 import org.springframework.jdbc.core.RowMapper;
51 import org.springframework.jdbc.core.namedparam.MapSqlParameterSource;
52 import org.springframework.jdbc.core.namedparam.SqlParameterSource;
53 import org.springframework.jdbc.core.simple.SimpleJdbcCall;
54 import org.springframework.stereotype.Repository;
57 * Data Access for CLDS Model tables.
59 @Repository("cldsDao")
60 public class CldsDao {
62 protected static final EELFLogger logger = EELFManager.getInstance().getLogger(CldsDao.class);
63 protected static final EELFLogger metricsLogger = EELFManager.getInstance().getMetricsLogger();
65 private JdbcTemplate jdbcTemplateObject;
66 private SimpleJdbcCall procGetModel;
67 private SimpleJdbcCall procGetModelTemplate;
68 private SimpleJdbcCall procSetModel;
69 private SimpleJdbcCall procInsEvent;
70 private SimpleJdbcCall procUpdEvent;
71 private SimpleJdbcCall procSetTemplate;
72 private SimpleJdbcCall procGetTemplate;
73 private SimpleJdbcCall procDelAllModelInstances;
74 private SimpleJdbcCall procInsModelInstance;
75 private SimpleJdbcCall procDelModelInstance;
77 private static final String HEALTHCHECK = "Select 1";
80 * Log message when instantiating
83 logger.info("CldsDao instantiating...");
87 * When dataSource is provided, instantiate spring jdbc objects.
91 public void setDataSource(DataSource dataSource) {
92 this.jdbcTemplateObject = new JdbcTemplate(dataSource);
93 this.procGetModel = new SimpleJdbcCall(dataSource).withProcedureName("get_model");
94 this.procGetModelTemplate = new SimpleJdbcCall(dataSource).withProcedureName("get_model_template");
95 this.procSetModel = new SimpleJdbcCall(dataSource).withProcedureName("set_model");
96 this.procInsEvent = new SimpleJdbcCall(dataSource).withProcedureName("ins_event");
97 this.procUpdEvent = new SimpleJdbcCall(dataSource).withProcedureName("upd_event");
98 this.procGetTemplate = new SimpleJdbcCall(dataSource).withProcedureName("get_template");
99 this.procSetTemplate = new SimpleJdbcCall(dataSource).withProcedureName("set_template");
100 this.procInsModelInstance = new SimpleJdbcCall(dataSource).withProcedureName("ins_model_instance");
101 this.procDelModelInstance = new SimpleJdbcCall(dataSource).withProcedureName("del_model_instance");
102 this.procDelAllModelInstances = new SimpleJdbcCall(dataSource).withProcedureName("del_all_model_instances");
106 * Get a model from the database given the model name.
111 public CldsModel getModel(String modelName) {
112 return getModel(modelName, null);
116 * Get a model from the database given the controlNameUuid.
118 * @param controlNameUuid
121 public CldsModel getModelByUuid(String controlNameUuid) {
122 return getModel(null, controlNameUuid);
126 * Get a model from the database given the model name or a controlNameUuid.
131 private CldsModel getModel(String modelName, String controlNameUuid) {
132 CldsModel model = new CldsModel();
133 model.setName(modelName);
134 SqlParameterSource in = new MapSqlParameterSource().addValue("v_model_name", modelName)
135 .addValue("v_control_name_uuid", controlNameUuid);
136 Map<String, Object> out = logSqlExecution(procGetModel, in);
137 model.setControlNamePrefix((String) out.get("v_control_name_prefix"));
138 model.setControlNameUuid((String) out.get("v_control_name_uuid"));
139 model.setId((String) (out.get("v_model_id")));
140 model.setTemplateId((String) (out.get("v_template_id")));
141 model.setTemplateName((String) (out.get("v_template_name")));
142 model.setBpmnId((String) (out.get("v_template_bpmn_id")));
143 model.setBpmnUserid((String) out.get("v_template_bpmn_user_id"));
144 model.setBpmnText((String) out.get("v_template_bpmn_text"));
145 model.setPropId((String) (out.get("v_model_prop_id")));
146 model.setPropUserid((String) out.get("v_model_prop_user_id"));
147 model.setPropText((String) out.get("v_model_prop_text"));
148 model.setImageId((String) (out.get("v_template_image_id")));
149 model.setImageUserid((String) out.get("v_template_image_user_id"));
150 model.setImageText((String) out.get("v_template_image_text"));
151 model.setDocId((String) (out.get("v_template_doc_id")));
152 model.setDocUserid((String) out.get("v_template_doc_user_id"));
153 model.setDocText((String) out.get("v_template_doc_text"));
154 model.setBlueprintText((String) out.get("v_model_blueprint_text"));
155 model.getEvent().setId((String) (out.get("v_event_id")));
156 model.getEvent().setActionCd((String) out.get("v_action_cd"));
157 model.getEvent().setActionStateCd((String) out.get("v_action_state_cd"));
158 model.getEvent().setProcessInstanceId((String) out.get("v_event_process_instance_id"));
159 model.getEvent().setUserid((String) out.get("v_event_user_id"));
160 model.setTypeId((String) out.get("v_service_type_id"));
161 model.setDeploymentId((String) out.get("v_deployment_id"));
166 * Get a model and template information from the database given the model
172 public CldsModel getModelTemplate(String modelName) {
173 CldsModel model = new CldsModel();
174 model.setName(modelName);
175 SqlParameterSource in = new MapSqlParameterSource().addValue("v_model_name", modelName);
176 Map<String, Object> out = logSqlExecution(procGetModelTemplate, in);
177 // todo : rationalize
178 model.setControlNamePrefix((String) out.get("v_control_name_prefix"));
179 model.setControlNameUuid((String) out.get("v_control_name_uuid"));
180 model.setId((String) (out.get("v_model_id")));
181 model.setTemplateId((String) (out.get("v_template_id")));
182 model.setTemplateName((String) (out.get("v_template_name")));
183 model.setBpmnId((String) (out.get("v_template_bpmn_id")));
184 model.setBpmnUserid((String) out.get("v_template_bpmn_user_id"));
185 model.setBpmnText((String) out.get("v_template_bpmn_text"));
186 model.setPropId((String) (out.get("v_model_prop_id")));
187 model.setPropUserid((String) out.get("v_model_prop_user_id"));
188 model.setPropText((String) out.get("v_model_prop_text"));
189 model.setImageId((String) (out.get("v_template_image_id")));
190 model.setImageUserid((String) out.get("v_template_image_user_id"));
191 model.setImageText((String) out.get("v_template_image_text"));
192 model.setDocId((String) (out.get("v_template_doc_id")));
193 model.setDocUserid((String) out.get("v_template_doc_user_id"));
194 model.setDocText((String) out.get("v_template_doc_text"));
195 model.setBlueprintText((String) out.get("v_model_blueprint_text"));
196 model.getEvent().setId((String) (out.get("v_event_id")));
197 model.getEvent().setActionCd((String) out.get("v_action_cd"));
198 model.getEvent().setActionStateCd((String) out.get("v_action_state_cd"));
199 model.getEvent().setProcessInstanceId((String) out.get("v_event_process_instance_id"));
200 model.getEvent().setUserid((String) out.get("v_event_user_id"));
201 model.setTypeId((String) out.get("v_service_type_id"));
202 model.setDeploymentId((String) out.get("v_deployment_id"));
204 Map<String, Object> modelResults = logSqlExecution(procGetModel, in);
205 Object modelResultObject = modelResults.get("#result-set-1");
206 if (modelResultObject != null && modelResultObject instanceof ArrayList) {
207 List<Object> modelInstanceRs = (List<Object>) modelResultObject;
208 for (Object currModelInstance : modelInstanceRs) {
209 if (currModelInstance != null && currModelInstance instanceof HashMap) {
210 HashMap<String, String> modelInstanceMap = (HashMap<String, String>) currModelInstance;
211 CldsModelInstance modelInstance = new CldsModelInstance();
212 modelInstance.setModelInstanceId(modelInstanceMap.get("model_instance_id"));
213 modelInstance.setVmName(modelInstanceMap.get("vm_name"));
214 modelInstance.setLocation(modelInstanceMap.get("location"));
215 model.getCldsModelInstanceList().add(modelInstance);
216 logger.info("value of currModel: {}", currModelInstance);
224 * Update model in the database using parameter values and return updated
231 public CldsModel setModel(CldsModel model, String userid) {
232 SqlParameterSource in = new MapSqlParameterSource().addValue("v_model_name", model.getName())
233 .addValue("v_template_id", model.getTemplateId()).addValue("v_user_id", userid)
234 .addValue("v_model_prop_text", model.getPropText())
235 .addValue("v_model_blueprint_text", model.getBlueprintText())
236 .addValue("v_service_type_id", model.getTypeId()).addValue("v_deployment_id", model.getDeploymentId())
237 .addValue("v_control_name_prefix", model.getControlNamePrefix())
238 .addValue("v_control_name_uuid", model.getControlNameUuid());
239 Map<String, Object> out = logSqlExecution(procSetModel, in);
240 model.setControlNamePrefix((String) out.get("v_control_name_prefix"));
241 model.setControlNameUuid((String) out.get("v_control_name_uuid"));
242 model.setId((String) (out.get("v_model_id")));
243 model.setPropId((String) (out.get("v_model_prop_id")));
244 model.setPropUserid((String) (out.get("v_model_prop_user_id")));
245 model.setBlueprintId((String) (out.get("v_model_blueprint_id")));
246 model.setBlueprintUserid((String) out.get("v_model_blueprint_user_id"));
247 model.getEvent().setId((String) (out.get("v_event_id")));
248 model.getEvent().setActionCd((String) out.get("v_action_cd"));
249 model.getEvent().setActionStateCd((String) out.get("v_action_state_cd"));
250 model.getEvent().setProcessInstanceId((String) out.get("v_event_process_instance_id"));
251 model.getEvent().setUserid((String) out.get("v_event_user_id"));
256 * Inserts new modelInstance in the database using parameter values and
257 * return updated model object.
260 * @param modelInstancesList
263 public void insModelInstance(CldsModel model, List<CldsModelInstance> modelInstancesList) {
264 // Delete all existing model instances for given controlNameUUID
265 logger.debug("deleting instances for: {}", model.getControlNameUuid());
266 delAllModelInstances(model.getControlNameUuid());
268 if (modelInstancesList == null) {
269 logger.debug("modelInstancesList == null");
271 for (CldsModelInstance currModelInstance : modelInstancesList) {
272 logger.debug("v_control_name_uuid={}", model.getControlNameUuid());
273 logger.debug("v_vm_name={}", currModelInstance.getVmName());
274 logger.debug("v_location={}", currModelInstance.getLocation());
275 SqlParameterSource in = new MapSqlParameterSource()
276 .addValue("v_control_name_uuid", model.getControlNameUuid())
277 .addValue("v_vm_name", currModelInstance.getVmName())
278 .addValue("v_location", currModelInstance.getLocation());
279 Map<String, Object> out = logSqlExecution(procInsModelInstance, in);
280 model.setId((String) (out.get("v_model_id")));
281 CldsModelInstance modelInstance = new CldsModelInstance();
282 modelInstance.setLocation(currModelInstance.getLocation());
283 modelInstance.setVmName(currModelInstance.getVmName());
284 modelInstance.setModelInstanceId((String) (out.get("v_model_instance_id")));
285 model.getCldsModelInstanceList().add(modelInstance);
291 * Delete a list of modelInstance from the database using parameter values
292 * and returns updated model object. This method is defunct - DCAE Proxy
293 * will not undeploy individual instances. It will send an empty list of
294 * deployed instances to indicate all have been removed. Or it will send an
295 * updated list to indicate those that are still deployed with any not on
296 * the list considered undeployed.
298 * @param controlNameUUid
299 * @param modelInstancesList
302 private CldsModel delModelInstance(String controlNameUUid, List<CldsModelInstance> modelInstancesList) {
303 CldsModel model = new CldsModel();
304 for (CldsModelInstance currModelInstance : modelInstancesList) {
305 SqlParameterSource in = new MapSqlParameterSource().addValue("v_control_name_uuid", controlNameUUid)
306 .addValue("v_vm_name", currModelInstance.getVmName());
307 Map<String, Object> out = logSqlExecution(procDelModelInstance, in);
308 model.setId((String) (out.get("v_model_id")));
314 * Insert an event in the database - require either modelName or
315 * controlNamePrefix/controlNameUuid.
318 * @param controlNamePrefix
319 * @param controlNameUuid
323 public CldsEvent insEvent(String modelName, String controlNamePrefix, String controlNameUuid, CldsEvent cldsEvent) {
324 CldsEvent event = new CldsEvent();
325 SqlParameterSource in = new MapSqlParameterSource().addValue("v_model_name", modelName)
326 .addValue("v_control_name_prefix", controlNamePrefix).addValue("v_control_name_uuid", controlNameUuid)
327 .addValue("v_user_id", cldsEvent.getUserid()).addValue("v_action_cd", cldsEvent.getActionCd())
328 .addValue("v_action_state_cd", cldsEvent.getActionStateCd())
329 .addValue("v_process_instance_id", cldsEvent.getProcessInstanceId());
330 Map<String, Object> out = logSqlExecution(procInsEvent, in);
331 event.setId((String) (out.get("v_event_id")));
336 * Method to delete all model instances based on controlNameUUID
338 * @param controlNameUUid
341 private String delAllModelInstances(String controlNameUUid) {
342 SqlParameterSource in = new MapSqlParameterSource().addValue("v_control_name_uuid", controlNameUUid);
343 Map<String, Object> out = logSqlExecution(procDelAllModelInstances, in);
344 return (String) (out.get("v_model_id"));
348 * Update event with process instance id.
351 * @param processInstanceId
353 public void updEvent(String eventId, String processInstanceId) {
354 SqlParameterSource in = new MapSqlParameterSource().addValue("v_event_id", eventId)
355 .addValue("v_process_instance_id", processInstanceId);
356 logSqlExecution(procUpdEvent, in);
360 * Generic mapper for list of values
362 private static final class ValueItemMapper implements RowMapper<ValueItem> {
364 public ValueItem mapRow(ResultSet rs, int rowNum) throws SQLException {
365 ValueItem item = new ValueItem();
366 item.setValue(rs.getString(1));
372 * Generic mapper for CldsDBServiceCache
374 private static final class CldsServiceDataMapper implements RowMapper<CldsServiceData> {
376 public CldsServiceData mapRow(ResultSet rs, int rowNum) throws SQLException {
377 CldsServiceData cldsServiceData = new CldsServiceData();
380 Blob blob = rs.getBlob(4);
381 InputStream is = blob.getBinaryStream();
382 ObjectInputStream oip;
384 oip = new ObjectInputStream(is);
385 cldsServiceData = (CldsServiceData) oip.readObject();
386 cldsServiceData.setAgeOfRecord(age);
387 } catch (IOException | ClassNotFoundException e) {
388 logger.error("Error caught while retrieving cldsServiceData from database", e);
390 return cldsServiceData;
395 * Return list of model names
397 * @return model names
399 public List<ValueItem> getBpmnNames() {
400 String sql = "SELECT model_name FROM model ORDER BY 1;";
401 return jdbcTemplateObject.query(sql, new ValueItemMapper());
405 * Update template in the database using parameter values and return updated
412 public CldsTemplate setTemplate(CldsTemplate template, String userid) {
413 SqlParameterSource in = new MapSqlParameterSource().addValue("v_template_name", template.getName())
414 .addValue("v_user_id", userid).addValue("v_template_bpmn_text", template.getBpmnText())
415 .addValue("v_template_image_text", template.getImageText())
416 .addValue("v_template_doc_text", template.getPropText());
417 Map<String, Object> out = logSqlExecution(procSetTemplate, in);
418 template.setId((String) (out.get("v_template_id")));
419 template.setBpmnUserid((String) (out.get("v_template_bpmn_user_id")));
420 template.setBpmnId((String) (out.get("v_template_bpmn_id")));
421 template.setBpmnText((String) (out.get("v_template_bpmn_text")));
422 template.setImageId((String) (out.get("v_template_image_id")));
423 template.setImageUserid((String) out.get("v_template_image_user_id"));
424 template.setImageText((String) out.get("v_template_image_text"));
425 template.setPropId((String) (out.get("v_template_doc_id")));
426 template.setPropUserid((String) out.get("v_template_doc_user_id"));
427 template.setPropText((String) out.get("v_template_doc_text"));
432 * Return list of template names
434 * @return template names
436 public List<ValueItem> getTemplateNames() {
437 String sql = "SELECT template_name FROM template ORDER BY 1;";
438 return jdbcTemplateObject.query(sql, new ValueItemMapper());
442 * Get a template from the database given the model name.
444 * @param templateName
447 public CldsTemplate getTemplate(String templateName) {
448 CldsTemplate template = new CldsTemplate();
449 template.setName(templateName);
450 SqlParameterSource in = new MapSqlParameterSource().addValue("v_template_name", templateName);
451 Map<String, Object> out = logSqlExecution(procGetTemplate, in);
452 template.setId((String) (out.get("v_template_id")));
453 template.setBpmnUserid((String) (out.get("v_template_bpmn_user_id")));
454 template.setBpmnId((String) (out.get("v_template_bpmn_id")));
455 template.setBpmnText((String) (out.get("v_template_bpmn_text")));
456 template.setImageId((String) (out.get("v_template_image_id")));
457 template.setImageUserid((String) out.get("v_template_image_user_id"));
458 template.setImageText((String) out.get("v_template_image_text"));
459 template.setPropId((String) (out.get("v_template_doc_id")));
460 template.setPropUserid((String) out.get("v_template_doc_user_id"));
461 template.setPropText((String) out.get("v_template_doc_text"));
465 public CldsServiceData getCldsServiceCache(String invariantUUID) {
466 CldsServiceData cldsServiceData = null;
467 List<CldsServiceData> cldsServiceDataList = new ArrayList<>();
468 String getCldsServiceSQL = "SELECT * , TIMESTAMPDIFF(SECOND, timestamp, CURRENT_TIMESTAMP()) FROM clds_service_cache where invariant_service_id = ? ";
469 cldsServiceData = jdbcTemplateObject.queryForObject(getCldsServiceSQL, new Object[] { invariantUUID },
470 new CldsServiceDataMapper());
471 logger.info("value of cldsServiceDataList: {}", cldsServiceDataList);
472 return cldsServiceData;
475 public void setCldsServiceCache(CldsDBServiceCache cldsDBServiceCache) {
476 if (cldsDBServiceCache != null && cldsDBServiceCache.getInvariantId() != null
477 && cldsDBServiceCache.getServiceId() != null) {
478 String invariantUuid = cldsDBServiceCache.getInvariantId();
479 String serviceUuid = cldsDBServiceCache.getServiceId();
480 InputStream is = cldsDBServiceCache.getCldsDataInstream();
481 String insertCldsServiceCacheSql = "INSERT INTO clds_service_cache"
482 + "(invariant_service_id,service_id,timestamp,object_data) VALUES"
483 + "(?,?,CURRENT_TIMESTAMP,?) ON DUPLICATE KEY UPDATE invariant_service_id = VALUES(invariant_service_id) , timestamp = CURRENT_TIMESTAMP , object_data = VALUES(object_data) ";
484 jdbcTemplateObject.update(insertCldsServiceCacheSql, invariantUuid, serviceUuid, is);
488 private static Map<String, Object> logSqlExecution(SimpleJdbcCall call, SqlParameterSource source) {
490 return call.execute(source);
491 } catch (Exception e) {
492 logger.error("Exception occured in " + source.getClass().getCanonicalName() + ": " + e);
497 public void doHealthCheck() {
498 jdbcTemplateObject.execute(HEALTHCHECK);