All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • brooklyn.management.ExecutionManager Maven / Gradle / Ivy

    package brooklyn.management;

import java.util.Collection;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;

import brooklyn.entity.Entity;

/** 
 * 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 {@link Runnable}s, {@link Callable}s, or {@link groovy.lang.Closure}s
 * 
    • Remembered after completion
 * 
    • Treated as {@link Task} instances (see below)
 * 
    • Given powerful synchronization capabilities
 * 
    
 * 
    
 * The advantage of treating them as {@link 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 {@link #submit(Map, Task)}, and for examples see the various
 * {@code ExecutionTest} and {@code TaskTest} instances.
 * 
    
 * It has been developed for multi-location provisioning and management to track work being
 * done by each {@link Entity}.
 * 
    
 * Note the use of the environment variable {@code THREAD_POOL_SIZE} which is used to size
 * the {@link 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.
 */
public interface ExecutionManager {
    public boolean isShutdown();
    
    /** returns the task with the given ID, or null if none */ 
    public Task getTask(String id);
    
    /** returns all tasks with the given tag (immutable) */
    public Set> getTasksWithTag(Object tag);

    /** returns all tasks that have any of the given tags (immutable) */
    public Set> getTasksWithAnyTag(Iterable tags);

    /** returns all tasks that have all of the given tags (immutable) */
    public Set> getTasksWithAllTags(Iterable tags);

    /** returns all tags known to this manager (immutable) */
    public Set getTaskTags();

//    /** returns all tasks known to this manager (immutable) */
//    public Set> getAllTasks();

    /** see {@link #submit(Map, Task)} */
    public Task submit(Runnable r);

    /** see {@link #submit(Map, Task)} */
    public  Task submit(Callable c);

    /** see {@link #submit(Map, Task)} */
    public  Task submit(TaskAdaptable task);
    
    /** see {@link #submit(Map, Task)} */
    public Task submit(Map flags, Runnable r);

    /** see {@link #submit(Map, Task)} */
    public  Task submit(Map flags, Callable c);

    /** 
     * @see {@link #submit(Map, Task)}
     * 
     * @deprecated since 0.5.0 or 0.6.0, while refactoring groovy->java; use strongly typed methods
     */
    @Deprecated
    public  Task submit(Map flags, Object c);

    /**
     * Submits the given {@link 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 {@link 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 {@link Collection} of strings, representing a category on which an object should own a synch lock 
     * 
    • synchObj - A string, or {@link Collection} of strings, representing a category on which an object should own a synch lock 
     * 
    • newTaskStartCallback - A {@link groovy.lang.Closure} that will be invoked just before the task starts if it starts as a result of this call
     * 
    • newTaskEndCallback - A {@link groovy.lang.Closure} that will be invoked when the task completes if it starts as a result of this call
     * 
    
     * Callbacks run in the task's thread, and if the callback is a {@link groovy.lang.Closure} it is passed the task for convenience. The closure can be any of the
     * following types; either a {@link groovy.lang.Closure}, {@link Runnable} or {@link Callable}.
     * 
    
     * If a Map is supplied it must be modifiable (currently; may allow immutable maps in future). 
     */
    public  Task submit(Map flags, TaskAdaptable task);

    //following also used, may be moved up to interface
//    void setTaskPreprocessorForTag(Object tag, Class preprocessor);
//    TaskPreprocessor getTaskPreprocessorForTag(Object tag);
//    void setTaskPreprocessorForTag(Object tag, TaskPreprocessor preprocessor);

}    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy