net.greghaines.jesque.admin

Class AbstractAdminClient

java.lang.Object

net.greghaines.jesque.admin.AbstractAdminClient

All Implemented Interfaces:

AdminClient

Direct Known Subclasses:

AdminClientImpl

public abstract class AbstractAdminClient
extends Object
implements AdminClient

Common logic for AdminClient implementations.

Author:

Greg Haines

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAdminClient(Config config)

Method Summary

Modifier and Type	Method and Description
static void	doPublish(redis.clients.jedis.Jedis jedis, String namespace, String channel, String jobJson) Helper method that encapsulates the minimum logic for publishing a job to a channel.
protected abstract void	doPublish(String queue, String msg) Actually publish the serialized job.
protected String	getNamespace()
void	publish(Job job) Publishes a job on the ResqueConstants.ADMIN_CHANNEL channel.
void	publish(String channel, Job job) Publishes a job on the given channel.
void	shutdownWorkers(boolean now) Send a shutdown command on the ResqueConstants.ADMIN_CHANNEL channel.
void	shutdownWorkers(String channel, boolean now) Send a shutdown command on the given channel.
void	togglePausedWorkers(boolean paused) Send a pause command on the ResqueConstants.ADMIN_CHANNEL channel.
void	togglePausedWorkers(String channel, boolean paused) Send a pause command on the given channel.

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.admin.AdminClient

end

Constructor Detail

AbstractAdminClient

protected AbstractAdminClient(Config config)

Parameters:

config - used to get the namespace for key creation

Method Detail

getNamespace

protected String getNamespace()

Returns:

the namespace this client will use

shutdownWorkers

public void shutdownWorkers(boolean now)

Send a shutdown command on the ResqueConstants.ADMIN_CHANNEL channel.

Specified by:

shutdownWorkers in interface AdminClient

Parameters:

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

shutdownWorkers

public void shutdownWorkers(String channel,
                            boolean now)

Send a shutdown command on the given channel.

Specified by:

shutdownWorkers in interface AdminClient

Parameters:

channel - the channel to publish the pause command to

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

togglePausedWorkers

public void togglePausedWorkers(boolean paused)

Send a pause command on the ResqueConstants.ADMIN_CHANNEL channel.

Specified by:

togglePausedWorkers in interface AdminClient

Parameters:

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

togglePausedWorkers

public void togglePausedWorkers(String channel,
                                boolean paused)

Send a pause command on the given channel.

Specified by:

togglePausedWorkers in interface AdminClient

Parameters:

channel - the channel to publish the pause command to

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

publish

public void publish(Job job)

Publishes a job on the ResqueConstants.ADMIN_CHANNEL channel.

Specified by:

publish in interface AdminClient

Parameters:

job - job the job to be published

publish

public void publish(String channel,
                    Job job)

Publishes a job on the given channel.

Specified by:

publish in interface AdminClient

Parameters:

channel - the channel to publish the job to

job - job the job to be published

doPublish

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

Actually publish the serialized job.

Parameters:

queue - the queue to add the Job to

msg - the serialized Job

Throws:

Exception - in case something goes wrong

doPublish

public static void doPublish(redis.clients.jedis.Jedis jedis,
                             String namespace,
                             String channel,
                             String jobJson)

Helper method that encapsulates the minimum logic for publishing a job to a channel.

Parameters:

jedis - the connection to Redis

namespace - the Resque namespace

channel - the channel name

jobJson - the job serialized as JSON