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