|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Task
The interface for Task Plugins.
Task Plugins are the simplest type of Plugins. They utilizes the
TaskEnvironment
which contains the Plugin configuration only.
Method Summary | |
---|---|
Status |
execute(TaskEnvironment env)
Executes the Task Plugin. |
Status |
setup(TaskEnvironment env)
Initializes the Plugin. |
void |
teardown(TaskEnvironment env)
Shuts the Plugin down and frees resources. |
Method Detail |
---|
Status setup(TaskEnvironment env) throws java.lang.Exception
If the returned status is null or the status code is a
non-success code then teardown(TaskEnvironment)
will be called
next.
Resources like sockets or files can be opened in this method.
env
- the configured TaskEnvironment for this Plugin
java.lang.Exception
teardown(TaskEnvironment)
Status execute(TaskEnvironment env) throws java.lang.Exception
This method is called at the scheduled intervals. If the Plugin execution
takes longer than the schedule interval, subsequent calls to
execute(TaskEnvironment)
will be skipped until this method
returns. After the execution duration exceeds the schedule timeout,
PluginEnvironment.isStopped()
will return true. In this
case execution should be stopped as soon as possible. If the Plugin
ignores PluginEnvironment.isStopped()
or fails to stop execution in
a reasonable timeframe, the execution thread will be stopped ungracefully
which might lead to resource leaks!
env
- a TaskEnvironment object that contains the Plugin
configuration
java.lang.Exception
void teardown(TaskEnvironment env) throws java.lang.Exception
The Plugin methods setup, execute and teardown are called on different threads, but they are called sequentially. This means that the execution of these methods does not overlap, they are executed one after the other.
Examples:
All by the Plugin allocated resources should be freed in this method. Examples are opened sockets or files.
java.lang.Exception
setup(TaskEnvironment)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |