org.nuxeo.ecm.core.redis.contribs

Class RedisWorkQueuing

java.lang.Object

org.nuxeo.ecm.core.redis.contribs.RedisWorkQueuing

All Implemented Interfaces:

WorkQueuing

public class RedisWorkQueuing
extends Object
implements WorkQueuing

Implementation of a WorkQueuing storing Work instances in Redis.

Since:

5.8

Constructor Summary

Constructors

Constructor and Description
RedisWorkQueuing(WorkManagerImpl mgr, WorkQueueDescriptorRegistry workQueueDescriptors)

Method Summary

Methods

Modifier and Type	Method and Description
void	addScheduledWork(String queueId, Work work) Persists a work instance and adds it to the scheduled queue.
void	clearCompletedWork(String queueId, long completionTime) Clears the list of completed work instances older than the given time in the given queue.
Work	find(String workId, Work.State state) Finds a work instance in the scheduled queue or running or completed sets.
Set<String>	getCompletedQueueIds() Finds which queues have completed work.
int	getQueueSize(String queueId, Work.State state) Gets the number of work instances in the given state in a given queue.
BlockingQueue<Runnable>	getScheduledQueue(String queueId) Gets the blocking queue for scheduled work, to be used in a ThreadPoolExecutor.
Work.State	getWorkState(String workId) Gets the state in which a work instance is.
void	init() Starts up this WorkQueuing and attempts to resume work previously suspended and saved at #shutdown time.
BlockingQueue<Runnable>	initScheduleQueue(String queueId)
boolean	isWorkInState(String workId, Work.State state) Checks if a work instance with the given id is in the given state.
List<Work>	listWork(String queueId, Work.State state) Lists the work instances in a given queue in a defined state.
List<String>	listWorkIds(String queueId, Work.State state) Lists the work ids in a given queue in a defined state.
Work	removeScheduled(String queueId, String workId) Finds a scheduled work instance and removes it from the scheduled work.
int	scheduleSuspendedWork(String queueId) Resumes all suspended work instances by moving them to the scheduled queue.
int	setSuspending(String queueId) Notifies this queuing that all work should be suspending.
int	suspendScheduledWork(String queueId) Suspends all scheduled work instances by moving them to the suspended queue.
void	workCompleted(String queueId, Work work) Moves a work instance from the running set to the completed set.
void	workRunning(String queueId, Work work) Moves a work instance from the scheduled queue to the running set.

Methods inherited from class java.lang.Object

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

Constructor Detail

RedisWorkQueuing

public RedisWorkQueuing(WorkManagerImpl mgr,
                WorkQueueDescriptorRegistry workQueueDescriptors)

Method Detail

init

public void init()

Description copied from interface: WorkQueuing

Starts up this WorkQueuing and attempts to resume work previously suspended and saved at #shutdown time.

Specified by:

init in interface WorkQueuing

initScheduleQueue

public BlockingQueue<Runnable> initScheduleQueue(String queueId)

Specified by:

initScheduleQueue in interface WorkQueuing

Returns:

getScheduledQueue

public BlockingQueue<Runnable> getScheduledQueue(String queueId)

Description copied from interface: WorkQueuing

Gets the blocking queue for scheduled work, to be used in a ThreadPoolExecutor.

Specified by:

getScheduledQueue in interface WorkQueuing

Parameters:

queueId - the queue id

Returns:

the queue

workRunning

public void workRunning(String queueId,
               Work work)

Description copied from interface: WorkQueuing

Moves a work instance from the scheduled queue to the running set. When called, the work instance is already removed from the scheduled queue.

Specified by:

workRunning in interface WorkQueuing

Parameters:

queueId - the queue id

work - the work instance

workCompleted

public void workCompleted(String queueId,
                 Work work)

Description copied from interface: WorkQueuing

Moves a work instance from the running set to the completed set.

Specified by:

workCompleted in interface WorkQueuing

Parameters:

queueId - the queue id

work - the work instance

listWork

public List<Work> listWork(String queueId,
                  Work.State state)

Description copied from interface: WorkQueuing

Lists the work instances in a given queue in a defined state.

Note that an instance requested as RUNNING could be found SUSPENDING or SUSPENDED, and an instance requested as COMPLETED could be found FAILED.

