de.aristaflow.adept2.core.runtimemanager

Interface ActivityStateListener

All Superinterfaces:

ADEPT2Service

public interface ActivityStateListener
extends ADEPT2Service

An ActivityStateListener provides access to an ActivityStateNotification which is notified when the observed activity terminates (has been closed, suspended, reset, failed or signalled). A default implementation exists, that allows local (!) ActivityStateListeners to register themselves for an activity and get notifications about its state changes. Services are also free to implement this interface. In this case only getActivityStateNotification() is relevant. The other two methods may be empty. However, for the callback to work with SynchronousActivityStarting, the provided URIs need to represent a service interface that directly implements ActivityStateListener. It will not work, if only the service implementation knows about ActivityStateListener but not its service interface!
Since most services will not be able to do this, they need to have the default implementation for this listener configured. Before starting or resuming the activity, they register at the listener instance and provide the returned URIs to SynchronousActivityStarting. The default implementation will unregister listeners implicitly, that is, as soon as an activity has terminated finally (not suspended), its listeners will be unregistered.

Author:

Ulrich Kreher

Method Summary

Modifier and Type	Method and Description
ActivityStateNotification	getActivityStateNotification() Gets the interface to send notifications to when the state of the observed activity changes, that is it has been closed, suspended, reset, failed or signalled.
java.net.URI[]	registerActivityStateListener(SessionToken session, EBPInstanceReference activity, ActivityStateNotification listener) Registers the designated listener for state changes of the designated activity.
void	unregisterActivityStateListener(SessionToken session, EBPInstanceReference activity, ActivityStateNotification listener) Unregisters the designated listener for state changes of the designated activity.

Methods inherited from interface de.aristaflow.adept2.base.service.ADEPT2Service

getLocalUris, getRelease, getRuntimeRequiredServices, getServiceInstanceName, getStartupRequiredServices, getURIs, init, ping, preShutdown, shutdown, start

Method Detail

getActivityStateNotification

ActivityStateNotification getActivityStateNotification()

Gets the interface to send notifications to when the state of the observed activity changes, that is it has been closed, suspended, reset, failed or signalled.

Returns:

The interface to send notifications to when the state of the observed activity changes, that is it has been closed, suspended, reset, failed or signalled.

registerActivityStateListener

java.net.URI[] registerActivityStateListener(SessionToken session,
                                             EBPInstanceReference activity,
                                             ActivityStateNotification listener)

Registers the designated listener for state changes of the designated activity. The designated listener has to be local with respect to this listener service. This service will forward all notifications.

This method need not be implemented by a service which is directly registered at a SynchronousActivityStarting. It cannot be called remotely.

Parameters:

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

activity - The activity for which to listen to state changes.

listener - A listener to register for activity state changes.

Returns:

The URIs to register at SynchronousActivityStarting.

unregisterActivityStateListener

void unregisterActivityStateListener(SessionToken session,
                                     EBPInstanceReference activity,
                                     ActivityStateNotification listener)

Unregisters the designated listener for state changes of the designated activity. The designated listener has to be local with respect to this listener service. Unregistering is not necessary after the activity has terminated (except it has suspended) since unregistering will be done implicitly.

This method need not be implemented by a service which is directly registered at a SynchronousActivityStarting. It cannot be called remotely.

Parameters:

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

activity - The activity for which no longer listen to state changes.

listener - A listener to unregister for activity state changes.