net.greghaines.jesque.worker

Interface JobExecutor

All Known Subinterfaces:

Admin, Worker

All Known Implementing Classes:

AdminImpl, WorkerExitOnEmpty, WorkerImpl, WorkerPool

public interface JobExecutor

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JobExecutor.State

Method Summary

Methods

Modifier and Type	Method and Description
void	addJobType(String jobName, Class<?> jobType) Allow the given job type to be executed.
void	end(boolean now) Shutdown this JobExecutor.
ExceptionHandler	getExceptionHandler() The current exception handler.
Map<String,Class<?>>	getJobTypes() The allowed job names and types that this JobExecutor will execute.
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	removeJobName(String jobName) Disallow the job name from being executed.
void	removeJobType(Class<?> jobType) Disallow the job type from being executed.
void	setExceptionHandler(ExceptionHandler exceptionHandler) Set this JobExecutor's exception handler to the given handler.
void	setJobTypes(Map<String,? extends Class<?>> jobTypes) Clear any current allowed job types and use the given set.

Method Detail

getJobTypes

Map<String,Class<?>> getJobTypes()

The allowed job names and types that this JobExecutor will execute.

Returns:

an unmodifiable view of the allowed job names and types

addJobType

void addJobType(String jobName,
              Class<?> jobType)

Allow the given job type to be executed.

Parameters:

jobName - the job name as seen

jobType - the job type to allow

removeJobType

void removeJobType(Class<?> jobType)

Disallow the job type from being executed.

Parameters:

jobType - the job type to disallow

removeJobName

void removeJobName(String jobName)

Disallow the job name from being executed.

Parameters:

jobName - the job name to disallow

setJobTypes

void setJobTypes(Map<String,? extends Class<?>> jobTypes)

Clear any current allowed job types and use the given set.

Parameters:

jobTypes - the job types to allow

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