gerrit.onap Code Review - appc.git/blob

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