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

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)
AdminImpl(Config config, Set<String> channels, Map<String,? extends Class<?>> jobTypes)

Method Summary

Methods

Modifier and Type	Method and Description
void	addJobType(String jobName, Class<?> jobType) Allow the given job type to be executed.
protected static void	checkChannels(Iterable<String> channels) Verify that the given channels are all valid.
protected void	checkJobTypes(Map<String,? extends Class<?>> jobTypes) Verify the given job types 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.
Map<String,Class<?>>	getJobTypes() The allowed job names and types that this JobExecutor will execute.
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	removeJobName(String jobName) Disallow the job name from being executed.
void	removeJobType(Class<?> jobType) Disallow the job type from being executed.
void	run()
void	setChannels(Set<String> channels)
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	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)

AdminImpl

public AdminImpl(Config config,
         Set<String> channels,
         Map<String,? extends Class<?>> jobTypes)

Method Detail

run

public void run()

Specified by:

run in interface Runnable

getChannels

public Set<String> getChannels()

Specified by:

getChannels in interface Admin

setChannels

public void setChannels(Set<String> channels)

Specified by:

setChannels in interface Admin

getWorker

public Worker getWorker()

Specified by:

getWorker in interface Admin

setWorker

public void setWorker(Worker worker)

Specified by:

setWorker in interface Admin

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

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

join

public void join(long millis)
          throws InterruptedException

Description copied from interface: JobExecutor

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

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

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

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

checkJobTypes

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

Verify the given job types are all valid.

Parameters:

jobTypes - the given job types