net.greghaines.jesque.admin

Class AdminImpl

java.lang.Object

net.greghaines.jesque.admin.AdminImpl

All Implemented Interfaces:

Runnable, Admin, JobExecutor

public class AdminImpl
extends Object
implements Admin

AdminImpl receives administrative jobs for a worker.

Author:

Greg Haines

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdminImpl.PubSubListener

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

JobExecutor.State

Field Summary

Fields

Modifier and Type	Field and Description
protected redis.clients.jedis.Jedis	jedis
protected AdminImpl.PubSubListener	jedisPubSub
protected String	namespace
protected AtomicReference<JobExecutor.State>	state
protected AtomicReference<Worker>	workerRef

Constructor Summary

Constructors

Constructor and Description
AdminImpl(Config config) Create a new AdminImpl which subscribes to ResqueConstants.ADMIN_CHANNEL, registers the PauseCommand and ShutdownCommand jobs, and creates a new Jedis connection.
AdminImpl(Config config, Set<String> channels, JobFactory jobFactory) Create a new AdminImpl which creates a new Jedis connection.
AdminImpl(Config config, Set<String> channels, JobFactory jobFactory, redis.clients.jedis.Jedis jedis) Create a new AdminImpl.

Method Summary

Modifier and Type	Method and Description
protected static void	checkChannels(Iterable<String> channels) Verify that the given channels are all valid.
void	end(boolean now) Shutdown this JobExecutor.
protected Object	execute(Job job, String curQueue, Object instance) Executes the given job.
Set<String>	getChannels()
ExceptionHandler	getExceptionHandler() The current exception handler.
JobFactory	getJobFactory() The job factory.
protected int	getReconnectAttempts()
Worker	getWorker()
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.
protected void	recoverFromException(String channel, Exception e) Handle an exception that was thrown from inside AdminImpl.PubSubListener.onMessage(String,String).
void	run()
void	setChannels(Set<String> channels)
void	setExceptionHandler(ExceptionHandler exceptionHandler) Set this JobExecutor's exception handler to the given handler.
void	setWorker(Worker worker)

Methods inherited from class java.lang.Object

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

Field Detail

jedis

protected final redis.clients.jedis.Jedis jedis

namespace

protected final String namespace

jedisPubSub

protected final AdminImpl.PubSubListener jedisPubSub

workerRef

protected final AtomicReference<Worker> workerRef

state

protected final AtomicReference<JobExecutor.State> state

Constructor Detail

AdminImpl

public AdminImpl(Config config)

Create a new AdminImpl which subscribes to ResqueConstants.ADMIN_CHANNEL, registers the PauseCommand and ShutdownCommand jobs, and creates a new Jedis connection.

Parameters:

config - the Jesque configuration

AdminImpl

public AdminImpl(Config config,
                 Set<String> channels,
                 JobFactory jobFactory)

Create a new AdminImpl which creates a new Jedis connection.

Parameters:

config - the Jesque configuration

channels - the channels to subscribe to

jobFactory - the job factory that materializes the jobs

AdminImpl

public AdminImpl(Config config,
                 Set<String> channels,
                 JobFactory jobFactory,
                 redis.clients.jedis.Jedis jedis)

Create a new AdminImpl.

Parameters:

config - the Jesque configuration

channels - the channels to subscribe to

jobFactory - the job factory that materializes the jobs

jedis - the connection to Redis

Method Detail

run

public void run()

Specified by:

run in interface Runnable

getChannels

public Set<String> getChannels()

Specified by:

getChannels in interface Admin

Returns:

the set of subscribed Redis Pub/Sub channels

setChannels

public void setChannels(Set<String> channels)

Specified by:

setChannels in interface Admin

Parameters:

channels - the set of Redis Pub/Sub channels to subscribe to

getWorker

public Worker getWorker()

Specified by:

getWorker in interface Admin

Returns:

the worker this admin controls

setWorker

public void setWorker(Worker worker)

Specified by:

setWorker in interface Admin

Parameters:

worker - the worker this admin controls

end

public void end(boolean now)

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()

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

isProcessingJob

public boolean isProcessingJob()

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

join

public 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 JobExecutor.end(boolean).

Specified by:

join in interface JobExecutor

Parameters:

millis - the time to wait in milliseconds

Throws:

InterruptedException - if any thread has interrupted the current thread

getJobFactory

public JobFactory getJobFactory()

The job factory.

Specified by:

getJobFactory in interface JobExecutor

Returns:

the job factory

getExceptionHandler

public ExceptionHandler getExceptionHandler()

The current exception handler.

Specified by:

getExceptionHandler in interface JobExecutor

Returns:

the current exception handler

setExceptionHandler

public void setExceptionHandler(ExceptionHandler exceptionHandler)

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

Specified by:

setExceptionHandler in interface JobExecutor

Parameters:

exceptionHandler - the exception handler to use

execute

protected Object execute(Job job,
                         String curQueue,
                         Object instance)
                  throws Exception

Executes the given job.

Parameters:

job - the job to execute

curQueue - the queue the job came from

instance - the materialized job

Returns:

the result of the job execution

Throws:

Exception - if the instance is a Callable and throws an exception

getReconnectAttempts

protected int getReconnectAttempts()

Returns:

the number of times this Admin will attempt to reconnect to Redis before giving up

recoverFromException

protected void recoverFromException(String channel,
                                    Exception e)

Handle an exception that was thrown from inside AdminImpl.PubSubListener.onMessage(String,String).

Parameters:

channel - the name of the channel that was being processed when the exception was thrown

e - the exception that was thrown

checkChannels

protected static void checkChannels(Iterable<String> channels)

Verify that the given channels are all valid.

Parameters:

channels - the given channels