net.greghaines.jesque.client

Class AbstractClient

java.lang.Object

net.greghaines.jesque.client.AbstractClient

All Implemented Interfaces:

Client

Direct Known Subclasses:

ClientImpl, ClientPoolImpl

public abstract class AbstractClient
extends Object
implements Client

Common logic for Client implementations.

Author:

Greg Haines, Animesh Kumar

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractClient(Config config) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	acquireLock(String lockName, String lockHolder, int timeout) Acquire a non-blocking distributed lock.
void	batchEnqueue(String queue, List<Job> jobs) Queues jobs in a given queue to be run.
void	delayedEnqueue(String queue, Job job, long future) Queues a job in a given queue to be run in the future.
static boolean	doAcquireLock(redis.clients.jedis.Jedis jedis, String namespace, String lockName, String lockHolder, int timeout) Helper method that encapsulates the logic to acquire a lock.
protected abstract boolean	doAcquireLock(String lockName, String lockHolder, int timeout) Actually acquire the lock based upon the client acquisition model.
static void	doBatchEnqueue(redis.clients.jedis.Jedis jedis, String namespace, String queue, List<String> jobJsons) Helper method that encapsulates the minimum logic for adding jobs to a queue.
protected abstract void	doBatchEnqueue(String queue, List<String> msgs) Actually enqueue the serialized jobs.
static void	doDelayedEnqueue(redis.clients.jedis.Jedis jedis, String namespace, String queue, String jobJson, long future)
protected abstract void	doDelayedEnqueue(String queue, String msg, long future)
static void	doEnqueue(redis.clients.jedis.Jedis jedis, String namespace, String queue, String jobJson) Helper method that encapsulates the minimum logic for adding a job to a queue.
protected abstract void	doEnqueue(String queue, String msg) Actually enqueue the serialized job.
static void	doPriorityEnqueue(redis.clients.jedis.Jedis jedis, String namespace, String queue, String jobJson) Helper method that encapsulates the minimum logic for adding a high priority job to a queue.
protected abstract void	doPriorityEnqueue(String queue, String msg) Actually enqueue the serialized job with high priority.
static void	doRecurringEnqueue(redis.clients.jedis.Jedis jedis, String namespace, String queue, String jobJson, long future, long frequency)
protected abstract void	doRecurringEnqueue(String queue, String msg, long future, long frequency)
static void	doRemoveDelayedEnqueue(redis.clients.jedis.Jedis jedis, String namespace, String queue, String jobJson)
protected abstract void	doRemoveDelayedEnqueue(String queue, String msg)
static void	doRemoveRecurringEnqueue(redis.clients.jedis.Jedis jedis, String namespace, String queue, String jobJson)
protected abstract void	doRemoveRecurringEnqueue(String queue, String msg)
void	enqueue(String queue, Job job) Queues a job in a given queue to be run.
protected String	getNamespace()
protected String	key(String... parts) Builds a namespaced Redis key with the given arguments.
void	priorityEnqueue(String queue, Job job) Queues a job with high priority in a given queue to be run.
void	recurringEnqueue(String queue, Job job, long future, long frequency) Queues a job to be in the future and recur
void	removeDelayedEnqueue(String queue, Job job) Removes a queued future job.
void	removeRecurringEnqueue(String queue, Job job) Removes a queued recurring job.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.greghaines.jesque.client.Client

end

Constructor Detail

AbstractClient

protected AbstractClient(Config config)

Constructor.

Parameters:

config - used to get the namespace for key creation

Method Detail

getNamespace

protected String getNamespace()

Returns:

the namespace this client will use

key

protected String key(String... parts)

Builds a namespaced Redis key with the given arguments.

Parameters:

parts - the key parts to be joined

Returns:

an assembled String key

enqueue

public void enqueue(String queue,
                    Job job)

Queues a job in a given queue to be run.

Specified by:

enqueue in interface Client

Parameters:

queue - the queue to add the Job to

job - the job to be enqueued

batchEnqueue

public void batchEnqueue(String queue,
                         List<Job> jobs)

Queues jobs in a given queue to be run. Consider splitting long lists of jobs into chunks of 10,000 or so.

Specified by:

batchEnqueue in interface Client

Parameters:

queue - the queue to add the Job to

jobs - the jobs to be enqueued

See Also:

Redis Pipelining, Important Note: Split at 10k jobs

priorityEnqueue

public void priorityEnqueue(String queue,
                            Job job)

Queues a job with high priority in a given queue to be run.

Specified by:

priorityEnqueue in interface Client

Parameters:

queue - the queue to add the Job to

job - the job to be enqueued

acquireLock

public boolean acquireLock(String lockName,
                           String lockHolder,
                           int timeout)

Acquire a non-blocking distributed lock. Calling this method again renews the lock.

Specified by:

acquireLock in interface Client

Parameters:

lockName - the name of the lock to acquire

lockHolder - a unique string identifying the caller

timeout - number of seconds until the lock will expire

Returns:

true, if the lock was acquired, false otherwise

doEnqueue

protected abstract void doEnqueue(String queue,
                                  String msg)
                           throws Exception

Actually enqueue the serialized job.

Parameters:

queue - the queue to add the Job to

msg - the serialized Job

Throws:

Exception - in case something goes wrong

doBatchEnqueue

protected abstract void doBatchEnqueue(String queue,
                                       List<String> msgs)
                                throws Exception

