de.aristaflow.adept2.core.eventmanager.common

Class DefaultEventManager

java.lang.Object

de.aristaflow.adept2.base.service.AbstractADEPT2Service

de.aristaflow.adept2.base.service.AbstractNonPrivilegedService

de.aristaflow.adept2.core.eventmanager.common.AbstractEventManager

de.aristaflow.adept2.core.eventmanager.common.DefaultEventManager

All Implemented Interfaces:

ADEPT2Service, LogService, ServiceThreadHandling, ActivityEventManager, EventManager, InstanceStartEventManager

public class DefaultEventManager
extends AbstractEventManager

The default event manager supports events based on SQL databases, (incoming) mails and changes in the file system.

Nested Class Summary

Nested classes/interfaces inherited from class de.aristaflow.adept2.base.service.AbstractADEPT2Service

AbstractADEPT2Service.ActiveSessions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PLUGIN_TYPE_DB_MEMORY_RESULT_SET_EVENT The plug-in type ID for memory result set events.
static java.lang.String	PLUGIN_TYPE_DB_RESULT_SET_EVENT The plug-in type ID for result set events.
static java.lang.String	PLUGIN_TYPE_FILE_EVENT The plug-in type ID for file events.
static java.lang.String	PLUGIN_TYPE_MAIL_EVENT The plug-in type ID for mail events.

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

activitySelecting, addEventSourceRetryCount, addEventSourceRetryDelay, CONF_ADD_EVENT_SOURCE_RETRY_COUNT, CONF_ADD_EVENT_SOURCE_RETRY_DELAY, CONF_CREATE_WORKLIST_RETRY_DELAY, CONF_CREATE_WORKLIST_SILENT_COUNT, CONF_HANDLER_MIN_POOL_SIZE, CONF_HANDLER_PRIORITY, CONF_HANDLER_QUEUE_LIMIT, CONF_LIB_DIRECTORY, CONF_MIN_POOL_SIZE, CONF_POLLER_PRIORITY, createWorklistRetryDelay, createWorklistSilentCount, dataLock, exmFactory, filterFactory, futures, handler, handlerMinPoolSize, handlerPriority, handlerQueueLimit, handlerService, handlerSource, instanceControl, libDirectory, MINIMAL_DELAY, minPoolSize, omm, pingWLMInterval, pm, pollerPriority, pollService, PREREGISTERED_EVENT_HANDLER, reconnectLogLevel, reconnectWLMInterval, resumeOnly, runtimeService, sharedSources, sourceCount, sources, supportedEventTypes, updateInterval, worklistHandler

Fields inherited from class de.aristaflow.adept2.base.service.AbstractADEPT2Service

CONF_CSV_LOGGING, configuration, logger, registry, runtimeRequiredServices, startupRequiredServices

Fields inherited from interface de.aristaflow.adept2.core.eventmanager.ActivityEventManager

ACT_CONF_EVENT_TYPE, ACT_CONF_RETRY_COUNT, ACT_CONF_RETRY_DELAY, ACT_CONF_SOURCE_ID, ACT_CONF_SOURCE_TYPE, PLUGIN_TYPE_ACTIVITY_EVENT_HANDLER

Fields inherited from interface de.aristaflow.adept2.core.eventmanager.EventManager

PLUGIN_TYPE_EVENT_HANDLER

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultEventManager(Configuration conf, Registry registry) Creates a new service polling for DB, mail and file events and handling them appropriately.
protected	DefaultEventManager(Configuration conf, Registry registry, java.lang.String[] startupRequiredServices, java.lang.String[] runtimeRequiredServices, java.util.Map<java.lang.String,java.lang.Class<? extends Event>> supportedEvents) Creates a new service polling for DB, mail and file events and handling them appropriately.

Method Summary

