appc-event-listener/appc-event-listener-bundle/src/main/java/org/onap/appc/listener/AbstractListener.java

   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.listener;
  26
  27 import java.security.SecureRandom;
  28 import java.util.concurrent.ArrayBlockingQueue;
  29 import java.util.concurrent.BlockingQueue;
  30 import java.util.concurrent.RejectedExecutionHandler;
  31 import java.util.concurrent.ThreadPoolExecutor;
  32 import java.util.concurrent.TimeUnit;
  33 import java.util.concurrent.atomic.AtomicBoolean;
  34
  35 import org.apache.commons.lang3.concurrent.BasicThreadFactory;
  36 import org.onap.appc.listener.impl.EventHandlerImpl;
  37
  38 import com.att.eelf.configuration.EELFLogger;
  39 import com.att.eelf.configuration.EELFManager;
  40
  41 public abstract class AbstractListener implements Listener {
  42
  43     private final EELFLogger LOG = EELFManager.getInstance().getLogger(AbstractListener.class);
  44
  45     protected AtomicBoolean run = new AtomicBoolean(false);
  46     protected int QUEUED_MIN = 1;
  47     protected int QUEUED_MAX = 10;
  48     protected int THREAD_MIN = 4;
  49     protected int THREAD_MAX = THREAD_MIN; // Fixed thread pool
  50     protected int THREAD_SCALE_DOWN_SEC = 10; // Number of seconds to wait until we remove idle threads
  51     protected ThreadPoolExecutor executor;
  52     protected EventHandler dmaap;
  53     protected ListenerProperties props;
  54
  55     private String listenerId;
  56
  57     public AbstractListener(ListenerProperties props) {
  58         updateProperties(props);
  59
  60         dmaap = new EventHandlerImpl(props);
  61         if (dmaap.getClientId().equals("0")) {
  62                 dmaap.setClientId(String.valueOf(new SecureRandom().nextInt(1000)));
  63         }
  64
  65         BlockingQueue<Runnable> threadQueue = new ArrayBlockingQueue<Runnable>(QUEUED_MAX + QUEUED_MIN + 1);
  66         executor = new ThreadPoolExecutor(THREAD_MIN, THREAD_MAX, THREAD_SCALE_DOWN_SEC, TimeUnit.SECONDS, threadQueue,
  67             new JobRejectionHandler());
  68
  69         // Custom Named thread factory
  70         BasicThreadFactory threadFactory = new BasicThreadFactory.Builder().namingPattern("DMaaP-Worker-%d").build();
  71         executor.setThreadFactory(threadFactory);
  72
  73         run.set(true);
  74     }
  75
  76     /**
  77      * Starts a loop that will only end after stop() or stopNow() are called. The loop will read messages off the DMaaP
  78      * topic and perform some action on them while writing messages back to DMaaP at critical points in the execution.
  79      * Inherited from Runnable.
  80      *
  81      * @see java.lang.Runnable#run()
  82      */
  83     @Override
  84     public void run() {
  85         LOG.error("Listener.run() has not been implemented");
  86     }
  87
  88     @Override
  89     public void stop() {
  90         run.set(false);
  91         LOG.info(String.format("Stopping with %d messages in queue", executor.getQueue().size()));
  92         executor.shutdown();
  93         try {
  94             executor.awaitTermination(10, TimeUnit.SECONDS);
  95         } catch (InterruptedException e) {
  96             LOG.error("Listener graceful stop() failed", e);
  97         }
  98
  99         // close DMaaP clients
 100         if (dmaap != null) {
 101                 dmaap.closeClients();
 102         }
 103         LOG.info("Listener Thread Pool Finished");
 104     }
 105
 106     @Override
 107     public void stopNow() {
 108         run.set(false);
 109         LOG.info(String.format("StopNow called. Orphaning %d messages in the queue", executor.getQueue().size()));
 110         executor.getQueue().clear();
 111         stop();
 112     }
 113
 114     @Override
 115     public String getBenchmark() {
 116         return String.format("%s - No benchmarking implemented.", getListenerId());
 117     }
 118
 119     @Override
 120     public String getListenerId() {
 121         return listenerId;
 122     }
 123
 124     // Sets the id of the listener in
 125     @Override
 126     public void setListenerId(String id) {
 127         listenerId = id;
 128     }
 129
 130     private void updateProperties(ListenerProperties properties) {
 131         this.props = properties;
 132         QUEUED_MIN =
 133             Integer.valueOf(props.getProperty(ListenerProperties.KEYS.THREADS_MIN_QUEUE, String.valueOf(QUEUED_MIN)));
 134         QUEUED_MAX =
 135             Integer.valueOf(props.getProperty(ListenerProperties.KEYS.THREADS_MAX_QUEUE, String.valueOf(QUEUED_MAX)));
 136         THREAD_MIN =
 137             Integer.valueOf(props.getProperty(ListenerProperties.KEYS.THREADS_MIN_POOL, String.valueOf(THREAD_MIN)));
 138         THREAD_MAX =
 139             Integer.valueOf(props.getProperty(ListenerProperties.KEYS.THREADS_MAX_POOL, String.valueOf(THREAD_MAX)));
 140
 141         listenerId = props.getPrefix();
 142     }
 143
 144     /**
 145      * This class will be used to handle what happens when we cannot add a job because of a ThreadPool issue. It does
 146      * not get invoked if there is any fault with the job. NOTE: So far, this has only been seen when doing a
 147      * {@link Listener#stopNow}
 148      *
 149      */
 150     class JobRejectionHandler implements RejectedExecutionHandler {
 151         @Override
 152         public void rejectedExecution(Runnable r, ThreadPoolExecutor executor) {
 153             LOG.error(String.format("A job was rejected. [%s]", r));
 154         }
 155     }
 156 }