appc-dispatcher/appc-workflow-management/appc-workflow-management-api/src/main/java/org/openecomp/appc/workflow/WorkFlowManager.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.workflow;
  23
  24 import org.openecomp.appc.workflow.objects.WorkflowExistsOutput;
  25 import org.openecomp.appc.workflow.objects.WorkflowRequest;
  26 import org.openecomp.appc.workflow.objects.WorkflowResponse;
  27
  28 public interface WorkFlowManager {
  29         /**
  30          * Execute workflow and return response.
  31          * This method execute workflow with following steps.
  32          * Retrieve workflow(DG) details - module, version and mode  from database based on command and vnf Type from incoming request.
  33          * Execute workflow (DG) using SVC Logic Service reference
  34          * Return response of workflow (DG) to caller.
  35          * @param workflowRequest workflow execution request which contains vnfType, command, requestId, targetId, payload and (optional) confID;
  36          * @return Workflow Response which contains execution status and payload from DG if any
  37          */
  38         WorkflowResponse  executeWorkflow(WorkflowRequest workflowRequest);
  39
  40         /**
  41          * Check if workflow (DG) exists in database
  42          * @param workflowQueryParams workflow request with command and vnf Type
  43          * @return WorkflowExistsOutput.mappingExist True if workflow mapping exists else False. WorkflowExistsOutput.dgExist True if DG workflow exists else False.
  44      */
  45         WorkflowExistsOutput workflowExists(WorkflowRequest workflowQueryParams);
  46
  47 }