org.apache.twill.api

Class AbstractTwillRunnable

java.lang.Object

org.apache.twill.api.AbstractTwillRunnable

All Implemented Interfaces:

Runnable, TwillRunnable

public abstract class AbstractTwillRunnable
extends Object
implements TwillRunnable

This abstract class provides default implementation of the TwillRunnable.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTwillRunnable()
protected	AbstractTwillRunnable(Map<String,String> args)

Method Summary

Modifier and Type	Method and Description
TwillRunnableSpecification	configure() Called at submission time.
void	destroy() Called when the Runnable.run() completed.
protected String	getArgument(String key)
protected Map<String,String>	getArguments()
protected TwillContext	getContext()
void	handleCommand(Command command) Called when a command is received.
void	initialize(TwillContext context) Called when the container process starts.
void	stop() Requests to stop the running service.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Constructor Detail

AbstractTwillRunnable

protected AbstractTwillRunnable()

AbstractTwillRunnable

protected AbstractTwillRunnable(Map<String,String> args)

Method Detail

configure

public TwillRunnableSpecification configure()

Description copied from interface: TwillRunnable

Called at submission time. Executed on the client side.

Specified by:

configure in interface TwillRunnable

Returns:

A TwillRunnableSpecification built by TwillRunnableSpecification.Builder.

initialize

public void initialize(TwillContext context)

Description copied from interface: TwillRunnable

Called when the container process starts. Executed in container machine. If any exception is thrown from this method, this runnable won't get retry.

Specified by:

initialize in interface TwillRunnable

Parameters:

context - Contains information about the runtime context.

handleCommand

public void handleCommand(Command command)
                   throws Exception

Description copied from interface: TwillRunnable

Called when a command is received. A normal return denotes the command has been processed successfully, otherwise Exception should be thrown.

Specified by:

handleCommand in interface TwillRunnable

Parameters:

command - Contains details of the command.

Throws:

Exception

stop

public void stop()

Description copied from interface: TwillRunnable

Requests to stop the running service.

Specified by:

stop in interface TwillRunnable

destroy

public void destroy()

Description copied from interface: TwillRunnable

Called when the Runnable.run() completed. Useful for doing resource cleanup. This method would only get called if the call to TwillRunnable.initialize(TwillContext) was successful.

Specified by:

destroy in interface TwillRunnable

getArguments

protected Map<String,String> getArguments()

getArgument

protected String getArgument(String key)

getContext

protected TwillContext getContext()