org.nuxeo.ecm.core.work.api

Interface WorkManager

All Known Implementing Classes:

WorkManagerImpl

public interface WorkManager

A WorkManager executes Work instances asynchronously.

A Work can be scheduled by calling schedule(org.nuxeo.ecm.core.work.api.Work).

Work is executed in a thread pool and a work queue that depends on the work's category.

Since:

5.6

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WorkManager.Scheduling The scheduling policy to use when adding a work instance using schedule(Work, Scheduling).

Method Summary

Modifier and Type	Method and Description
boolean	awaitCompletion(long timeout, TimeUnit unit) Waits for completion of all work.
boolean	awaitCompletion(String queueId, long timeout, TimeUnit unit) Waits for completion of work in a given queue.
void	cleanup() Clears the list of completed work instances older than what's configured for each queue.
void	clearCompletedWork(long completionTime) Clears the list of completed work instances older than the given time.
void	clearCompletedWork(String queueId) Clears the list of completed work instances for a given queue.
Work	find(String workId, Work.State state) Finds a work instance.
Work	find(Work work, Work.State state, boolean useEquals, int[] pos) Deprecated. since 5.8, use getWorkState(java.lang.String) instead
String	findResult(String workId) Finds a work result.
String	getCategoryQueueId(String category) Gets the queue id used for a given work category.
int	getNonCompletedWorkSize(String queueId) Deprecated. since 5.8, use getQueueSize(java.lang.String, org.nuxeo.ecm.core.work.api.Work.State) with null state instead
int	getQueueSize(String queueId, Work.State state) Gets the number of work instances in a given queue in a defined state.
WorkQueueDescriptor	getWorkQueueDescriptor(String queueId) Gets the work queue descriptor for a given queue id.
List<String>	getWorkQueueIds() Lists the ids of the existing work queues.
Work.State	getWorkState(String workId) Gets the state in which a work instance is.
void	init() Starts up this WorkManager and attempts to resume work previously suspended and saved at shutdown(long, java.util.concurrent.TimeUnit) time.
boolean	isStarted()
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.
void	schedule(Work work) Schedules work for execution at a later time.
void	schedule(Work work, boolean afterCommit) Schedules work for execution at a later time, after the current transaction (if any) has committed.
void	schedule(Work work, WorkManager.Scheduling scheduling) Schedules work for execution at a later time, with a specific scheduling policy.
void	schedule(Work work, WorkManager.Scheduling scheduling, boolean afterCommit) Schedules work for execution at a later time, with a specific scheduling policy.
boolean	shutdown(long timeout, TimeUnit unit) Shuts down this WorkManager and attempts to suspend and save the running and scheduled work instances.
boolean	shutdownQueue(String queueId, long timeout, TimeUnit unit) Shuts down a work queue and attempts to suspend and save the running and scheduled work instances.

Method Detail

getWorkQueueIds

List<String> getWorkQueueIds()

Lists the ids of the existing work queues.

Returns:

the list of queue ids

getCategoryQueueId

String getCategoryQueueId(String category)

Gets the queue id used for a given work category.

Parameters:

category - the category

Returns:

the queue id

getWorkQueueDescriptor

WorkQueueDescriptor getWorkQueueDescriptor(String queueId)

Gets the work queue descriptor for a given queue id.

Parameters:

queueId - the queue id

Returns:

the work queue descriptor, or null

init

void init()

Starts up this WorkManager and attempts to resume work previously suspended and saved at shutdown(long, java.util.concurrent.TimeUnit) time.

shutdownQueue

boolean shutdownQueue(String queueId,
                      long timeout,
                      TimeUnit unit)
               throws InterruptedException

Shuts down a work queue and attempts to suspend and save the running and scheduled work instances.

Parameters:

queueId - the queue id

timeout - the time to wait

unit - the timeout unit

Returns:

true if shutdown is done, false if there are still some threads executing after the timeout

Throws:

InterruptedException

shutdown

boolean shutdown(long timeout,
                 TimeUnit unit)
          throws InterruptedException

Shuts down this WorkManager and attempts to suspend and save the running and scheduled work instances.

Parameters:

timeout - the time to wait

unit - the timeout unit

Returns:

true if shutdown is done, false if there are still some threads executing after the timeout

Throws:

InterruptedException

schedule

void schedule(Work work)

Schedules work for execution at a later time.

This method is identical to schedule(Work, boolean) with afterCommit = false.

Parameters:

work - the work to execute

schedule

void schedule(Work work,
              boolean afterCommit)

Schedules work for execution at a later time, after the current transaction (if any) has committed.

Parameters:

work - the work to execute

afterCommit - if true and the work is scheduled, it will only be run after the current transaction (if any) has committed

schedule

void schedule(Work work,
              WorkManager.Scheduling scheduling)

Schedules work for execution at a later time, with a specific scheduling policy.

This method is identical to schedule(Work, Scheduling, boolean) with afterCommit = false.

Parameters:

work - the work to execute

scheduling - the scheduling policy

See Also:

schedule(Work)

schedule

void schedule(Work work,
              WorkManager.Scheduling scheduling,
              boolean afterCommit)

Schedules work for execution at a later time, with a specific scheduling policy.

Parameters:

work - the work to execute

scheduling - the scheduling policy

afterCommit - if true and the work is scheduled, it will only be run after the current transaction (if any) has committed

See Also:

schedule(Work)

find

@Deprecated
Work find(Work work,
                      Work.State state,
                      boolean useEquals,
                      int[] pos)

Deprecated. since 5.8, use getWorkState(java.lang.String) instead

Finds a work instance.

Parameters:

work - the work to find

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

useEquals - ignored, always uses work id equality

pos - ignored, pass null

Returns:

the found work instance, or null if not found

find

Work find(String workId,
          Work.State state)

Finds a work instance.

Parameters:

workId - the id of the work to find

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

Returns:

the found work instance, or null if not found

Since:

7.3

findResult

String findResult(String workId)

Finds a work result.

Parameters:

workId - the id of the work to find the result

Returns:

the found work result, or null if there is no result or if work is not COMPLETED

Since:

7.4

getWorkState

Work.State getWorkState(String workId)

Gets the state in which a work instance is.

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

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.

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

Since:

5.8

getQueueSize

int getQueueSize(String queueId,
                 Work.State state)

Gets the number of work instances 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 ( SCHEDULED or RUNNING)

Returns:

the number of work instances in the given state

Since:

5.8

getNonCompletedWorkSize

@Deprecated
int getNonCompletedWorkSize(String queueId)

Deprecated. since 5.8, use getQueueSize(java.lang.String, org.nuxeo.ecm.core.work.api.Work.State) with null state instead

Gets the size of the non-completed work (scheduled + running) for a give queue.

Parameters:

queueId - the queue id

Returns:

the number of non-completed work instances

awaitCompletion

boolean awaitCompletion(String queueId,
                        long timeout,
                        TimeUnit unit)
                 throws InterruptedException

Waits for completion of work in a given queue.

Parameters:

queueId - the queue id

timeout - the time to wait

unit - the timeout unit

Returns:

true if all work completed in the queue, or false if there is still some non-completed work after the timeout

Throws:

InterruptedException

awaitCompletion

boolean awaitCompletion(long timeout,
                        TimeUnit unit)
                 throws InterruptedException

Waits for completion of all work.

Parameters:

timeout - the time to wait

unit - the timeout unit

Returns:

true if all work completed, or false if there is still some non-completed work after the timeout

Throws:

InterruptedException

clearCompletedWork

void clearCompletedWork(String queueId)

Clears the list of completed work instances for a given queue.

Parameters:

queueId - the queue id

clearCompletedWork

void clearCompletedWork(long completionTime)

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

Parameters:

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

cleanup

void cleanup()

Clears the list of completed work instances older than what's configured for each queue.

isStarted

boolean isStarted()

Returns:

true if active

Since:

6.0

See Also:

DefaultComponent.applicationStarted(org.nuxeo.runtime.model.ComponentContext), init(), shutdown(long, TimeUnit)