org.apache.brooklyn.api.mgmt

Interface ExecutionManager

All Known Implementing Classes:

BasicExecutionManager

public interface ExecutionManager

This class manages the execution of a number of jobs with tags. It is like an executor service (and it ends up delegating to one) but adds additional support where jobs can be:

• Tracked with tags/buckets
• Be Runnables or Callables, (support for Closure is deprecated)
• Remembered after completion
• Treated as Task instances (see below)
• Given powerful synchronization capabilities

The advantage of treating them as Task instances include:

• Richer status information
• Started-by, contained-by relationships automatically remembered
• Runtime metadata (start, stop, etc)
• Grid and multi-machine support)

For usage instructions see submit(Map, TaskAdaptable), and for examples see the various ExecutionTest and TaskTest instances.

It has been developed for multi-location provisioning and management to track work being done by each Entity.

Note the use of the environment variable THREAD_POOL_SIZE which is used to size the ExecutorService thread pool. The default is calculated as twice the number of CPUs in the system plus two, giving 10 for a four core system, 18 for an eight CPU server and so on.

Method Summary

Modifier and Type	Method and Description
Task<?>	getTask(java.lang.String id) returns the task with the given ID, or null if none
java.util.Set<Task<?>>	getTasksWithAllTags(java.lang.Iterable<?> tags) returns all tasks that have all of the given tags (immutable)
java.util.Set<Task<?>>	getTasksWithAnyTag(java.lang.Iterable<?> tags) returns all tasks that have any of the given tags (immutable)
java.util.Set<Task<?>>	getTasksWithTag(java.lang.Object tag) returns all tasks with the given tag (immutable)
java.util.Set<java.lang.Object>	getTaskTags() returns all tags known to this manager (immutable)
boolean	isShutdown()
<T> Task<T>	submit(java.util.concurrent.Callable<T> r) Deprecated. since 1.0.0 pass displayName or map
<T> Task<T>	submit(java.util.Map<?,?> flags, java.util.concurrent.Callable<T> c) see submit(Map, TaskAdaptable)
Task<?>	submit(java.util.Map<?,?> flags, java.lang.Runnable r) see submit(Map, TaskAdaptable)
<T> Task<T>	submit(java.util.Map<?,?> flags, TaskAdaptable<T> task) Submits the given Task for execution in the context associated with this manager.
Task<?>	submit(java.lang.Runnable r) Deprecated. since 1.0.0 pass displayName or map
<T> Task<T>	submit(java.lang.String displayName, java.util.concurrent.Callable<T> c) see submit(Map, TaskAdaptable)
Task<?>	submit(java.lang.String displayName, java.lang.Runnable c) see submit(Map, TaskAdaptable)
<T> Task<T>	submit(TaskAdaptable<T> task) see submit(Map, TaskAdaptable)

Method Detail

isShutdown

boolean isShutdown()

getTask

Task<?> getTask(java.lang.String id)

returns the task with the given ID, or null if none

getTasksWithTag

java.util.Set<Task<?>> getTasksWithTag(java.lang.Object tag)

returns all tasks with the given tag (immutable)

getTasksWithAnyTag

java.util.Set<Task<?>> getTasksWithAnyTag(java.lang.Iterable<?> tags)

returns all tasks that have any of the given tags (immutable)

getTasksWithAllTags

java.util.Set<Task<?>> getTasksWithAllTags(java.lang.Iterable<?> tags)

returns all tasks that have all of the given tags (immutable)

getTaskTags

java.util.Set<java.lang.Object> getTaskTags()

returns all tags known to this manager (immutable)

submit

@Deprecated
Task<?> submit(java.lang.Runnable r)

Deprecated. since 1.0.0 pass displayName or map

see submit(Map, TaskAdaptable)

submit

@Deprecated
<T> Task<T> submit(java.util.concurrent.Callable<T> r)

Deprecated. since 1.0.0 pass displayName or map

see submit(Map, TaskAdaptable)

submit

Task<?> submit(java.lang.String displayName,
               java.lang.Runnable c)

see submit(Map, TaskAdaptable)

submit

<T> Task<T> submit(java.lang.String displayName,
                   java.util.concurrent.Callable<T> c)

see submit(Map, TaskAdaptable)

submit

<T> Task<T> submit(TaskAdaptable<T> task)

see submit(Map, TaskAdaptable)

submit

Task<?> submit(java.util.Map<?,?> flags,
               java.lang.Runnable r)

see submit(Map, TaskAdaptable)

submit

<T> Task<T> submit(java.util.Map<?,?> flags,
                   java.util.concurrent.Callable<T> c)

see submit(Map, TaskAdaptable)

submit

<T> Task<T> submit(java.util.Map<?,?> flags,
                   TaskAdaptable<T> task)

Submits the given Task for execution in the context associated with this manager. The following optional flags supported (in the optional map first arg):

• tag - A single object to be used as a tag for looking up the task
• tags - A Collection of object tags each of which the task should be associated, used for associating with contexts, mutex execution, and other purposes
• synchId - A string, or Collection of strings, representing a category on which an object should own a synch lock
• synchObj - A string, or Collection of strings, representing a category on which an object should own a synch lock
• newTaskStartCallback - A callback that will be invoked just before the task starts if it starts as a result of this call.
• newTaskEndCallback - A callback that will be invoked when the task completes if it starts as a result of this call

Callbacks run in the task's thread. It can be one of the following types:

• Runnable
• Callable
• Function that matches the generics <? super Task, ?>
• Support for Closure is deprecated.

If a Map is supplied it must be modifiable (currently; may allow immutable maps in future).