com.ebay.bascomtask.core

Interface TaskRunner

All Known Implementing Classes:

ConsumerTask.ConsumerTask1, ConsumerTask.ConsumerTask2, LogTaskRunner, ProfilingTaskRunner, StatTaskRunner, SupplierTask.SupplierTask0, SupplierTask.SupplierTask1, SupplierTask.SupplierTask2

public interface TaskRunner

Interface for task execution hooks that allow custom code to be inserted before and after the invocation of task methods. Implementing classes can be defined for such purposes as logging or various kinds of profiling or performance tracking. Subclass instances can be added for all Orchestrators through GlobalOrchestratorConfig or locally to any individual Orchestrator. Several built-in versions are also available.

Author:

Brendan McCarthy

See Also:

LogTaskRunner, StatTaskRunner, ProfilingTaskRunner

Method Summary

Modifier and Type	Method and Description
Object	before(TaskRun taskRun) Called before 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.

Method Detail

before

Object before(TaskRun taskRun)

Called before 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.

Parameters:

taskRun - that will also be passed to executeTaskMethod

Returns:

a possibly-null object to pass to executeTaskMethod

executeTaskMethod

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). 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());
         }
     }
 

Parameters:

taskRun - to execute

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

fromBefore - value returned from before(TaskRun)

Returns:

return value from task invocation

onComplete

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.

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.

Parameters:

taskRun - that was executed

fromBefore - value returned from before(TaskRun)

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