org.opennms.core.tasks

Class DefaultTaskCoordinator

java.lang.Object

org.opennms.core.tasks.DefaultTaskCoordinator

All Implemented Interfaces:

TaskCoordinator, org.springframework.beans.factory.InitializingBean

public class DefaultTaskCoordinator
extends Object
implements TaskCoordinator, org.springframework.beans.factory.InitializingBean

This DefaultTaskCoordinator class provides utility methods to construct and schedule hierarchies of Tasks.

Author:

brozow

Field Summary

Fields inherited from interface org.opennms.core.tasks.TaskCoordinator

DEFAULT_EXECUTOR

Constructor Summary

Constructors

Constructor and Description
DefaultTaskCoordinator(String name) Constructor for DefaultTaskCoordinator.

Method Summary

Modifier and Type	Method and Description
void	addDependency(AbstractTask prereq, AbstractTask dependent) addDependency
void	addOrUpdateExecutor(String executorName, Executor executor) addExecutor
void	afterPropertiesSet() afterPropertiesSet
TaskBuilder<BatchTask>	createBatch() createBatch
TaskBuilder<BatchTask>	createBatch(ContainerTask<?> parent) createBatch
BatchTask	createBatch(ContainerTask<?> parent, Runnable... tasks) createBatch
BatchTask	createBatch(Runnable... tasks) createBatch
TaskBuilder<SequenceTask>	createSequence() createSequence
TaskBuilder<SequenceTask>	createSequence(ContainerTask<?> parent) createSequence
SequenceTask	createSequence(ContainerTask<?> parent, Runnable... tasks) createSequence
<T> AsyncTask<T>	createTask(ContainerTask<?> parent, Async<T> async, Callback<T> cb) createTask
SyncTask	createTask(ContainerTask<?> parent, Runnable r) createTask
SyncTask	createTask(ContainerTask<?> parent, Runnable r, String schedulingHint) createTask
void	markTaskAsCompleted(AbstractTask task)
void	schedule(AbstractTask task) schedule
void	setDefaultExecutor(String executorName) setDefaultExecutor
void	setExecutors(Map<String,Executor> executors) setExecutors
void	setLoopDelay(long millis) setLoopDelay
void	submitToExecutor(String executorPreference, Runnable workToBeDone, AbstractTask owningTask)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultTaskCoordinator

public DefaultTaskCoordinator(String name)

Constructor for DefaultTaskCoordinator.

Parameters:

name - a String object.

defaultExecutor - a Executor object.

Method Detail

setDefaultExecutor

public final void setDefaultExecutor(String executorName)

setDefaultExecutor

Parameters:

executorName - a String object.

afterPropertiesSet

public void afterPropertiesSet()

afterPropertiesSet

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

createTask

public SyncTask createTask(ContainerTask<?> parent,
                           Runnable r)

createTask

Specified by:

createTask in interface TaskCoordinator

Parameters:

parent - a ContainerTask object.

r - a Runnable object.

Returns:

a SyncTask object.

createTask

public SyncTask createTask(ContainerTask<?> parent,
                           Runnable r,
                           String schedulingHint)

createTask

Specified by:

createTask in interface TaskCoordinator

Parameters:

parent - a ContainerTask object.

r - a Runnable object.

schedulingHint - a String object.

Returns:

a SyncTask object.

createTask

public <T> AsyncTask<T> createTask(ContainerTask<?> parent,
                                   Async<T> async,
                                   Callback<T> cb)

createTask

Specified by:

createTask in interface TaskCoordinator

Type Parameters:

T - a T object.

Parameters:

parent - a ContainerTask object.

async - a Async object.

cb - a Callback object.

Returns:

a AsyncTask object.

createBatch

public TaskBuilder<BatchTask> createBatch(ContainerTask<?> parent)

createBatch

Specified by:

createBatch in interface TaskCoordinator

Parameters:

parent - a ContainerTask object.

Returns:

a TaskBuilder object.

createBatch

public TaskBuilder<BatchTask> createBatch()

createBatch

Specified by:

createBatch in interface TaskCoordinator

Returns:

a TaskBuilder object.

createBatch

public BatchTask createBatch(ContainerTask<?> parent,
                             Runnable... tasks)

createBatch

Specified by:

createBatch in interface TaskCoordinator

Parameters:

parent - a ContainerTask object.

tasks - a Runnable object.

Returns:

a BatchTask object.

createBatch

public BatchTask createBatch(Runnable... tasks)

createBatch

Specified by:

createBatch in interface TaskCoordinator

Parameters:

tasks - a Runnable object.

Returns:

a BatchTask object.

createSequence

public TaskBuilder<SequenceTask> createSequence(ContainerTask<?> parent)

createSequence

Specified by:

createSequence in interface TaskCoordinator

Parameters:

parent - a ContainerTask object.

Returns:

a TaskBuilder object.

createSequence

public TaskBuilder<SequenceTask> createSequence()

createSequence

Specified by:

createSequence in interface TaskCoordinator

Returns:

a TaskBuilder object.

createSequence

public SequenceTask createSequence(ContainerTask<?> parent,
                                   Runnable... tasks)

createSequence

Specified by:

createSequence in interface TaskCoordinator

Parameters:

parent - a ContainerTask object.

tasks - a Runnable object.

Returns:

a SequenceTask object.

setLoopDelay

public final void setLoopDelay(long millis)

setLoopDelay

Specified by:

setLoopDelay in interface TaskCoordinator

Parameters:

millis - a long.

schedule

public void schedule(AbstractTask task)

schedule

Specified by:

schedule in interface TaskCoordinator

Parameters:

task - a AbstractTask object.

addDependency

public void addDependency(AbstractTask prereq,
                          AbstractTask dependent)

addDependency

Specified by:

addDependency in interface TaskCoordinator

Parameters:

prereq - a AbstractTask object.

dependent - a AbstractTask object.

markTaskAsCompleted

public void markTaskAsCompleted(AbstractTask task)

Specified by:

markTaskAsCompleted in interface TaskCoordinator

submitToExecutor

public void submitToExecutor(String executorPreference,
                             Runnable workToBeDone,
                             AbstractTask owningTask)

Specified by:

submitToExecutor in interface TaskCoordinator

addOrUpdateExecutor

public final void addOrUpdateExecutor(String executorName,
                                      Executor executor)

addExecutor

Specified by:

addOrUpdateExecutor in interface TaskCoordinator

Parameters:

executorName - a String object.

executor - a Executor object.

setExecutors

public final void setExecutors(Map<String,Executor> executors)

setExecutors

Specified by:

setExecutors in interface TaskCoordinator

Parameters:

executors - a Map object.