org.apache.hadoop.util

Class ExitUtil

java.lang.Object

org.apache.hadoop.util.ExitUtil

@InterfaceAudience.LimitedPrivate(value={"HDFS","MapReduce"})
@InterfaceStability.Unstable
public final class ExitUtil
extends Object

Facilitates hooking process termination for tests and debugging.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExitUtil.ExitException
static class	ExitUtil.HaltException

Constructor Summary

Constructors

Constructor and Description
ExitUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	disableSystemExit() Disable the use of System.exit for testing.
static void	disableSystemHalt() Disable the use of Runtime.getRuntime().halt() for testing.
static ExitUtil.ExitException	getFirstExitException()
static ExitUtil.HaltException	getFirstHaltException()
static void	halt(int status) Forcibly terminates the currently running Java virtual machine.
static void	halt(int status, String msg) Forcibly terminates the currently running Java virtual machine.
static void	halt(int status, Throwable t) Forcibly terminates the currently running Java virtual machine.
static boolean	haltCalled()
static void	resetFirstExitException() Reset the tracking of process termination.
static void	resetFirstHaltException()
static void	terminate(int status) Like terminate(int, String) without a message.
static void	terminate(int status, String msg) Terminate the current process.
static void	terminate(int status, Throwable t) Like terminate(int, String) but uses the given throwable to initialize the ExitException.
static boolean	terminateCalled()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExitUtil

public ExitUtil()

Method Detail

disableSystemExit

public static void disableSystemExit()

Disable the use of System.exit for testing.

disableSystemHalt

public static void disableSystemHalt()

Disable the use of Runtime.getRuntime().halt() for testing.

terminateCalled

public static boolean terminateCalled()

Returns:

true if terminate has been called

haltCalled

public static boolean haltCalled()

Returns:

true if halt has been called

getFirstExitException

public static ExitUtil.ExitException getFirstExitException()

Returns:

the first ExitException thrown, null if none thrown yet

getFirstHaltException

public static ExitUtil.HaltException getFirstHaltException()

Returns:

the first HaltException thrown, null if none thrown yet

resetFirstExitException

public static void resetFirstExitException()

Reset the tracking of process termination. This is for use in unit tests where one test in the suite expects an exit but others do not.

resetFirstHaltException

public static void resetFirstHaltException()

terminate

public static void terminate(int status,
             String msg)
                      throws ExitUtil.ExitException

Terminate the current process. Note that terminate is the *only* method that should be used to terminate the daemon processes.

Parameters:

status - exit code

msg - message used to create the ExitException

Throws:

ExitUtil.ExitException - if System.exit is disabled for test purposes

halt

public static void halt(int status,
        String msg)
                 throws ExitUtil.HaltException

Forcibly terminates the currently running Java virtual machine.

Parameters:

status - exit code

msg - message used to create the HaltException

Throws:

ExitUtil.HaltException - if Runtime.getRuntime().halt() is disabled for test purposes

terminate

public static void terminate(int status,
             Throwable t)
                      throws ExitUtil.ExitException

Like terminate(int, String) but uses the given throwable to initialize the ExitException.

Parameters:

status -

t - throwable used to create the ExitException

Throws:

ExitUtil.ExitException - if System.exit is disabled for test purposes

halt

public static void halt(int status,
        Throwable t)
                 throws ExitUtil.HaltException

Forcibly terminates the currently running Java virtual machine.

Parameters:

status -

t -

Throws:

ExitUtil.ExitException

ExitUtil.HaltException

terminate

public static void terminate(int status)
                      throws ExitUtil.ExitException

Like terminate(int, String) without a message.

Parameters:

status -

Throws:

ExitUtil.ExitException - if System.exit is disabled for test purposes

halt

public static void halt(int status)
                 throws ExitUtil.HaltException

Forcibly terminates the currently running Java virtual machine.

Parameters:

status -

Throws:

ExitUtil.ExitException

ExitUtil.HaltException