net.greghaines.jesque.worker

Class WorkerPool

java.lang.Object

net.greghaines.jesque.worker.WorkerPool

All Implemented Interfaces:

Runnable, JobExecutor, Worker, WorkerEventEmitter

public class WorkerPool
extends Object
implements Worker

Creates a fixed number of identical Workers, each on a separate Thread.

Author:

Greg Haines

Nested Class Summary

Nested classes/interfaces inherited from interface net.greghaines.jesque.worker.JobExecutor

JobExecutor.State

Field Summary

Fields inherited from interface net.greghaines.jesque.worker.Worker

ALL_QUEUES

Constructor Summary

Constructors

Constructor and Description
WorkerPool(Callable<? extends Worker> workerFactory, int numWorkers) Create a WorkerPool with the given number of Workers and the default ThreadFactory.
WorkerPool(Callable<? extends Worker> workerFactory, int numWorkers, ThreadFactory threadFactory) Create a WorkerPool with the given number of Workers and the given ThreadFactory.

Method Summary

Methods

Modifier and Type	Method and Description
void	addJobType(String jobName, Class<?> jobType) Allow the given job type to be executed.
void	addListener(WorkerListener listener) Register a WorkerListener for all WorkerEvents.
void	addListener(WorkerListener listener, WorkerEvent... events) Register a WorkerListener for the specified WorkerEvents.
void	addQueue(String queueName) Poll the given queue.
void	end(boolean now) Shutdown this JobExecutor.
void	endAndJoin(boolean now, long millis) Shutdown this pool and wait millis time per thread or until all threads are finished if millis is 0.
ExceptionHandler	getExceptionHandler() The current exception handler.
Map<String,Class<?>>	getJobTypes() The allowed job names and types that this JobExecutor will execute.
String	getName() Returns the name of this Worker.
Collection<String>	getQueues() The queues that this Worker will poll.
boolean	isPaused() Returns whether this worker is paused.
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) Join to internal threads and wait millis time per thread or until all threads are finished if millis is 0.
void	removeAllListeners() Unregister all WorkerListeners for all WorkerEvents.
void	removeAllListeners(WorkerEvent... events) Unregister all WorkerListeners for the specified WorkerEvents.
void	removeAllQueues() Stop polling all queues.
void	removeJobName(String jobName) Disallow the job name from being executed.
void	removeJobType(Class<?> jobType) Disallow the job type from being executed.
void	removeListener(WorkerListener listener) Unregister a WorkerListener for all WorkerEvents.
void	removeListener(WorkerListener listener, WorkerEvent... events) Unregister a WorkerListener for the specified WorkerEvents.
void	removeQueue(String queueName, boolean all) Stop polling the given queue.
void	run()
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.
void	setQueues(Collection<String> queues) Clear any current queues and poll the given queues.
void	togglePause(boolean paused) Toggle whether this worker will process any new jobs.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkerPool

public WorkerPool(Callable<? extends Worker> workerFactory,
          int numWorkers)

Create a WorkerPool with the given number of Workers and the default ThreadFactory.

Parameters:

workerFactory - a Callable that returns an implementation of Worker

numWorkers - the number of Workers to create

WorkerPool

public WorkerPool(Callable<? extends Worker> workerFactory,
          int numWorkers,
          ThreadFactory threadFactory)

Create a WorkerPool with the given number of Workers and the given ThreadFactory.

Parameters:

workerFactory - a Callable that returns an implementation of Worker

numWorkers - the number of Workers to create

threadFactory - the factory to create pre-configured Threads

Method Detail

endAndJoin

public void endAndJoin(boolean now,
              long millis)
                throws InterruptedException

Shutdown this pool and wait millis time per thread or until all threads are finished if millis is 0.

Parameters:

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

millis - the time to wait in milliseconds for the threads to join; a timeout of 0 means to wait forever.

Throws:

InterruptedException - if any thread has interrupted the current thread. The interrupted status of the current thread is cleared when this exception is thrown.

join

public void join(long millis)
          throws InterruptedException

Join to internal threads and wait millis time per thread or until all threads are finished if millis is 0.

Specified by:

join in interface JobExecutor

Parameters:

millis - the time to wait in milliseconds for the threads to join; a timeout of 0 means to wait forever.

Throws:

InterruptedException - if any thread has interrupted the current thread. The interrupted status of the current thread is cleared when this exception is thrown.

getName

public String getName()

Description copied from interface: Worker

Returns the name of this Worker.

Specified by:

getName in interface Worker

Returns:

the name of this Worker

run

public void run()

Specified by:

run in interface Runnable

addListener

public void addListener(WorkerListener listener)

Description copied from interface: WorkerEventEmitter

Register a WorkerListener for all WorkerEvents.

Specified by:

addListener in interface WorkerEventEmitter

Parameters:

listener - the WorkerListener to register

addListener

public void addListener(WorkerListener listener,
               WorkerEvent... events)

Description copied from interface: WorkerEventEmitter

Register a WorkerListener for the specified WorkerEvents.

Specified by:

