Class TriggerDefinition
java.lang.Object
com.inet.taskplanner.server.api.common.AbstractDefinition<TriggerDefinition>
com.inet.taskplanner.server.api.trigger.TriggerDefinition
Defines a configured trigger for a task with its settings. A trigger is responsible to initiate the execution of a
task for example at a certain time or when an event occurs.
TriggerDefinition
——extensionName
—⟶TriggerFactory
—— TriggerFactory#createInstanceFrom(DEFINITION, GUID) createFrom()—⟶Trigger
*
To map from a TriggerDefinition
to a TriggerFactory
the method AbstractDefinition.getExtensionName()
has to return a name
for which a TriggerFactory
is registered in the ServerPluginManager
.
This definition also includes settings for the trigger, i.e. for a time trigger the the start date and cycle.
The extension name and the valid properties are usually defined and documented in the corresponding TriggerFactory
.
It is recommended to use Builders to create TriggerDefinitions
.
- Since:
- taskplanner 3.0
- See Also:
-
FileChangeTriggerBuilder
TimeTriggerBuilder
ServerStartTrigger
CronTriggerBuilder
-
Constructor Summary
ConstructorsConstructorDescriptionTriggerDefinition
(String extensionName) Creates a new TriggerDefinition instance.TriggerDefinition
(String extensionName, Map<String, String> properties) Creates a new TriggerDefinition instance. -
Method Summary
Modifier and TypeMethodDescriptionMakes a deep copy of this definition.Get summary infos about this Trigger.Methods inherited from class com.inet.taskplanner.server.api.common.AbstractDefinition
copyDefinitions, equals, getExtensionName, getProperties, getProperty, getUid, hashCode, removeProperty, setProperty, setUid
-
Constructor Details
-
TriggerDefinition
Creates a new TriggerDefinition instance.- Parameters:
extensionName
- the unique name for this kind of triggers. For example you can pass for predefined triggersFileChangeTriggerFactory.EXTENSION_NAME
orTimeTriggerFactory.EXTENSION_NAME
- Since:
- taskplanner 3.0
-
TriggerDefinition
Creates a new TriggerDefinition instance.- Parameters:
extensionName
- the unique name for this kind of triggers. For example you can pass for predefined triggersFileChangeTriggerFactory.EXTENSION_NAME
orTimeTriggerFactory.EXTENSION_NAME
properties
- the initial properties to be set,null
will have no effect- Since:
- taskplanner 3.0
-
-
Method Details
-
copyDefinition
Makes a deep copy of this definition.- Specified by:
copyDefinition
in classAbstractDefinition<TriggerDefinition>
- Returns:
- a deep copy of this definition.
-
getSummary
Get summary infos about this Trigger.This summary lines are shown in the webgui.
- Returns:
- List with summary infos, can be null if the
TriggerFactory
implementation decides to return null. - Throws:
IllegalStateException
- if no correspondingTriggerFactory
is registered- Since:
- taskplanner 3.0
- See Also:
-