Interface ControllerNotificationSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface ControllerNotificationSession extends OsidSession

This session defines methods to receive notifications on adds/changes to Controllers in this System . This also includes existing controllers that may appear or disappear due to changes in the System hierarchy, This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

The two views defined in this session correspond to the views in the ControllerLookupSession .

  • Method Details

    • getSystemId

      Id getSystemId()
      Gets the System Id associated with this session.
      Returns:
      the System Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getSystem

      System getSystem() throws OperationFailedException, PermissionDeniedException
      Gets the System associated with this session.
      Returns:
      the system
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForControllerNotifications

      boolean canRegisterForControllerNotifications()
      Tests if this user can register for Controller notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer notification operations.
      Returns:
      false if notification methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedSystemView

      void useFederatedSystemView()
      Federates the view for methods in this session. A federated view will include controllers in systems which are children of this system in the system hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedSystemView

      void useIsolatedSystemView()
      Isolates the view for methods in this session. An isolated view restricts notifications to this system only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableControllerNotifications

      void reliableControllerNotifications()
      Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeControllerNotification() .
      Compliance:
      mandatory - This method is must be implemented.

    • unreliableControllerNotifications

      void unreliableControllerNotifications()
      Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
      Compliance:
      mandatory - This method is must be implemented.

    • acknowledgeControllerNotification

      void acknowledgeControllerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a controller notification.
      Parameters:
      notificationId - the Id of the notification
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewControllers

      void registerForNewControllers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new controllers. ControllerReceiver.newControllers() is invoked when a new Controller appears in this system.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedControllers

      void registerForChangedControllers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated controllers. ControllerReceiver.changedControllers() is invoked when a controller in this system is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedController

      void registerForChangedController(Id controllerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated controller. SceneReceiver.changedControllers() is invoked when the specified controller in this system is changed.
      Parameters:
      controllerId - the Id of the Controller to monitor
      Throws:
      NullArgumentException - controllerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedControllers

      void registerForDeletedControllers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted controllers. ControllerReceiver.deletedControllers() is invoked when a controller is deleted or removed from this system.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedController

      void registerForDeletedController(Id controllerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted controller. ControllerReceiver.deletedControllers() is invoked when the specified controller is deleted or removed from this system.
      Parameters:
      controllerId - the Id of the Controller to monitor
      Throws:
      NullArgumentException - controllerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.