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