de.aristaflow.adept2.model.events.sources

Interface PollingFileSource

All Superinterfaces:

EventSource<FileEvent>, PollingSource<FileEvent>, java.lang.Runnable

All Known Implementing Classes:

FileEventActivitySource, FileEventSource

@ConfigurationDescription(properties={@Property(name="SearchDirectoryPath",description="The path of the directory which causes an event when a new file is inserted."),,,,,,,})
public interface PollingFileSource
extends PollingSource<FileEvent>

An event source causing an event based on the presence of a file. This may be a file that has been stored to a special folder.
An ordinary implementation of this file source creates an event for each file (and possibly also a directory) present in the folder. This is good for mostly empty folders. Filters may apply for specific files. It is not advised to track the files internally and only create events for new files and ignore existing files. This should be rather solved with an event handler moving a file that has been successfully handled so that the file source does not find the file again.

Author:

Ulrich Kreher, Marco Waimer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONF_FILENAME_FILTER Configuration key for the file name filter.
static java.lang.String	CONF_IS_LOCK_FILE Configuration key for the is lock file flag.
static java.lang.String	CONF_LOCK_FILE_EVENT Configuration key for the lock file event flag.
static java.lang.String	CONF_LOCK_SUFFIX Configuration key for the lock suffix.
static java.lang.String	CONF_SEARCH_DIRECTORY Configuration key for the directory in which to look for the files that cause the events of this event source.
static java.lang.String	CONF_SKIP_DIRECTORIES Configuration key for the skip directories filter.
static java.lang.String	CONF_SKIP_FILES Configuration key for the skip files filter.
static java.lang.String	CONF_SKIP_LOCKED Configuration key for the skip locked files filter.

Fields inherited from interface de.aristaflow.adept2.model.events.sources.PollingSource

CONF_POLL_TIME, CONF_START_TIME

Method Summary

Methods inherited from interface de.aristaflow.adept2.model.events.sources.PollingSource

getPollTime, getStartTime, init, terminate

Methods inherited from interface de.aristaflow.adept2.model.events.sources.EventSource

addAll, addHandler, getEventHandler, getHierarchicalSourceName, getID, getType, removeHandler, setConfiguration

Methods inherited from interface java.lang.Runnable

run

Field Detail

CONF_SEARCH_DIRECTORY

static final java.lang.String CONF_SEARCH_DIRECTORY

Configuration key for the directory in which to look for the files that cause the events of this event source.

See Also:

Constant Field Values

CONF_FILENAME_FILTER

static final java.lang.String CONF_FILENAME_FILTER

Configuration key for the file name filter.

See Also:

Constant Field Values

CONF_SKIP_DIRECTORIES

static final java.lang.String CONF_SKIP_DIRECTORIES

Configuration key for the skip directories filter.

See Also:

Constant Field Values

CONF_SKIP_FILES

static final java.lang.String CONF_SKIP_FILES

Configuration key for the skip files filter.

See Also:

Constant Field Values

CONF_SKIP_LOCKED

static final java.lang.String CONF_SKIP_LOCKED

Configuration key for the skip locked files filter.

See Also:

Constant Field Values

CONF_LOCK_SUFFIX

static final java.lang.String CONF_LOCK_SUFFIX

Configuration key for the lock suffix.

See Also:

Constant Field Values

CONF_LOCK_FILE_EVENT

static final java.lang.String CONF_LOCK_FILE_EVENT

Configuration key for the lock file event flag.

See Also:

Constant Field Values

CONF_IS_LOCK_FILE

static final java.lang.String CONF_IS_LOCK_FILE

Configuration key for the is lock file flag.

See Also:

Constant Field Values