com.ebay.bascomtask.runners

Class LogTaskRunner

java.lang.Object

com.ebay.bascomtask.runners.LogTaskRunner

All Implemented Interfaces:

TaskRunner

public class LogTaskRunner
extends Object
implements TaskRunner

Logs task execution before and after, with a configurable level and detail. A completion message is also logged if the completion (of a CompletableFuture) occurs after message exit.

Author:

Brendan McCarthy

Constructor Summary

Constructors

Constructor and Description
LogTaskRunner()

Method Summary

Modifier and Type	Method and Description
Object	before(TaskRun taskRun) Called before TaskRunner.executeTaskMethod(TaskRun, Thread, Object), but in the parent thread.
Object	executeTaskMethod(TaskRun taskRun, Thread parentThread, Object fromBefore) Task invocation -- an implementation should invoke TaskRun.run() to complete the invocation (unless there is some reason to prevent it, but then the implementation must take responsibility to ensure the all CompletableFuture return values are completed).
void	onComplete(TaskRun taskRun, Object fromBefore, boolean doneOnExit) Called once any CompletableFuture return result completes, which may be before the call to TaskRun.run() or after if a method returns an incomplete CompletableFuture.
void	setFullSignatureLogging(boolean full) Makes log output include actual method arguments.
void	setLevel(LogTaskLevel level) Set debug level.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogTaskRunner

public LogTaskRunner()

Method Detail

setLevel

public void setLevel(LogTaskLevel level)

Set debug level. This does not configure the level, which must be done in any slf4j-conformant manner.

Parameters:

level - to use

setFullSignatureLogging

public void setFullSignatureLogging(boolean full)

Makes log output include actual method arguments.

Parameters:

full - include method arguments or not

before

public Object before(TaskRun taskRun)

Description copied from interface: TaskRunner

Called before TaskRunner.executeTaskMethod(TaskRun, Thread, Object), but in the parent thread. If there is no immediate spawning then it will be the same thread. The returned object will simply be passed to executeTaskMethod and is otherwise not read or modified by the framework.

Specified by:

before in interface TaskRunner

Parameters:

taskRun - that will also be passed to executeTaskMethod

Returns:

a possibly-null object to pass to executeTaskMethod

executeTaskMethod

public Object executeTaskMethod(TaskRun taskRun,
                                Thread parentThread,
                                Object fromBefore)

Description copied from interface: TaskRunner

Task invocation -- an implementation should invoke TaskRun.run() to complete the invocation (unless there is some reason to prevent it, but then the implementation must take responsibility to ensure the all CompletableFuture return values are completed). A typical subclass implementation would be to simply surround the call, e.g.:

     public Object executeTaskMethod(TaskRun taskRun, Thread parentThread, Object fromBefore) {
         LOG.info("STARTED " + taskRun.getTaskPlusMethodName());
         try {
             taskRun.run()
         } finally {
             LOG.info("ENDED " + taskRun.getTaskPlusMethodName());
         }
     }
 

Specified by:

executeTaskMethod in interface TaskRunner

Parameters:

taskRun - to execute

parentThread - of spawned task, which may be same as Thread.currentThread()

fromBefore - value returned from TaskRunner.before(TaskRun)

Returns:

return value from task invocation

onComplete

public void onComplete(TaskRun taskRun,
                       Object fromBefore,
                       boolean doneOnExit)

Description copied from interface: TaskRunner

Called once any CompletableFuture return result completes, which may be before the call to TaskRun.run() or after if a method returns an incomplete CompletableFuture.

The provided doneOnExit parameter indicates whether a CompletableFuture return value had isDone()==true when the method completed. This should not be taken as very close but not exactly precise, since there are very small time intervals involved in the steps behind making that determination.

Specified by:

onComplete in interface TaskRunner

Parameters:

taskRun - that was executed

fromBefore - value returned from TaskRunner.before(TaskRun)

doneOnExit - false iff a CompletableFuture was returned and it was not done when the method exited