bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/workflow/tasks/OrchestrationStatusValidator.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - SO
   4  * ================================================================================
   5  * Copyright (C) 2017 - 2018 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.so.bpmn.infrastructure.workflow.tasks;
  22
  23 import org.onap.so.bpmn.common.BuildingBlockExecution;
  24 import org.onap.so.bpmn.servicedecomposition.entities.ResourceKey;
  25 import org.onap.so.bpmn.servicedecomposition.tasks.ExtractPojosForBB;
  26 import org.onap.so.client.exception.ExceptionBuilder;
  27 import org.onap.so.client.exception.OrchestrationStatusValidationException;
  28 import org.onap.so.db.catalog.beans.BuildingBlockDetail;
  29 import org.onap.so.db.catalog.beans.OrchestrationStatus;
  30 import org.onap.so.db.catalog.beans.OrchestrationStatusStateTransitionDirective;
  31 import org.onap.so.db.catalog.beans.OrchestrationStatusValidationDirective;
  32 import org.onap.so.db.catalog.client.CatalogDbClient;
  33 import org.onap.so.logger.MsoLogger;
  34 import org.springframework.beans.factory.annotation.Autowired;
  35 import org.springframework.stereotype.Component;
  36
  37 @Component
  38 public class OrchestrationStatusValidator {
  39         private static final MsoLogger msoLogger = MsoLogger.getMsoLogger(MsoLogger.Catalog.BPEL, OrchestrationStatusValidator.class);
  40
  41         private static final String BUILDING_BLOCK_DETAIL_NOT_FOUND = "Building Block (%s) not set up in Orchestration_Status_Validation table in CatalogDB.";
  42         private static final String UNKNOWN_RESOURCE_TYPE = "Building Block (%s) not set up correctly in Orchestration_Status_Validation table in CatalogDB. ResourceType=(%s), TargetAction=(%s)";
  43         private static final String ORCHESTRATION_VALIDATION_FAIL = "Orchestration Status Validation failed. ResourceType=(%s), TargetAction=(%s), OrchestrationStatus=(%s)";
  44         private static final String ORCHESTRATION_STATUS_VALIDATION_RESULT = "orchestrationStatusValidationResult";
  45
  46
  47         @Autowired
  48         private ExtractPojosForBB extractPojosForBB;
  49         @Autowired
  50         private ExceptionBuilder exceptionBuilder;
  51         @Autowired
  52         private CatalogDbClient catalogDbClient;
  53
  54         public void validateOrchestrationStatus(BuildingBlockExecution execution) {
  55                 try {
  56                         execution.setVariable(ORCHESTRATION_STATUS_VALIDATION_RESULT, null);
  57
  58                         String buildingBlockFlowName = (String) execution.getVariable("flowToBeCalled");
  59
  60                         BuildingBlockDetail buildingBlockDetail = catalogDbClient.getBuildingBlockDetail(buildingBlockFlowName);
  61
  62                         if (buildingBlockDetail == null) {
  63                                 throw new OrchestrationStatusValidationException(String.format(BUILDING_BLOCK_DETAIL_NOT_FOUND, buildingBlockFlowName));
  64                         }
  65
  66                         OrchestrationStatus orchestrationStatus = null;
  67
  68                         switch(buildingBlockDetail.getResourceType()) {
  69                         case SERVICE:
  70                                 org.onap.so.bpmn.servicedecomposition.bbobjects.ServiceInstance serviceInstance = extractPojosForBB.extractByKey(execution, ResourceKey.SERVICE_INSTANCE_ID, execution.getLookupMap().get(ResourceKey.SERVICE_INSTANCE_ID));
  71                                 orchestrationStatus = serviceInstance.getOrchestrationStatus();
  72                                 break;
  73                         case VNF:
  74                                 org.onap.so.bpmn.servicedecomposition.bbobjects.GenericVnf genericVnf = extractPojosForBB.extractByKey(execution, ResourceKey.GENERIC_VNF_ID, execution.getLookupMap().get(ResourceKey.GENERIC_VNF_ID));
  75                                 orchestrationStatus = genericVnf.getOrchestrationStatus();
  76                                 break;
  77                         case VF_MODULE:
  78                                 org.onap.so.bpmn.servicedecomposition.bbobjects.VfModule vfModule = extractPojosForBB.extractByKey(execution, ResourceKey.VF_MODULE_ID, execution.getLookupMap().get(ResourceKey.VF_MODULE_ID));
  79                                 orchestrationStatus = vfModule.getOrchestrationStatus();
  80                                 break;
  81                         case VOLUME_GROUP:
  82                                 org.onap.so.bpmn.servicedecomposition.bbobjects.VolumeGroup volumeGroup = extractPojosForBB.extractByKey(execution, ResourceKey.VOLUME_GROUP_ID, execution.getLookupMap().get(ResourceKey.VOLUME_GROUP_ID));
  83                                 orchestrationStatus = volumeGroup.getOrchestrationStatus();
  84                                 break;
  85                         case NETWORK:
  86                                 org.onap.so.bpmn.servicedecomposition.bbobjects.L3Network network = extractPojosForBB.extractByKey(execution, ResourceKey.NETWORK_ID, execution.getLookupMap().get(ResourceKey.NETWORK_ID));
  87                                 orchestrationStatus = network.getOrchestrationStatus();
  88                                 break;
  89                         case NETWORK_COLLECTION:
  90                                 org.onap.so.bpmn.servicedecomposition.bbobjects.ServiceInstance serviceInst = extractPojosForBB.extractByKey(execution, ResourceKey.SERVICE_INSTANCE_ID, execution.getLookupMap().get(ResourceKey.SERVICE_INSTANCE_ID));
  91                                 org.onap.so.bpmn.servicedecomposition.bbobjects.Collection networkCollection = serviceInst.getCollection();
  92                                 orchestrationStatus = networkCollection.getOrchestrationStatus();
  93                                 break;
  94                         case CONFIGURATION:
  95                                 org.onap.so.bpmn.servicedecomposition.bbobjects.Configuration configuration = extractPojosForBB.extractByKey(execution, ResourceKey.CONFIGURATION_ID, execution.getLookupMap().get(ResourceKey.CONFIGURATION_ID));
  96                                 orchestrationStatus = configuration.getOrchestrationStatus();
  97                                 break;
  98                         default:
  99                                 // can't currently get here, so not tested. Added in case enum is expanded without a change to this code
 100                                 throw new OrchestrationStatusValidationException(String.format(UNKNOWN_RESOURCE_TYPE, buildingBlockFlowName, buildingBlockDetail.getResourceType(), buildingBlockDetail.getTargetAction()));
 101                         }
 102
 103                         if(orchestrationStatus==null){
 104                                 throw new OrchestrationStatusValidationException("The resource's orchstration status is null. Cannot perform task on a null orchestration status");
 105                         }
 106                         OrchestrationStatusStateTransitionDirective orchestrationStatusStateTransitionDirective = catalogDbClient.getOrchestrationStatusStateTransitionDirective(buildingBlockDetail.getResourceType(), orchestrationStatus, buildingBlockDetail.getTargetAction());
 107
 108                         if (orchestrationStatusStateTransitionDirective.getFlowDirective() == OrchestrationStatusValidationDirective.FAIL) {
 109                                 throw new OrchestrationStatusValidationException(String.format(ORCHESTRATION_VALIDATION_FAIL, buildingBlockDetail.getResourceType(), buildingBlockDetail.getTargetAction(), orchestrationStatus));
 110                         }
 111
 112                         execution.setVariable(ORCHESTRATION_STATUS_VALIDATION_RESULT, orchestrationStatusStateTransitionDirective.getFlowDirective());
 113                 } catch (Exception e) {
 114                         exceptionBuilder.buildAndThrowWorkflowException(execution, 7000, e);
 115                 }
 116         }
 117 }