io.cdap.cdap.api.worker

Interface Worker

All Superinterfaces:

ProgramLifecycle<WorkerContext>, Runnable

All Known Implementing Classes:

AbstractWorker, PartitionExploreCorrector.PartitionWorker

public interface Worker
extends Runnable, ProgramLifecycle<WorkerContext>

Defines a Worker.

Method Summary

Modifier and Type	Method and Description
void	configure(WorkerConfigurer configurer) Configure a Worker.
void	destroy() Destroy the Worker.
void	initialize(WorkerContext context) Initialize the Worker.
void	stop() Stop the Worker.

Methods inherited from interface java.lang.Runnable

run

Method Detail

configure

void configure(WorkerConfigurer configurer)

Configure a Worker.

initialize

void initialize(WorkerContext context)
         throws Exception

Initialize the Worker. Note that unlike most program types, this method is not called within an implicit transaction, but instead it can start its own transactions using Transactional.execute(TxRunnable). methods.

Specified by:

initialize in interface ProgramLifecycle<WorkerContext>

Parameters:

context - An instance of RuntimeContext

Throws:

Exception - If there is any error during initialization.

destroy

void destroy()

Destroy the Worker. Note that unlike most program types, this method is not called within an implicit transaction, but instead it can start its own transactions using Transactional.execute(TxRunnable).

Specified by:

destroy in interface ProgramLifecycle<WorkerContext>

stop

void stop()

Stop the Worker. This method will be invoked whenever the worker is externally stopped by CDAP. This method will be invoked from a different thread than the one calling the Runnable.run() method.