com.conversantmedia.mapreduce.tool.event

Class ToolListenerAdapter<T>

java.lang.Object

com.conversantmedia.mapreduce.tool.event.ToolListenerAdapter<T>

Type Parameters:

T - the driver context bean type

All Implemented Interfaces:

ToolListener<T>

Direct Known Subclasses:

Driver.NULLLISTENER, Tool.NULLLISTENER

public class ToolListenerAdapter<T>
extends Object
implements ToolListener<T>

Default base do-nothing listener to ease the burden on subclasses.

Nested Class Summary

Nested classes/interfaces inherited from interface com.conversantmedia.mapreduce.tool.event.ToolListener

ToolListener.Event

Constructor Summary

Constructors

Constructor and Description
ToolListenerAdapter()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolListenerAdapter

public ToolListenerAdapter()

Method Detail

onAfterInitCliOptions

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

Description copied from interface: ToolListener

Called immediately following CLI initialization.

Specified by:

onAfterInitCliOptions in interface ToolListener<T>

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

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

Description copied from interface: ToolListener

Called immediately following CLI initialization.

Specified by:

onAfterParseCli in interface ToolListener<T>

Parameters:

event - the event that occurred

line - the command line arguments

Throws:

Exception - if an exception occurs during handling

onBeforeInitDriver

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

Description copied from interface: ToolListener

Called just prior to BaseTool.init being called.

Specified by:

onBeforeInitDriver in interface ToolListener<T>

Parameters:

id - the uuid generated for this driver instance

event - the event that occurred

Throws:

Exception - if an exception occurs during handling

onBeforeInitJob

public void onBeforeInitJob(ToolEvent<T> event)
                     throws Exception

Description copied from interface: ToolListener

Called just prior to BaseTool.initJob being called.

Specified by:

onBeforeInitJob in interface ToolListener<T>

Parameters:

event - the event that occurred

Throws:

Exception - if an exception occurs during handling

onBeforeMapReduceSubmit

public void onBeforeMapReduceSubmit(ToolEvent<T> event)
                             throws Exception

Description copied from interface: ToolListener

Called just prior to submitting MR job.

Specified by:

onBeforeMapReduceSubmit in interface ToolListener<T>

Parameters:

event - the event that occurred

Throws:

Exception - if an exception occurs during handling

onAfterMapReduceFinish

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

Description copied from interface: ToolListener

Called following a MapReduce job run.

Specified by:

onAfterMapReduceFinish in interface ToolListener<T>

Parameters:

retVal - the application exit code

event - the event that occurred

Throws:

Exception - if an exception occurs during handling

onBeforeExit

public void onBeforeExit(ToolEvent<T> event)
                  throws Exception

Description copied from interface: ToolListener

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

Specified by:

onBeforeExit in interface ToolListener<T>

Parameters:

event - the event that occurred

Throws:

Exception - if an exception occurs during handling

onJobException

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

Description copied from interface: ToolListener

Called if the job throws an exception.

Specified by:

onJobException in interface ToolListener<T>

Parameters:

event - the event that occurred

e - the exception encountered

Throws:

Exception - if an exception occurs during handling