gerrit.onap Code Review - appc.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Copyright (C) 2017 Amdocs
   8  * =============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.appc.transactionrecorder.impl;
  25
  26 import org.apache.commons.lang.StringUtils;
  27 import org.onap.appc.domainmodel.lcm.Flags;
  28 import org.onap.appc.domainmodel.lcm.RequestStatus;
  29 import org.onap.appc.domainmodel.lcm.VNFOperation;
  30 import org.onap.appc.exceptions.APPCException;
  31 import org.onap.appc.transactionrecorder.TransactionRecorder;
  32 import org.onap.appc.domainmodel.lcm.TransactionRecord;
  33 import org.onap.appc.transactionrecorder.objects.TransactionConstants;
  34 import org.onap.ccsdk.sli.core.dblib.DbLibService;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37
  38 import javax.sql.rowset.CachedRowSet;
  39 import java.sql.SQLException;
  40 import java.text.ParseException;
  41 import java.text.SimpleDateFormat;
  42 import java.time.Instant;
  43 import java.time.ZoneOffset;
  44 import java.time.format.DateTimeFormatter;
  45 import java.util.ArrayList;
  46 import java.util.List;
  47 import java.util.Map;
  48
  49 import static org.onap.appc.transactionrecorder.objects.TransactionConstants.TRANSACTION_ATTRIBUTES.*;
  50 import static org.onap.appc.transactionrecorder.objects.TransactionConstants.*;
  51
  52
  53 public class TransactionRecorderImpl implements TransactionRecorder {
  54
  55     private final String SCHEMA = "sdnctl";
  56
  57     private String appcInstanceId;
  58
  59     private DbLibService dbLibService;
  60
  61     public void setDbLibService(DbLibService dbLibService) {
  62         this.dbLibService = dbLibService;
  63     }
  64
  65     private static final Logger logger = LoggerFactory.getLogger(TransactionRecorderImpl.class);
  66
  67     /**
  68      * Stores transaction record to appc database by calling APPC Dao layer.
  69      *
  70      * @param record Transaction record data.
  71      */
  72     @Override
  73     public void store(TransactionRecord record) throws APPCException {
  74         if (logger.isTraceEnabled()) {
  75             logger.trace("Transaction data insertion into DB");
  76         }
  77         final String STORE_DATE_QUERY = TransactionConstants.INSERT_INTO + TransactionConstants.TRANSACTIONS +
  78             "(" + TRANSACTION_ID.getColumnName() + TransactionConstants.COMMA +
  79             ORIGIN_TIMESTAMP.getColumnName() + TransactionConstants.COMMA +
  80             REQUEST_ID.getColumnName() + TransactionConstants.COMMA +
  81             SUBREQUEST_ID.getColumnName() + TransactionConstants.COMMA +
  82             ORIGINATOR_ID.getColumnName() + TransactionConstants.COMMA +
  83             START_TIME.getColumnName() + TransactionConstants.COMMA +
  84             END_TIME.getColumnName() + TransactionConstants.COMMA +
  85             TARGET_ID.getColumnName() + TransactionConstants.COMMA +
  86             TARGET_TYPE.getColumnName() + TransactionConstants.COMMA +
  87             OPERATION.getColumnName() + TransactionConstants.COMMA +
  88             RESULT_CODE.getColumnName() + TransactionConstants.COMMA +
  89             DESCRIPTION.getColumnName() + TransactionConstants.COMMA +
  90             STATE.getColumnName() + TransactionConstants.COMMA +
  91             SERVICE_INSTANCE_ID + TransactionConstants.COMMA +
  92             VNFC_NAME + TransactionConstants.COMMA +
  93             VSERVER_ID + TransactionConstants.COMMA +
  94             VF_MODULE_ID + TransactionConstants.COMMA +
  95             MODE + ") " +
  96             "values(?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)";
  97         try {
  98             dbLibService.writeData(STORE_DATE_QUERY, prepareArguments(record), SCHEMA);
  99         } catch (SQLException e) {
 100             logger.error("Error on storing record " + record.toString(), e);
 101             throw new APPCException(ERROR_ACCESSING_DATABASE, e);
 102         }
 103         if (logger.isTraceEnabled()) {
 104             logger.trace("Transaction Data Inserted Successfully into DB");
 105         }
 106     }
 107
 108     @Override
 109     public void update(String key, Map<TransactionConstants.TRANSACTION_ATTRIBUTES, String> updateColumns) throws
 110         APPCException {
 111         ArrayList<String> values = new ArrayList<>();
 112
 113         StringBuilder queryBuilder = new StringBuilder("UPDATE TRANSACTIONS SET ");
 114         for (Map.Entry<TransactionConstants.TRANSACTION_ATTRIBUTES, String> entry : updateColumns.entrySet()) {
 115             queryBuilder.append(entry.getKey().getColumnName() + " = ? ,");
 116             values.add(entry.getValue());
 117         }
 118         queryBuilder.deleteCharAt(queryBuilder.lastIndexOf(","));
 119         queryBuilder.append(WHERE + TRANSACTION_ID.getColumnName() + " = ?");
 120         values.add(appcInstanceId + "~" + key);
 121
 122         String query = queryBuilder.toString();
 123         try {
 124             dbLibService.writeData(query, values, SCHEMA);
 125         } catch (SQLException e) {
 126             logger.error("Error in updating records " + e);
 127             throw new APPCException(ERROR_ACCESSING_DATABASE, e);
 128         }
 129         if (logger.isTraceEnabled()) {
 130             logger.trace("Transaction data updated successfully");
 131         }
 132
 133     }
 134
 135     @Override
 136     public void markTransactionsAborted(String appcInstanceId) {
 137         if (logger.isTraceEnabled()) {
 138             logger.trace("marking in progress transactions to aborted");
 139         }
 140         final String updateQuery =
 141             "UPDATE " + TransactionConstants.TRANSACTIONS +
 142                 " SET " + STATE.getColumnName() + " = '" + RequestStatus.ABORTED.name() + "',"
 143                         + END_TIME.getColumnName() + " = ? " +
 144                 WHERE + TRANSACTION_ID.getColumnName() + " LIKE '" + appcInstanceId + "%'  AND "
 145                 + STATE.getColumnName() + " in (?,?)";
 146
 147         if (logger.isDebugEnabled()) {
 148             logger.debug("Update query " + updateQuery + " appc-instance-id " + appcInstanceId);
 149         }
 150
 151         ArrayList<String> arguments = new ArrayList<>();
 152         arguments.add(dateToStringConverterMillis(Instant.now()));
 153         arguments.add(RequestStatus.ACCEPTED.name());
 154         arguments.add(RequestStatus.RECEIVED.name());
 155         try {
 156             dbLibService.writeData(updateQuery, arguments, SCHEMA);
 157         } catch (SQLException e) {
 158             String message = "In progress transactions couldn't be marked aborted on server start up";
 159             logger.error(message);
 160             throw new RuntimeException(message);
 161         }
 162         if (logger.isTraceEnabled()) {
 163             logger.trace("In progress transactions marked aborted");
 164         }
 165     }
 166
 167     @Override
 168     public List<TransactionRecord> getInProgressRequests(TransactionRecord record) throws APPCException {
 169
 170         final String IN_PROGRESS_REQUESTS_QUERY = "SELECT * FROM " +
 171             TransactionConstants.TRANSACTIONS + WHERE +
 172             TARGET_ID + " = ? AND " +
 173             STATE.getColumnName() + " IN (?,?) AND " +
 174             START_TIME.getColumnName() + " < ?";
 175
 176         ArrayList<String> inProgressQueryParams = new ArrayList<>();
 177         inProgressQueryParams.add(record.getTargetId());
 178         inProgressQueryParams.add(RequestStatus.RECEIVED.name());
 179         inProgressQueryParams.add(RequestStatus.ACCEPTED.name());
 180         inProgressQueryParams.add(dateToStringConverterMillis(record.getStartTime()));
 181
 182         try (CachedRowSet rowSet = dbLibService.getData(IN_PROGRESS_REQUESTS_QUERY, inProgressQueryParams, SCHEMA)) {
 183             List<TransactionRecord> inProgressRecords = new ArrayList<>();
 184             TransactionRecord transaction;
 185             while (rowSet.next()) {
 186                 transaction = new TransactionRecord();
 187                 transaction.setTransactionId(rowSet.getString(TRANSACTION_ID.getColumnName()));
 188                 transaction.setRequestId(rowSet.getString(REQUEST_ID.getColumnName()));
 189                 transaction.setSubRequestId(rowSet.getString(SUBREQUEST_ID.getColumnName()));
 190                 transaction.setOriginatorId(rowSet.getString(ORIGINATOR_ID.getColumnName()));
 191                 transaction.setStartTime(stringToDateConverterMillis(rowSet.getString(START_TIME.getColumnName())));
 192                 transaction.setTargetId(rowSet.getString(TARGET_ID.getColumnName()));
 193                 transaction.setTargetType(rowSet.getString(TARGET_TYPE.getColumnName()));
 194                 transaction.setOperation(VNFOperation.valueOf(rowSet.getString(OPERATION.getColumnName())));
 195                 transaction.setRequestState(RequestStatus.valueOf(rowSet.getString(STATE.getColumnName())));
 196                 transaction.setVnfcName(rowSet.getString(VNFC_NAME.getColumnName()));
 197                 transaction.setVserverId(rowSet.getString(VSERVER_ID.getColumnName()));
 198                 transaction.setVfModuleId(rowSet.getString(VF_MODULE_ID.getColumnName()));
 199                 transaction.setServiceInstanceId(rowSet.getString(SERVICE_INSTANCE_ID.getColumnName()));
 200                 transaction.setMode(Flags.Mode.valueOf(rowSet.getString(MODE.getColumnName())));
 201                 inProgressRecords.add(transaction);
 202             }
 203             if (logger.isTraceEnabled()) {
 204                 logger.trace("In progress transaction records fetched from database successfully.");
 205             }
 206             return inProgressRecords;
 207         } catch (ParseException e) {
 208             logger.error("Error parsing start date during fetching in progress records ", e);
 209             throw new APPCException(ERROR_ACCESSING_DATABASE, e);
 210         } catch (SQLException e) {
 211             logger.error("Error fetching in progress records for Transaction ID = " + appcInstanceId + "~" + record
 212                 .getTransactionId(), e);
 213             throw new APPCException(ERROR_ACCESSING_DATABASE, e);
 214         }
 215     }
 216
 217     @Override
 218     public Boolean isTransactionDuplicate(TransactionRecord record) throws APPCException {
 219
 220         StringBuilder duplicateRequestCheckQuery = new StringBuilder("SELECT " +
 221             TRANSACTION_ID.getColumnName() + " FROM " +
 222             TransactionConstants.TRANSACTIONS + WHERE +
 223             TRANSACTION_ID.getColumnName() + " <> ? AND " +
 224             REQUEST_ID.getColumnName() + " = ? AND " +
 225             STATE.getColumnName() + " IN(?,?) ");
 226
 227         ArrayList<String> duplicateCheckParams = new ArrayList<>();
 228         duplicateCheckParams.add(appcInstanceId + "~" + record.getTransactionId());
 229         duplicateCheckParams.add(record.getRequestId());
 230         duplicateCheckParams.add(RequestStatus.RECEIVED.name());
 231         duplicateCheckParams.add(RequestStatus.ACCEPTED.name());
 232
 233         if (!StringUtils.isBlank(record.getSubRequestId())) {
 234             duplicateRequestCheckQuery.append(AND + SUBREQUEST_ID.getColumnName() + " = ? ");
 235             duplicateCheckParams.add(record.getSubRequestId());
 236         } else {
 237             duplicateRequestCheckQuery.append(AND + SUBREQUEST_ID.getColumnName() + IS_NULL);
 238         }
 239         if (!StringUtils.isBlank(record.getOriginatorId())) {
 240             duplicateRequestCheckQuery.append(AND + ORIGINATOR_ID.getColumnName() + " = ? ");
 241             duplicateCheckParams.add(record.getOriginatorId());
 242         } else {
 243             duplicateRequestCheckQuery.append(AND + ORIGINATOR_ID.getColumnName() + IS_NULL);
 244         }
 245         if (logger.isDebugEnabled()) {
 246             logger.debug(duplicateRequestCheckQuery.toString());
 247         }
 248         try (CachedRowSet rowSet = dbLibService.getData(duplicateRequestCheckQuery.toString(), duplicateCheckParams,
 249             SCHEMA)) {
 250             if (rowSet.first()) {
 251                 String transactionId = rowSet.getString(TRANSACTION_ID.getColumnName());
 252                 if (logger.isErrorEnabled()) {
 253                     logger.error("Duplicate request found. Transaction ID " + transactionId + " is currently in " +
 254                         "progress.");
 255                 }
 256                 return true;
 257             }
 258             return false;
 259         } catch (SQLException e) {
 260             logger.error("Error checking duplicate records for Transaction ID = " + appcInstanceId + "~" + record
 261                 .getTransactionId(), e);
 262             throw new APPCException(ERROR_ACCESSING_DATABASE, e);
 263         }
 264     }
 265
 266     @Override
 267     public Integer getInProgressRequestsCount() throws APPCException {
 268         final String inProgressRequestCountQuery = "SELECT COUNT(*) as VALUE FROM "
 269             + TransactionConstants.TRANSACTIONS
 270             + WHERE + STATE.getColumnName() + " IN (?,?) ";
 271
 272         ArrayList<String> checkInProgressParams = new ArrayList<>();
 273         checkInProgressParams.add(RequestStatus.RECEIVED.name());
 274         checkInProgressParams.add(RequestStatus.ACCEPTED.name());
 275         try(CachedRowSet rowSet=dbLibService.getData(inProgressRequestCountQuery,checkInProgressParams,SCHEMA)){
 276             if (rowSet.first()) {
 277                 int count = rowSet.getInt("VALUE");
 278                 logger.info("In progress request count fetched from database successfully.");
 279                 return count;
 280             }
 281         }
 282         catch (SQLException e) {
 283             logger.error("Error checking in progress request count in the transaction table", e);
 284             throw new APPCException(ERROR_ACCESSING_DATABASE, e);
 285         }
 286         logger.error("Error checking in progress request count in the transaction table");
 287         throw new APPCException(ERROR_ACCESSING_DATABASE);
 288     }
 289
 290     @Override
 291     public void setAppcInstanceId(String appcInstanceId) {
 292         this.appcInstanceId = appcInstanceId;
 293     }
 294
 295
 296     @Override
 297     public List<RequestStatus> getRecords(String requestId, String subrequestId, String originatorId, String vnfId)
 298         throws APPCException {
 299         StringBuilder queryString = (new StringBuilder(1024))
 300             .append("SELECT " + TRANSACTION_ATTRIBUTES.STATE.getColumnName())
 301             .append(" FROM " + TRANSACTIONS)
 302             .append(" WHERE " + TRANSACTION_ATTRIBUTES.REQUEST_ID.getColumnName() + "  = ? AND " +
 303                 TRANSACTION_ATTRIBUTES.TARGET_ID.getColumnName() + " = ?");
 304
 305         ArrayList<String> argList = new ArrayList<>();
 306         argList.add(requestId);
 307         argList.add(vnfId);
 308
 309         if (subrequestId != null) {
 310             queryString.append(" AND " + TRANSACTION_ATTRIBUTES.SUBREQUEST_ID.getColumnName() + " = ?");
 311             argList.add(subrequestId);
 312         }
 313         if (originatorId != null) {
 314             queryString.append(" AND " + TRANSACTION_ATTRIBUTES.ORIGINATOR_ID.getColumnName() + " = ?");
 315             argList.add(originatorId);
 316         }
 317
 318         List<RequestStatus> requestStatusList = new ArrayList<>();
 319         try {
 320             CachedRowSet resultSet = dbLibService.getData(queryString.toString(), argList, SCHEMA);
 321             while (resultSet.next()) {
 322                 String name = resultSet.getString(TRANSACTION_ATTRIBUTES.STATE.getColumnName());
 323                 RequestStatus requestStatus = null;
 324                 try {
 325                     requestStatus = RequestStatus.valueOf(name);
 326                 } catch (IllegalArgumentException e) {
 327                     logger.error(String.format("Invalid request status (%s) using (%s) :", name, RequestStatus
 328                         .UNKNOWN), e);
 329                     requestStatus = RequestStatus.UNKNOWN;
 330                 }
 331                 requestStatusList.add(requestStatus);
 332                 logger.debug(String.format("Request Status obtained (%s).", requestStatus));
 333             }
 334         } catch (SQLException e) {
 335             logger.error("Error Accessing Database ", e);
 336             throw new APPCException(String.format("Error retrieving record for requestID %s and vnfId %s " +
 337                 "from the transactions table", requestId, vnfId), e);
 338         }
 339
 340         return requestStatusList;
 341     }
 342
 343     private ArrayList<String> prepareArguments(TransactionRecord input) {
 344         ArrayList<String> arguments = new ArrayList<>();
 345         arguments.add(appcInstanceId + "~" + input.getTransactionId());
 346         arguments.add(dateToStringConverterMillis(input.getOriginTimestamp()));
 347         arguments.add(input.getRequestId());
 348         arguments.add(input.getSubRequestId());
 349         arguments.add(input.getOriginatorId());
 350         arguments.add(dateToStringConverterMillis(input.getStartTime()));
 351         arguments.add(dateToStringConverterMillis(input.getEndTime()));
 352         arguments.add(input.getTargetId());
 353         arguments.add(input.getTargetType());
 354         arguments.add(input.getOperation().name());
 355         arguments.add(String.valueOf(input.getResultCode()));
 356         arguments.add(input.getDescription());
 357         arguments.add(input.getRequestState());
 358         arguments.add(input.getServiceInstanceId());
 359         arguments.add(input.getVnfcName());
 360         arguments.add(input.getVserverId());
 361         arguments.add(input.getVfModuleId());
 362         arguments.add(input.getMode());
 363
 364         return arguments;
 365     }
 366
 367     private static String dateToStringConverterMillis(Instant date) {
 368         if (date == null) {
 369             return null;
 370         }
 371         DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss.SSS").withZone(ZoneOffset.UTC);
 372         return formatter.format(date);
 373     }
 374
 375     private static Instant stringToDateConverterMillis(String dateString) throws ParseException {
 376         SimpleDateFormat customDate = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS");
 377         return customDate.parse(dateString).toInstant();
 378     }
 379 }