appc-dispatcher/appc-dispatcher-common/transaction-recorder/src/main/java/org/onap/appc/transactionrecorder/impl/TransactionRecorderImpl.java

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