Actually enqueue the serialized jobs.

Parameters:

queue - the queue to add the Jobs to

msgs - the serialized Jobs

Throws:

Exception - in case something goes wrong

doPriorityEnqueue

protected abstract void doPriorityEnqueue(String queue,
                                          String msg)
                                   throws Exception

Actually enqueue the serialized job with high priority.

Parameters:

queue - the queue to add the Job to

msg - the serialized Job

Throws:

Exception - in case something goes wrong

doAcquireLock

protected abstract boolean doAcquireLock(String lockName,
                                         String lockHolder,
                                         int timeout)
                                  throws Exception

Actually acquire the lock based upon the client acquisition model.

Parameters:

lockName - the name of the lock to acquire

timeout - number of seconds until the lock will expire

lockHolder - a unique string identifying the caller

Returns:

true, if the lock was acquired, false otherwise

Throws:

Exception - in case something goes wrong

doEnqueue

public static void doEnqueue(redis.clients.jedis.Jedis jedis,
                             String namespace,
                             String queue,
                             String jobJson)

Helper method that encapsulates the minimum logic for adding a job to a queue.

Parameters:

jedis - the connection to Redis

namespace - the Resque namespace

queue - the Resque queue name

jobJson - the job serialized as JSON

doBatchEnqueue

public static void doBatchEnqueue(redis.clients.jedis.Jedis jedis,
                                  String namespace,
                                  String queue,
                                  List<String> jobJsons)

Helper method that encapsulates the minimum logic for adding jobs to a queue.

Parameters:

jedis - the connection to Redis

namespace - the Resque namespace

queue - the Resque queue name

jobJsons - a list of jobs serialized as JSON

doPriorityEnqueue

public static void doPriorityEnqueue(redis.clients.jedis.Jedis jedis,
                                     String namespace,
                                     String queue,
                                     String jobJson)

Helper method that encapsulates the minimum logic for adding a high priority job to a queue.

Parameters:

jedis - the connection to Redis

namespace - the Resque namespace

queue - the Resque queue name

jobJson - the job serialized as JSON

doAcquireLock

public static boolean doAcquireLock(redis.clients.jedis.Jedis jedis,
                                    String namespace,
                                    String lockName,
                                    String lockHolder,
                                    int timeout)

Helper method that encapsulates the logic to acquire a lock.

Parameters:

jedis - the connection to Redis

namespace - the Resque namespace

lockName - all calls to this method will contend for a unique lock with the name of lockName

timeout - seconds until the lock will expire

lockHolder - a unique string used to tell if you are the current holder of a lock for both acquisition, and extension

Returns:

Whether or not the lock was acquired.

doDelayedEnqueue

public static void doDelayedEnqueue(redis.clients.jedis.Jedis jedis,
                                    String namespace,
                                    String queue,
                                    String jobJson,
                                    long future)

doDelayedEnqueue

protected abstract void doDelayedEnqueue(String queue,
                                         String msg,
                                         long future)
                                  throws Exception

Throws:

Exception

delayedEnqueue

public void delayedEnqueue(String queue,
                           Job job,
                           long future)

Queues a job in a given queue to be run in the future.

Specified by:

delayedEnqueue in interface Client

Parameters:

queue - the queue to add the Job to

job - the job to be enqueued

future - timestamp when the job will run

doRemoveDelayedEnqueue

public static void doRemoveDelayedEnqueue(redis.clients.jedis.Jedis jedis,
                                          String namespace,
                                          String queue,
                                          String jobJson)

doRemoveDelayedEnqueue

protected abstract void doRemoveDelayedEnqueue(String queue,
                                               String msg)
                                        throws Exception

Throws:

Exception

removeDelayedEnqueue

public void removeDelayedEnqueue(String queue,
                                 Job job)

Removes a queued future job.

Specified by:

removeDelayedEnqueue in interface Client

Parameters:

queue - the queue to remove the Job from

job - the job to be removed

doRecurringEnqueue

public static void doRecurringEnqueue(redis.clients.jedis.Jedis jedis,
                                      String namespace,
                                      String queue,
                                      String jobJson,
                                      long future,
                                      long frequency)

doRecurringEnqueue

protected abstract void doRecurringEnqueue(String queue,
                                           String msg,
                                           long future,
                                           long frequency)
                                    throws Exception

Throws:

Exception

recurringEnqueue

public void recurringEnqueue(String queue,
                             Job job,
                             long future,
                             long frequency)

Queues a job to be in the future and recur

Specified by:

recurringEnqueue in interface Client

Parameters:

queue - the queue to add the Job too

job - the job to be enqueued

future - timestamp when the job will run

frequency - frequency in millis how often the job will run

doRemoveRecurringEnqueue

public static void doRemoveRecurringEnqueue(redis.clients.jedis.Jedis jedis,
                                            String namespace,
                                            String queue,
                                            String jobJson)

doRemoveRecurringEnqueue

protected abstract void doRemoveRecurringEnqueue(String queue,
                                                 String msg)
                                          throws Exception

Throws:

Exception

removeRecurringEnqueue

public void removeRecurringEnqueue(String queue,
                                   Job job)

Description copied from interface: Client

Removes a queued recurring job.

Specified by:

removeRecurringEnqueue in interface Client

Parameters:

queue - the queue to remove the Job from

job - the job to be removed