addListener in interface WorkerEventEmitter

Parameters:

listener - the WorkerListener to register

events - the WorkerEvents to be notified of

removeListener

public void removeListener(WorkerListener listener)

Description copied from interface: WorkerEventEmitter

Unregister a WorkerListener for all WorkerEvents.

Specified by:

removeListener in interface WorkerEventEmitter

Parameters:

listener - the WorkerListener to unregister

removeListener

public void removeListener(WorkerListener listener,
                  WorkerEvent... events)

Description copied from interface: WorkerEventEmitter

Unregister a WorkerListener for the specified WorkerEvents.

Specified by:

removeListener in interface WorkerEventEmitter

Parameters:

listener - the WorkerListener to unregister

events - the WorkerEvents to no longer be notified of

removeAllListeners

public void removeAllListeners()

Description copied from interface: WorkerEventEmitter

Unregister all WorkerListeners for all WorkerEvents.

Specified by:

removeAllListeners in interface WorkerEventEmitter

removeAllListeners

public void removeAllListeners(WorkerEvent... events)

Description copied from interface: WorkerEventEmitter

Unregister all WorkerListeners for the specified WorkerEvents.

Specified by:

removeAllListeners in interface WorkerEventEmitter

Parameters:

events - the WorkerEvents to no longer be notified of

end

public void end(boolean now)

Description copied from interface: JobExecutor

Shutdown this JobExecutor.

Specified by:

end in interface JobExecutor

Parameters:

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

isShutdown

public boolean isShutdown()

Description copied from interface: JobExecutor

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

Specified by:

isShutdown in interface JobExecutor

Returns:

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

isPaused

public boolean isPaused()

Description copied from interface: Worker

Returns whether this worker is paused.

Specified by:

isPaused in interface Worker

Returns:

whether this worker is paused. If true, the worker is not processing any new jobs; if false, the worker is processing new jobs

togglePause

public void togglePause(boolean paused)

Description copied from interface: Worker

Toggle whether this worker will process any new jobs.

Specified by:

togglePause in interface Worker

Parameters:

paused - if true, the worker will not process any new jobs; if false, the worker will process new jobs

isProcessingJob

public boolean isProcessingJob()

Description copied from interface: JobExecutor

Returns whether this JobExecutor is currently processing a job.

Specified by:

isProcessingJob in interface JobExecutor

Returns:

true if this JobExecutor is currently processing a job

getQueues

public Collection<String> getQueues()

Description copied from interface: Worker

The queues that this Worker will poll.

Specified by:

getQueues in interface Worker

Returns:

an unmodifiable view of the queues to be polled

addQueue

public void addQueue(String queueName)

Description copied from interface: Worker

Poll the given queue. If the queue exists multiple times, it will be checked that many times per loop. This allows for a queue to be given higher priority by checking it more often.

Specified by:

addQueue in interface Worker

Parameters:

queueName - the name of the queue to poll

removeQueue

public void removeQueue(String queueName,
               boolean all)

Description copied from interface: Worker

Stop polling the given queue. If the all argument is true, all instances of the queue will be removed, otherwise, only one instance is removed.

Specified by:

removeQueue in interface Worker

Parameters:

queueName - the queue to stop polling

all - whether to remove all or only one of the instances

removeAllQueues

public void removeAllQueues()

Description copied from interface: Worker

Stop polling all queues.

Specified by:

removeAllQueues in interface Worker

setQueues

public void setQueues(Collection<String> queues)

Description copied from interface: Worker

Clear any current queues and poll the given queues.

Specified by:

setQueues in interface Worker

Parameters:

queues - the queues to poll

getJobTypes

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

Description copied from interface: JobExecutor

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

Specified by:

getJobTypes in interface JobExecutor

Returns:

an unmodifiable view of the allowed job names and types

addJobType

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

Description copied from interface: JobExecutor

Allow the given job type to be executed.

Specified by:

addJobType in interface JobExecutor

Parameters:

jobName - the job name as seen

jobType - the job type to allow

removeJobType

public void removeJobType(Class<?> jobType)

Description copied from interface: JobExecutor

Disallow the job type from being executed.

Specified by:

removeJobType in interface JobExecutor

Parameters:

jobType - the job type to disallow

removeJobName

public void removeJobName(String jobName)

Description copied from interface: JobExecutor

Disallow the job name from being executed.

Specified by:

removeJobName in interface JobExecutor

Parameters:

jobName - the job name to disallow

setJobTypes

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

Description copied from interface: JobExecutor

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

Specified by:

setJobTypes in interface JobExecutor

Parameters:

jobTypes - the job types to allow

getExceptionHandler

public ExceptionHandler getExceptionHandler()

Description copied from interface: JobExecutor

The current exception handler.

Specified by:

getExceptionHandler in interface JobExecutor

Returns:

the current exception handler.

setExceptionHandler

public void setExceptionHandler(ExceptionHandler exceptionHandler)

Description copied from interface: JobExecutor

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

Specified by:

setExceptionHandler in interface JobExecutor

Parameters:

exceptionHandler - the exception handler to use