Modifier and Type	Method and Description
ExtendedConnection	getConnection(java.lang.String dataSource, boolean readOnly) Retrieves a connection to the designated data source.
java.sql.Connection	getConnection(java.lang.String driver, java.lang.String connectionURL, java.lang.String userName, java.lang.String password) Retrieves a connection to a JDBC-database using the designated information.
java.sql.Connection	getConnection(java.lang.String driver, java.lang.String connectionURL, java.lang.String userName, java.lang.String password, boolean readOnly) Retrieves a connection to a JDBC-database using the designated information.
protected static java.util.Map<java.lang.String,java.lang.Class<? extends Event>>	mergeSupportedEventTypes(java.util.Map<java.lang.String,java.lang.Class<? extends Event>> supportedEvents) Merges the events supported by subclasses and by this default event manager.

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

addEventHandler, addEventHandler, addEventHandler, addEventSource, addPreregistered, addPreregistered, createAndStartInstance, createInstanceDataContainer, createSession, deselectActivity, getEventHandler, getEventSources, getHandlerExecutorService, getInstanceControl, getLatestTemplateReference, getProgressMonitor, getRuntimeEnvironment, getScheduledExecutorService, getSimpleSessionContext, getSupportedEventTypes, getTemplateReference, init, removeAllSources, removeEventHandler, removeEventSource, selectActivity, shutdown, start, startActivity

Methods inherited from class de.aristaflow.adept2.base.service.AbstractNonPrivilegedService

authenticateService, awaitActiveSessions, getSecurityManager, getSessionFactory, simpleInit

Methods inherited from class de.aristaflow.adept2.base.service.AbstractADEPT2Service

_sessionActive, _sessionFinished, activeOrInvalidServiceStateException, changeLogContext, changeLogContext, changeLogContext, consoleLog, csvLoggingEnabled, getClassSpecificJulLogger, getDependencyRegistry, getLocalUris, getLogger, getRelease, getRuntimeRequiredServices, getServiceInstanceName, getStartupRequiredServices, getURIs, getUserCredentials, isActive, isSessionActive, isShutdown, logMethodEntry, logMethodEntry, logMethodEntry, logMethodExit, logMethodExit, ping, preShutdown, privilegeSession, privilegeThread, revertLogContextChanges, sessionActive, sessionActive, sessionActive, sessionActive, sessionFinished, sessionFinished, signalShutdown, signalStart, unprivilegeThread

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.base.service.ADEPT2Service

getLocalUris, getRelease, getRuntimeRequiredServices, getServiceInstanceName, getStartupRequiredServices, getURIs, ping, preShutdown

Field Detail

PLUGIN_TYPE_DB_RESULT_SET_EVENT

public static final java.lang.String PLUGIN_TYPE_DB_RESULT_SET_EVENT

The plug-in type ID for result set events.

See Also:

Constant Field Values

PLUGIN_TYPE_DB_MEMORY_RESULT_SET_EVENT

public static final java.lang.String PLUGIN_TYPE_DB_MEMORY_RESULT_SET_EVENT

The plug-in type ID for memory result set events.

See Also:

Constant Field Values

PLUGIN_TYPE_MAIL_EVENT

public static final java.lang.String PLUGIN_TYPE_MAIL_EVENT

The plug-in type ID for mail events.

See Also:

Constant Field Values

PLUGIN_TYPE_FILE_EVENT

public static final java.lang.String PLUGIN_TYPE_FILE_EVENT

The plug-in type ID for file events.

See Also:

Constant Field Values

Constructor Detail

DefaultEventManager

protected DefaultEventManager(Configuration conf,
                              Registry registry,
                              java.lang.String[] startupRequiredServices,
                              java.lang.String[] runtimeRequiredServices,
                              java.util.Map<java.lang.String,java.lang.Class<? extends Event>> supportedEvents)
                       throws ConfigurationException

Creates a new service polling for DB, mail and file events and handling them appropriately. This constructor is for subclasses allowing to extend the startup and runtime required services as well as the supported event types.

Parameters:

conf - The configuration of this event manager.

