org.apache.twill.api

Interface TwillRunnable

All Superinterfaces:

Runnable

All Known Implementing Classes:

AbstractTwillRunnable, BundledJarRunnable

public interface TwillRunnable
extends Runnable

The TwillRunnable interface should be implemented by any class whose instances are intended to be executed in a Twill cluster.

Method Summary

Modifier and Type	Method and Description
TwillRunnableSpecification	configure() Called at submission time.
void	destroy() Called when the Runnable.run() completed.
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 interface java.lang.Runnable

run

Method Detail

configure

TwillRunnableSpecification configure()

Called at submission time. Executed on the client side.

Returns:

A TwillRunnableSpecification built by TwillRunnableSpecification.Builder.

initialize

void initialize(TwillContext context)

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

Parameters:

context - Contains information about the runtime context.

handleCommand

void handleCommand(Command command)
            throws Exception

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

Parameters:

command - Contains details of the command.

Throws:

Exception

stop

void stop()

Requests to stop the running service.

destroy

void destroy()

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