appc-event-listener/appc-event-listener-bundle/src/main/java/org/openecomp/appc/listener/Controller.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.listener;
  23
  24 import java.util.Map;
  25
  26 /**
  27  * A controller is responsible for creating a listener for each ListenerProperties object that is passed in to it on
  28  * instantiation. The controller will create a thread pool that will contain all of the listener threads so no listener
  29  * can crash the controller.
  30  *
  31  */
  32 public interface Controller {
  33
  34     /**
  35      * Creates a new thread in the thread pool for an implementation of the {@see #Listener} class set in the
  36      * ListenerProperties. This thread is run immediately after it is created.
  37      */
  38     public void start();
  39
  40     /**
  41      * Stops each of the listeners known by this controller. Takes an optional parameter that indicates the the listener
  42      * should stop immediately rather than waiting for all threads to complete.
  43      *
  44      * @param stopNow
  45      *            Determines what method the listeners should use to shutdown. If true, listeners will use the stopNow()
  46      *            method. Otherwise they will use the stop() method.
  47      */
  48     public void stop(boolean stopNow);
  49
  50     /**
  51      * @return A Map of ListenerProperties and the Listener object that is running in the controllers thread pool.
  52      */
  53     public Map<ListenerProperties, Listener> getListeners();
  54
  55 }