de.aristaflow.adept2.core.eventmanager.fileevents

Class FileEventActivitySource

java.lang.Object

de.aristaflow.adept2.core.eventmanager.common.AbstractEventSource<FileEvent>

de.aristaflow.adept2.core.eventmanager.fileevents.FileEventSource

de.aristaflow.adept2.core.eventmanager.fileevents.FileEventActivitySource

All Implemented Interfaces:

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

public class FileEventActivitySource
extends FileEventSource

A file event source that takes its configuration from an activity configuration provided from a process step. This allows to have activities that wait for an event to occur.

Author:

Ulrich Kreher, Marco Waimer

Nested Class Summary

Nested classes/interfaces inherited from class de.aristaflow.adept2.core.eventmanager.fileevents.FileEventSource

FileEventSource.FileEventFilter

Field Summary

Fields inherited from class de.aristaflow.adept2.core.eventmanager.fileevents.FileEventSource

eventManagerURIs, filterName, isLockFile, lockFileEvent, lockSuffix, namePattern, pollTime, searchPath, skipDirectories, skipFiles, skipLocked, startPoint

Fields inherited from class de.aristaflow.adept2.core.eventmanager.common.AbstractEventSource

eventType, handlerList, id, lock, logger, sourceType, thread, threadLock

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

CONF_FILENAME_FILTER, CONF_IS_LOCK_FILE, CONF_LOCK_FILE_EVENT, CONF_LOCK_SUFFIX, CONF_SEARCH_DIRECTORY, CONF_SKIP_DIRECTORIES, CONF_SKIP_FILES, CONF_SKIP_LOCKED

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

CONF_POLL_TIME, CONF_START_TIME

Constructor Summary

Constructors

Constructor and Description
FileEventActivitySource(Configuration conf, EventManager eventManager, Registry registry) Default constructor for a plugin of an EventManager called by a service registry.

Method Summary

Modifier and Type	Method and Description
void	setConfiguration(Configuration conf, boolean completed) Sets the internal fields according to the values of the designated configuration.

Methods inherited from class de.aristaflow.adept2.core.eventmanager.fileevents.FileEventSource

checkForAndHandleEvent, createFileEvent, createFileEvent, createLockFileEvent, createLockFileEvent, getPollTime, getStartTime, init, nextHandler, setConfiguration, terminate, verifyConfigurationValues

Methods inherited from class de.aristaflow.adept2.core.eventmanager.common.AbstractEventSource

addAll, addedHandlerLocked, addedHandlerLocked, addHandler, createPattern, forwardEvent, getEventHandler, getHierarchicalSourceName, getID, getType, maskedInterrupt, maskInterrupt, removeHandler, removingHandlerLocked, replaceValueParams, run, unmaskInterrupt

Methods inherited from class java.lang.Object

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

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

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

Methods inherited from interface java.lang.Runnable

run

Constructor Detail

FileEventActivitySource

public FileEventActivitySource(Configuration conf,
                               EventManager eventManager,
                               Registry registry)
                        throws ConfigurationException

Default constructor for a plugin of an EventManager called by a service registry.

Parameters:

conf - The configuration as provided from the registry.

eventManager - The event manager this event source is a plugin of.

registry - The registry of this plugin.

Throws:

ConfigurationException - If the configuration is not valid for a PollingFileSource, a ConfigurationException will be thrown.

Method Detail

setConfiguration

public void setConfiguration(Configuration conf,
                             boolean completed)
                      throws ConfigurationException

Sets the internal fields according to the values of the designated configuration. Note that this method is called from the constructor and therefore this object may not be fully initialised! Sets the configuration by retrieving the session context from it and setting the fields according to the session context. This incorporates overwriting the existing configuration with the values from the activity configuration.
Afterwards parameter references in the attribute values will be replaced with the data context.

Overrides:

setConfiguration in class FileEventSource

Parameters:

conf - The configuration from which to get the configuration values.

completed - Whether the configuration is complete after this setting and therefore the values should be verified.

Throws:

ConfigurationException - If there are problems with the configuration, for instance the configuration does not provide required values, a ConfigurationException may be thrown.