/*
 * 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.lang.Thread.UncaughtExceptionHandler;

/**
 * A component based on lifecycle management.
 */
public interface LifecycleComponent extends AutoCloseable {

    String getName();

    Lifecycle.State lifecycleState();

    void addLifecycleListener(LifecycleListener listener);

    void removeLifecycleListener(LifecycleListener listener);

    default void publishInfo(ComponentInfoPublisher componentInfoPublisher) {
    }

    void start();

    void stop();

    @Override
    void close();

    /**
     * Set the default handler invoked when a lifecycle component
     * abruptly terminates due an uncaught exception.
     *
     * @param handler handler invoked when an uncaught exception happens
     *                in the lifecycle component.
     */
    void setExceptionHandler(UncaughtExceptionHandler handler);
}
