com.conversantmedia.mapreduce.tool.event

Interface ToolListener<T>

Type Parameters:

T - the driver context bean type

All Known Implementing Classes:

Driver.NULLLISTENER, Tool.NULLLISTENER, ToolListenerAdapter

public interface ToolListener<T>

An event listener that may register to be informed of events on the driver.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ToolListener.Event

Method Summary

Modifier and Type	Method and Description
void	onAfterInitCliOptions(ToolEvent<T> event, org.apache.commons.cli.Options options) Called immediately following CLI initialization.
void	onAfterMapReduceFinish(int retVal, ToolEvent<T> event) Called following a MapReduce job run.
void	onAfterParseCli(ToolEvent<T> event, org.apache.commons.cli.CommandLine line) Called immediately following CLI initialization.
void	onBeforeExit(ToolEvent<T> event) Called just prior to exit but after the default 'cleanup'
void	onBeforeInitDriver(String id, ToolEvent<T> event) Called just prior to BaseTool.init being called.
void	onBeforeInitJob(ToolEvent<T> event) Called just prior to BaseTool.initJob being called.
void	onBeforeMapReduceSubmit(ToolEvent<T> event) Called just prior to submitting MR job.
void	onJobException(ToolEvent<T> event, Exception e) Called if the job throws an exception.

Method Detail

onAfterInitCliOptions

void onAfterInitCliOptions(ToolEvent<T> event,
                           org.apache.commons.cli.Options options)
                    throws Exception

Called immediately following CLI initialization.

Parameters:

event - the event that occurred the event that occurred

options - the driver's parsed command line options

Throws:

Exception - if an exception occurs during handling

onAfterParseCli

void onAfterParseCli(ToolEvent<T> event,
                     org.apache.commons.cli.CommandLine line)
              throws Exception

Called immediately following CLI initialization.

Parameters:

event - the event that occurred

line - the command line arguments

Throws:

Exception - if an exception occurs during handling

onBeforeInitDriver

void onBeforeInitDriver(String id,
                        ToolEvent<T> event)
                 throws Exception

Called just prior to BaseTool.init being called.

Parameters:

id - the uuid generated for this driver instance

event - the event that occurred

Throws:

Exception - if an exception occurs during handling

onBeforeInitJob

void onBeforeInitJob(ToolEvent<T> event)
              throws Exception

Called just prior to BaseTool.initJob being called.

Parameters:

event - the event that occurred

Throws:

Exception - if an exception occurs during handling

onBeforeMapReduceSubmit

void onBeforeMapReduceSubmit(ToolEvent<T> event)
                      throws Exception

Called just prior to submitting MR job.

Parameters:

event - the event that occurred

Throws:

Exception - if an exception occurs during handling

onAfterMapReduceFinish

void onAfterMapReduceFinish(int retVal,
                            ToolEvent<T> event)
                     throws Exception

Called following a MapReduce job run.

Parameters:

retVal - the application exit code

event - the event that occurred

Throws:

Exception - if an exception occurs during handling

onBeforeExit

void onBeforeExit(ToolEvent<T> event)
           throws Exception

Called just prior to exit but after the default 'cleanup'

Parameters:

event - the event that occurred

Throws:

Exception - if an exception occurs during handling

onJobException

void onJobException(ToolEvent<T> event,
                    Exception e)
             throws Exception

Called if the job throws an exception.

Parameters:

event - the event that occurred

e - the exception encountered

Throws:

Exception - if an exception occurs during handling