flux.file
Interface FileTrigger

All Superinterfaces:
Action, java.lang.Cloneable, RuntimeDataMap, java.io.Serializable, SingleFileParameter, Trigger
All Known Subinterfaces:
FileExistTrigger, FileModifiedTrigger, FileNotExistTrigger

public interface FileTrigger
extends Trigger, SingleFileParameter

Abstract interface that fires when specified files and directories change state. The file trigger scans the appropriate file system and returns all files and directories that match specific file trigger criteria. The result is returned to the flow context as an object of type FileTrigger.FileTriggerResult.

Author:
Copyright 2014 Flux Corporation. All rights reserved.

Nested Class Summary
static class FileTrigger.File_Res
          Deprecated. Use FileTriggerResult instead. Deprecated in Flux 7.2. Will be removed in Flux 8.0.
static class FileTrigger.FileTriggerResult
          File trigger result, which contains matching files and directories from a concrete file trigger.
 
Method Summary
 AllowableBusinessInterval getActiveWindow()
          Deprecated. Use FileTrigger.getActiveWindowNamespace. Deprecated in Flux 8.0. Will be removed in a future release.
 java.lang.String getActiveWindowNamespace()
          Returns a repository namespace to a business interval, which indicates the times when this file trigger may scan for files.
 java.lang.String getPollingDelay()
          Returns the delay that occurs between file polling.
 SortOrder getSortOrder()
          Returns the sorting algorithm used to order the file trigger result contents.
 void setActiveWindow(AllowableBusinessInterval activeWindow)
          Deprecated. Use FileTrigger.setActiveWindowNamespace. Deprecated in Flux 8.0. Will be removed in a future release.
 void setActiveWindowNamespace(java.lang.String activeWindowNamespace)
          Sets a repository namespace to a business interval, which indicates the times when this file trigger may scan for files.
 void setPollingDelay(java.lang.String timeExpression)
          Sets the delay that occurs between file polling.
 void setSortOrder(SortOrder sortingAlgorithm)
          Sets the sorting algorithm used to order the file trigger result contents.
 
Methods inherited from interface flux.Action
addFlow, addFlow, addSignalFlow, clone, execute, getDescription, getFlows, getHiddenVariableNames, getJoinExpression, getName, getPostscript, getPostscriptLanguage, getPrescript, getPrescriptLanguage, getResultInfo, getSignalsToMonitor, getTimeoutBusinessInterval, getTimeoutBusinessIntervalNamespace, getTimeoutExpression, getVariableManager, isEndOfRun, isJoinPoint, isSkippable, isStartAction, isStartOfRun, isTransactionBreak, removeFlow, reset, setDescription, setElseFlow, setEndOfRun, setErrorFlow, setErrorFlowWithoutRollback, setErrorFlowWithRollback, setJoinExpression, setJoinPoint, setName, setPostscript, setPostscriptLanguage, setPrescript, setPrescriptLanguage, setSignalsToMonitor, setSkippable, setStartAction, setStartOfRun, setTimeoutBusinessInterval, setTimeoutBusinessIntervalNamespace, setTimeoutExpression, setTimeoutFlow, setTransactionBreak, verify, verifyOnClient
 
Methods inherited from interface flux.runtimedatamap.RuntimeDataMap
getRuntimeDataMap, setRuntimeDataMap
 
Methods inherited from interface flux.file.SingleFileParameter
addSource, clear, getSources
 

Method Detail

getActiveWindow

@Deprecated
AllowableBusinessInterval getActiveWindow()
Deprecated. Use FileTrigger.getActiveWindowNamespace. Deprecated in Flux 8.0. Will be removed in a future release.

Returns the times when this file trigger may scan for files. If the active window is null, this file trigger may always scan for files.

Returns:
The times when this file trigger may scan for files. May be null.

getActiveWindowNamespace

java.lang.String getActiveWindowNamespace()
Returns a repository namespace to a business interval, which indicates the times when this file trigger may scan for files. If the active window namespace is null, this file trigger may always scan for files.

Returns:
The times when this file trigger may scan for files. May be null.

getPollingDelay

java.lang.String getPollingDelay()
Returns the delay that occurs between file polling. Defaults to "+3s", 3 seconds.

Returns:
The delay that occurs between file polling.

getSortOrder

SortOrder getSortOrder()
Returns the sorting algorithm used to order the file trigger result contents. The default algorithm is SortOrder.FILENAME_ASCENDING.

Returns:
The sorting algorithm used to order the file trigger result contents.

setActiveWindow

@Deprecated
void setActiveWindow(AllowableBusinessInterval activeWindow)
Deprecated. Use FileTrigger.setActiveWindowNamespace. Deprecated in Flux 8.0. Will be removed in a future release.

Sets the times when this file trigger may scan for files. If the active window is null, this file trigger may always scan for files.

Parameters:
activeWindow - The times when this file trigger may scan for files. May be null.

setActiveWindowNamespace

void setActiveWindowNamespace(java.lang.String activeWindowNamespace)
Sets a repository namespace to a business interval, which indicates the times when this file trigger may scan for files. If the active window namespace is null, this file trigger may always scan for files.

Parameters:
activeWindowNamespace - A repository namespace to a business interval, which indicates the times when this file trigger may scan for files. May be null.

setPollingDelay

void setPollingDelay(java.lang.String timeExpression)
                     throws EngineException
Sets the delay that occurs between file polling. Defaults to "+3s", 3 seconds.

Parameters:
timeExpression - The delay that occurs between file polling.
Throws:
EngineException - If the time expression is invalid or not a positive value or a system error occurs.

setSortOrder

void setSortOrder(SortOrder sortingAlgorithm)
Sets the sorting algorithm used to order the file trigger result contents.

Parameters:
sortingAlgorithm - The sorting algorithm used to order the file trigger result contents.


© 2014 Flux Corporation. All rights reserved.