org.opennms.core.tasks

Class SyncTask

java.lang.Object

org.opennms.core.tasks.Task

org.opennms.core.tasks.SyncTask

public class SyncTask
extends Task

SyncTask

Version:

$Id: $

Author:

brozow

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMIN_EXECUTOR Constant ADMIN_EXECUTOR="admin"
static String	DEFAULT_EXECUTOR Constant DEFAULT_EXECUTOR="default"

Constructor Summary

Constructors

Constructor and Description
SyncTask(DefaultTaskCoordinator coordinator, ContainerTask<?> parent, Runnable action) Constructor for SyncTask.
SyncTask(DefaultTaskCoordinator coordinator, ContainerTask<?> parent, Runnable action, String preferredExecutor) Constructor for SyncTask.

Method Summary

Modifier and Type	Method and Description
protected void	doSubmit() This method submits a task to be executed and is called when all dependencies are completed for that task This method should place a runnable on an executor or submit the task in some other way so that it will run as soon as possible.
String	getPreferredExecutor() getPreferredExecutor
void	run() This is the run method where the 'work' related to the Task gets down.
void	setPreferredExecutor(String preferredExecutor) setPreferredExecutor
String	toString() toString

Methods inherited from class org.opennms.core.tasks.Task

addDependent, addPrerequisite, completeSubmit, getCoordinator, getMonitor, isFinished, isScheduled, markTaskAsCompleted, postSchedule, preSchedule, schedule, submitRunnable, waitFor, waitFor

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EXECUTOR

public static final String DEFAULT_EXECUTOR

Constant DEFAULT_EXECUTOR="default"

See Also:

Constant Field Values

ADMIN_EXECUTOR

public static final String ADMIN_EXECUTOR

Constant ADMIN_EXECUTOR="admin"

See Also:

Constant Field Values

Constructor Detail

SyncTask

public SyncTask(DefaultTaskCoordinator coordinator,
                ContainerTask<?> parent,
                Runnable action)

Constructor for SyncTask.

Parameters:

coordinator - a DefaultTaskCoordinator object.

parent - a ContainerTask object.

action - a Runnable object.

SyncTask

public SyncTask(DefaultTaskCoordinator coordinator,
                ContainerTask<?> parent,
                Runnable action,
                String preferredExecutor)

Constructor for SyncTask.

Parameters:

coordinator - a DefaultTaskCoordinator object.

parent - a ContainerTask object.

action - a Runnable object.

preferredExecutor - a String object.

Method Detail

doSubmit

protected void doSubmit()

This method submits a task to be executed and is called when all dependencies are completed for that task This method should place a runnable on an executor or submit the task in some other way so that it will run as soon as possible. Tasks that have no processing to be done may override completeSubmit to notify the Task coordinator that the task is done.

Overrides:

doSubmit in class Task

run

public void run()

This is the run method where the 'work' related to the Task gets down. This method can be overridden or a Runnable can be passed to the task in the constructor. The Task is not complete until this method finishes

getPreferredExecutor

public String getPreferredExecutor()

getPreferredExecutor

Returns:

a String object.

setPreferredExecutor

public void setPreferredExecutor(String preferredExecutor)

setPreferredExecutor

Parameters:

preferredExecutor - a String object.

toString

public String toString()

toString

Overrides:

toString in class Task

Returns:

a String object.