org.apache.bookkeeper.common.component.ComponentStarter Maven / Gradle / Ivy

Go to download
/*
 * 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.bookkeeper.common.component;

import java.util.concurrent.CompletableFuture;
import org.apache.bookkeeper.common.concurrent.FutureUtils;

/**
 * Utils to start components.
 */
public class ComponentStarter {
    private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(ComponentStarter.class);


    static class ComponentShutdownHook implements Runnable {
        private final LifecycleComponent component;
        private final CompletableFuture future;

        ComponentShutdownHook(LifecycleComponent component, CompletableFuture future) {
            this.component = component;
            this.future = future;
        }

        @Override
        public void run() {
            log.info("Closing component {} in shutdown hook.", component.getName());
            try {
                component.close();
                log.info("Closed component {} in shutdown hook successfully. Exiting.", component.getName());
                FutureUtils.complete(future, null);
            } catch (Throwable e) {
                log.error("Failed to close component {} in shutdown hook gracefully, Exiting anyway", component.getName(), e);
                future.completeExceptionally(e);
            }
        }
    }

    /**
     * Start a component and register a shutdown hook.
     *
     * @param component component to start.
     */
    public static CompletableFuture startComponent(LifecycleComponent component) {
        CompletableFuture future = new CompletableFuture<>();
        final Thread shutdownHookThread = new Thread(new ComponentShutdownHook(component, future), "component-shutdown-thread");
        // register a shutdown hook
        Runtime.getRuntime().addShutdownHook(shutdownHookThread);
        // register a component exception handler
        component.setExceptionHandler((t, e) -> {
            log.error("Triggered exceptionHandler of Component: {} because of Exception in Thread: {}", component.getName(), t, e);
            // start the shutdown hook when an uncaught exception happen in the lifecycle component.
            shutdownHookThread.start();
        });
        component.publishInfo(new ComponentInfoPublisher());
        log.info("Starting component {}.", component.getName());
        component.start();
        log.info("Started component {}.", component.getName());
        return future;
    }
}