Specified by:

listWork in interface WorkQueuing

Parameters:

queueId - the queue id

state - the state defining the state to look into, SCHEDULED, RUNNING, COMPLETED, or null for non-completed

Returns:

the list of work instances in the given state

listWorkIds

public List<String> listWorkIds(String queueId,
                       Work.State state)

Description copied from interface: WorkQueuing

Lists the work ids in a given queue in a defined state.

Specified by:

listWorkIds in interface WorkQueuing

Parameters:

queueId - the queue id

state - the state defining the state to look into, SCHEDULED, RUNNING, COMPLETED, or null for non-completed

Returns:

the list of work ids in the given state

getQueueSize

public int getQueueSize(String queueId,
               Work.State state)

Description copied from interface: WorkQueuing

Gets the number of work instances in the given state in a given queue.

Specified by:

getQueueSize in interface WorkQueuing

Parameters:

queueId - the queue id

state - the state, SCHEDULED, RUNNING or COMPLETED

Returns:

the number of scheduled work instances in the queue

find

public Work find(String workId,
        Work.State state)

Description copied from interface: WorkQueuing

Finds a work instance in the scheduled queue or running or completed sets.

Specified by:

find in interface WorkQueuing

Parameters:

workId - the id of the work to find

state - the state defining the state to look into, SCHEDULED, RUNNING, COMPLETED, or null for SCHEDULED or RUNNING

Returns:

the found work instance, or null if not found

isWorkInState

public boolean isWorkInState(String workId,
                    Work.State state)

Description copied from interface: WorkQueuing

Checks if a work instance with the given id is in the given state.

Specified by:

isWorkInState in interface WorkQueuing

Parameters:

workId - the work id

state - the state, SCHEDULED, RUNNING, COMPLETED, or null for non-completed

Returns:

true if a work instance with the given id is in the given state

removeScheduled

public Work removeScheduled(String queueId,
                   String workId)

Description copied from interface: WorkQueuing

Finds a scheduled work instance and removes it from the scheduled work.

Specified by:

removeScheduled in interface WorkQueuing

Parameters:

queueId - the queue id

workId - the id of the work to find

Returns:

the work if found, otherwise null

getWorkState

public Work.State getWorkState(String workId)

Description copied from interface: WorkQueuing

Gets the state in which a work instance is.

This can be Work.State.SCHEDULED, Work.State.RUNNING, Work.State.COMPLETED, Work.State.FAILED, or Work.State.CANCELED.

Specified by:

getWorkState in interface WorkQueuing

Parameters:

workId - the id of the work to find

Returns:

the work state, or null if not found

setSuspending

public int setSuspending(String queueId)

Description copied from interface: WorkQueuing

Notifies this queuing that all work should be suspending.

Specified by:

setSuspending in interface WorkQueuing

Returns:

the number of scheduled instances removed from queue

clearCompletedWork

public void clearCompletedWork(String queueId,
                      long completionTime)

Description copied from interface: WorkQueuing

Clears the list of completed work instances older than the given time in the given queue.

Specified by:

clearCompletedWork in interface WorkQueuing

Parameters:

queueId - the queue id

completionTime - the completion time (milliseconds since epoch) before which completed work instances are cleared, or 0 for all

addScheduledWork

public void addScheduledWork(String queueId,
                    Work work)
                      throws IOException

Persists a work instance and adds it to the scheduled queue.

Parameters:

queueId - the queue id

work - the work instance

Throws:

IOException

getCompletedQueueIds

public Set<String> getCompletedQueueIds()

Description copied from interface: WorkQueuing

Finds which queues have completed work.

Specified by:

getCompletedQueueIds in interface WorkQueuing

Returns:

a set of queue ids

scheduleSuspendedWork

public int scheduleSuspendedWork(String queueId)
                          throws IOException

Resumes all suspended work instances by moving them to the scheduled queue.

Parameters:

queueId - the queue id

Returns:

the number of work instances scheduled

Throws:

IOException

Since:

5.8

suspendScheduledWork

public int suspendScheduledWork(String queueId)
                         throws IOException

Suspends all scheduled work instances by moving them to the suspended queue.

Parameters:

queueId - the queue id

Returns:

the number of work instances suspended

Throws:

IOException

Since:

5.8