kaos.core.csi.observe
Interface ObserverManager

All Known Implementing Classes:

Amigo, BreveBot, ER1, ExecutionManager, KAoSAriaCamera, KAoSAriaLaser, KAoSAriaLaserAndCamera, KAoSAriaRobot, KAoSAriaSonar, KAoSPlayer, KAoSRobot, KAoSRobotTest, KAoSTBot02, KBot, ObserverManagerImpl, ObserverManagerWithFlexfeed, StubBot, Tbot

public interface ObserverManager

Defines the operations to map KAoSObservers with KAoSObservables and forwards updates from KAoSObservable to the associated KAoSObservers.

Author:

KAoS Team $Revision: 1.6 $

Method Summary

void	deregisterObserver(KAoSObserver observer, java.lang.String updateType, java.io.Serializable updateCondition, KAoSEntityDescription observableDesc) Deregister the given KAoSObserver from the registry of observers asoociated with the KAoSObservable, whose KAoSEntityDescription is given.
void	deregisterObserver(KAoSObserver observer, java.lang.String updateType, java.io.Serializable updateCondition, java.lang.String observableGUID) Deregister the given KAoSObserver from the registry of observers associated with the KAoSObservable, whose GUID is given.
void	registerKAoSExtensionComponentObserver(java.lang.String repType, java.lang.String ontType, KAoSObserver observer, java.lang.String updateType, java.io.Serializable updateCondition, KAoSEntityDescription entityDesc)
void	registerObserver(KAoSObserver observer, java.lang.String updateType, java.io.Serializable updateCondition, KAoSEntityDescription observableDesc) Register the given KAoSObserver with the KAoSObservable, whose KAoSEntityDescription is given, for updates described by the updateType and updateConstraints.
void	registerObserver(KAoSObserver observer, java.lang.String updateType, java.io.Serializable updateCondition, java.lang.String observableGUID) Register the given KAoSObserver with the KAoSObservable, whose GUID is given for updates described by the updateType and updateConditions.
void	registerObserver(KAoSObserver observer, java.lang.String updateType, java.io.Serializable updateCondition, java.lang.String observableGUID, java.lang.String brokerGUID) Register the given KAoSObserver with the KAoSObservable, whose GUID is given for updates described by the updateType and updateConditions.

Method Detail

registerObserver

void registerObserver(KAoSObserver observer,
                      java.lang.String updateType,
                      java.io.Serializable updateCondition,
                      java.lang.String observableGUID)
                      throws NotLocatableException,
                             TransportFailure

Register the given KAoSObserver with the KAoSObservable, whose GUID is given for updates described by the updateType and updateConditions.

Parameters:

observer - KAoSObserver requesting registration for updates.

updateType - String indicating type of update the KAoSObserver is interested in.

updateCondition - Serializable describing the conditions under which to send the update.

observableGUID - String containing the GUID of the KAoSObservable to register with.

Throws:

NotLocatableException - when the KAoSObservable cannot be located.

TransportFailure - when transport services fails.

registerObserver

void registerObserver(KAoSObserver observer,
                      java.lang.String updateType,
                      java.io.Serializable updateCondition,
                      KAoSEntityDescription observableDesc)
                      throws NotLocatableException,
                             TransportFailure

Register the given KAoSObserver with the KAoSObservable, whose KAoSEntityDescription is given, for updates described by the updateType and updateConstraints.

Parameters:

observer - KAoSObserver registering with for updates.

updateType - String indicating type of update the KAoSObserver is interested in.

updateCondition - Object describing the conditions under which to send the update.

observableDesc - KAoSEntityDescription describing the observable.

Throws:

NotLocatableException - when the KAoSObservable cannot be located.

TransportFailure - when transport services fail.

registerObserver

void registerObserver(KAoSObserver observer,
                      java.lang.String updateType,
                      java.io.Serializable updateCondition,
                      java.lang.String observableGUID,
                      java.lang.String brokerGUID)
                      throws NotLocatableException,
                             TransportFailure

Register the given KAoSObserver with the KAoSObservable, whose GUID is given for updates described by the updateType and updateConditions.

Parameters:

observer - KAoSObserver requesting registration for updates.

updateType - String indicating type of update the KAoSObserver is interested in.

updateCondition - Serializable describing the conditions under which to send the update.

observableGUID - String containing the GUID of the KAoSObservable to register with.

brokerGUID - String containing the GUID of the broker, through which to reach the observable.

Throws:

NotLocatableException - when the KAoSObservable or broker cannot be located.

TransportFailure - when transport services fail. the rgistration will be processed.

registerKAoSExtensionComponentObserver

void registerKAoSExtensionComponentObserver(java.lang.String repType,
                                            java.lang.String ontType,
                                            KAoSObserver observer,
                                            java.lang.String updateType,
                                            java.io.Serializable updateCondition,
                                            KAoSEntityDescription entityDesc)
                                            throws NotLocatableException,
                                                   TransportFailure

Throws:

NotLocatableException

TransportFailure

deregisterObserver

void deregisterObserver(KAoSObserver observer,
                        java.lang.String updateType,
                        java.io.Serializable updateCondition,
                        java.lang.String observableGUID)
                        throws NotLocatableException,
                               TransportFailure

Deregister the given KAoSObserver from the registry of observers associated with the KAoSObservable, whose GUID is given.

Parameters:

observer - KAoSObserver deregistering.

updateType - String indicating type of update the KAoSObserver is no longer interested in.

updateCondition - Serializable containing the condition the KAoSObserver is no longer interested in.

observableGUID - String specifying the GUID of the observable, from which to deregister for the given update type.

Throws:

NotLocatableException - when the KAoSObservable cannot be located.

TransportFailure - when transport services fail.

deregisterObserver

void deregisterObserver(KAoSObserver observer,
                        java.lang.String updateType,
                        java.io.Serializable updateCondition,
                        KAoSEntityDescription observableDesc)
                        throws NotLocatableException,
                               TransportFailure

Deregister the given KAoSObserver from the registry of observers asoociated with the KAoSObservable, whose KAoSEntityDescription is given.

Parameters:

observer - KAoSObserver deregistering.

updateType - String indicating type of update the KAoSObserver is no longer interested in.

updateCondition - Serializable containing the condition the KAoSObserver is no longer interested in.

observableDesc - KAoSEntityDescription of the observable, from which to deregister for the given update type.

Throws:

NotLocatableException - when the KAoSObservable cannot be located.

TransportFailure - when transport services fail.