de.aristaflow.adept2.core.eventmanager.common

Class AbstractEventManager

java.lang.Object

de.aristaflow.adept2.base.service.AbstractADEPT2Service

de.aristaflow.adept2.base.service.AbstractNonPrivilegedService

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

All Implemented Interfaces:

ADEPT2Service, LogService, ServiceThreadHandling, ActivityEventManager, EventManager, InstanceStartEventManager

Direct Known Subclasses:

DefaultEventManager

@ConfigurationDescription(properties={@Property(name="LibDirectory",defaultValue="${arflow:arflow.libdir}",description="The name of the directory providing the JDBC libraries. This is actually the directory containing a directory named \'jdbc4\' which in turn contains the JDBC drivers."),,,,,,,,,,,,,,})
public class AbstractEventManager
extends AbstractNonPrivilegedService
implements ActivityEventManager, InstanceStartEventManager

The event manager creates event handler and event sources. Polling event sources are regularly (depending on their configuration) executed. Event handlers may be preregistered for specific event sources in the configuration of this event manager. This allows for generic event handling without knowing the sources. Additionally, event sources can be started together with this event manager. Together with an appropriate event handler this can be used, for instance to start process instances as soon as the corresponding event occurs.

This event service also listens at the worklist for activities that need to wait for an event. These activities will be started activities to retrieve their configuration and the data context. Afterwards the corresponding event source will be created and the activity will be suspended or reset. Resuming or starting of the activity is then up to the corresponding event handler.

