net.openhft.chronicle.core.onoes

Class ThreadLocalisedExceptionHandler

java.lang.Object

net.openhft.chronicle.core.onoes.ThreadLocalisedExceptionHandler

All Implemented Interfaces:

ExceptionHandler

public class ThreadLocalisedExceptionHandler
extends Object
implements ExceptionHandler

Provides a per-thread ExceptionHandler.

The handler supplied to the constructor becomes the default. Each thread may override this via threadLocalHandler(ExceptionHandler) and the override can be removed with resetThreadLocalHandler(). Nested ChainedExceptionHandler instances are rejected by defaultHandler(ExceptionHandler).

This class is conditionally thread-safe: the default handler is shared while per-thread handlers are isolated using ThreadLocal.

See Also:

ChainedExceptionHandler

Constructor Summary

Constructors

Constructor and Description
ThreadLocalisedExceptionHandler(ExceptionHandler handler) Creates a new instance using the supplied handler as the default.

Method Summary

Modifier and Type	Method and Description
ExceptionHandler	defaultHandler() Returns the current default handler.
ThreadLocalisedExceptionHandler	defaultHandler(ExceptionHandler defaultHandler) Sets the default handler to use when no thread-local handler is present.
boolean	isEnabled(@NotNull Class<?> aClass) Checks if the exception handler is enabled for the given class.
void	on(@NotNull Class<?> clazz, @Nullable String message, @Nullable Throwable thrown) Handles an exception for the given class, message and throwable.
void	on(@NotNull org.slf4j.Logger logger, @Nullable String message, Throwable thrown) Handles an exception with the given logger, message and throwable.
void	resetThreadLocalHandler() Clears any thread specific handler so the default will be used.
ExceptionHandler	threadLocalHandler() Returns the handler specific to the current thread or null if none is set.
ThreadLocalisedExceptionHandler	threadLocalHandler(ExceptionHandler handler) Overrides the handler for the current thread.
static ExceptionHandler	unwrap(ExceptionHandler eh) Unwraps the supplied handler if it is an instance of this class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.core.onoes.ExceptionHandler

ignoresEverything, on, on, on

Constructor Detail

ThreadLocalisedExceptionHandler

public ThreadLocalisedExceptionHandler(ExceptionHandler handler)

Creates a new instance using the supplied handler as the default.

Parameters:

handler - the handler used when no thread-local handler is present

Method Detail

on

public void on(@NotNull
               @NotNull Class<?> clazz,
               @Nullable
               @Nullable String message,
               @Nullable
               @Nullable Throwable thrown)

Description copied from interface: ExceptionHandler

Handles an exception for the given class, message and throwable. If logging fails this method attempts to log again at Slf4jExceptionHandler.ERROR level.

Specified by:

on in interface ExceptionHandler

Parameters:

clazz - the class where the exception occurred

message - a custom message providing additional information or null

thrown - the exception that needs to be handled, may be null

on

public void on(@NotNull
               @NotNull org.slf4j.Logger logger,
               @Nullable
               @Nullable String message,
               Throwable thrown)

Description copied from interface: ExceptionHandler

Handles an exception with the given logger, message and throwable.

Specified by:

on in interface ExceptionHandler

Parameters:

logger - the logger used to record the error

message - a custom message detailing the error, may be null

thrown - the throwable instance representing the error, may be null

defaultHandler

public ExceptionHandler defaultHandler()

Returns the current default handler.

Specified by:

defaultHandler in interface ExceptionHandler

Returns:

the default handler in use

unwrap

public static ExceptionHandler unwrap(ExceptionHandler eh)

Unwraps the supplied handler if it is an instance of this class.

Parameters:

eh - the handler to unwrap

Returns:

the underlying handler or the supplied instance if it is not wrapped

defaultHandler

public ThreadLocalisedExceptionHandler defaultHandler(ExceptionHandler defaultHandler)

Sets the default handler to use when no thread-local handler is present. Nested ChainedExceptionHandler instances are rejected.

Parameters:

defaultHandler - the new default handler, or null to use NullExceptionHandler.NOTHING

Returns:

this for chaining

threadLocalHandler

public ExceptionHandler threadLocalHandler()

Returns the handler specific to the current thread or null if none is set.

Returns:

the thread-local handler or null

threadLocalHandler

public ThreadLocalisedExceptionHandler threadLocalHandler(ExceptionHandler handler)

Overrides the handler for the current thread.

Parameters:

handler - the handler to install for this thread, may be null

Returns:

this for chaining

resetThreadLocalHandler

public void resetThreadLocalHandler()

Clears any thread specific handler so the default will be used.

isEnabled

public boolean isEnabled(@NotNull
                         @NotNull Class<?> aClass)

Checks if the exception handler is enabled for the given class.

Specified by:

isEnabled in interface ExceptionHandler

Parameters:

aClass - the class to test

Returns:

true if this handler should be invoked for the class