Package org.apache.flink.util

Class ShutdownHookUtil

java.lang.Object

org.apache.flink.util.ShutdownHookUtil

public class ShutdownHookUtil
extends Object

Utils class for dealing with JVM shutdown hooks.

Method Summary

Modifier and Type	Method	Description
static Thread	addShutdownHook(AutoCloseable service, String serviceName, org.slf4j.Logger logger)	Adds a shutdown hook to the JVM and returns the Thread, which has been registered.
static boolean	addShutdownHookThread(Thread shutdownHook, String serviceName, org.slf4j.Logger logger)	Adds a shutdown hook to the JVM.
static void	removeShutdownHook(Thread shutdownHook, String serviceName, org.slf4j.Logger logger)	Removes a shutdown hook from the JVM.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addShutdownHook

public static Thread addShutdownHook(AutoCloseable service,
                                     String serviceName,
                                     org.slf4j.Logger logger)

Adds a shutdown hook to the JVM and returns the Thread, which has been registered.

addShutdownHookThread

public static boolean addShutdownHookThread(Thread shutdownHook,
                                            String serviceName,
                                            org.slf4j.Logger logger)

Adds a shutdown hook to the JVM.

Parameters:

shutdownHook - Shutdown hook to be registered.

serviceName - The name of service.

logger - The logger to log.

Returns:

Whether the hook has been successfully registered.

removeShutdownHook

public static void removeShutdownHook(Thread shutdownHook,
                                      String serviceName,
                                      org.slf4j.Logger logger)

Removes a shutdown hook from the JVM.