org.opendaylight.infrautils.utils.concurrent

Class LoggingUncaughtThreadDeathContextRunnable

java.lang.Object

org.opendaylight.infrautils.utils.concurrent.LoggingUncaughtThreadDeathContextRunnable

All Implemented Interfaces:

Runnable

public abstract class LoggingUncaughtThreadDeathContextRunnable
extends Object
implements Runnable

Runnable with final run() method that catches any unexpected checked exceptions (RuntimeException & Error) and logs them with some kind of context which allows to better identify the root cause.

Author:

Michael Vorburger.ch

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LoggingUncaughtThreadDeathContextRunnable(org.slf4j.Logger logger, Supplier<String> debugLogContextSupplier) Constructor.

Method Summary

Modifier and Type	Method and Description
void	run() Final run() method; subclasses implement runWithUncheckedExceptionLogging() instead of this.
protected abstract void	runWithUncheckedExceptionLogging() Run method which you implement instead of the original run().
static Runnable	wrap(Runnable runnable, org.slf4j.Logger logger, Supplier<String> debugLogContextSupplier) Wraps an existing Runnable.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingUncaughtThreadDeathContextRunnable

protected LoggingUncaughtThreadDeathContextRunnable(org.slf4j.Logger logger,
                                                    Supplier<String> debugLogContextSupplier)

Constructor.

Parameters:

logger - the Logger of the class which created this Runnable

debugLogContextSupplier - supplies useful context included in error log in case of caught checked exception

Method Detail

wrap

public static Runnable wrap(Runnable runnable,
                            org.slf4j.Logger logger,
                            Supplier<String> debugLogContextSupplier)

Wraps an existing Runnable.

Parameters:

logger - the Logger of the class which created this Runnable

debugLogContextSupplier - supplies useful context included in error log in case of caught checked exception

run

public final void run()

Final run() method; subclasses implement runWithUncheckedExceptionLogging() instead of this.

Specified by:

run in interface Runnable

runWithUncheckedExceptionLogging

protected abstract void runWithUncheckedExceptionLogging()

Run method which you implement instead of the original run().