appc-dispatcher/appc-request-handler/appc-request-handler-core/src/main/java/org/openecomp/appc/requesthandler/impl/RequestHandlerImpl.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * openECOMP : APP-C
   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
  22 package org.openecomp.appc.requesthandler.impl;
  23
  24 import org.apache.commons.lang.ObjectUtils;
  25 import org.openecomp.appc.common.constant.Constants;
  26 import org.openecomp.appc.configuration.Configuration;
  27 import org.openecomp.appc.configuration.ConfigurationFactory;
  28 import org.openecomp.appc.domainmodel.lcm.*;
  29 import org.openecomp.appc.exceptions.APPCException;
  30 import org.openecomp.appc.executor.CommandExecutor;
  31 import org.openecomp.appc.executor.UnstableVNFException;
  32 import org.openecomp.appc.executor.objects.CommandExecutorInput;
  33 import org.openecomp.appc.executor.objects.LCMCommandStatus;
  34 import org.openecomp.appc.executor.objects.Params;
  35 import org.openecomp.appc.executor.objects.UniqueRequestIdentifier;
  36 import org.openecomp.appc.i18n.Msg;
  37 import org.openecomp.appc.lifecyclemanager.objects.LifecycleException;
  38 import org.openecomp.appc.lifecyclemanager.objects.NoTransitionDefinedException;
  39 import org.openecomp.appc.lockmanager.api.LockException;
  40 import org.openecomp.appc.lockmanager.api.LockManager;
  41 import org.openecomp.appc.logging.LoggingConstants;
  42 import org.openecomp.appc.logging.LoggingUtils;
  43 import org.openecomp.appc.messageadapter.MessageAdapter;
  44 import org.openecomp.appc.messageadapter.impl.MessageAdapterDmaapImpl;
  45 import org.openecomp.appc.metricservice.MetricRegistry;
  46 import org.openecomp.appc.metricservice.MetricService;
  47 import org.openecomp.appc.metricservice.metric.DispatchingFuntionMetric;
  48 import org.openecomp.appc.metricservice.metric.Metric;
  49 import org.openecomp.appc.metricservice.metric.MetricType;
  50 import org.openecomp.appc.metricservice.policy.PublishingPolicy;
  51 import org.openecomp.appc.metricservice.publisher.LogPublisher;
  52 import org.openecomp.appc.requesthandler.RequestHandler;
  53 import org.openecomp.appc.requesthandler.exceptions.*;
  54 import org.openecomp.appc.requesthandler.helper.RequestRegistry;
  55 import org.openecomp.appc.requesthandler.helper.RequestValidator;
  56 import org.openecomp.appc.requesthandler.objects.RequestHandlerInput;
  57 import org.openecomp.appc.requesthandler.objects.RequestHandlerOutput;
  58 import org.openecomp.appc.transactionrecorder.TransactionRecorder;
  59 import org.openecomp.appc.transactionrecorder.objects.TransactionRecord;
  60 import org.openecomp.appc.workingstatemanager.WorkingStateManager;
  61 import org.openecomp.appc.workingstatemanager.objects.VNFWorkingState;
  62 import com.att.eelf.configuration.EELFLogger;
  63 import com.att.eelf.configuration.EELFManager;
  64 import com.att.eelf.i18n.EELFResourceManager;
  65 import org.openecomp.sdnc.sli.SvcLogicContext;
  66 import org.openecomp.sdnc.sli.SvcLogicException;
  67 import org.openecomp.sdnc.sli.SvcLogicResource.QueryStatus;
  68 import org.openecomp.sdnc.sli.aai.AAIService;
  69 import org.osgi.framework.BundleContext;
  70 import org.osgi.framework.FrameworkUtil;
  71 import org.osgi.framework.ServiceReference;
  72 import org.slf4j.MDC;
  73
  74 import static com.att.eelf.configuration.Configuration.*;
  75
  76 import java.net.InetAddress;
  77 import java.util.Date;
  78 import java.util.HashMap;
  79 import java.util.Map;
  80 import java.util.Properties;
  81
  82 /**
  83  * This class provides application logic for the Request/Response Handler Component.
  84  *
  85  */
  86 public class RequestHandlerImpl implements RequestHandler {
  87
  88     /**
  89      * APP-C VNF lock idle timeout in milliseconds. Applied only when locking VNF using northbound API "lock"
  90      */
  91     private static final String PROP_IDLE_TIMEOUT = "org.openecomp.appc.lock.idleTimeout";
  92
  93     private CommandExecutor commandExecutor;
  94
  95     private TransactionRecorder transactionRecorder;
  96     private MessageAdapter messageAdapter;
  97     private RequestValidator requestValidator;
  98     private static MetricRegistry metricRegistry;
  99     private boolean isMetricEnabled = false;
 100     private RequestRegistry requestRegistry;
 101     private LockManager lockManager;
 102     private WorkingStateManager workingStateManager;
 103     private AAIService aaiService;
 104
 105     private static final EELFLogger logger = EELFManager.getInstance().getLogger(RequestHandlerImpl.class);
 106
 107     public void setAaiService(AAIService aaiService) {
 108         this.aaiService = aaiService;
 109     }
 110
 111     public void setTransactionRecorder(TransactionRecorder transactionRecorder) {
 112         this.transactionRecorder = transactionRecorder;
 113     }
 114
 115     public void setLockManager(LockManager lockManager) {
 116         this.lockManager = lockManager;
 117     }
 118
 119     public void setRequestValidator(RequestValidator requestValidator) {
 120         this.requestValidator = requestValidator;
 121     }
 122
 123     public void setMessageAdapter(MessageAdapter messageAdapter) {
 124         this.messageAdapter = messageAdapter;
 125     }
 126
 127     private static final Configuration configuration = ConfigurationFactory.getConfiguration();
 128
 129     public void setWorkingStateManager(WorkingStateManager workingStateManager) {
 130         this.workingStateManager = workingStateManager;
 131     }
 132
 133     public RequestHandlerImpl() {
 134         requestRegistry = new RequestRegistry();
 135         messageAdapter = new MessageAdapterDmaapImpl();
 136         messageAdapter.init();
 137         Properties properties = configuration.getProperties();
 138         if (properties != null && properties.getProperty("metric.enabled") != null) {
 139             isMetricEnabled = Boolean.valueOf(properties.getProperty("metric.enabled"));
 140         }
 141         if (isMetricEnabled) {
 142             initMetric();
 143         }
 144     }
 145
 146     public void setCommandExecutor(CommandExecutor commandExecutor) {
 147         this.commandExecutor = commandExecutor;
 148     }
 149
 150
 151     /**
 152      * It receives requests from the north-bound REST API (Communication) Layer and
 153      * performs following validations.
 154      * 1. VNF exists in A&AI for the given targetID (VnfID)
 155      * 2. For the current VNF  Orchestration Status, the command can be executed
 156      * 3. For the given VNF type and Operation, there exists work-flow definition in the APPC database
 157      * If any of the validation fails, it returns appropriate response
 158      *
 159      * @param input RequestHandlerInput object which contains request header and  other request parameters like command , target Id , payload etc.
 160      * @return response for request as enum with Return code and message.
 161      */
 162     @Override
 163     public RequestHandlerOutput handleRequest(RequestHandlerInput input) {
 164         if (logger.isTraceEnabled())
 165             logger.trace("Entering to handleRequest with RequestHandlerInput = " + ObjectUtils.toString(input) + ")");
 166         Params params = null;
 167         String vnfId = null, vnfType = null, errorMessage = null;
 168         Date startTime = new Date(System.currentTimeMillis());
 169         RequestHandlerOutput output = null;
 170         setInitialLogProperties(input.getRequestContext());
 171
 172         RuntimeContext runtimeContext = new RuntimeContext();
 173         runtimeContext.setRequestContext(input.getRequestContext());
 174         runtimeContext.setTimeStart(startTime);
 175         runtimeContext.setRpcName(input.getRpcName());
 176
 177         final ResponseContext responseContext = new ResponseContext();
 178         responseContext.setStatus(new Status(0, null));
 179         responseContext.setAdditionalContext(new HashMap<String, String>(4));
 180         responseContext.setCommonHeader(input.getRequestContext().getCommonHeader());
 181         runtimeContext.setResponseContext(responseContext);
 182         runtimeContext.getResponseContext().setStatus(new Status(0, null));
 183
 184         vnfId = runtimeContext.getRequestContext().getActionIdentifiers().getVnfId();
 185
 186         try {
 187
 188             requestValidator.validateRequest(runtimeContext);
 189
 190             handleRequest(runtimeContext);
 191
 192             final int statusCode = runtimeContext.getResponseContext().getStatus().getCode();
 193             if (statusCode % 100 == 2 || statusCode % 100 == 3) {
 194                 createTransactionRecord(runtimeContext);
 195             }
 196             output = new RequestHandlerOutput();
 197             output.setResponseContext(runtimeContext.getResponseContext());
 198
 199         } catch (VNFNotFoundException e) {
 200             errorMessage = e.getMessage();
 201             String logMessage = EELFResourceManager.format(Msg.APPC_NO_RESOURCE_FOUND, vnfId);
 202             storeErrorMessageToLog(runtimeContext, LoggingConstants.TargetNames.AAI, "", logMessage);
 203             params = new Params().addParam("vnfId", vnfId);
 204             output = buildRequestHandlerOutput(LCMCommandStatus.VNF_NOT_FOUND, params);
 205         } catch (NoTransitionDefinedException e) {
 206             errorMessage = e.getMessage();
 207             String logMessage = EELFResourceManager.format(Msg.VF_UNDEFINED_STATE, input.getRequestContext().getCommonHeader().getOriginatorId(), input.getRequestContext().getAction().name());
 208             params = new Params().addParam("actionName", input.getRequestContext().getAction()).addParam("currentState", e.currentState);
 209             output = buildRequestHandlerOutput(LCMCommandStatus.NO_TRANSITION_DEFINE, params);
 210             storeErrorMessageToLog(runtimeContext,
 211                     LoggingConstants.TargetNames.APPC,
 212                     LoggingConstants.TargetNames.STATE_MACHINE,
 213                     logMessage);
 214         } catch (LifecycleException e) {
 215             errorMessage = e.getMessage();
 216             params = new Params().addParam("actionName", input.getRequestContext().getAction()).addParam("currentState", e.currentState);
 217             output = buildRequestHandlerOutput(LCMCommandStatus.ACTION_NOT_SUPPORTED, params);
 218         } catch (UnstableVNFException e) {
 219             errorMessage = e.getMessage();
 220             params = new Params().addParam("vnfId", vnfId);
 221             output = buildRequestHandlerOutput(LCMCommandStatus.UNSTABLE_VNF, params);
 222         } catch (WorkflowNotFoundException e) {
 223             errorMessage = e.getMessage();
 224             String vnfTypeVersion = e.vnfTypeVersion;
 225             params = new Params().addParam("actionName", input.getRequestContext().getAction()).addParam("vnfTypeVersion", vnfTypeVersion);
 226             output = buildRequestHandlerOutput(LCMCommandStatus.WORKFLOW_NOT_FOUND, params);
 227         } catch (DGWorkflowNotFoundException e) {
 228             errorMessage = e.getMessage();
 229             String logMessage = EELFResourceManager.format(Msg.APPC_WORKFLOW_NOT_FOUND, vnfType, input.getRequestContext().getAction().name());
 230             storeErrorMessageToLog(runtimeContext,
 231                     LoggingConstants.TargetNames.APPC,
 232                     LoggingConstants.TargetNames.WORKFLOW_MANAGER,
 233                     logMessage);
 234             params = new Params().addParam("actionName", input.getRequestContext().getAction().name())
 235                     .addParam("dgModule", e.workflowModule).addParam("dgName", e.workflowName).addParam("dgVersion", e.workflowVersion);
 236             output = buildRequestHandlerOutput(LCMCommandStatus.DG_WORKFLOW_NOT_FOUND, params);
 237         } catch (RequestExpiredException e) {
 238             errorMessage = e.getMessage();
 239             params = new Params().addParam("actionName", input.getRequestContext().getAction().name());
 240             output = buildRequestHandlerOutput(LCMCommandStatus.EXPIRED_REQUEST, params);
 241         } catch (InvalidInputException e) {
 242             errorMessage = e.getMessage() != null ? e.getMessage() : e.toString();
 243             params = new Params().addParam("errorMsg", errorMessage);
 244             output = buildRequestHandlerOutput(LCMCommandStatus.INVALID_INPUT_PARAMETER, params);
 245         } catch (DuplicateRequestException e) {
 246             errorMessage = e.getMessage();
 247             output = buildRequestHandlerOutput(LCMCommandStatus.DUPLICATE_REQUEST, null);
 248         } catch (Exception e) {
 249             storeErrorMessageToLog(runtimeContext, "", "", "Exception = " + e.getMessage());
 250             errorMessage = e.getMessage() != null ? e.getMessage() : e.toString();
 251             params = new Params().addParam("errorMsg", errorMessage);
 252             output = buildRequestHandlerOutput(LCMCommandStatus.UNEXPECTED_ERROR, params);
 253         } finally {
 254             try {
 255                 if (logger.isDebugEnabled() && errorMessage != null)
 256                     logger.debug("error occurred in handleRequest " + errorMessage);
 257                 logger.debug("output.getResponse().getResponseCode().equals(LCMCommandStatus.ACCEPTED.getResponseCode():  " + (output.getResponseContext().getStatus().getCode() == LCMCommandStatus.ACCEPTED.getResponseCode()));
 258                 logger.debug("output.getResponse().getResponseCode().equals(LCMCommandStatus.SUCCESS.getResponseCode():  " + (output.getResponseContext().getStatus().getCode() == LCMCommandStatus.SUCCESS.getResponseCode()));
 259
 260                 runtimeContext.setResponseContext(output.getResponseContext());
 261                 if ((null == output) || !(output.getResponseContext().getStatus().getCode() == LCMCommandStatus.ACCEPTED.getResponseCode())) {
 262                     if (isMetricEnabled) {
 263                         ((DispatchingFuntionMetric) metricRegistry.metric("DISPATCH_FUNCTION")).incrementRejectedRequest();
 264                     }
 265                     removeRequestFromRegistry(input.getRequestContext().getCommonHeader());
 266                 }
 267             } finally {
 268                 storeAuditLogRecord(runtimeContext);
 269                 storeMetricLogRecord(runtimeContext);
 270                 clearRequestLogProperties();
 271             }
 272         }
 273         if (logger.isTraceEnabled()) {
 274             logger.trace("Exiting from handleRequest with (RequestHandlerOutput = " + ObjectUtils.toString(output.getResponseContext()) + ")");
 275         }
 276         return output;
 277     }
 278
 279     private void storeErrorMessageToLog(RuntimeContext runtimeContext, String targetEntity, String targetServiceName, String additionalMessage) {
 280         LoggingUtils.logErrorMessage(runtimeContext.getResponseContext().getStatus() != null ?
 281                         String.valueOf(runtimeContext.getResponseContext().getStatus().getCode()) : "",
 282                 runtimeContext.getResponseContext().getStatus() != null ?
 283                         String.valueOf(runtimeContext.getResponseContext().getStatus().getMessage()) : "",
 284                 targetEntity,
 285                 targetServiceName,
 286                 additionalMessage,
 287                 this.getClass().getCanonicalName());
 288     }
 289
 290     private void createTransactionRecord(RuntimeContext runtimeContext) {
 291         TransactionRecord transactionRecord = new TransactionRecord();
 292         transactionRecord.setTimeStamp(runtimeContext.getResponseContext().getCommonHeader().getTimeStamp());
 293         transactionRecord.setRequestID(runtimeContext.getResponseContext().getCommonHeader().getRequestId());
 294         transactionRecord.setStartTime(runtimeContext.getTimeStart());
 295         transactionRecord.setEndTime(new Date(System.currentTimeMillis()));
 296         transactionRecord.setTargetID(runtimeContext.getVnfContext().getId());
 297         transactionRecord.setTargetType(runtimeContext.getVnfContext().getType());
 298         transactionRecord.setOperation(runtimeContext.getRequestContext().getAction().name());
 299         transactionRecord.setResultCode(String.valueOf(runtimeContext.getResponseContext().getStatus().getCode()));
 300         transactionRecord.setDescription(runtimeContext.getResponseContext().getStatus().getMessage());
 301         transactionRecorder.store(transactionRecord);
 302     }
 303
 304     private void handleRequest(RuntimeContext runtimeContext) {
 305
 306         switch (runtimeContext.getRequestContext().getAction()) {
 307             case Lock:
 308                 try {
 309                     lockWithTimeout(runtimeContext.getVnfContext().getId(), runtimeContext.getRequestContext().getCommonHeader().getRequestId());
 310                     fillStatus(runtimeContext,LCMCommandStatus.SUCCESS, null);
 311                 } catch (LockException e) {
 312                     Params params = new Params().addParam("errorMsg", e.getMessage());
 313                     fillStatus(runtimeContext, LCMCommandStatus.LOCKING_FAILURE, params);
 314                     storeErrorMessageToLog(runtimeContext,
 315                             LoggingConstants.TargetNames.APPC,
 316                             LoggingConstants.TargetNames.LOCK_MANAGER,
 317                             EELFResourceManager.format(Msg.VF_SERVER_BUSY, runtimeContext.getVnfContext().getId()));
 318                 }
 319
 320                 break;
 321
 322             case Unlock:
 323                 try {
 324                     releaseVNFLock(runtimeContext.getVnfContext().getId(), runtimeContext.getRequestContext().getCommonHeader().getRequestId());
 325                     fillStatus(runtimeContext,LCMCommandStatus.SUCCESS, null);
 326                 } catch (LockException e) {
 327                     //TODO add proper error code and message
 328                     //  logger.error(EELFResourceManager.format(Msg.VF_SERVER_BUSY, runtimeContext.getVnfContext().getId()));
 329                     Params params = new Params().addParam("errorMsg", e.getMessage());
 330                     fillStatus(runtimeContext, LCMCommandStatus.LOCKING_FAILURE, params);
 331                 }
 332                 break;
 333
 334             case CheckLock:
 335                 boolean isLocked = lockManager.isLocked(runtimeContext.getVnfContext().getId());
 336                 fillStatus(runtimeContext,LCMCommandStatus.SUCCESS, null);
 337                 runtimeContext.getResponseContext().addKeyValueToAdditionalContext("locked", String.valueOf(isLocked).toUpperCase());
 338                 break;
 339             default:
 340                 try {
 341                     boolean lockAcquired = acquireVNFLock(runtimeContext.getVnfContext().getId(), runtimeContext.getRequestContext().getCommonHeader().getRequestId(), 0);
 342                     runtimeContext.setIsLockAcquired(lockAcquired);
 343                     callWfOperation(runtimeContext);
 344                 } catch (LockException e) {
 345                     Params params = new Params().addParam("errorMsg", e.getMessage());
 346                     fillStatus(runtimeContext, LCMCommandStatus.LOCKING_FAILURE, params);
 347                 } finally {
 348                     if (runtimeContext.isLockAcquired()) {
 349                         final int statusCode = runtimeContext.getResponseContext().getStatus().getCode();
 350                         if (statusCode % 100 == 2 || statusCode % 100 == 3) {
 351                             try {
 352                                 releaseVNFLock(runtimeContext.getVnfContext().getId(), runtimeContext.getRequestContext().getCommonHeader().getRequestId());
 353                                 //TODO add logger call
 354                             } catch (LockException e) {
 355                                 //ignore
 356                             }
 357                         }
 358                     }
 359                 }
 360         }
 361
 362     }
 363
 364     private void callWfOperation(RuntimeContext runtimeContext) {
 365         int remainingTTL = calculateRemainingTTL(runtimeContext.getRequestContext().getCommonHeader());
 366         if (remainingTTL > 0) {
 367             if (logger.isDebugEnabled()) {
 368                 logger.debug("Calling command Executor with remaining TTL value: " + remainingTTL);
 369             }
 370
 371             RuntimeContext clonedContext = cloneContext(runtimeContext);
 372
 373             CommandExecutorInput commandExecutorInput = new CommandExecutorInput(clonedContext, remainingTTL);
 374
 375             try {
 376                 commandExecutor.executeCommand(commandExecutorInput);
 377                 if(logger.isTraceEnabled()) {
 378                     logger.trace("Command was added to queue successfully for vnfID = " + ObjectUtils.toString(runtimeContext.getRequestContext().getActionIdentifiers().getVnfId()));
 379                 }
 380                 fillStatus(runtimeContext, LCMCommandStatus.ACCEPTED, null);
 381                 if (isMetricEnabled) {
 382                     ((DispatchingFuntionMetric) metricRegistry.metric("DISPATCH_FUNCTION")).incrementAcceptedRequest();
 383                 }
 384             } catch (APPCException e) {
 385                 String errorMessage = e.getMessage() != null ? e.getMessage() : e.toString();
 386                 Params params = new Params().addParam("errorMsg", errorMessage);
 387                 fillStatus(runtimeContext, LCMCommandStatus.UNEXPECTED_ERROR, params);
 388             }
 389
 390         } else {
 391             fillStatus(runtimeContext, LCMCommandStatus.EXPIRED_REQUEST, null);
 392             storeErrorMessageToLog(runtimeContext,
 393                     LoggingConstants.TargetNames.APPC,
 394                     LoggingConstants.TargetNames.REQUEST_HANDLER,
 395                     EELFResourceManager.format(Msg.APPC_EXPIRED_REQUEST,
 396                             runtimeContext.getRequestContext().getCommonHeader().getOriginatorId(),
 397                             runtimeContext.getRequestContext().getActionIdentifiers().getVnfId(),
 398                             String.valueOf(runtimeContext.getRequestContext().getCommonHeader().getFlags().getTtl())));
 399         }
 400     }
 401
 402     private void fillStatus(RuntimeContext runtimeContext, LCMCommandStatus lcmCommandStatus, Params params) {
 403         runtimeContext.getResponseContext().setStatus(lcmCommandStatus.toStatus(params));
 404     }
 405
 406     /*
 407      * Workaround to clone context in order to prevent sharing of ResponseContext by two threads (one to set Accepted
 408      * status code and other - depending on DG status). Other properties should not be a problem
 409      */
 410     private RuntimeContext cloneContext(RuntimeContext runtimeContext) {
 411         RuntimeContext other = new RuntimeContext();
 412         other.setRequestContext(runtimeContext.getRequestContext());
 413         other.setResponseContext(new ResponseContext());
 414         other.getResponseContext().setStatus(new Status(0, null));
 415         other.getResponseContext().setCommonHeader(runtimeContext.getRequestContext().getCommonHeader());
 416         other.setVnfContext(runtimeContext.getVnfContext());
 417         other.setRpcName(runtimeContext.getRpcName());
 418         other.setTimeStart(runtimeContext.getTimeStart());
 419         other.setIsLockAcquired(runtimeContext.isLockAcquired());
 420         return other;
 421     }
 422
 423
 424     private void clearRequestLogProperties() {
 425         try {
 426             MDC.remove(MDC_KEY_REQUEST_ID);
 427             MDC.remove(MDC_SERVICE_INSTANCE_ID);
 428             MDC.remove(MDC_SERVICE_NAME);
 429             MDC.remove(LoggingConstants.MDCKeys.PARTNER_NAME);
 430             MDC.remove(LoggingConstants.MDCKeys.TARGET_VIRTUAL_ENTITY);
 431         } catch (Exception e) {
 432
 433         }
 434     }
 435
 436     private void removeRequestFromRegistry(CommonHeader commonHeader) {
 437         if (logger.isTraceEnabled())
 438             logger.trace("Entering to removeRequestFromRegistry with RequestHeader = " + ObjectUtils.toString(commonHeader));
 439         requestRegistry.removeRequest(
 440                 new UniqueRequestIdentifier(commonHeader.getOriginatorId(),
 441                         commonHeader.getRequestId(),
 442                         commonHeader.getSubRequestId()));
 443     }
 444
 445     private boolean acquireVNFLock(String vnfID, String requestId, long timeout) throws LockException {
 446         if (logger.isTraceEnabled())
 447             logger.trace("Entering to acquireVNFLock with vnfID = " + vnfID);
 448         boolean lockAcquired = lockManager.acquireLock(vnfID, requestId, timeout);
 449         if (lockAcquired) {
 450             logger.info("Lock acquired for vnfID = " + vnfID);
 451         } else {
 452             logger.info("vnfID = " + vnfID + " was already locked");
 453         }
 454         return lockAcquired;
 455     }
 456
 457     private void lockWithTimeout(String vnfId, String requestId) throws LockException {
 458         long timeout = configuration.getLongProperty(PROP_IDLE_TIMEOUT, Constants.DEFAULT_IDLE_TIMEOUT);
 459         acquireVNFLock(vnfId, requestId, timeout);
 460     }
 461
 462     private void resetLock(String vnfId, String requestId, boolean lockAcquired, boolean resetLockTimeout) {
 463         if (lockAcquired) {
 464             try {
 465                 releaseVNFLock(vnfId, requestId);
 466             } catch (LockException e) {
 467                 logger.error("Unlock VNF [" + vnfId + "] failed. Request id: [" + requestId + "]", e);
 468
 469
 470             }
 471         } else if (resetLockTimeout) {
 472             try {
 473                 // reset timeout to previous value
 474                 lockWithTimeout(vnfId, requestId);
 475             } catch (LockException e) {
 476                 logger.error("Reset lock idle timeout for VNF [" + vnfId + "] failed. Request id: [" + requestId + "]", e);
 477             }
 478         }
 479     }
 480
 481     private void releaseVNFLock(String vnfId, String transactionId) throws LockException {
 482         lockManager.releaseLock(vnfId, transactionId);
 483         logger.info("Lock released for vnfID = " + vnfId);
 484     }
 485
 486     private void setInitialLogProperties(RequestContext requestContext) {
 487
 488         try {
 489             MDC.put(MDC_KEY_REQUEST_ID, requestContext.getCommonHeader().getRequestId());
 490             if (requestContext.getActionIdentifiers().getServiceInstanceId() != null) {
 491                 MDC.put(MDC_SERVICE_INSTANCE_ID, requestContext.getActionIdentifiers().getServiceInstanceId());
 492             }
 493             MDC.put(LoggingConstants.MDCKeys.PARTNER_NAME, requestContext.getCommonHeader().getOriginatorId());
 494             MDC.put(MDC_INSTANCE_UUID, ""); // value should be created in the future
 495             try {
 496                 MDC.put(MDC_SERVER_FQDN, InetAddress.getLocalHost().getCanonicalHostName()); //Don't change it to a .getHostName() again please. It's wrong!
 497                 MDC.put(MDC_SERVER_IP_ADDRESS, InetAddress.getLocalHost().getHostAddress());
 498                 MDC.put(LoggingConstants.MDCKeys.SERVER_NAME, InetAddress.getLocalHost().getHostName());
 499                 MDC.put(MDC_SERVICE_NAME, requestContext.getAction().name());
 500                 MDC.put(LoggingConstants.MDCKeys.TARGET_VIRTUAL_ENTITY, requestContext.getActionIdentifiers().getVnfId());
 501
 502             } catch (Exception e) {
 503                 logger.debug(e.getMessage());
 504             }
 505         } catch (RuntimeException e) {
 506             //ignore
 507         }
 508     }
 509
 510
 511     private int calculateRemainingTTL(CommonHeader commonHeader) {
 512         if (logger.isTraceEnabled()) {
 513             logger.trace("Entering to calculateRemainingTTL with RequestHeader = " + ObjectUtils.toString(commonHeader));
 514         }
 515         long usedTimeInMillis = (System.currentTimeMillis() - commonHeader.getTimeStamp().getTime());
 516         logger.debug("usedTimeInMillis = " + usedTimeInMillis);
 517         int usedTimeInSeconds = Math.round(usedTimeInMillis / 1000);
 518         logger.debug("usedTimeInSeconds = " + usedTimeInSeconds);
 519         Integer inputTTL = this.getInputTTL(commonHeader);
 520         logger.debug("inputTTL = " + inputTTL);
 521         Integer remainingTTL = inputTTL - usedTimeInSeconds;
 522         logger.debug("Remaining TTL = " + remainingTTL);
 523         if (logger.isTraceEnabled())
 524             logger.trace("Exiting from calculateRemainingTTL with (remainingTTL = " + ObjectUtils.toString(remainingTTL) + ")");
 525         return remainingTTL;
 526     }
 527
 528     private Integer getInputTTL(CommonHeader header) {
 529         if (logger.isTraceEnabled())
 530             logger.trace("Entering in getInputTTL with RequestHeader = " + ObjectUtils.toString(header));
 531         if (!isValidTTL(String.valueOf(header.getFlags().getTtl()))) {
 532             String defaultTTLStr = configuration.getProperty("org.openecomp.appc.workflow.default.ttl", String.valueOf(Constants.DEFAULT_TTL));
 533             Integer defaultTTL = Integer.parseInt(defaultTTLStr);
 534             if (logger.isTraceEnabled())
 535                 logger.trace("Exiting from getInputTTL with (defaultTTL = " + ObjectUtils.toString(defaultTTL) + ")");
 536             return defaultTTL;
 537         }
 538         if (logger.isTraceEnabled())
 539             logger.trace("Exiting from getInputTTL with (inputTTL = " + ObjectUtils.toString(header.getFlags().getTtl()) + ")");
 540
 541         return header.getFlags().getTtl();
 542     }
 543
 544     private boolean isValidTTL(String ttl) {
 545         if (ttl == null || ttl.length() == 0) {
 546             if (logger.isTraceEnabled())
 547                 logger.trace("Exiting from getInputTTL with (result = false)");
 548             return false;
 549         }
 550         try {
 551             Integer i = Integer.parseInt(ttl);
 552             return (i > 0);
 553         } catch (NumberFormatException e) {
 554             if (logger.isTraceEnabled())
 555                 logger.trace("Exiting from getInputTTL with (result = false)");
 556             return false;
 557         }
 558     }
 559
 560     private Boolean isLoggingEnabled() {
 561         String defaultFlagStr = configuration.getProperty("org.openecomp.appc.localTransactionRecorder.enable", String.valueOf(Constants.DEFAULT_LOGGING_FLAG));
 562         Boolean defaultFlag = Boolean.parseBoolean(defaultFlagStr);
 563         return defaultFlag;
 564     }
 565
 566     private static RequestHandlerOutput buildRequestHandlerOutput(LCMCommandStatus response, Params params) {
 567         RequestHandlerOutput output = new RequestHandlerOutput();
 568         ResponseContext responseContext = new ResponseContext();
 569         responseContext.setStatus(response.toStatus(params));
 570         output.setResponseContext(responseContext);
 571         return output;
 572     }
 573
 574     /**
 575      * This method perform operations required before execution of workflow starts. It retrieves next state for current operation from Lifecycle manager and update it in AAI.
 576      *
 577      * @return true in case AAI updates are successful. false for any error or exception.
 578      */
 579     @Override
 580     public void onRequestExecutionStart(String vnfId, boolean readOnlyActivity, String requestIdentifierString, boolean forceFlag) throws UnstableVNFException {
 581         if (logger.isTraceEnabled()) {
 582             logger.trace("Entering to onRequestExecutionStart with vnfId = " + vnfId + "and requestIdentifierString = " + requestIdentifierString);
 583         }
 584         try {
 585             boolean updated = workingStateManager.setWorkingState(vnfId, VNFWorkingState.UNSTABLE, requestIdentifierString, forceFlag);
 586             if (!updated) {
 587                 throw new UnstableVNFException("VNF is not stable for vnfID = " + vnfId);
 588             }
 589         } catch (Exception e) {
 590             logger.error("Error updating working state for vnf " + vnfId + e);
 591             throw new RuntimeException(e);
 592         }
 593
 594         if (logger.isTraceEnabled())
 595             logger.trace("Exiting from onRequestExecutionStart ");
 596     }
 597
 598     /**
 599      * This method perform following operations required after execution of workflow.
 600      * It posts asynchronous response to message bus (DMaaP).
 601      * Unlock VNF Id
 602      * Removes request from request registry.
 603      * Generate audit logs.
 604      * Adds transaction record to database id if transaction logging is enabled.
 605      *
 606      * @param isAAIUpdated boolean flag which indicate AAI upodate status after request completion.
 607      */
 608     @Override
 609     public void onRequestExecutionEnd(RuntimeContext runtimeContext, boolean isAAIUpdated) {
 610         if (logger.isTraceEnabled()) {
 611             logger.trace("Entering to onRequestExecutionEnd with runtimeContext = " + ObjectUtils.toString(runtimeContext));
 612         }
 613
 614         postMessageToDMaaP(runtimeContext.getRequestContext().getAction(), runtimeContext.getRpcName(), runtimeContext.getResponseContext());
 615         requestRegistry.removeRequest(
 616                 new UniqueRequestIdentifier(runtimeContext.getResponseContext().getCommonHeader().getOriginatorId(),
 617                         runtimeContext.getResponseContext().getCommonHeader().getRequestId(),
 618                         runtimeContext.getResponseContext().getCommonHeader().getSubRequestId()));
 619         resetLock(runtimeContext.getVnfContext().getId(), runtimeContext.getResponseContext().getCommonHeader().getRequestId(), runtimeContext.isLockAcquired(), true);
 620         Status status = runtimeContext.getResponseContext().getStatus();
 621
 622         VNFWorkingState workingState;
 623         if (status.getCode() == LCMCommandStatus.SUCCESS.getResponseCode() || isReadOnlyAction(runtimeContext.getRequestContext().getAction())) {
 624             workingState = VNFWorkingState.STABLE;
 625         } else {
 626             workingState = VNFWorkingState.UNKNOWN;
 627         }
 628
 629         UniqueRequestIdentifier requestIdentifier = new UniqueRequestIdentifier(runtimeContext.getResponseContext().getCommonHeader().getOriginatorId(),
 630                 runtimeContext.getResponseContext().getCommonHeader().getRequestId(),
 631                 runtimeContext.getResponseContext().getCommonHeader().getSubRequestId());
 632
 633         String requestIdentifierString = requestIdentifier.toIdentifierString();
 634         workingStateManager.setWorkingState(runtimeContext.getVnfContext().getId(), workingState, requestIdentifierString, false);
 635
 636
 637         storeAuditLogRecord(runtimeContext);
 638
 639         if (isLoggingEnabled()) {
 640             createTransactionRecord(runtimeContext);
 641         }
 642     }
 643
 644     private void storeAuditLogRecord(RuntimeContext runtimeContext) {
 645         LoggingUtils.logAuditMessage(runtimeContext.getTimeStart(),
 646                 new Date(System.currentTimeMillis()),
 647                 String.valueOf(runtimeContext.getResponseContext().getStatus().getCode()),
 648                 runtimeContext.getResponseContext().getStatus().getMessage(),
 649                 this.getClass().getCanonicalName());
 650     }
 651
 652     private void storeMetricLogRecord(RuntimeContext runtimeContext) {
 653         LoggingUtils.logMetricsMessage(runtimeContext.getTimeStart(),
 654                 new Date(System.currentTimeMillis()),
 655                 LoggingConstants.TargetNames.APPC,
 656                 runtimeContext.getRequestContext().getAction().name(),
 657                 runtimeContext.getResponseContext().getStatus().getCode() == LCMCommandStatus.ACCEPTED.getResponseCode() ? LoggingConstants.StatusCodes.COMPLETE : LoggingConstants.StatusCodes.ERROR,
 658                 String.valueOf(runtimeContext.getResponseContext().getStatus().getCode()),
 659                 runtimeContext.getResponseContext().getStatus().getMessage(),
 660                 this.getClass().getCanonicalName());
 661     }
 662
 663     private boolean isReadOnlyAction(VNFOperation action) {
 664         return VNFOperation.Sync == action
 665                 || VNFOperation.Audit == action;
 666     }
 667
 668
 669     //returns null if asyncResponse was not modified otherwise reutrns the updated asyncResponse
 670     private void postMessageToDMaaP(VNFOperation operation, String rpcName, ResponseContext responseContext/*, boolean isTTLEnd, boolean aaiUpdateSuccess*/) {
 671         if (logger.isTraceEnabled()) {
 672             logger.trace("Entering to postMessageToDMaaP with AsyncResponse = " + ObjectUtils.toString(responseContext));
 673         }
 674         /*boolean updated = updateAsyncResponseStatus(responseContext, isTTLEnd, aaiUpdateSuccess);
 675          */
 676         boolean callbackResponse = messageAdapter.post(operation, rpcName, responseContext);
 677         if (!callbackResponse) {
 678             logger.error("DMaaP posting status: " + callbackResponse, "dmaapMessage: " + responseContext);
 679         }
 680         if (logger.isTraceEnabled())
 681             logger.trace("Exiting from postMessageToDMaaP with (callbackResponse = " + ObjectUtils.toString(callbackResponse) + ")");
 682     }
 683
 684     //returns true if asyncResponse was modified
 685     /*    private boolean updateAsyncResponseStatus(ResponseContext asyncResponse, boolean isTTLEnd, boolean aaiUpdateSuccess) {
 686         boolean updated = false;
 687         if (logger.isTraceEnabled())
 688             logger.trace("Entering to updateAsyncResponseStatus with AsyncResponse = "+ObjectUtils.toString(asyncResponse)+ ", isTTLEnd = "+ ObjectUtils.toString(isTTLEnd)+ ", aaiUpdateSuccess = "+ ObjectUtils.toString(aaiUpdateSuccess));
 689         if(!aaiUpdateSuccess){
 690                 if (asyncResponse.getStatus().getCode() == 0 || asyncResponse.getStatus().getCode() == LCMCommandStatus.SUCCESS.getResponseCode()) {
 691                     asyncResponse.getStatus().setCode(LCMCommandStatus.UPDATE_AAI_FAILURE.getResponseCode());
 692                     asyncResponse.getStatus().setMessage(LCMCommandStatus.UPDATE_AAI_FAILURE.getResponseMessage());
 693                 updated = true;
 694             }
 695         }else if(isTTLEnd){
 696                 asyncResponse.getStatus().setCode(LCMCommandStatus.EXPIRED_REQUEST_FAILURE.getResponseCode());
 697                 asyncResponse.getStatus().setMessage(LCMCommandStatus.EXPIRED_REQUEST_FAILURE.getResponseMessage());
 698             updated = true;
 699         }
 700         if (logger.isTraceEnabled())
 701             logger.trace("Exiting from updateAsyncResponseStatus with (asyncResponse = "+ ObjectUtils.toString(asyncResponse)+")");
 702         return updated;
 703     }*/
 704
 705
 706     /**
 707      * This method perform following operations required if TTL ends when request still waiting in execution queue .
 708      * It posts asynchronous response to message bus (DMaaP).
 709      * Unlock VNF Id
 710      * Removes request from request registry.
 711      *
 712      * @param runtimeContext AsyncResponse object which contains VNF Id         , timestamp , apiVersion, responseId, executionSuccess, payload, isExpired, action, startTime, vnfType, originatorId, subResponseId;
 713      * @param updateAAI      boolean flag which indicate AAI upodate status after request completion.
 714      */
 715     @Override
 716     public void onRequestTTLEnd(RuntimeContext runtimeContext, boolean updateAAI) {
 717         if (logger.isTraceEnabled()) {
 718             logger.trace("Entering to onRequestTTLEnd with " +
 719                     "AsyncResponse = " + ObjectUtils.toString(runtimeContext) +
 720                     ", updateAAI = " + ObjectUtils.toString(updateAAI));
 721         }
 722         logger.error(LCMCommandStatus.EXPIRED_REQUEST_FAILURE.getResponseMessage());
 723         fillStatus(runtimeContext, LCMCommandStatus.EXPIRED_REQUEST_FAILURE, null);
 724         postMessageToDMaaP(runtimeContext.getRequestContext().getAction(), runtimeContext.getRpcName(), runtimeContext.getResponseContext());
 725         resetLock(runtimeContext.getVnfContext().getId(), runtimeContext.getResponseContext().getCommonHeader().getRequestId(), runtimeContext.isLockAcquired(), true);
 726         requestRegistry.removeRequest(
 727                 new UniqueRequestIdentifier(runtimeContext.getResponseContext().getCommonHeader().getOriginatorId(),
 728                         runtimeContext.getResponseContext().getCommonHeader().getRequestId(),
 729                         runtimeContext.getResponseContext().getCommonHeader().getSubRequestId()));
 730     }
 731
 732     private SvcLogicContext getVnfdata(String vnf_id, String prefix, SvcLogicContext ctx) throws VNFNotFoundException {
 733         String key = "vnf-id = '" + vnf_id + "'";
 734         if (logger.isTraceEnabled()) {
 735             logger.trace("Entering to getVnfdata with " +
 736                     "vnfId = " + vnf_id +
 737                     ", prefix = " + prefix +
 738                     ", SvcLogicContex = " + ObjectUtils.toString(ctx));
 739         }
 740         try {
 741             QueryStatus response = aaiService.query("generic-vnf", false, null, key, prefix, null, ctx);
 742             if (QueryStatus.NOT_FOUND.equals(response)) {
 743                 throw new VNFNotFoundException("VNF not found for vnf_id = " + vnf_id);
 744             } else if (QueryStatus.FAILURE.equals(response)) {
 745                 throw new RuntimeException("Error Querying AAI with vnfID = " + vnf_id);
 746             }
 747             logger.info("AAIResponse: " + response.toString());
 748         } catch (SvcLogicException e) {
 749             logger.error("Error in getVnfdata " + e);
 750             throw new RuntimeException(e);
 751         }
 752         if (logger.isTraceEnabled()) {
 753             logger.trace("Exiting from getVnfdata with (SvcLogicContext = " + ObjectUtils.toString(ctx) + ")");
 754         }
 755         return ctx;
 756     }
 757
 758     private boolean postVnfdata(String vnf_id, String status, String prefix, SvcLogicContext ctx) throws VNFNotFoundException {
 759         if (logger.isTraceEnabled()) {
 760             logger.trace("Entering to postVnfdata with " +
 761                     "vnfId = " + vnf_id +
 762                     ", status = " + status +
 763                     ", prefix = " + prefix +
 764                     ", SvcLogicContext = " + ObjectUtils.toString(ctx));
 765         }
 766         String key = "vnf-id = '" + vnf_id + "'";
 767         Map<String, String> data = new HashMap<>();
 768         data.put("orchestration-status", status);
 769         try {
 770             QueryStatus response = aaiService.update("generic-vnf", key, data, prefix, ctx);
 771             if (QueryStatus.NOT_FOUND.equals(response)) {
 772                 throw new VNFNotFoundException("VNF not found for vnf_id = " + vnf_id);
 773             }
 774             logger.info("AAIResponse: " + response.toString());
 775             if (response.toString().equals("SUCCESS")) {
 776                 if (logger.isTraceEnabled()) {
 777                     logger.trace("Exiting from postVnfdata with (Result = " + ObjectUtils.toString(true) + ")");
 778                 }
 779                 return true;
 780             }
 781
 782         } catch (SvcLogicException e) {
 783             logger.error("Error in postVnfdata " + e);
 784             throw new RuntimeException(e);
 785         }
 786         if (logger.isTraceEnabled()) {
 787             logger.trace("Exiting from postVnfdata with (Result = " + ObjectUtils.toString(false) + ")");
 788         }
 789         return false;
 790     }
 791
 792     private void initMetric() {
 793         if (logger.isDebugEnabled())
 794             logger.debug("Metric getting initialized");
 795         MetricService metricService = getMetricservice();
 796         metricRegistry = metricService.createRegistry("APPC");
 797         DispatchingFuntionMetric dispatchingFuntionMetric = metricRegistry.metricBuilderFactory().
 798                 dispatchingFunctionCounterBuilder().
 799                 withName("DISPATCH_FUNCTION").withType(MetricType.COUNTER).
 800                 withAcceptRequestValue(0)
 801                 .withRejectRequestValue(0)
 802                 .build();
 803         if (metricRegistry.register(dispatchingFuntionMetric)) {
 804             Metric[] metrics = new Metric[]{dispatchingFuntionMetric};
 805             LogPublisher logPublisher = new LogPublisher(metricRegistry, metrics);
 806             LogPublisher[] logPublishers = new LogPublisher[1];
 807             logPublishers[0] = logPublisher;
 808             PublishingPolicy manuallyScheduledPublishingPolicy = metricRegistry.policyBuilderFactory().
 809                     scheduledPolicyBuilder().withPublishers(logPublishers).
 810                     withMetrics(metrics).
 811                     build();
 812             if (logger.isDebugEnabled())
 813                 logger.debug("Policy getting initialized");
 814             manuallyScheduledPublishingPolicy.init();
 815             if (logger.isDebugEnabled())
 816                 logger.debug("Metric initialized");
 817         }
 818     }
 819
 820
 821     private MetricService getMetricservice() {
 822         BundleContext bctx = FrameworkUtil.getBundle(MetricService.class).getBundleContext();
 823         ServiceReference sref = bctx.getServiceReference(MetricService.class.getName());
 824         if (sref != null) {
 825             logger.info("Metric Service from bundlecontext");
 826             return (MetricService) bctx.getService(sref);
 827         } else {
 828             logger.info("Metric Service error from bundlecontext");
 829             logger.warn("Cannot find service reference for org.openecomp.appc.metricservice.MetricService");
 830             return null;
 831         }
 832     }
 833 }