registry - The registry for retrieving the services required by this service.

startupRequiredServices - The services required by subclasses for starting and shutting down the event manager. This must neither be null nor contain null values.

runtimeRequiredServices - The services required at runtime of the event manager. This must neither be null nor contain null values.

supportedEvents - The events supported by subclasses. This may be null. The keys of this map will be used to preregister event sources and handlers.

Throws:

ConfigurationException - If the password for this authenticated service cannot be parsed from the configuration, a ConfigurationException will be thrown.

DefaultEventManager

public DefaultEventManager(Configuration conf,
                           Registry registry)
                    throws ConfigurationException

Creates a new service polling for DB, mail and file events and handling them appropriately.
Subclasses should use DefaultEventManager(Configuration, Registry, String[], String[], Map) instead from their registry-conform public constructor.

Parameters:

conf - The configuration of this event manager.

registry - The registry for retrieving the services required by this service.

Throws:

ConfigurationException - If the password for this authenticated service cannot be parsed from the configuration, a ConfigurationException will be thrown.

Method Detail

mergeSupportedEventTypes

protected static java.util.Map<java.lang.String,java.lang.Class<? extends Event>> mergeSupportedEventTypes(java.util.Map<java.lang.String,java.lang.Class<? extends Event>> supportedEvents)

Merges the events supported by subclasses and by this default event manager.

Parameters:

supportedEvents - The events supported by subclasses.

Returns:

The events supported by subclasses merged with the events supported by this default event manager.

getConnection

public ExtendedConnection getConnection(java.lang.String dataSource,
                                        boolean readOnly)
                                 throws ServiceNotKnownException,
                                        java.sql.SQLException

Retrieves a connection to the designated data source.

Parameters:

dataSource - The simple instance name of the data source to which to retrieve a connection.

readOnly - whether the returned connection will be used as read-only

Returns:

A connection to the designated data source.

Throws:

ServiceNotKnownException - If the designated data source cannot be retrieved from the registry, a ServiceNotKnownException will be thrown.

java.sql.SQLException - If creating the connection to the data source fails, an SQLException will be thrown.

getConnection

public java.sql.Connection getConnection(java.lang.String driver,
                                         java.lang.String connectionURL,
                                         java.lang.String userName,
                                         java.lang.String password)
                                  throws ConfigurationException,
                                         java.sql.SQLException

Retrieves a connection to a JDBC-database using the designated information.

Parameters:

driver - The fully-qualified name of the class of the JDBC-driver.

connectionURL - The URL to connect to the database.

userName - The name of the user to log on at the database with. Depending on the JDBC-driver, this may be null.

password - The password to log on a the database with. Depending on the JDBC-driver, this may be null.

Returns:

A connection to a JDBC-database using the designated information.

Throws:

ConfigurationException - If the designated JDBC-driver cannot is not found or cannot be instantiated, a ConfigurationException will be thrown.

java.sql.SQLException - If creating the connection to the JDBC-database fails, an SQLException will be thrown.

getConnection

public java.sql.Connection getConnection(java.lang.String driver,
                                         java.lang.String connectionURL,
                                         java.lang.String userName,
                                         java.lang.String password,
                                         boolean readOnly)
                                  throws ConfigurationException,
                                         java.sql.SQLException

Retrieves a connection to a JDBC-database using the designated information.

Parameters:

driver - The fully-qualified name of the class of the JDBC-driver.

connectionURL - The URL to connect to the database.

userName - The name of the user to log on at the database with. Depending on the JDBC-driver, this may be null.

password - The password to log on a the database with. Depending on the JDBC-driver, this may be null.

readOnly - whether the returned connection will be used as read-only

Returns:

A connection to a JDBC-database using the designated information.

Throws:

ConfigurationException - If the designated JDBC-driver cannot is not found or cannot be instantiated, a ConfigurationException will be thrown.

java.sql.SQLException - If creating the connection to the JDBC-database fails, an SQLException will be thrown.