appc-client/client-kit/src/main/java/org/onap/appc/client/lcm/api/AppcLifeCycleManagerServiceFactory.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017-2018 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  * ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.appc.client.lcm.api;
  25
  26 import org.onap.appc.client.lcm.exceptions.AppcClientException;
  27
  28 import java.util.Properties;
  29
  30 public interface AppcLifeCycleManagerServiceFactory {
  31
  32     /**
  33      * Creates a new stateful LCM API
  34      * @param context application context parameters
  35      * @param properties configures the behaviour of the LCM
  36      * @return a new stateful LCM API
  37      * @throws AppcClientException in case of problem in instantiation
  38      */
  39     LifeCycleManagerStateful createLifeCycleManagerStateful(ApplicationContext context, Properties properties) throws AppcClientException;
  40
  41     /**
  42      * Creates a new stateful LCM API given a controller type
  43      * @param context application context parameters
  44      * @param properties configures the behaviour of the LCM
  45      * @return a new stateful LCM API
  46      * @throws AppcClientException in case of problem in instantiation
  47      */
  48     LifeCycleManagerStateful createLifeCycleManagerStateful(ApplicationContext context, Properties properties, String controllerType) throws AppcClientException;
  49
  50     /**
  51      * performs a shutdown of LCM API.
  52      * in case of graceful, will try and execute the remaining requests, otherwise, will force the shutdown right away
  53      * @param isForceShutdown - boolean. If true to perform force shutdown, other to perform graceful shutdown.
  54      */
  55     void shutdownLifeCycleManager(boolean isForceShutdown);
  56
  57
  58     /**
  59      * performs a shutdown of LCM API, given a controller type
  60      * in case of graceful, will try and execute the remaining requests, otherwise, will force the shutdown right away
  61      * @param isForceShutdown - boolean. If true to perform force shutdown, other to perform graceful shutdown.
  62      */
  63     void shutdownLifeCycleManager(boolean isForceShutdown, String controllerType);
  64
  65 }