MemoryWorkQueuing (Nuxeo ECM Projects 7.10-SNAPSHOT API)

java.lang.Object
- org.nuxeo.ecm.core.work.MemoryWorkQueuing

All Implemented Interfaces:

WorkQueuing

Direct Known Subclasses:

TestWorkQueuing
```
public class MemoryWorkQueuing
extends Object
implements WorkQueuing
```
Implementation of a WorkQueuing using in-memory queuing.

Since:

5.8

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,Map<String,Work>>`	`allCompleted`
`protected Map<String,Map<String,Work>>`	`allRunning`
`protected Map<String,BlockingQueue<Runnable>>`	`allScheduled`
`protected WorkManagerImpl`	`mgr`
`protected WorkQueueDescriptorRegistry`	`workQueueDescriptors`

Constructor Summary

Constructors
Constructor and Description

MemoryWorkQueuing(WorkManagerImpl mgr, WorkQueueDescriptorRegistry workQueueDescriptors)

Constructors
Constructor and Description
`MemoryWorkQueuing(WorkManagerImpl mgr, WorkQueueDescriptorRegistry workQueueDescriptors)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`protected Work`	`findCompleted(String workId)`
`protected Work`	`findRunning(String workId)`
`protected Work`	`findScheduled(String workId)`
`protected Map<String,Work>`	`getCompleted(String queueId)`
`Set<String>`	`getCompletedQueueIds()` Finds which queues have completed work.
`protected int`	`getCompletedSize(String queueId)`
`protected WorkQueueDescriptor`	`getDescriptor(String queueId)`
`int`	`getQueueSize(String queueId, Work.State state)` Gets the number of work instances in the given state in a given queue.
`protected Map<String,Work>`	`getRunning(String queueId)`
`protected int`	`getRunningSize(String queueId)`
`BlockingQueue<Runnable>`	`getScheduledQueue(String queueId)` Gets the blocking queue for scheduled work, to be used in a `ThreadPoolExecutor`.
`protected int`	`getScheduledSize(String queueId)`
`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)`
`protected boolean`	`isCompleted(String workId)`
`protected boolean`	`isRunning(String workId)`
`protected boolean`	`isScheduled(String workId)`
`boolean`	`isWorkInState(String workId, Work.State state)` Checks if a work instance with the given id is in the given state.
`protected List<Work>`	`listCompleted(String queueId)`
`protected List<String>`	`listCompletedIds(String queueId)`
`protected List<String>`	`listNonCompletedIds(String queueId)`
`protected List<Work>`	`listRunning(String queueId)`
`protected List<String>`	`listRunningIds(String queueId)`
`protected List<Work>`	`listScheduled(String queueId)`
`protected List<String>`	`listScheduledIds(String queueId)`
`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.
`protected BlockingQueue<Runnable>`	`newBlockingQueue(WorkQueueDescriptor workQueueDescriptor)`
`protected Map<String,Work>`	`newCompletedMap()`
`protected Map<String,Work>`	`newRunningMap()`
`Work`	`removeScheduled(String queueId, String workId)` Finds a scheduled work instance and removes it from the scheduled work.
`int`	`setSuspending(String queueId)` Notifies this queuing that all work should be suspending.
`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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - mgr
```
protected final WorkManagerImpl mgr
```
  - workQueueDescriptors
```
protected final WorkQueueDescriptorRegistry workQueueDescriptors
```
  - allScheduled
```
protected final Map<String,BlockingQueue<Runnable>> allScheduled
```
  - allRunning
```
protected final Map<String,Map<String,Work>> allRunning
```
  - allCompleted
```
protected final Map<String,Map<String,Work>> allCompleted
```
- Constructor Detail
  - MemoryWorkQueuing
```
public MemoryWorkQueuing(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
  - getDescriptor
```
protected WorkQueueDescriptor getDescriptor(String queueId)
```
  - 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
  - getRunning
```
protected Map<String,Work> getRunning(String queueId)
```
  - getCompleted
```
protected Map<String,Work> getCompleted(String queueId)
```
  - newBlockingQueue
```
protected BlockingQueue<Runnable> newBlockingQueue(WorkQueueDescriptor workQueueDescriptor)
```
  - newRunningMap
```
protected Map<String,Work> newRunningMap()
```
  - newCompletedMap
```
protected Map<String,Work> newCompletedMap()
```
  - 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
  - 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
  - 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
  - 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
  - getScheduledSize
```
protected int getScheduledSize(String queueId)
```
  - getRunningSize
```
protected int getRunningSize(String queueId)
```
  - getCompletedSize
```
protected int getCompletedSize(String queueId)
```
  - isScheduled
```
protected boolean isScheduled(String workId)
```
  - isRunning
```
protected boolean isRunning(String workId)
```
  - isCompleted
```
protected boolean isCompleted(String workId)
```
  - findScheduled
```
protected Work findScheduled(String workId)
```
  - findRunning
```
protected Work findRunning(String workId)
```
  - findCompleted
```
protected Work findCompleted(String workId)
```
  - listScheduled
```
protected List<Work> listScheduled(String queueId)
```
  - listRunning
```
protected List<Work> listRunning(String queueId)
```
  - listCompleted
```
protected List<Work> listCompleted(String queueId)
```
  - listScheduledIds
```
protected List<String> listScheduledIds(String queueId)
```
  - listRunningIds
```
protected List<String> listRunningIds(String queueId)
```
  - listNonCompletedIds
```
protected List<String> listNonCompletedIds(String queueId)
```
  - listCompletedIds
```
protected List<String> listCompletedIds(String queueId)
```
  - 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
  - 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
  - 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
  - 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

Class MemoryWorkQueuing

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mgr

workQueueDescriptors

allScheduled

allRunning

allCompleted

Constructor Detail

MemoryWorkQueuing

Method Detail

init

getDescriptor

initScheduleQueue

getScheduledQueue

getRunning

getCompleted

newBlockingQueue

newRunningMap

newCompletedMap

workRunning

workCompleted

find

isWorkInState

getWorkState

listWork

listWorkIds

getQueueSize

getScheduledSize

getRunningSize

getCompletedSize

isScheduled

isRunning

isCompleted

findScheduled

findRunning

findCompleted

listScheduled

listRunning

listCompleted

listScheduledIds

listRunningIds

listNonCompletedIds

listCompletedIds

removeScheduled

setSuspending

getCompletedQueueIds

clearCompletedWork