gerrit.onap Code Review - appc.git/blob

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