2 * ============LICENSE_START=======================================================
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
13 * http://www.apache.org/licenses/LICENSE-2.0
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.
21 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
22 * ============LICENSE_END=========================================================
25 package org.onap.appc.listener;
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;
35 import org.apache.commons.lang3.concurrent.BasicThreadFactory;
36 import org.onap.appc.listener.impl.EventHandlerImpl;
38 import com.att.eelf.configuration.EELFLogger;
39 import com.att.eelf.configuration.EELFManager;
41 public abstract class AbstractListener implements Listener {
43 private final EELFLogger LOG = EELFManager.getInstance().getLogger(AbstractListener.class);
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;
55 private String listenerId;
57 public AbstractListener(ListenerProperties props) {
58 updateProperties(props);
60 dmaap = new EventHandlerImpl(props);
61 if (dmaap.getClientId().equals("0")) {
62 dmaap.setClientId(String.valueOf(new SecureRandom().nextInt(1000)));
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());
69 // Custom Named thread factory
70 BasicThreadFactory threadFactory = new BasicThreadFactory.Builder().namingPattern("DMaaP-Worker-%d").build();
71 executor.setThreadFactory(threadFactory);
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.
81 * @see java.lang.Runnable#run()
85 LOG.error("Listener.run() has not been implemented");
91 LOG.info(String.format("Stopping with %d messages in queue", executor.getQueue().size()));
94 executor.awaitTermination(10, TimeUnit.SECONDS);
95 } catch (InterruptedException e) {
96 LOG.error("Listener graceful stop() failed", e);
99 // close DMaaP clients
101 dmaap.closeClients();
103 LOG.info("Listener Thread Pool Finished");
107 public void stopNow() {
109 LOG.info(String.format("StopNow called. Orphaning %d messages in the queue", executor.getQueue().size()));
110 executor.getQueue().clear();
115 public String getBenchmark() {
116 return String.format("%s - No benchmarking implemented.", getListenerId());
120 public String getListenerId() {
124 // Sets the id of the listener in
126 public void setListenerId(String id) {
130 private void updateProperties(ListenerProperties properties) {
131 this.props = properties;
133 Integer.valueOf(props.getProperty(ListenerProperties.KEYS.THREADS_MIN_QUEUE, String.valueOf(QUEUED_MIN)));
135 Integer.valueOf(props.getProperty(ListenerProperties.KEYS.THREADS_MAX_QUEUE, String.valueOf(QUEUED_MAX)));
137 Integer.valueOf(props.getProperty(ListenerProperties.KEYS.THREADS_MIN_POOL, String.valueOf(THREAD_MIN)));
139 Integer.valueOf(props.getProperty(ListenerProperties.KEYS.THREADS_MAX_POOL, String.valueOf(THREAD_MAX)));
141 listenerId = props.getPrefix();
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}
150 class JobRejectionHandler implements RejectedExecutionHandler {
152 public void rejectedExecution(Runnable r, ThreadPoolExecutor executor) {
153 LOG.error(String.format("A job was rejected. [%s]", r));