WorkQueuing (Nuxeo ECM Projects 7.2-SNAPSHOT API)

All Known Implementing Classes:

MemoryWorkQueuing, RedisWorkQueuing
```
public interface WorkQueuing
```
Interface describing how the WorkManager implements queuing.
There are 3 structures maintained per-queue:
- the queue of scheduled work,
- the set of running work,
- the set of completed work.
Since:

5.8

Method Summary

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.
`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`	`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.

- Method Detail
  - init
```
void init()
```
    Starts up this WorkQueuing and attempts to resume work previously suspended and saved at #shutdown time.
  - initScheduleQueue
```
BlockingQueue<Runnable> initScheduleQueue(String queueId)
```
    Parameters:
    queueId -
    
    Returns:
    Since:
    
    6.0
  - getScheduledQueue
```
BlockingQueue<Runnable> getScheduledQueue(String queueId)
```
    Gets the blocking queue for scheduled work, to be used in a ThreadPoolExecutor.
    
    Parameters:
    queueId - the queue id
    
    Returns:
    the queue
    Since:
    
    5.8
  - workRunning
```
void workRunning(String queueId,
               Work work)
```
    Moves a work instance from the scheduled queue to the running set. When called, the work instance is already removed from the scheduled queue.
    
    Parameters:
    queueId - the queue id
    work - the work instance
    Since:
    
    5.8
  - workCompleted
```
void workCompleted(String queueId,
                 Work work)
```
    Moves a work instance from the running set to the completed set.
    
    Parameters:
    queueId - the queue id
    work - the work instance
    Since:
    
    5.8
  - find
```
Work find(String workId,
        Work.State state)
```
    Finds a work instance in the scheduled queue or running or completed sets.
    
    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
  - removeScheduled
```
Work removeScheduled(String queueId,
                   String workId)
```
    Finds a scheduled work instance and removes it from the scheduled work.
    
    Parameters:
    queueId - the queue id
    workId - the id of the work to find
    
    Returns:
    the work if found, otherwise null
    Since:
    
    5.8
  - isWorkInState
```
boolean isWorkInState(String workId,
                    Work.State state)
```
    Checks if a work instance with the given id is in the given state.
    
    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
    Since:
    
    5.8
  - getWorkState
```
Work.State getWorkState(String workId)
```
    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.
    
    Parameters:
    workId - the id of the work to find
    
    Returns:
    the work state, or null if not found
    Since:
    
    5.8
  - listWork
```
List<Work> listWork(String queueId,
                  Work.State state)
```
    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.
    
    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
```
List<String> listWorkIds(String queueId,
                       Work.State state)
```
    Lists the work ids in a given queue in a defined state.
    
    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
```
int getQueueSize(String queueId,
               Work.State state)
```
    Gets the number of work instances in the given state in a given queue.
    
    Parameters:
    queueId - the queue id
    state - the state, SCHEDULED, RUNNING or COMPLETED
    
    Returns:
    the number of scheduled work instances in the queue
    Since:
    
    5.8
  - setSuspending
```
int setSuspending(String queueId)
```
    Notifies this queuing that all work should be suspending.
    
    Returns:
    the number of scheduled instances removed from queue
  - getCompletedQueueIds
```
Set<String> getCompletedQueueIds()
```
    Finds which queues have completed work.
    
    Returns:
    a set of queue ids
    Since:
    
    5.8
  - clearCompletedWork
```
void clearCompletedWork(String queueId,
                      long completionTime)
```
    Clears the list of completed work instances older than the given time in the given queue.
    
    Parameters:
    queueId - the queue id
    completionTime - the completion time (milliseconds since epoch) before which completed work instances are cleared, or 0 for all

Interface WorkQueuing

Method Summary

Method Detail

init

initScheduleQueue

getScheduledQueue

workRunning

workCompleted

find

removeScheduled

isWorkInState

getWorkState

listWork

listWorkIds

getQueueSize

setSuspending

getCompletedQueueIds

clearCompletedWork