Besides simple polling sources, this event manager also supports shared event sources that poll for several sharing event sources. Occurred events are distributed among the registered sharing event sources. For instance, in case of an SQL database a sharing event sources may wait for specific using an SQL statement. Event sources having SQL statements that differ only in some values may be combined using one SQL statement. The result of the SQL statements, that are the rows of the result set, are distributed appropriately among the sharing event sources so that every event source gets the results it waits for.

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
protected ActivityStarting	activitySelecting The interface for selecting an activity.
protected int	addEventSourceRetryCount The number of retries for adding an event source.
protected long	addEventSourceRetryDelay The time in milliseconds to wait before retrying to add an event source.
protected static java.lang.String	CONF_ADD_EVENT_SOURCE_RETRY_COUNT Configuration key: The number of retries for adding an event source.
protected static java.lang.String	CONF_ADD_EVENT_SOURCE_RETRY_DELAY Configuration key: The time in milliseconds to wait before retrying to add an event source.
protected static java.lang.String	CONF_CREATE_WORKLIST_RETRY_DELAY Configuration key: The time in milliseconds to wait before retrying to create (retrieve) a client worklist.
protected static java.lang.String	CONF_CREATE_WORKLIST_SILENT_COUNT Configuration key: The number of retries for creating (retrieving) a client worklist before logging the exception as critical.
protected static java.lang.String	CONF_HANDLER_MIN_POOL_SIZE Configuration key: The minimal number of executor threads for handling events by various sources.
protected static java.lang.String	CONF_HANDLER_PRIORITY Configuration key: The priority of the event handling threads used by various sources.
protected static java.lang.String	CONF_HANDLER_QUEUE_LIMIT Configuration key: The number of tasks in the executor queue that are allowed before warnings will be logged.
protected static java.lang.String	CONF_LIB_DIRECTORY Configuration key for the name of the directory providing the JDBC libraries (actually one level above the directory 'jdbc4' containing the drivers).
protected static java.lang.String	CONF_MIN_POOL_SIZE Configuration key: The minimal number of executor threads for polling events.
protected static java.lang.String	CONF_POLLER_PRIORITY Configuration key: The priority of the polling threads.
protected long	createWorklistRetryDelay The time in milliseconds to wait before retrying to create (retrieve) a client worklist.
protected int	createWorklistSilentCount The number of retries for creating (retrieving) a client worklist before logging the exception as critical.
protected java.util.concurrent.locks.ReadWriteLock	dataLock The lock protecting the data structures containing the handler and sources.
protected ExecutionFactory	exmFactory The factory for creating the execution context for starting instances.
protected FilterFactory	filterFactory The filter factory required for retrieving the "latest" template of a specific process type.
protected java.util.Map<PollingSource<?>,java.util.concurrent.ScheduledFuture<?>>	futures /** All the event sources mapped to the corresponding futures from the poll service.
protected java.util.Map<Pair<java.lang.String,java.lang.String>,java.util.List<EventHandler>>	handler All known event handler indexed by the event and source type they are registered for.
protected int	handlerMinPoolSize Minimal number of executor threads for handling events.
protected int	handlerPriority The priority of the event handling threads used by various sources.
protected int	handlerQueueLimit The number of tasks in the executor queue that are allowed before executor warnings will be logged.
protected java.util.concurrent.ExecutorService	handlerService The service that is shared among sources for asynchronous event handling.
protected java.util.Map<EventHandler,java.util.Collection<EventSource<?>>>	handlerSource All handler and the sources they are registered for.
protected InstanceControl	instanceControl The control interface for starting instances.
protected java.lang.String	libDirectory The name of the directory providing the JDBC libraries (actually one level above the directory 'jdbc4' containing the drivers).
protected static long	MINIMAL_DELAY The minimal delay for the first poll of polling sources.
protected int	minPoolSize Minimal number of executor threads for polling events.
protected OrgModelManager	omm The org model manager for checking the starter rule.
protected long	pingWLMInterval The time interval in milliseconds which to regularly check whether the worklist manager is still available or available again.
protected ProcessManager	pm The process manager for retrieving templates to be started.
protected int	pollerPriority The priority of the polling threads.
protected LoggingScheduledThreadPoolExecutor	pollService The service that executes the pollers that cause the events.
protected static java.lang.String	PREREGISTERED_EVENT_HANDLER The configuration key for the pre-registered event handler per source.
protected java.util.logging.Level	reconnectLogLevel The log level that will be used to log that no push update was received yet.
protected long	reconnectWLMInterval The time interval in milliseconds which to regularly reconnect to the worklist manager if no push update was received yet.
protected boolean	resumeOnly Flag to indicate whether to resume items and not to start new ones.
protected RuntimeService	runtimeService The runtime service for starting and terminating activities that wait for an event.
protected java.util.Collection<SharedPollingSource<?>>	sharedSources All shared polling sources.
protected ObjectCounting<Triple<java.lang.String,java.lang.String,java.lang.String>>	sourceCount The amount of sources per source ID.
protected java.util.Map<Pair<java.lang.String,java.lang.String>,java.util.Map<java.lang.String,EventSource<?>>>	sources All existing event sources indexed by event type and source type mapped to source ID and source.
protected java.util.Map<java.lang.String,java.lang.Class<? extends Event>>	supportedEventTypes All event types that are supported by this event manager.
protected long	updateInterval Interval (in ms) for pushed updates.
protected de.aristaflow.adept2.core.automaticclient.AbstractWorklistHandler	worklistHandler The worklist handler creating event sources depending on the contents of the worklist.

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
protected	AbstractEventManager(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 an event manager creating event sources and combining them with the appropriate event handlers.

Method Summary

Modifier and Type	Method and Description
EventHandler	addEventHandler(SessionToken session, java.lang.String eventType, java.lang.String sourceType, EventHandler current, int index) Adds the designated event handler to the designated event type and event source at the designated position.
protected EventHandler	addEventHandler(SessionToken session, java.lang.String eventType, java.lang.String sourceType, java.lang.String handlerID, EventHandler current, int index) Adds the designated event handler to the designated event type and source type.
EventHandler	addEventHandler(SessionToken session, java.lang.String eventType, java.lang.String sourceType, java.lang.String handlerID, int index) Adds an event handler having the designated ID to the designated event type and event source at the designated position.
EventSource<?>	addEventSource(SessionToken session, java.lang.String eventType, java.lang.String sourceType, java.lang.String sourceID, Configuration conf) Adds an event source having the designated ID to the designated event type and event source.
protected void	addPreregistered(Configuration conf) Reads the event handler and sources from the configuration based on the supported event types, registers and starts them initially and adds them afterwards.
protected void	addPreregistered(Configuration conf, java.util.Iterator<java.lang.String> sourceTypes) Reads the event handler and sources for the designated source types from the configuration, registers and starts them initially and adds them afterwards.
java.util.UUID	createAndStartInstance(SessionToken session, java.util.UUID templateID, InstanceDataContainer dataContainer) Creates a new instance of the designated process template, starts the instance and logs the designated user as initiator of the process instance.
InstanceDataContainer	createInstanceDataContainer(SessionToken session, java.util.UUID templateID) Creates an instance data container for the input (and output) parameters of the designated template.
SessionToken	createSession() Creates a new session token using the client session factory assigned to this service.
void	deselectActivity(EBPInstanceReference activity) Deselects the designated activity and thus makes it available for reassigning.
java.util.List<java.lang.String>	getEventHandler(SessionToken session, java.lang.String eventType, java.lang.String sourceType) Gets the event handler that are registered for the designated event type and source type.
java.util.Collection<java.lang.String>	getEventSources(SessionToken session, java.lang.String eventType, java.lang.String sourceType) Gets the event sources that exist for the designated event type and source type.
java.util.concurrent.ExecutorService	getHandlerExecutorService() Gets an executor service for event handling by arbitrary event sources.
InstanceControl	getInstanceControl() Gets the instance control of the execution manager of this event manager for starting a new instance based on an occurred database event.
TemplateReference	getLatestTemplateReference(SessionToken session, java.lang.String processType, boolean checkStarterRule) Gets the lightweight representation of the "latest" process template of the designated process type.
RemoteProgressMonitor	getProgressMonitor() Gets the interface for remotely using ProgressMonitor.
RemoteRuntimeEnvironment	getRuntimeEnvironment() Gets the interface for remotely using RuntimeEnvironment.
protected LoggingScheduledThreadPoolExecutor	getScheduledExecutorService() Gets the scheduled executor service for usage by worklist handler and event source management.
SimpleSessionContext	getSimpleSessionContext(EBPInstanceReference activity, ProcessConstants.ExecutionMode executionMode) Gets an uncomplete simple session context for the designated activity.
java.util.Map<java.lang.String,java.lang.Class<? extends Event>>	getSupportedEventTypes(SessionToken session) Gets all the event types this event manager supports, that is, it can create event sources for these event types.
TemplateReference	getTemplateReference(SessionToken session, java.util.UUID templateID) Gets the lightweight representation of the designated process template.
void	init(java.net.URI[] localExportedUris, java.net.URI[] globalExportedUris) Copies the designated URI array and stores it internally and authenticates to the system and sets the session factory.
protected void	removeAllSources() Removes all currently active data sources and stops their polling.
EventHandler	removeEventHandler(SessionToken session, java.lang.String eventType, java.lang.String sourceType, java.lang.String handlerID) Removes the event handler having the designated ID and being registered for the designated event type and event source.
EventSource<?>	removeEventSource(SessionToken session, java.lang.String eventType, java.lang.String sourceType, java.lang.String sourceID) Removes the event source having the designated event type, event source and ID.
SimpleSessionContext	selectActivity(EBPInstanceReference activity) Selects the designated activity and thus assigns it to this event manager.
void	shutdown(boolean emergency) Awaits the termination of the active sessions and nulls the session factory.
void	start() Method setting the status to the current time.
Pair<SessionToken,SimpleSessionContext>	startActivity(EBPInstanceReference activity, ProcessConstants.ExecutionMode executionMode) Starts the designated activity if it is appropriate for a RuntimeService and provides its process context.

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

PREREGISTERED_EVENT_HANDLER

protected static final java.lang.String PREREGISTERED_EVENT_HANDLER

The configuration key for the pre-registered event handler per source.

See Also:

Constant Field Values

CONF_LIB_DIRECTORY

protected static final java.lang.String CONF_LIB_DIRECTORY

Configuration key for the name of the directory providing the JDBC libraries (actually one level above the directory 'jdbc4' containing the drivers).

See Also:

Constant Field Values

libDirectory

protected final java.lang.String libDirectory

The name of the directory providing the JDBC libraries (actually one level above the directory 'jdbc4' containing the drivers).

CONF_ADD_EVENT_SOURCE_RETRY_COUNT

protected static final java.lang.String CONF_ADD_EVENT_SOURCE_RETRY_COUNT

Configuration key: The number of retries for adding an event source.

See Also:

Constant Field Values

addEventSourceRetryCount

protected final int addEventSourceRetryCount

The number of retries for adding an event source.

CONF_ADD_EVENT_SOURCE_RETRY_DELAY

protected static final java.lang.String CONF_ADD_EVENT_SOURCE_RETRY_DELAY

Configuration key: The time in milliseconds to wait before retrying to add an event source.

See Also:

Constant Field Values

addEventSourceRetryDelay

protected final long addEventSourceRetryDelay

The time in milliseconds to wait before retrying to add an event source.

CONF_MIN_POOL_SIZE

protected static final java.lang.String CONF_MIN_POOL_SIZE

Configuration key: The minimal number of executor threads for polling events.

See Also:

Constant Field Values

minPoolSize

protected final int minPoolSize

Minimal number of executor threads for polling events. These are at least 2.

pingWLMInterval

protected final long pingWLMInterval

The time interval in milliseconds which to regularly check whether the worklist manager is still available or available again.

reconnectWLMInterval

protected final long reconnectWLMInterval

The time interval in milliseconds which to regularly reconnect to the worklist manager if no push update was received yet.

reconnectLogLevel

protected final java.util.logging.Level reconnectLogLevel

The log level that will be used to log that no push update was received yet.

CONF_CREATE_WORKLIST_SILENT_COUNT

protected static final java.lang.String CONF_CREATE_WORKLIST_SILENT_COUNT

Configuration key: The number of retries for creating (retrieving) a client worklist before logging the exception as critical.

See Also:

Constant Field Values

createWorklistSilentCount

protected final int createWorklistSilentCount

The number of retries for creating (retrieving) a client worklist before logging the exception as critical.

CONF_CREATE_WORKLIST_RETRY_DELAY

protected static final java.lang.String CONF_CREATE_WORKLIST_RETRY_DELAY

Configuration key: The time in milliseconds to wait before retrying to create (retrieve) a client worklist.

See Also:

Constant Field Values

createWorklistRetryDelay

protected final long createWorklistRetryDelay

The time in milliseconds to wait before retrying to create (retrieve) a client worklist.

CONF_POLLER_PRIORITY

protected static final java.lang.String CONF_POLLER_PRIORITY

Configuration key: The priority of the polling threads.

See Also:

Constant Field Values

pollerPriority

protected final int pollerPriority

The priority of the polling threads.

CONF_HANDLER_MIN_POOL_SIZE

protected static final java.lang.String CONF_HANDLER_MIN_POOL_SIZE

Configuration key: The minimal number of executor threads for handling events by various sources.

See Also:

Constant Field Values

handlerMinPoolSize

protected final int handlerMinPoolSize

Minimal number of executor threads for handling events.

CONF_HANDLER_PRIORITY

protected static final java.lang.String CONF_HANDLER_PRIORITY

Configuration key: The priority of the event handling threads used by various sources.

See Also:

Constant Field Values

handlerPriority

protected final int handlerPriority

The priority of the event handling threads used by various sources.

CONF_HANDLER_QUEUE_LIMIT

protected static final java.lang.String CONF_HANDLER_QUEUE_LIMIT

Configuration key: The number of tasks in the executor queue that are allowed before warnings will be logged.

See Also:

Constant Field Values

handlerQueueLimit

protected final int handlerQueueLimit

The number of tasks in the executor queue that are allowed before executor warnings will be logged.

resumeOnly

protected final boolean resumeOnly

Flag to indicate whether to resume items and not to start new ones.

updateInterval

protected final long updateInterval

Interval (in ms) for pushed updates.

MINIMAL_DELAY

protected static final long MINIMAL_DELAY

The minimal delay for the first poll of polling sources. Polling should not start earlier to allow for the corresponding handlers to be registered appropriately at the new source.

See Also:

Constant Field Values

exmFactory

protected ExecutionFactory exmFactory

The factory for creating the execution context for starting instances.

filterFactory

protected FilterFactory filterFactory

The filter factory required for retrieving the "latest" template of a specific process type.

runtimeService

protected RuntimeService runtimeService

The runtime service for starting and terminating activities that wait for an event.

pm

protected ProcessManager pm

The process manager for retrieving templates to be started.

instanceControl

protected InstanceControl instanceControl

The control interface for starting instances.

activitySelecting

protected ActivityStarting activitySelecting

The interface for selecting an activity.

omm

protected OrgModelManager omm

The org model manager for checking the starter rule.

pollService

protected LoggingScheduledThreadPoolExecutor pollService

The service that executes the pollers that cause the events.

handlerService

protected java.util.concurrent.ExecutorService handlerService

The service that is shared among sources for asynchronous event handling.

worklistHandler

protected de.aristaflow.adept2.core.automaticclient.AbstractWorklistHandler worklistHandler

The worklist handler creating event sources depending on the contents of the worklist.

dataLock

protected final java.util.concurrent.locks.ReadWriteLock dataLock

The lock protecting the data structures containing the handler and sources.

sources

protected final java.util.Map<Pair<java.lang.String,java.lang.String>,java.util.Map<java.lang.String,EventSource<?>>> sources

All existing event sources indexed by event type and source type mapped to source ID and source.

sourceCount

protected final ObjectCounting<Triple<java.lang.String,java.lang.String,java.lang.String>> sourceCount

The amount of sources per source ID. In case a source has been added several times it must not be removed until the last adder removes it again.

futures

protected final java.util.Map<PollingSource<?>,java.util.concurrent.ScheduledFuture<?>> futures

/** All the event sources mapped to the corresponding futures from the poll service. This allows to terminate an event source.

sharedSources

protected final java.util.Collection<SharedPollingSource<?>> sharedSources

All shared polling sources. These need to be tracked separately so that they can be reused when adding a sharing event source.

handler

protected final java.util.Map<Pair<java.lang.String,java.lang.String>,java.util.List<EventHandler>> handler

All known event handler indexed by the event and source type they are registered for.

handlerSource

protected final java.util.Map<EventHandler,java.util.Collection<EventSource<?>>> handlerSource

All handler and the sources they are registered for.

supportedEventTypes

protected final java.util.Map<java.lang.String,java.lang.Class<? extends Event>> supportedEventTypes

All event types that are supported by this event manager.

Constructor Detail

AbstractEventManager

protected AbstractEventManager(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 an event manager creating event sources and combining them with the appropriate event handlers. It also provides the means for starting instances or activities.

Parameters:

conf - The configuration of this service.

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.

Method Detail

init

public void init(java.net.URI[] localExportedUris,
                 java.net.URI[] globalExportedUris)
          throws AbortServiceException

Description copied from class: AbstractNonPrivilegedService

Copies the designated URI array and stores it internally and authenticates to the system and sets the session factory.
This method can be called any time in overriding init-methods.

Specified by:

init in interface ADEPT2Service

Overrides:

init in class AbstractNonPrivilegedService

Parameters:

localExportedUris - The URIs with which this service is exported locally or a local URI or an empty array for internal services.

globalExportedUris - The URIs with which this service is published globally or null in case the service is not published.

Throws:

AbortServiceException - If authenticating at the security manager fails, an AbortServiceException will be thrown.

start

public void start()
           throws AbortServiceException

Description copied from class: AbstractADEPT2Service

Method setting the status to the current time. Subclasses have to call this method!

Specified by:

start in interface ADEPT2Service

Overrides:

start in class AbstractADEPT2Service

Throws:

AbortServiceException - If this service cannot be started due to a severe problem, an AbortServiceException will be thrown. ADEPT2Service.shutdown(boolean) will not be called when aborting; the service has to shut down itself/clean up before throwing the exception.

shutdown

public void shutdown(boolean emergency)

Description copied from class: AbstractNonPrivilegedService

Awaits the termination of the active sessions and nulls the session factory.

Specified by:

shutdown in interface ADEPT2Service

Overrides:

shutdown in class AbstractNonPrivilegedService

Parameters:

emergency - Whether the shutdown will be an emergency shutdown.

addPreregistered

protected void addPreregistered(Configuration conf)
                         throws ServiceNotKnownException,
                                ConfigurationException

Reads the event handler and sources from the configuration based on the supported event types, registers and starts them initially and adds them afterwards.

Parameters:

conf - The configuration from which to retrieve the event handler and event sources to be registered when initialising/starting this event manager.

Throws:

ServiceNotKnownException - If there are problems with the plugin configuration or no plugin configured at all for the pre-registered event handler or event sources, a ServiceNotKnownException will be thrown.

ConfigurationException - If there are problems with the configuration of an event source, a ConfigurationException will be thrown.

addPreregistered

protected void addPreregistered(Configuration conf,
                                java.util.Iterator<java.lang.String> sourceTypes)
                         throws ServiceNotKnownException,
                                ConfigurationException

Reads the event handler and sources for the designated source types from the configuration, registers and starts them initially and adds them afterwards.

Parameters:

conf - The configuration from which to retrieve the event handler and event sources to be registered when initialising/starting this event manager.

sourceTypes - The source types for which to retrieve the event handler and event sources to be registered when initialising/starting this event manager.

Throws:

ServiceNotKnownException - If there are problems with the plugin configuration or no plugin configured at all for the pre-registered event handler or event sources, a ServiceNotKnownException will be thrown.

ConfigurationException - If there are problems with the configuration of an event source, a ConfigurationException will be thrown.

createSession

public SessionToken createSession()

Creates a new session token using the client session factory assigned to this service.

Overridden to make it accessible within this package.

Overrides:

createSession in class AbstractNonPrivilegedService

Returns:

A new session token using the client session factory assigned to this service.

getScheduledExecutorService

protected LoggingScheduledThreadPoolExecutor getScheduledExecutorService()

Gets the scheduled executor service for usage by worklist handler and event source management. Use this for polling at determined times.

Returns:

The scheduled executor service for usage by worklist handler and event source management.

getHandlerExecutorService

public java.util.concurrent.ExecutorService getHandlerExecutorService()

Gets an executor service for event handling by arbitrary event sources. This allows them to handle events asynchronously without creating too many threads.

Returns:

An executor service for event handling by arbitrary event sources allowing them to handle events asynchronously without creating too many threads.

removeAllSources

protected void removeAllSources()

Removes all currently active data sources and stops their polling.

getSupportedEventTypes

public java.util.Map<java.lang.String,java.lang.Class<? extends Event>> getSupportedEventTypes(SessionToken session)

Description copied from interface: EventManager

Gets all the event types this event manager supports, that is, it can create event sources for these event types.

Specified by:

getSupportedEventTypes in interface EventManager

Parameters:

session - The session which is used to check for access rights on this method.

Returns:

All event types that are supported by this event manager and for which this event manager can create event sources. They are indexed by the event type name (which equals the plugin type name for event sources).

getEventSources

public java.util.Collection<java.lang.String> getEventSources(SessionToken session,
                                                              java.lang.String eventType,
                                                              java.lang.String sourceType)

Description copied from interface: EventManager

Gets the event sources that exist for the designated event type and source type.

Specified by:

getEventSources in interface EventManager

Parameters:

session - The session which is used to check for access rights on this method.

eventType - The event type for which to get the event sources.

sourceType - The source type for which to get the event sources.

Returns:

The event sources registered for the designated event type and source type. In case no source exists for this event type and source type, the empty collection will be returned.

addEventSource

public EventSource<?> addEventSource(SessionToken session,
                                     java.lang.String eventType,
                                     java.lang.String sourceType,
                                     java.lang.String sourceID,
                                     Configuration conf)
                              throws ConfigurationException,
                                     ServiceNotKnownException

Description copied from interface: EventManager

Adds an event source having the designated ID to the designated event type and event source. The designated configuration will complement the plugin configuration of the source. If there is already a source of the designated ID for the designated event type and source type, it will be returned. Event handler registered for the designated event type and source type will be registered at the new source.

Specified by:

addEventSource in interface EventManager

Parameters:

session - The session which is used to check for access rights on this method.

eventType - The type of which the source creates events.

sourceType - The type of the source to add.

sourceID - The unique (with respect to the event type and source type) ID of the source to add.

conf - The configuration of the source which complements the plugin configuration.

Returns:

The newly created or the existing event source.

Throws:

ConfigurationException - If there are problems with the designated configuration, a ConfigurationException will be thrown.

ServiceNotKnownException - If there are problems with the plugin configuration or no plugin configured at all for the designated source a ServiceNotKnownException will be thrown.

removeEventSource

public EventSource<?> removeEventSource(SessionToken session,
                                        java.lang.String eventType,
                                        java.lang.String sourceType,
                                        java.lang.String sourceID)

Description copied from interface: EventManager

Removes the event source having the designated event type, event source and ID. The removed event source will be returned. If no event source is found, null will be returned. All handler will be removed from the designated event source.

Specified by:

removeEventSource in interface EventManager

Parameters:

session - The session which is used to check for access rights on this method.

eventType - The event type of which to remove a source.

sourceType - The type of which to remove a source.

sourceID - The ID of the source to remove.

Returns:

The removed event source or null in case there is already an event source of the designated source ID.

getEventHandler

public java.util.List<java.lang.String> getEventHandler(SessionToken session,
                                                        java.lang.String eventType,
                                                        java.lang.String sourceType)

Description copied from interface: EventManager

Gets the event handler that are registered for the designated event type and source type.

Specified by:

getEventHandler in interface EventManager

Parameters:

session - The session which is used to check for access rights on this method.

eventType - The event type for which to get the event handler.

sourceType - The source type for which to get the event handler.

Returns:

The event handler registered for the designated event type and source type in the order they are notified about the corresponding events. In case no handler is registered, the empty list will be returned.

addEventHandler

public EventHandler addEventHandler(SessionToken session,
                                    java.lang.String eventType,
                                    java.lang.String sourceType,
                                    java.lang.String handlerID,
                                    int index)
                             throws ServiceNotKnownException

Description copied from interface: EventManager

Adds an event handler having the designated ID to the designated event type and event source at the designated position. If there is already an event handler of the designated ID for the designated event type and source type, it will be returned. An existing handler may change its position according to the provided one. The event handler will be registered at all existing sources of the designated event type and source type.

Specified by:

addEventHandler in interface EventManager

Parameters:

session - The session which is used to check for access rights on this method.

eventType - The event type for which to register the event handler.

sourceType - The source type for which to register the event handler.

handlerID - The unique (with respect to the event type and source type) ID of the handler to add.

index - The (0-based) position in the handler list for the designated event type and source type.

Returns:

The newly created or the existing event handler.

Throws:

ServiceNotKnownException - If there are problems with the plugin configuration or no plugin configured at all for the designated source a ServiceNotKnownException will be thrown.

addEventHandler

public EventHandler addEventHandler(SessionToken session,
                                    java.lang.String eventType,
                                    java.lang.String sourceType,
                                    EventHandler current,
                                    int index)

Description copied from interface: EventManager

Adds the designated event handler to the designated event type and event source at the designated position. If there is already an event handler of the designated ID for the designated event type and source type, it will be returned and the designated handler will be ignored. An existing handler may change its position according to the provided one. The event handler will be registered at all existing sources of the designated event type and source type.
This method does not retrieve the handler as plugin and therefore does not need an appropriate plugin configuration for the handler.

Specified by:

addEventHandler in interface EventManager

Parameters:

session - The session which is used to check for access rights on this method.

eventType - The event type for which to register the event handler.

sourceType - The source type for which to register the event handler.

current - The handler which to add.

index - The (0-based) position in the handler list for the designated event type and source type.

Returns:

The designated or the existing event handler.

addEventHandler

protected EventHandler addEventHandler(SessionToken session,
                                       java.lang.String eventType,
                                       java.lang.String sourceType,
                                       java.lang.String handlerID,
                                       EventHandler current,
                                       int index)
                                throws ServiceNotKnownException

Adds the designated event handler to the designated event type and source type. This handler will be registered at all sources providing this event type and having this source type. If only a handler ID is provided, a new handler will be created as plugin to this event manager.
Adding as well as creating will be skipped, if a handler of the designated ID is already registered for the event type and source type. In this case the existing handler may change its position in the list (if the position differs from the handler’s current position). Additionally, the existing handler will be returned instead of the designated or the newly created one.

Parameters:

session - The session which is used to check for access rights on this method.

eventType - The event type for which to add an event handler.

sourceType - The source type for which to add an event handler.

handlerID - The ID of the handler. This refers to the corresponding plugin ID. If this is null, a valid handler needs to be provided as current.

current - The handler to add to the designated event type and source type. If this is null, a valid handler ID (the instance name of the corresponding plugin) needs to be provided.

index - The position where to add the designated handler in the handler list of the designated event type and source type. If the handler is already part of the list, it will be moved in case the new position differs from its current position.

Returns:

The newly created handler or the handler object that has already been registered for the designated event type and source type (and having the same handler ID).

Throws:

ServiceNotKnownException - If a handler ID is provided and this does not refer to a valid plugin instance for an activity event handler, a ServiceNotKnownException will be thrown.

removeEventHandler

public EventHandler removeEventHandler(SessionToken session,
                                       java.lang.String eventType,
                                       java.lang.String sourceType,
                                       java.lang.String handlerID)

Description copied from interface: EventManager

Removes the event handler having the designated ID and being registered for the designated event type and event source. The removed event handler will be returned. If no event handler is found, null will be returned. The handler will be removed from the corresponding event sources.

Specified by:

removeEventHandler in interface EventManager

Parameters:

session - The session which is used to check for access rights on this method.

eventType - The event type of which to remove an event handler.

sourceType - The source type of which to remove an event handler.

handlerID - The ID of the handler to remove.

Returns:

The removed event source or null in case there is already an event source of the designated source ID.

selectActivity

public SimpleSessionContext selectActivity(EBPInstanceReference activity)
                                    throws InvalidActivityStateException,
                                           InvalidInstanceStateException

Description copied from interface: ActivityEventManager

Selects the designated activity and thus assigns it to this event manager. This prevents other users from starting the activity. The simple session context of the activity will be returned which is similar to retrieving it without selection for ProcessConstants.ExecutionMode.PRODUCTION.
This method is used to indicate that an event source has been created or is about to be created for the activity and is waiting for the event to occur.

Specified by:

selectActivity in interface ActivityEventManager

Parameters:

activity - The activity to select for which an event source exists or is about to be created.

Returns:

The session context of the activity providing more information on the activity waiting for an event.

Throws:

InvalidActivityStateException - If the activity (process step) is not activated, an InvalidActivityStateException will be raised.

InvalidInstanceStateException - If the instance is not running but stopped, aborted, finished or changed, an InvalidInstanceStateException will be thrown.

See Also:

ActivityStarting.selectActivity(SessionToken, EBPInstanceReference)

deselectActivity

public void deselectActivity(EBPInstanceReference activity)
                      throws InvalidActivityStateException,
                             InvalidInstanceStateException

Description copied from interface: ActivityEventManager

Deselects the designated activity and thus makes it available for reassigning. This allows other users to start the activity. This method indicates that no event source is waiting for the event of the activity any more.

Specified by:

deselectActivity in interface ActivityEventManager

Parameters:

activity - The activity to deselect.

Throws:

InvalidActivityStateException - If the activity (process step) is not selected by the designated user, an InvalidActivityStateException will be raised.

InvalidInstanceStateException - If the instance is not running but stopped, aborted, finished or changed, an InvalidInstanceStateException will be thrown.

See Also:

ActivityStarting.deselectActivity(SessionToken, EBPInstanceReference)

getSimpleSessionContext

public SimpleSessionContext getSimpleSessionContext(EBPInstanceReference activity,
                                                    ProcessConstants.ExecutionMode executionMode)
                                             throws InvalidActivityStateException,
                                                    InvalidInstanceStateException

Description copied from interface: ActivityEventManager

Gets an uncomplete simple session context for the designated activity. This just returns the simple session context without any state changes of the activity. This method can only be called for activities that are assigned to this event manager, for instance by having called ActivityEventManager.selectActivity(EBPInstanceReference).

The SimpleSessionContext.getSessionID() of the returned context will be null and the flag SimpleSessionContext.isResumed() will be unset since they cannot be determined.

Specified by:

getSimpleSessionContext in interface ActivityEventManager

Parameters:

activity - The activity for which to retrieve the simple session context.

executionMode - The execution mode which to apply, which may have consequences on the configuration.

Returns:

The simple session context for the designated activity as far as its attributes can be determined. This is only returned if the activity is assigned (selected, running or suspended) to this event manager.

Throws:

InvalidActivityStateException - If the activity (process step) is not selected, running or suspended this event manager, an InvalidActivityStateException will be raised.

InvalidInstanceStateException - If the instance is not running but stopped, aborted, finished or changed, an InvalidInstanceStateException is thrown.

See Also:

ActivityStarting.getExecutionContext(SessionToken, EBPInstanceReference)

startActivity

public Pair<SessionToken,SimpleSessionContext> startActivity(EBPInstanceReference activity,
                                                             ProcessConstants.ExecutionMode executionMode)
                                                      throws InvalidActivityStateException,
                                                             InvalidInstanceStateException

Description copied from interface: ActivityEventManager

Starts the designated activity if it is appropriate for a RuntimeService and provides its process context. This activity event manager registers as ExecutionMessageListener and forwards the messages to the appropriate event handler. Since starting the activity is internally asynchronous, a timeout is required. If this timeout elapses the start will be aborted and null will be returned.

Specified by:

startActivity in interface ActivityEventManager

Parameters:

activity - The unique ID of the activity to start.

executionMode - The execution mode in which to start the activity, for instance, a test mode.

Returns:

The session token which with the activity is started and the SimpleSessionContext providing the process context (e.g. the input parameter values) of the started activity.

Throws:

InvalidActivityStateException - If the activity (process step) is not activated or selected by the designated user, an InvalidActivityStateException will be raised.

InvalidInstanceStateException - If the instance is not running but stopped, aborted, finished or changed, an InvalidInstanceStateException is thrown.

See Also:

de.aristaflow.adept2.core.runtimeservice.RemoteActivityStarting#startActivity(SessionToken, EBPInstanceReference, ExecutionMode, java.net.URI[])

getRuntimeEnvironment

public RemoteRuntimeEnvironment getRuntimeEnvironment()

Description copied from interface: ActivityEventManager

Gets the interface for remotely using RuntimeEnvironment. Since we do not have an ExecutableComponent, the interaction with the RuntimeEnvironment needs to be done via a service.

Specified by:

getRuntimeEnvironment in interface ActivityEventManager

Returns:

The interface for remotely using RuntimeEnvironment clients executing activities proprietarily not using ExecutableComponent.

See Also:

RuntimeService.getRuntimeEnvironment()

getProgressMonitor

public RemoteProgressMonitor getProgressMonitor()

Description copied from interface: ActivityEventManager

Gets the interface for remotely using ProgressMonitor. Since we do not have an ExecutableComponent, the interaction with the ProgressMonitor needs to be done via a service.

Specified by:

getProgressMonitor in interface ActivityEventManager

Returns:

The interface for remotely using ProgressMonitor clients executing activities proprietarily not using ExecutableComponent.

See Also:

RuntimeService.getProgressMonitor()

getInstanceControl

public InstanceControl getInstanceControl()

Gets the instance control of the execution manager of this event manager for starting a new instance based on an occurred database event.

Returns:

The instance control of the execution manager of this event manager for starting a new instance based on an occurred database event.

getTemplateReference

public TemplateReference getTemplateReference(SessionToken session,
                                              java.util.UUID templateID)

Description copied from interface: InstanceStartEventManager

Gets the lightweight representation of the designated process template.

Specified by:

getTemplateReference in interface InstanceStartEventManager

Parameters:

session - The session which is used to check for access rights on this method.

templateID - The ID of the process template to retrieve the lightweight representation of.

Returns:

The lightweight representation of the designated process template.

See Also:

TemplateManager.getTemplateReference(SessionToken, UUID)

getLatestTemplateReference

public TemplateReference getLatestTemplateReference(SessionToken session,
                                                    java.lang.String processType,
                                                    boolean checkStarterRule)

Description copied from interface: InstanceStartEventManager

Gets the lightweight representation of the "latest" process template of the designated process type. Note that the "latest" template need not really be the latest template of the designated process type and dynamic retrieval may cause some trouble in case the template input or output parameter have changed.

Specified by:

getLatestTemplateReference in interface InstanceStartEventManager

Parameters:

session - The session which is used to check for access rights on this method.

processType - The name of the process type of which to get the "latest" template.

checkStarterRule - Whether the starter rule should be checked. If true, the starter rule of the template will be resolved and it will be checked, whether the EventManager is allowed to start the process from one of its InstanceStartEventHandlers.

Returns:

The "latest" template of the designated process type from the designated template manager. This is the instantiable top-level template having the highest version number. If no template is found for the designated process type, null will be returned.

See Also:

ProcessManagerTools.getLatestTemplateVersion(SessionToken, String, de.aristaflow.adept2.core.processmanager.TemplateManager, de.aristaflow.adept2.model.filter.FilterFactory)

createInstanceDataContainer

public InstanceDataContainer createInstanceDataContainer(SessionToken session,
                                                         java.util.UUID templateID)

Description copied from interface: InstanceStartEventManager

Creates an instance data container for the input (and output) parameters of the designated template. The values of the input parameters can be set and provided to the start of an instance based on the designated template.

Specified by:

createInstanceDataContainer in interface InstanceStartEventManager

Parameters:

session - The session which is used to check for access rights on this method.

templateID - The template for which to create a data container having the corresponding input and output parameters.

Returns:

An InstanceDataContainer having all input and output parameters of the designated template which allows to set input parameters and retrieve the values of the output parameters.

See Also:

InstanceControl.createInstanceDataContainer(SessionToken, UUID)

createAndStartInstance

public java.util.UUID createAndStartInstance(SessionToken session,
                                             java.util.UUID templateID,
                                             InstanceDataContainer dataContainer)
                                      throws InvalidTemplateStateException,
                                             InvalidDataContainerException

Description copied from interface: InstanceStartEventManager

Creates a new instance of the designated process template, starts the instance and logs the designated user as initiator of the process instance. The start node of the created instance is executed immediately internally and the values of the input parameter provided by the (appropriate) data container are set in the created instance.

Specified by:

createAndStartInstance in interface InstanceStartEventManager

Parameters:

session - The session which is used to check for access rights on this method. The starting agent and the corresponding organisational position is retrieved from the execution context!

templateID - The template which is to be instantiated. The template has to be in state INSTANTIABLE for top-level usage.

dataContainer - The data container providing the input data and output data of the instance. This can be null in case the process does not have mandatory input parameters.

Returns:

The ID of the created process instance which is unique with respect to the process management system and the server respectively

Throws:

InvalidTemplateStateException - If the process template is not instantiable for top-level usage, an InvalidTemplateStateException will be raised.

InvalidDataContainerException - If the designated process has mandatory input or output parameters that are not incorporated in the designated data container, an InvalidDataContainerException will be raised.

See Also:

InstanceControl.createAndStartInstance(SessionToken, UUID, de.aristaflow.adept2.model.execution.ExecutionContext, java.net.URI[], java.net.URI[])