de.aristaflow.adept2.core.eventmanager.mailevents

Class FilteredMailEventActivitySource

java.lang.Object

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

de.aristaflow.adept2.core.eventmanager.mailevents.MailEventSource

de.aristaflow.adept2.core.eventmanager.mailevents.FilteredMailEventSource

de.aristaflow.adept2.core.eventmanager.mailevents.FilteredMailEventActivitySource

All Implemented Interfaces:

EventSource<MailEvent>, FilteredMailSource, MailSource, PollingMailSource, PollingSource<MailEvent>, java.lang.Runnable

public class FilteredMailEventActivitySource
extends FilteredMailEventSource

A mail event source that allows for filtering mails and additionally provides the means to get the configuration from an activity. Thus this class unifies FilteredMailEventSource and MailEventActivitySource.

Author:

Ulrich Kreher

Field Summary

Fields inherited from class de.aristaflow.adept2.core.eventmanager.mailevents.FilteredMailEventSource

filterBody, filterFlagAnswered, filterFlagDeleted, filterFlagDraft, filterFlagFlagged, filterFlagRecent, filterFlagSeen, filterFlagUser, filterFrom, filterSubject, filterTo, patternBody, patternFrom, patternSubject, patternTo

Fields inherited from class de.aristaflow.adept2.core.eventmanager.mailevents.MailEventSource

eventManagerURIs, folderName, host, keepConnection, password, pollTime, port, protocol, startPoint, store, timeout, userName

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.FilteredMailSource

CONF_BODY_FILTER, CONF_FLAG_ANSWERED_FILTER, CONF_FLAG_DELETED_FILTER, CONF_FLAG_DRAFT_FILTER, CONF_FLAG_FLAGGED_FILTER, CONF_FLAG_RECENT_FILTER, CONF_FLAG_SEEN_FILTER, CONF_FLAG_USER_FILTER, CONF_FROM_FILTER, CONF_SUBJECT_FILTER, CONF_TO_FILTER

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

CONF_FOLDER, CONF_HOST, CONF_PASSWORD, CONF_PORT, CONF_PROTOCOL, CONF_TIMEOUT, CONF_USER_NAME

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

CONF_KEEP_CONNECTION

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

CONF_POLL_TIME, CONF_START_TIME

Constructor Summary

Constructors

Constructor and Description
FilteredMailEventActivitySource(Configuration conf, DefaultEventManager 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.mailevents.FilteredMailEventSource

createMailEvent, filtersApply, filtersApply

Methods inherited from class de.aristaflow.adept2.core.eventmanager.mailevents.MailEventSource

checkForAndHandleEvent, close, closeStore, connectToStore, getPollTime, getStartTime, init, nextHandler, openFolder, setConfiguration, terminate, timedOut, 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, setConfiguration

Methods inherited from interface java.lang.Runnable

run

Constructor Detail

FilteredMailEventActivitySource

public FilteredMailEventActivitySource(Configuration conf,
                                       DefaultEventManager 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 PollingMailSource and a FilteredMailSource, 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! Additionally sets the filters and creates the corresponding string patterns that allow for matching regular expressions. 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 FilteredMailEventSource

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.