Class TriggerDefinition

java.lang.Object

com.inet.taskplanner.server.api.common.AbstractDefinition<TriggerDefinition>

com.inet.taskplanner.server.api.trigger.TriggerDefinition

@JsonData
public final class TriggerDefinition
extends AbstractDefinition<TriggerDefinition>

Defines a configured trigger for a task with its settings. A trigger is responsible for initiating execution of a task, for example at a certain time or when an event occurs.

TriggerDefinition ——extensionName—⟶ TriggerFactory ——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. the start date and cycle for a time trigger. 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

Constructors

Constructor	Description
TriggerDefinition(String extensionName)	Creates a new TriggerDefinition instance.
TriggerDefinition(String extensionName, Map<String,String> properties)	Creates a new TriggerDefinition instance.

Method Summary

Modifier and Type	Method	Description
TriggerDefinition	copyDefinition()	Makes a deep copy of this definition.
SummaryInfo	getSummary()	Gets summary information about this trigger.

Methods inherited from class AbstractDefinition

copyDefinitions, equals, getExtensionName, getProperties, getProperty, getUid, hashCode, removeProperty, setProperty, setUid

Methods inherited from class Object

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

Constructor Details

TriggerDefinition

public TriggerDefinition(String extensionName)

Creates a new TriggerDefinition instance.

Parameters:

extensionName - the unique name for this kind of trigger. For example, you can pass one of the predefined trigger FileChangeTriggerFactory.EXTENSION_NAME or TimeTriggerFactory.EXTENSION_NAME

Since:

taskplanner 3.0

TriggerDefinition

public TriggerDefinition(String extensionName,
 Map<String,String> properties)

Creates a new TriggerDefinition instance.

Parameters:

extensionName - the unique name for this kind of trigger. For example, you can pass one of the predefined trigger FileChangeTriggerFactory.EXTENSION_NAME or TimeTriggerFactory.EXTENSION_NAME

properties - the initial properties to be set, null will have no effect

Since:

taskplanner 3.0

Method Details

copyDefinition

public TriggerDefinition copyDefinition()

Makes a deep copy of this definition.

Specified by:

copyDefinition in class AbstractDefinition<TriggerDefinition>

Returns:

a deep copy of this definition.

getSummary

public SummaryInfo getSummary()

Gets summary information about this trigger.

These summary lines are shown in the web GUI.

Returns:

summary information, or null if the TriggerFactory implementation decides to return null

Throws:

IllegalStateException - if no corresponding TriggerFactory is registered

Since:

taskplanner 3.0

See Also:

• AbstractFactory.getSummary(AbstractDefinition)