sli/provider/src/main/java/org/openecomp/sdnc/sli/provider/SvcLogicService.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * openECOMP : SDN-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.sdnc.sli.provider;
  23
  24 import java.util.Properties;
  25
  26 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  27 import org.openecomp.sdnc.sli.SvcLogicException;
  28
  29 public interface SvcLogicService {
  30
  31         public static final String NAME = "org.openecomp.sdnc.sli.provider.SvcLogicService";
  32
  33         // public SvcLogicContext execute(SvcLogicGraph graph, SvcLogicContext ctx) throws SvcLogicException;
  34         /**
  35          * Check for existence of a directed graph
  36          * @param module - module name
  37          * @param rpc - rpc name
  38          * @param version - version.  If null, looks for active version
  39          * @param mode - mode (sync/async)
  40          * @return true if directed graph found, false otherwise
  41          * @throws SvcLogicException
  42          */
  43         public boolean hasGraph(String module, String rpc, String version, String mode) throws SvcLogicException;
  44
  45         /**
  46          *  Execute a directed graph
  47          *
  48          * @param module - module name
  49          * @param rpc - rpc name
  50          * @param version - version.  If null, use active version
  51          * @param mode - mode (sync/async)
  52          * @param parms - parameters, used to set SvcLogicContext attributes
  53          * @return final values of attributes from SvcLogicContext, as Properties
  54          * @throws SvcLogicException
  55          *
  56          *
  57          *  @deprecated use execute(String module, String rpc, String version, String mode, DOMDataBroker dataBroker) instead
  58          */
  59         @Deprecated
  60         public Properties execute(String module, String rpc, String version, String mode, Properties parms) throws SvcLogicException;
  61
  62         /**
  63          * Execute a directed graph
  64          *
  65          * @param module - module name
  66          * @param rpc - rpc name
  67          * @param version - version.  If null, use active version
  68          * @param mode - mode (sync/async)
  69          * @param parms - parameters, used to set SvcLogicContext attributes
  70          * @param domDataBroker - DOMDataBroker object
  71          * @return final values of attributes from SvcLogicContext, as Properties
  72          * @throws SvcLogicException
  73          */
  74         public Properties execute(String module, String rpc, String version, String mode, Properties parms, DOMDataBroker domDataBroker) throws SvcLogicException;
  75
  76 }