Class FileChangeTriggerFactory

java.lang.Object

com.inet.taskplanner.server.api.common.AbstractFactory<com.inet.taskplanner.server.api.trigger.filechange.FileChangeTrigger, TriggerDefinition, TriggerInfo, SummaryInfo>

com.inet.taskplanner.server.api.common.SeriesIndependentFactory<com.inet.taskplanner.server.api.trigger.filechange.FileChangeTrigger, TriggerDefinition, TriggerInfo, SummaryInfo>

com.inet.taskplanner.server.api.trigger.TriggerFactory<com.inet.taskplanner.server.api.trigger.filechange.FileChangeTrigger>

com.inet.taskplanner.server.api.trigger.filechange.FileChangeTriggerFactory

All Implemented Interfaces:

com.inet.plugin.NamedExtension

public class FileChangeTriggerFactory
extends TriggerFactory<com.inet.taskplanner.server.api.trigger.filechange.FileChangeTrigger>

A task planner trigger that executes a task when a file or folder changes.

Since:

taskplanner 3.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXTENSION_NAME	Extension name of the file change trigger to use in triggerDefinitions.
static final String	PROPERTY_FILE_PATH	Key of the property which holds the path to the file to observe.
static final String	PROPERTY_FOLDER_PATH	Key of the property which holds the path to the folder to observe.
static final String	PROPERTY_TYPE	Key of the property that determines whether a file or a folder must be observed.
static final String	VALUE_FILE	Observe a file and trigger if that file is created, deleted or modified.
static final String	VALUE_FOLDER	Observes a folder and triggers if files in that folder change or the folder itself changes.

Constructor Summary

Constructors

Constructor	Description
FileChangeTriggerFactory()	Creates a file-change trigger factory instance.

Method Summary

Modifier and Type	Method	Description
protected com.inet.taskplanner.server.api.trigger.filechange.FileChangeTrigger	createInstanceFrom(TriggerDefinition definition, com.inet.id.GUID taskID)	Constructs a component (PRODUCT) from the given definition.
TriggerInfo	getInformation(com.inet.id.GUID taskID)	Returns an information object about components which can be produced with this factory.
static @Nullable String	getPathOutOfDef(TriggerDefinition definition)	Gets path out of trigger definition.
SummaryInfo	getSummary(TriggerDefinition definition)	Constructs summary information for the component represented by the given definition.
boolean	isAvailable()	Whether the (COMPONENT) is available or not.
void	validate(TriggerDefinition triggerDefinition, com.inet.id.GUID taskID)	Validate the given definition.

Methods inherited from class TriggerFactory

getNextExecutionTimes

Methods inherited from class SeriesIndependentFactory

createFrom, updateValues

Methods inherited from class AbstractFactory

checkDefinitionArgument, createInstanceFrom, getExtensionName, getInformation, getKeywords, isSupportedForSystemTasks

Methods inherited from class Object

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

Field Details

EXTENSION_NAME

public static final String EXTENSION_NAME

Extension name of the file change trigger to use in triggerDefinitions.

See Also:

• Constant Field Values

PROPERTY_TYPE

public static final String PROPERTY_TYPE

Key of the property that determines whether a file or a folder must be observed. Values can be VALUE_FILE or VALUE_FOLDER

See Also:

• Constant Field Values

VALUE_FILE

public static final String VALUE_FILE

Observe a file and trigger if that file is created, deleted or modified.

See Also:

• Constant Field Values

VALUE_FOLDER

public static final String VALUE_FOLDER

Observes a folder and triggers if files in that folder change or the folder itself changes.

See Also:

• Constant Field Values

PROPERTY_FILE_PATH

public static final String PROPERTY_FILE_PATH

Key of the property which holds the path to the file to observe.

See Also:

• Constant Field Values

PROPERTY_FOLDER_PATH

public static final String PROPERTY_FOLDER_PATH

Key of the property which holds the path to the folder to observe.

See Also:

• Constant Field Values

Constructor Details

FileChangeTriggerFactory

public FileChangeTriggerFactory()

Creates a file-change trigger factory instance.

Since:

taskplanner 3.0

Method Details

createInstanceFrom

protected com.inet.taskplanner.server.api.trigger.filechange.FileChangeTrigger createInstanceFrom(TriggerDefinition definition,
 com.inet.id.GUID taskID)

Constructs a component (PRODUCT) from the given definition.

Overrides:

createInstanceFrom in class AbstractFactory<com.inet.taskplanner.server.api.trigger.filechange.FileChangeTrigger, TriggerDefinition, TriggerInfo, SummaryInfo>

Parameters:

definition - the definition holding information for the PRODUCT

taskID - the ID of the task the definition belongs or will belong to, for optional use. Can be null if the operation is done for a non-saved task.

Returns:

a new PRODUCT

getInformation

public TriggerInfo getInformation(com.inet.id.GUID taskID)

Returns an information object about components which can be produced with this factory.

The returned info contains information about how such a component is to be presented in the Task Planner web GUI. This includes display information and available configuration options. The returned information contains fields that describe the values a user can specify in the web GUI. The fields are also responsible for replacing placeholders for the corresponding property in a serial task. That means properties without a field definition will not get any series placeholder replaced.

If you implement a factory for a component used only through the API, you can return null here.

Specified by:

getInformation in class AbstractFactory<com.inet.taskplanner.server.api.trigger.filechange.FileChangeTrigger, TriggerDefinition, TriggerInfo, SummaryInfo>

Parameters:

taskID - the ID of the task the definition belongs or will belong to, for optional use. Can be null if the operation is done for a non-saved task.

Returns:

an information object for components this factory can produce

validate

public void validate(TriggerDefinition triggerDefinition,
 com.inet.id.GUID taskID)
              throws ValidationException

Validate the given definition.

The given definition is guaranteed to belong to this factory

Specified by:

validate in class SeriesIndependentFactory<com.inet.taskplanner.server.api.trigger.filechange.FileChangeTrigger, TriggerDefinition, TriggerInfo, SummaryInfo>

Parameters:

triggerDefinition - the definition to validate

taskID - the ID of the task the definition belongs or will belong to, for optional use. Can be null if the operation is done for a non-saved task.

Throws:

IllegalArgumentException - if given definition is null.

ValidationException - if the component has some errors

getPathOutOfDef

public static @Nullable String getPathOutOfDef(TriggerDefinition definition)

Gets path out of trigger definition.

Parameters:

definition - definition of the trigger.

Returns:

path from the trigger definition. May be null.

Throws:

IllegalArgumentException - if the definition is null

Since:

taskplanner 3.0

getSummary

public SummaryInfo getSummary(TriggerDefinition definition)

Constructs summary information for the component represented by the given definition.

The summary information is used when the web GUI displays the component.

When implementing a factory for a component to be used only through the API, you can return null here.

Specified by:

getSummary in class AbstractFactory<com.inet.taskplanner.server.api.trigger.filechange.FileChangeTrigger, TriggerDefinition, TriggerInfo, SummaryInfo>

Parameters:

definition - the definition with the settings made by a user

Returns:

summary information containing text lines to be displayed in the web GUI for this component.

isAvailable

public boolean isAvailable()

Whether the (COMPONENT) is available or not.

Overrides:

isAvailable in class AbstractFactory<com.inet.taskplanner.server.api.trigger.filechange.FileChangeTrigger, TriggerDefinition, TriggerInfo, SummaryInfo>

Returns:

whether the (COMPONENT) is available or not