MainDurationEventNotifier.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.camel.main;

import java.util.EventObject;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;

import org.apache.camel.CamelContext;
import org.apache.camel.management.event.ExchangeCompletedEvent;
import org.apache.camel.management.event.ExchangeCreatedEvent;
import org.apache.camel.management.event.ExchangeFailedEvent;
import org.apache.camel.support.EventNotifierSupport;
import org.apache.camel.util.StopWatch;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * A {@link org.apache.camel.spi.EventNotifier} to trigger shutdown of the Main JVM
 * when maximum number of messages has been processed.
 */
public class MainDurationEventNotifier extends EventNotifierSupport {

    private static final Logger LOG = LoggerFactory.getLogger(MainLifecycleStrategy.class);
    private final CamelContext camelContext;
    private final int maxMessages;
    private final long maxIdleSeconds;
    private final AtomicBoolean completed;
    private final CountDownLatch latch;
    private final boolean stopCamelContext;

    private volatile int doneMessages;
    private volatile StopWatch watch;
    private volatile ScheduledExecutorService executorService;

    public MainDurationEventNotifier(CamelContext camelContext, int maxMessages, long maxIdleSeconds,
                                     AtomicBoolean completed, CountDownLatch latch, boolean stopCamelContext) {
        this.camelContext = camelContext;
        this.maxMessages = maxMessages;
        this.maxIdleSeconds = maxIdleSeconds;
        this.completed = completed;
        this.latch = latch;
        this.stopCamelContext = stopCamelContext;
    }

    @Override
    public void notify(EventObject event) throws Exception {
        boolean begin = event instanceof ExchangeCreatedEvent;
        boolean complete = event instanceof ExchangeCompletedEvent || event instanceof ExchangeFailedEvent;

        if (maxMessages > 0 && complete) {
            doneMessages++;

            boolean result = doneMessages >= maxMessages;
            LOG.trace("Duration max messages check {} >= {} -> {}", doneMessages, maxMessages, result);

            if (result) {
                if (completed.compareAndSet(false, true)) {
                    LOG.info("Duration max messages triggering shutdown of the JVM.");
                    try {
                        // shutting down CamelContext
                        if (stopCamelContext) {
                            camelContext.stop();
                        }
                    } catch (Exception e) {
                        LOG.warn("Error during stopping CamelContext. This exception is ignored.", e);
                    } finally {
                        // trigger stopping the Main
                        latch.countDown();
                    }
                }
            }
        }

        // idle reacts on both incoming and complete messages
        if (maxIdleSeconds > 0 && (begin || complete)) {
            LOG.trace("Message activity so restarting stop watch");
            watch.restart();
        }
    }

    @Override
    public boolean isEnabled(EventObject event) {
        return event instanceof ExchangeCompletedEvent || event instanceof ExchangeFailedEvent;
    }

    @Override
    public String toString() {
        return "MainDurationEventNotifier[" + maxMessages + " max messages]";
    }

    @Override
    protected void doStart() throws Exception {
        if (maxIdleSeconds > 0) {

            // we only start watch when Camel is started
            camelContext.addStartupListener((context, alreadyStarted) -> watch = new StopWatch());

            // okay we need to trigger on idle after X period, and therefore we need a background task that checks this
            executorService = camelContext.getExecutorServiceManager().newSingleThreadScheduledExecutor(this, "MainDurationIdleChecker");
            Runnable task = () -> {
                if (watch == null) {
                    // camel has not been started yet
                    return;
                }

                // any inflight messages currently
                int inflight = camelContext.getInflightRepository().size();
                if (inflight > 0) {
                    LOG.trace("Duration max idle check is skipped due {} inflight messages", inflight);
                    return;
                }

                long seconds = watch.taken() / 1000;
                boolean result = seconds >= maxIdleSeconds;
                LOG.trace("Duration max idle check {} >= {} -> {}", seconds, maxIdleSeconds, result);

                if (result) {
                    if (completed.compareAndSet(false, true)) {
                        LOG.info("Duration max idle triggering shutdown of the JVM.");
                        try {
                            // shutting down CamelContext
                            if (stopCamelContext) {
                                camelContext.stop();
                            }
                        } catch (Exception e) {
                            LOG.warn("Error during stopping CamelContext. This exception is ignored.", e);
                        } finally {
                            // trigger stopping the Main
                            latch.countDown();
                        }
                    }
                }
            };
            executorService.scheduleAtFixedRate(task, 1, 1, TimeUnit.SECONDS);
        }
    }

}