net.greghaines.jesque.worker

Interface JobExecutor

All Known Subinterfaces:

Admin, Worker

All Known Implementing Classes:

AdminImpl, WorkerImpl, WorkerPool

public interface JobExecutor

JobExecutor is an object that executes jobs.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JobExecutor.State States of the job executor.

Method Summary

Methods

Modifier and Type	Method and Description
void	end(boolean now) Shutdown this JobExecutor.
ExceptionHandler	getExceptionHandler() The current exception handler.
JobFactory	getJobFactory() The job factory.
boolean	isProcessingJob() Returns whether this JobExecutor is currently processing a job.
boolean	isShutdown() Returns whether this JobExecutor is either shutdown or in the process of shutting down.
void	join(long millis) Wait for this JobExecutor to complete.
void	setExceptionHandler(ExceptionHandler exceptionHandler) Set this JobExecutor's exception handler to the given handler.

Method Detail

getJobFactory

JobFactory getJobFactory()

The job factory.

Returns:

the job factory

getExceptionHandler

ExceptionHandler getExceptionHandler()

The current exception handler.

Returns:

the current exception handler

setExceptionHandler

void setExceptionHandler(ExceptionHandler exceptionHandler)

Set this JobExecutor's exception handler to the given handler.

Parameters:

exceptionHandler - the exception handler to use

end

void end(boolean now)

Shutdown this JobExecutor.

Parameters:

now - if true, an effort will be made to stop any job in progress

isShutdown

boolean isShutdown()

Returns whether this JobExecutor is either shutdown or in the process of shutting down.

Returns:

true if this JobExecutor is either shutdown or in the process of shutting down

isProcessingJob

boolean isProcessingJob()

Returns whether this JobExecutor is currently processing a job.

Returns:

true if this JobExecutor is currently processing a job

join

void join(long millis)
          throws InterruptedException

Wait for this JobExecutor to complete. A timeout of 0 means to wait forever. This method will only return after a thread has called end(boolean).

Parameters:

millis - the time to wait in milliseconds

Throws:

InterruptedException - if any thread has interrupted the current thread