appc-dispatcher/appc-workflow-management/appc-workflow-management-api/src/main/java/org/onap/appc/workflow/WorkFlowManager.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Copyright (C) 2017 Amdocs
   8  * =============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  * ============LICENSE_END=========================================================
  23  */
  24
  25 package org.onap.appc.workflow;
  26
  27 import org.onap.appc.workflow.objects.WorkflowExistsOutput;
  28 import org.onap.appc.workflow.objects.WorkflowRequest;
  29 import org.onap.appc.workflow.objects.WorkflowResponse;
  30
  31 public interface WorkFlowManager {
  32         /**
  33          * Execute workflow and return response.
  34          * This method execute workflow with following steps.
  35          * Retrieve workflow(DG) details - module, version and mode  from database based on command and vnf Type from incoming request.
  36          * Execute workflow (DG) using SVC Logic Service reference
  37          * Return response of workflow (DG) to caller.
  38          * @param workflowRequest workflow execution request which contains vnfType, command, requestId, targetId, payload and (optional) confID;
  39          * @return Workflow Response which contains execution status and payload from DG if any
  40          */
  41         WorkflowResponse  executeWorkflow(WorkflowRequest workflowRequest);
  42
  43         /**
  44          * Check if workflow (DG) exists in database
  45          * @param workflowQueryParams workflow request with command and vnf Type
  46          * @return WorkflowExistsOutput.mappingExist True if workflow mapping exists else False. WorkflowExistsOutput.dgExist True if DG workflow exists else False.
  47      */
  48         WorkflowExistsOutput workflowExists(WorkflowRequest workflowQueryParams);
  49
  50 }