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();
 374             commandExecutorInput.setRuntimeContext(clonedContext);
 375             commandExecutorInput.setTtl(remainingTTL);
 376
 377             try {
 378                 commandExecutor.executeCommand(commandExecutorInput);
 379                 if(logger.isTraceEnabled()) {
 380                     logger.trace("Command was added to queue successfully for vnfID = " + ObjectUtils.toString(runtimeContext.getRequestContext().getActionIdentifiers().getVnfId()));
 381                 }
 382                 fillStatus(runtimeContext, LCMCommandStatus.ACCEPTED, null);
 383                 if (isMetricEnabled) {
 384                     ((DispatchingFuntionMetric) metricRegistry.metric("DISPATCH_FUNCTION")).incrementAcceptedRequest();
 385                 }
 386             } catch (APPCException e) {
 387                 String errorMessage = e.getMessage() != null ? e.getMessage() : e.toString();
 388                 Params params = new Params().addParam("errorMsg", errorMessage);
 389                 fillStatus(runtimeContext, LCMCommandStatus.UNEXPECTED_ERROR, params);
 390             }
 391
 392         } else {
 393             fillStatus(runtimeContext, LCMCommandStatus.EXPIRED_REQUEST, null);
 394             storeErrorMessageToLog(runtimeContext,
 395                     LoggingConstants.TargetNames.APPC,
 396                     LoggingConstants.TargetNames.REQUEST_HANDLER,
 397                     EELFResourceManager.format(Msg.APPC_EXPIRED_REQUEST,
 398                             runtimeContext.getRequestContext().getCommonHeader().getOriginatorId(),
 399                             runtimeContext.getRequestContext().getActionIdentifiers().getVnfId(),
 400                             String.valueOf(runtimeContext.getRequestContext().getCommonHeader().getFlags().getTtl())));
 401         }
 402     }
 403
 404     private void fillStatus(RuntimeContext runtimeContext, LCMCommandStatus lcmCommandStatus, Params params) {
 405         runtimeContext.getResponseContext().setStatus(lcmCommandStatus.toStatus(params));
 406     }
 407
 408     /*
 409      * Workaround to clone context in order to prevent sharing of ResponseContext by two threads (one to set Accepted
 410      * status code and other - depending on DG status). Other properties should not be a problem
 411      */
 412     private RuntimeContext cloneContext(RuntimeContext runtimeContext) {
 413         RuntimeContext other = new RuntimeContext();
 414         other.setRequestContext(runtimeContext.getRequestContext());
 415         other.setResponseContext(new ResponseContext());
 416         other.getResponseContext().setStatus(new Status(0, null));
 417         other.getResponseContext().setCommonHeader(runtimeContext.getRequestContext().getCommonHeader());
 418         other.setVnfContext(runtimeContext.getVnfContext());
 419         other.setRpcName(runtimeContext.getRpcName());
 420         other.setTimeStart(runtimeContext.getTimeStart());
 421         other.setIsLockAcquired(runtimeContext.isLockAcquired());
 422         return other;
 423     }
 424
 425
 426     private void clearRequestLogProperties() {
 427         try {
 428             MDC.remove(MDC_KEY_REQUEST_ID);
 429             MDC.remove(MDC_SERVICE_INSTANCE_ID);
 430             MDC.remove(MDC_SERVICE_NAME);
 431             MDC.remove(LoggingConstants.MDCKeys.PARTNER_NAME);
 432             MDC.remove(LoggingConstants.MDCKeys.TARGET_VIRTUAL_ENTITY);
 433         } catch (Exception e) {
 434
 435         }
 436     }
 437
 438     private void removeRequestFromRegistry(CommonHeader commonHeader) {
 439         if (logger.isTraceEnabled())
 440             logger.trace("Entering to removeRequestFromRegistry with RequestHeader = " + ObjectUtils.toString(commonHeader));
 441         requestRegistry.removeRequest(
 442                 new UniqueRequestIdentifier(commonHeader.getOriginatorId(),
 443                         commonHeader.getRequestId(),
 444                         commonHeader.getSubRequestId()));
 445     }
 446
 447     private boolean acquireVNFLock(String vnfID, String requestId, long timeout) throws LockException {
 448         if (logger.isTraceEnabled())
 449             logger.trace("Entering to acquireVNFLock with vnfID = " + vnfID);
 450         boolean lockAcquired = lockManager.acquireLock(vnfID, requestId, timeout);
 451         if (lockAcquired) {
 452             logger.info("Lock acquired for vnfID = " + vnfID);
 453         } else {
 454             logger.info("vnfID = " + vnfID + " was already locked");
 455         }
 456         return lockAcquired;
 457     }
 458
 459     private void lockWithTimeout(String vnfId, String requestId) throws LockException {
 460         long timeout = configuration.getLongProperty(PROP_IDLE_TIMEOUT, Constants.DEFAULT_IDLE_TIMEOUT);
 461         acquireVNFLock(vnfId, requestId, timeout);
 462     }
 463
 464     private void resetLock(String vnfId, String requestId, boolean lockAcquired, boolean resetLockTimeout) {
 465         if (lockAcquired) {
 466             try {
 467                 releaseVNFLock(vnfId, requestId);
 468             } catch (LockException e) {
 469                 logger.error("Unlock VNF [" + vnfId + "] failed. Request id: [" + requestId + "]", e);
 470
 471
 472             }
 473         } else if (resetLockTimeout) {
 474             try {
 475                 // reset timeout to previous value
 476                 lockWithTimeout(vnfId, requestId);
 477             } catch (LockException e) {
 478                 logger.error("Reset lock idle timeout for VNF [" + vnfId + "] failed. Request id: [" + requestId + "]", e);
 479             }
 480         }
 481     }
 482
 483     private void releaseVNFLock(String vnfId, String transactionId) throws LockException {
 484         lockManager.releaseLock(vnfId, transactionId);
 485         logger.info("Lock released for vnfID = " + vnfId);
 486     }
 487
 488     private void setInitialLogProperties(RequestContext requestContext) {
 489
 490         try {
 491             MDC.put(MDC_KEY_REQUEST_ID, requestContext.getCommonHeader().getRequestId());
 492             if (requestContext.getActionIdentifiers().getServiceInstanceId() != null) {
 493                 MDC.put(MDC_SERVICE_INSTANCE_ID, requestContext.getActionIdentifiers().getServiceInstanceId());
 494             }
 495             MDC.put(LoggingConstants.MDCKeys.PARTNER_NAME, requestContext.getCommonHeader().getOriginatorId());
 496             MDC.put(MDC_INSTANCE_UUID, ""); // value should be created in the future
 497             try {
 498                 MDC.put(MDC_SERVER_FQDN, InetAddress.getLocalHost().getCanonicalHostName()); //Don't change it to a .getHostName() again please. It's wrong!
 499                 MDC.put(MDC_SERVER_IP_ADDRESS, InetAddress.getLocalHost().getHostAddress());
 500                 MDC.put(LoggingConstants.MDCKeys.SERVER_NAME, InetAddress.getLocalHost().getHostName());
 501                 MDC.put(MDC_SERVICE_NAME, requestContext.getAction().name());
 502                 MDC.put(LoggingConstants.MDCKeys.TARGET_VIRTUAL_ENTITY, requestContext.getActionIdentifiers().getVnfId());
 503
 504             } catch (Exception e) {
 505                 logger.debug(e.getMessage());
 506             }
 507         } catch (RuntimeException e) {
 508             //ignore
 509         }
 510     }
 511
 512
 513     private int calculateRemainingTTL(CommonHeader commonHeader) {
 514         if (logger.isTraceEnabled()) {
 515             logger.trace("Entering to calculateRemainingTTL with RequestHeader = " + ObjectUtils.toString(commonHeader));
 516         }
 517         long usedTimeInMillis = (System.currentTimeMillis() - commonHeader.getTimeStamp().getTime());
 518         logger.debug("usedTimeInMillis = " + usedTimeInMillis);
 519         int usedTimeInSeconds = Math.round(usedTimeInMillis / 1000);
 520         logger.debug("usedTimeInSeconds = " + usedTimeInSeconds);
 521         Integer inputTTL = this.getInputTTL(commonHeader);
 522         logger.debug("inputTTL = " + inputTTL);
 523         Integer remainingTTL = inputTTL - usedTimeInSeconds;
 524         logger.debug("Remaining TTL = " + remainingTTL);
 525         if (logger.isTraceEnabled())
 526             logger.trace("Exiting from calculateRemainingTTL with (remainingTTL = " + ObjectUtils.toString(remainingTTL) + ")");
 527         return remainingTTL;
 528     }
 529
 530     private Integer getInputTTL(CommonHeader header) {
 531         if (logger.isTraceEnabled())
 532             logger.trace("Entering in getInputTTL with RequestHeader = " + ObjectUtils.toString(header));
 533         if (!isValidTTL(String.valueOf(header.getFlags().getTtl()))) {
 534             String defaultTTLStr = configuration.getProperty("org.openecomp.appc.workflow.default.ttl", String.valueOf(Constants.DEFAULT_TTL));
 535             Integer defaultTTL = Integer.parseInt(defaultTTLStr);
 536             if (logger.isTraceEnabled())
 537                 logger.trace("Exiting from getInputTTL with (defaultTTL = " + ObjectUtils.toString(defaultTTL) + ")");
 538             return defaultTTL;
 539         }
 540         if (logger.isTraceEnabled())
 541             logger.trace("Exiting from getInputTTL with (inputTTL = " + ObjectUtils.toString(header.getFlags().getTtl()) + ")");
 542
 543         return header.getFlags().getTtl();
 544     }
 545
 546     private boolean isValidTTL(String ttl) {
 547         if (ttl == null || ttl.length() == 0) {
 548             if (logger.isTraceEnabled())
 549                 logger.trace("Exiting from getInputTTL with (result = false)");
 550             return false;
 551         }
 552         try {
 553             Integer i = Integer.parseInt(ttl);
 554             return (i > 0);
 555         } catch (NumberFormatException e) {
 556             if (logger.isTraceEnabled())
 557                 logger.trace("Exiting from getInputTTL with (result = false)");
 558             return false;
 559         }
 560     }
 561
 562     private Boolean isLoggingEnabled() {
 563         String defaultFlagStr = configuration.getProperty("org.openecomp.appc.localTransactionRecorder.enable", String.valueOf(Constants.DEFAULT_LOGGING_FLAG));
 564         Boolean defaultFlag = Boolean.parseBoolean(defaultFlagStr);
 565         return defaultFlag;
 566     }
 567
 568     private static RequestHandlerOutput buildRequestHandlerOutput(LCMCommandStatus response, Params params) {
 569         RequestHandlerOutput output = new RequestHandlerOutput();
 570         ResponseContext responseContext = new ResponseContext();
 571         responseContext.setStatus(response.toStatus(params));
 572         output.setResponseContext(responseContext);
 573         return output;
 574     }
 575
 576     /**
 577      * 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.
 578      *
 579      * @return true in case AAI updates are successful. false for any error or exception.
 580      */
 581     @Override
 582     public void onRequestExecutionStart(String vnfId, boolean readOnlyActivity, String requestIdentifierString, boolean forceFlag) throws UnstableVNFException {
 583         if (logger.isTraceEnabled()) {
 584             logger.trace("Entering to onRequestExecutionStart with vnfId = " + vnfId + "and requestIdentifierString = " + requestIdentifierString);
 585         }
 586         try {
 587             boolean updated = workingStateManager.setWorkingState(vnfId, VNFWorkingState.UNSTABLE, requestIdentifierString, forceFlag);
 588             if (!updated) {
 589                 throw new UnstableVNFException("VNF is not stable for vnfID = " + vnfId);
 590             }
 591         } catch (Exception e) {
 592             logger.error("Error updating working state for vnf " + vnfId + e);
 593             throw new RuntimeException(e);
 594         }
 595
 596         if (logger.isTraceEnabled())
 597             logger.trace("Exiting from onRequestExecutionStart ");
 598     }
 599
 600     /**
 601      * This method perform following operations required after execution of workflow.
 602      * It posts asynchronous response to message bus (DMaaP).
 603      * Unlock VNF Id
 604      * Removes request from request registry.
 605      * Generate audit logs.
 606      * Adds transaction record to database id if transaction logging is enabled.
 607      *
 608      * @param isAAIUpdated boolean flag which indicate AAI upodate status after request completion.
 609      */
 610     @Override
 611     public void onRequestExecutionEnd(RuntimeContext runtimeContext, boolean isAAIUpdated) {
 612         if (logger.isTraceEnabled()) {
 613             logger.trace("Entering to onRequestExecutionEnd with runtimeContext = " + ObjectUtils.toString(runtimeContext));
 614         }
 615
 616         postMessageToDMaaP(runtimeContext.getRequestContext().getAction(), runtimeContext.getRpcName(), runtimeContext.getResponseContext());
 617         requestRegistry.removeRequest(
 618                 new UniqueRequestIdentifier(runtimeContext.getResponseContext().getCommonHeader().getOriginatorId(),
 619                         runtimeContext.getResponseContext().getCommonHeader().getRequestId(),
 620                         runtimeContext.getResponseContext().getCommonHeader().getSubRequestId()));
 621         resetLock(runtimeContext.getVnfContext().getId(), runtimeContext.getResponseContext().getCommonHeader().getRequestId(), runtimeContext.isLockAcquired(), true);
 622         Status status = runtimeContext.getResponseContext().getStatus();
 623
 624         VNFWorkingState workingState;
 625         if (status.getCode() == LCMCommandStatus.SUCCESS.getResponseCode() || isReadOnlyAction(runtimeContext.getRequestContext().getAction())) {
 626             workingState = VNFWorkingState.STABLE;
 627         } else {
 628             workingState = VNFWorkingState.UNKNOWN;
 629         }
 630
 631         UniqueRequestIdentifier requestIdentifier = new UniqueRequestIdentifier(runtimeContext.getResponseContext().getCommonHeader().getOriginatorId(),
 632                 runtimeContext.getResponseContext().getCommonHeader().getRequestId(),
 633                 runtimeContext.getResponseContext().getCommonHeader().getSubRequestId());
 634
 635         String requestIdentifierString = requestIdentifier.toIdentifierString();
 636         workingStateManager.setWorkingState(runtimeContext.getVnfContext().getId(), workingState, requestIdentifierString, false);
 637
 638
 639         storeAuditLogRecord(runtimeContext);
 640
 641         if (isLoggingEnabled()) {
 642             createTransactionRecord(runtimeContext);
 643         }
 644     }
 645
 646     private void storeAuditLogRecord(RuntimeContext runtimeContext) {
 647         LoggingUtils.logAuditMessage(runtimeContext.getTimeStart(),
 648                 new Date(System.currentTimeMillis()),
 649                 String.valueOf(runtimeContext.getResponseContext().getStatus().getCode()),
 650                 runtimeContext.getResponseContext().getStatus().getMessage(),
 651                 this.getClass().getCanonicalName());
 652     }
 653
 654     private void storeMetricLogRecord(RuntimeContext runtimeContext) {
 655         LoggingUtils.logMetricsMessage(runtimeContext.getTimeStart(),
 656                 new Date(System.currentTimeMillis()),
 657                 LoggingConstants.TargetNames.APPC,
 658                 runtimeContext.getRequestContext().getAction().name(),
 659                 runtimeContext.getResponseContext().getStatus().getCode() == LCMCommandStatus.ACCEPTED.getResponseCode() ? LoggingConstants.StatusCodes.COMPLETE : LoggingConstants.StatusCodes.ERROR,
 660                 String.valueOf(runtimeContext.getResponseContext().getStatus().getCode()),
 661                 runtimeContext.getResponseContext().getStatus().getMessage(),
 662                 this.getClass().getCanonicalName());
 663     }
 664
 665     private boolean isReadOnlyAction(VNFOperation action) {
 666         return VNFOperation.Sync == action
 667                 || VNFOperation.Audit == action;
 668     }
 669
 670
 671     //returns null if asyncResponse was not modified otherwise reutrns the updated asyncResponse
 672     private void postMessageToDMaaP(VNFOperation operation, String rpcName, ResponseContext responseContext/*, boolean isTTLEnd, boolean aaiUpdateSuccess*/) {
 673         if (logger.isTraceEnabled()) {
 674             logger.trace("Entering to postMessageToDMaaP with AsyncResponse = " + ObjectUtils.toString(responseContext));
 675         }
 676         /*boolean updated = updateAsyncResponseStatus(responseContext, isTTLEnd, aaiUpdateSuccess);
 677          */
 678         boolean callbackResponse = messageAdapter.post(operation, rpcName, responseContext);
 679         if (!callbackResponse) {
 680             logger.error("DMaaP posting status: " + callbackResponse, "dmaapMessage: " + responseContext);
 681         }
 682         if (logger.isTraceEnabled())
 683             logger.trace("Exiting from postMessageToDMaaP with (callbackResponse = " + ObjectUtils.toString(callbackResponse) + ")");
 684     }
 685
 686     //returns true if asyncResponse was modified
 687     /*    private boolean updateAsyncResponseStatus(ResponseContext asyncResponse, boolean isTTLEnd, boolean aaiUpdateSuccess) {
 688         boolean updated = false;
 689         if (logger.isTraceEnabled())
 690             logger.trace("Entering to updateAsyncResponseStatus with AsyncResponse = "+ObjectUtils.toString(asyncResponse)+ ", isTTLEnd = "+ ObjectUtils.toString(isTTLEnd)+ ", aaiUpdateSuccess = "+ ObjectUtils.toString(aaiUpdateSuccess));
 691         if(!aaiUpdateSuccess){
 692                 if (asyncResponse.getStatus().getCode() == 0 || asyncResponse.getStatus().getCode() == LCMCommandStatus.SUCCESS.getResponseCode()) {
 693                     asyncResponse.getStatus().setCode(LCMCommandStatus.UPDATE_AAI_FAILURE.getResponseCode());
 694                     asyncResponse.getStatus().setMessage(LCMCommandStatus.UPDATE_AAI_FAILURE.getResponseMessage());
 695                 updated = true;
 696             }
 697         }else if(isTTLEnd){
 698                 asyncResponse.getStatus().setCode(LCMCommandStatus.EXPIRED_REQUEST_FAILURE.getResponseCode());
 699                 asyncResponse.getStatus().setMessage(LCMCommandStatus.EXPIRED_REQUEST_FAILURE.getResponseMessage());
 700             updated = true;
 701         }
 702         if (logger.isTraceEnabled())
 703             logger.trace("Exiting from updateAsyncResponseStatus with (asyncResponse = "+ ObjectUtils.toString(asyncResponse)+")");
 704         return updated;
 705     }*/
 706
 707
 708     /**
 709      * This method perform following operations required if TTL ends when request still waiting in execution queue .
 710      * It posts asynchronous response to message bus (DMaaP).
 711      * Unlock VNF Id
 712      * Removes request from request registry.
 713      *
 714      * @param runtimeContext AsyncResponse object which contains VNF Id         , timestamp , apiVersion, responseId, executionSuccess, payload, isExpired, action, startTime, vnfType, originatorId, subResponseId;
 715      * @param updateAAI      boolean flag which indicate AAI upodate status after request completion.
 716      */
 717     @Override
 718     public void onRequestTTLEnd(RuntimeContext runtimeContext, boolean updateAAI) {
 719         if (logger.isTraceEnabled()) {
 720             logger.trace("Entering to onRequestTTLEnd with " +
 721                     "AsyncResponse = " + ObjectUtils.toString(runtimeContext) +
 722                     ", updateAAI = " + ObjectUtils.toString(updateAAI));
 723         }
 724         logger.error(LCMCommandStatus.EXPIRED_REQUEST_FAILURE.getResponseMessage());
 725         fillStatus(runtimeContext, LCMCommandStatus.EXPIRED_REQUEST_FAILURE, null);
 726         postMessageToDMaaP(runtimeContext.getRequestContext().getAction(), runtimeContext.getRpcName(), runtimeContext.getResponseContext());
 727         resetLock(runtimeContext.getVnfContext().getId(), runtimeContext.getResponseContext().getCommonHeader().getRequestId(), runtimeContext.isLockAcquired(), true);
 728         requestRegistry.removeRequest(
 729                 new UniqueRequestIdentifier(runtimeContext.getResponseContext().getCommonHeader().getOriginatorId(),
 730                         runtimeContext.getResponseContext().getCommonHeader().getRequestId(),
 731                         runtimeContext.getResponseContext().getCommonHeader().getSubRequestId()));
 732     }
 733
 734     private SvcLogicContext getVnfdata(String vnf_id, String prefix, SvcLogicContext ctx) throws VNFNotFoundException {
 735         String key = "vnf-id = '" + vnf_id + "'";
 736         if (logger.isTraceEnabled()) {
 737             logger.trace("Entering to getVnfdata with " +
 738                     "vnfId = " + vnf_id +
 739                     ", prefix = " + prefix +
 740                     ", SvcLogicContex = " + ObjectUtils.toString(ctx));
 741         }
 742         try {
 743             QueryStatus response = aaiService.query("generic-vnf", false, null, key, prefix, null, ctx);
 744             if (QueryStatus.NOT_FOUND.equals(response)) {
 745                 throw new VNFNotFoundException("VNF not found for vnf_id = " + vnf_id);
 746             } else if (QueryStatus.FAILURE.equals(response)) {
 747                 throw new RuntimeException("Error Querying AAI with vnfID = " + vnf_id);
 748             }
 749             logger.info("AAIResponse: " + response.toString());
 750         } catch (SvcLogicException e) {
 751             logger.error("Error in getVnfdata " + e);
 752             throw new RuntimeException(e);
 753         }
 754         if (logger.isTraceEnabled()) {
 755             logger.trace("Exiting from getVnfdata with (SvcLogicContext = " + ObjectUtils.toString(ctx) + ")");
 756         }
 757         return ctx;
 758     }
 759
 760     private boolean postVnfdata(String vnf_id, String status, String prefix, SvcLogicContext ctx) throws VNFNotFoundException {
 761         if (logger.isTraceEnabled()) {
 762             logger.trace("Entering to postVnfdata with " +
 763                     "vnfId = " + vnf_id +
 764                     ", status = " + status +
 765                     ", prefix = " + prefix +
 766                     ", SvcLogicContext = " + ObjectUtils.toString(ctx));
 767         }
 768         String key = "vnf-id = '" + vnf_id + "'";
 769         Map<String, String> data = new HashMap<>();
 770         data.put("orchestration-status", status);
 771         try {
 772             QueryStatus response = aaiService.update("generic-vnf", key, data, prefix, ctx);
 773             if (QueryStatus.NOT_FOUND.equals(response)) {
 774                 throw new VNFNotFoundException("VNF not found for vnf_id = " + vnf_id);
 775             }
 776             logger.info("AAIResponse: " + response.toString());
 777             if (response.toString().equals("SUCCESS")) {
 778                 if (logger.isTraceEnabled()) {
 779                     logger.trace("Exiting from postVnfdata with (Result = " + ObjectUtils.toString(true) + ")");
 780                 }
 781                 return true;
 782             }
 783
 784         } catch (SvcLogicException e) {
 785             logger.error("Error in postVnfdata " + e);
 786             throw new RuntimeException(e);
 787         }
 788         if (logger.isTraceEnabled()) {
 789             logger.trace("Exiting from postVnfdata with (Result = " + ObjectUtils.toString(false) + ")");
 790         }
 791         return false;
 792     }
 793
 794     private void initMetric() {
 795         if (logger.isDebugEnabled())
 796             logger.debug("Metric getting initialized");
 797         MetricService metricService = getMetricservice();
 798         metricRegistry = metricService.createRegistry("APPC");
 799         DispatchingFuntionMetric dispatchingFuntionMetric = metricRegistry.metricBuilderFactory().
 800                 dispatchingFunctionCounterBuilder().
 801                 withName("DISPATCH_FUNCTION").withType(MetricType.COUNTER).
 802                 withAcceptRequestValue(0)
 803                 .withRejectRequestValue(0)
 804                 .build();
 805         if (metricRegistry.register(dispatchingFuntionMetric)) {
 806             Metric[] metrics = new Metric[]{dispatchingFuntionMetric};
 807             LogPublisher logPublisher = new LogPublisher(metricRegistry, metrics);
 808             LogPublisher[] logPublishers = new LogPublisher[1];
 809             logPublishers[0] = logPublisher;
 810             PublishingPolicy manuallyScheduledPublishingPolicy = metricRegistry.policyBuilderFactory().
 811                     scheduledPolicyBuilder().withPublishers(logPublishers).
 812                     withMetrics(metrics).
 813                     build();
 814             if (logger.isDebugEnabled())
 815                 logger.debug("Policy getting initialized");
 816             manuallyScheduledPublishingPolicy.init();
 817             if (logger.isDebugEnabled())
 818                 logger.debug("Metric initialized");
 819         }
 820     }
 821
 822
 823     private MetricService getMetricservice() {
 824         BundleContext bctx = FrameworkUtil.getBundle(MetricService.class).getBundleContext();
 825         ServiceReference sref = bctx.getServiceReference(MetricService.class.getName());
 826         if (sref != null) {
 827             logger.info("Metric Service from bundlecontext");
 828             return (MetricService) bctx.getService(sref);
 829         } else {
 830             logger.info("Metric Service error from bundlecontext");
 831             logger.warn("Cannot find service reference for org.openecomp.appc.metricservice.MetricService");
 832             return null;
 833         }
 834     }
 835 }