adapters/mso-vnfm-adapter/mso-vnfm-etsi-adapter/src/main/java/org/onap/so/adapters/vnfmadapter/jobmanagement/JobManager.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.so.adapters.vnfmadapter.jobmanagement;
  22
  23 import static org.slf4j.LoggerFactory.getLogger;
  24 import com.google.common.base.Optional;
  25 import com.google.common.collect.Maps;
  26 import java.util.Map;
  27 import java.util.UUID;
  28 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.VnfmServiceProvider;
  29 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.InlineResponse200;
  30 import org.onap.so.adapters.vnfmadapter.rest.exceptions.JobNotFoundException;
  31 import org.onap.vnfmadapter.v1.model.OperationEnum;
  32 import org.onap.vnfmadapter.v1.model.OperationStateEnum;
  33 import org.onap.vnfmadapter.v1.model.OperationStatusRetrievalStatusEnum;
  34 import org.onap.vnfmadapter.v1.model.QueryJobResponse;
  35 import org.slf4j.Logger;
  36 import org.springframework.beans.factory.annotation.Autowired;
  37 import org.springframework.stereotype.Component;
  38
  39 /**
  40  * Manages jobs enabling the status of jobs to be queried. A job is associated with an operation on a VNFM.
  41  */
  42 @Component
  43 public class JobManager {
  44     private static final String SEPARATOR = "_";
  45     private static Logger logger = getLogger(JobManager.class);
  46     private final Map<String, VnfmOperation> mapOfJobIdToVnfmOperation = Maps.newConcurrentMap();
  47     private final VnfmServiceProvider vnfmServiceProvider;
  48
  49     @Autowired
  50     JobManager(final VnfmServiceProvider vnfmServiceProvider) {
  51         this.vnfmServiceProvider = vnfmServiceProvider;
  52     }
  53
  54     /**
  55      * Create a job associated with an operation on a VNFM.
  56      *
  57      * @param vnfmId the VNFM the operation relates to
  58      * @param operationId the ID of the associated VNFM operation
  59      * @param waitForNotificationForSuccess if set to <code>true</code> the {@link QueryJobResponse#getOperationState()}
  60      *        shall not return {@link org.onap.vnfmadapter.v1.model.OperationStateEnum#COMPLETED} unless a required
  61      *        notification has been processed
  62      * @return the ID of the job. Can be used to query the job using {@link #getVnfmOperation(String)}
  63      */
  64     public String createJob(final String vnfmId, final String operationId,
  65             final boolean waitForNotificationForSuccess) {
  66         final String jobId = vnfmId + SEPARATOR + UUID.randomUUID().toString();
  67         final VnfmOperation vnfmOperation = new VnfmOperation(vnfmId, operationId, waitForNotificationForSuccess);
  68         mapOfJobIdToVnfmOperation.put(jobId, vnfmOperation);
  69         return jobId;
  70     }
  71
  72     /**
  73      * Get the operation, associated with the given job ID, from the VNFM.
  74      *
  75      * @param jobId the job ID
  76      * @return the associated operation from the VNFM, or <code>null</code> of no operation is associated with the given
  77      *         job ID
  78      */
  79     public QueryJobResponse getVnfmOperation(final String jobId) {
  80         final VnfmOperation vnfmOperation = mapOfJobIdToVnfmOperation.get(jobId);
  81         final QueryJobResponse response = new QueryJobResponse();
  82
  83         if (vnfmOperation == null) {
  84             throw new JobNotFoundException("No job found with ID: " + jobId);
  85         }
  86
  87         if (vnfmOperation.isVnfDeleted()) {
  88             response.setOperationStatusRetrievalStatus(OperationStatusRetrievalStatusEnum.STATUS_FOUND);
  89             return response.operationState(getOperationState(vnfmOperation, null));
  90         }
  91
  92         try {
  93             final Optional<InlineResponse200> operationOptional =
  94                     vnfmServiceProvider.getOperation(vnfmOperation.getVnfmId(), vnfmOperation.getOperationId());
  95
  96             if (!operationOptional.isPresent()) {
  97                 return response.operationStatusRetrievalStatus(OperationStatusRetrievalStatusEnum.OPERATION_NOT_FOUND);
  98             }
  99             final InlineResponse200 operation = operationOptional.get();
 100
 101             logger.debug(
 102                     "Job Id: " + jobId + ", operationId: " + operation.getId() + ", operation details: " + operation);
 103
 104             if (operation.getOperationState() == null) {
 105                 return response.operationStatusRetrievalStatus(OperationStatusRetrievalStatusEnum.WAITING_FOR_STATUS);
 106             }
 107
 108             response.setOperationStatusRetrievalStatus(OperationStatusRetrievalStatusEnum.STATUS_FOUND);
 109             response.setId(operation.getId());
 110             response.setOperation(OperationEnum.fromValue(operation.getOperation().getValue()));
 111             response.setOperationState(getOperationState(vnfmOperation, operation));
 112             response.setStartTime(operation.getStartTime());
 113             response.setStateEnteredTime(operation.getStateEnteredTime());
 114             response.setVnfInstanceId(operation.getVnfInstanceId());
 115
 116             return response;
 117         } catch (final Exception exception) {
 118             logger.error("Exception encountered trying to get operation status for operation id "
 119                     + vnfmOperation.getOperationId(), exception);
 120             return response.operationStatusRetrievalStatus(OperationStatusRetrievalStatusEnum.WAITING_FOR_STATUS);
 121         }
 122     }
 123
 124     private OperationStateEnum getOperationState(final VnfmOperation vnfmOperation,
 125             final InlineResponse200 operationResponse) {
 126         switch (vnfmOperation.getNotificationStatus()) {
 127             case NOTIFICATION_PROCESSING_NOT_REQUIRED:
 128             default:
 129                 return OperationStateEnum.fromValue(operationResponse.getOperationState().getValue());
 130             case NOTIFICATION_PROCESSING_PENDING:
 131                 return org.onap.vnfmadapter.v1.model.OperationStateEnum.PROCESSING;
 132             case NOTIFICATION_PROCEESING_SUCCESSFUL:
 133                 return org.onap.vnfmadapter.v1.model.OperationStateEnum.COMPLETED;
 134             case NOTIFICATION_PROCESSING_FAILED:
 135                 return org.onap.vnfmadapter.v1.model.OperationStateEnum.FAILED;
 136         }
 137     }
 138
 139     public void notificationProcessedForOperation(final String operationId,
 140             final boolean notificationProcessingWasSuccessful) {
 141         logger.debug("Notification processed for operation ID {} success?: {}", operationId,
 142                 notificationProcessingWasSuccessful);
 143         final java.util.Optional<VnfmOperation> relatedOperation = mapOfJobIdToVnfmOperation.values().stream()
 144                 .filter(operation -> operation.getOperationId().equals(operationId)).findFirst();
 145         if (relatedOperation.isPresent()) {
 146             relatedOperation.get().setNotificationProcessed(notificationProcessingWasSuccessful);
 147         } else {
 148             logger.debug("No operation found for operation ID " + operationId);
 149         }
 150     }
 151
 152     public void vnfDeleted(final String operationId) {
 153         logger.debug("VNF deleyed for operation ID {}", operationId);
 154         final java.util.Optional<VnfmOperation> relatedOperation = mapOfJobIdToVnfmOperation.values().stream()
 155                 .filter(operation -> operation.getOperationId().equals(operationId)).findFirst();
 156         if (relatedOperation.isPresent()) {
 157             relatedOperation.get().setVnfDeleted();;
 158         } else {
 159             logger.debug("No operation found for operation ID " + operationId);
 160         }
 161     }
 162
 163 }