Interface SignalEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to SignalEnabler objects in this Map . This also includes existing SignalEnablers that may appear or disappear due to changes in the Map 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 SignalEnablerLookupSession .

  • Method Details

    • getMapId

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

    • getMap

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

    • canRegisterForSignalEnablerNotifications

      boolean canRegisterForSignalEnablerNotifications()
      Tests if this user can register for SignalEnabler 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.

    • useFederatedMapView

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

    • useIsolatedMapView

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

    • reliableSignalEnablerNotifications

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

    • unreliableSignalEnablerNotifications

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

    • acknowledgeSignalEnablerNotification

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

    • registerForNewSignalEnablers

      void registerForNewSignalEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new signal enablers. SignalEnablerReceiver.newSignalEnablers() is invoked when a new SignalEnabler appears in this map.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSignalEnablers

      void registerForChangedSignalEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated map. SignalEnablerReceiver.changedSignalEnablers() is invoked when a signal enabler in this map is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSignalEnabler

      void registerForChangedSignalEnabler(Id signalEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of an updated signal enabler. ProvisionableReceiver.changedSignalEnablers() is invoked when the specified signal enabler in this map is changed.
      Parameters:
      signalEnablerId - the Id of the SignalEnabler to monitor
      Throws:
      NotFoundException - a signal enabler was not found in this broker matchmaker identified by the given Id
      NullArgumentException - signalEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedSignalEnablers

      void registerForDeletedSignalEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted signal enablers. SignalEnablerReceiver.deletedSignalEnablers() is invoked when a signal enabler is deleted or removed from this map.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedSignalEnabler

      void registerForDeletedSignalEnabler(Id signalEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted signal enabler. SignalEnablerReceiver.deletedSignalEnablers() is invoked when the specified signal enabler is deleted or removed from this map.
      Parameters:
      signalEnablerId - the Id of the SignalEnabler to monitor
      Throws:
      NotFoundException - a signal enabler was not found in this broker matchmaker identified by the given Id
      NullArgumentException - signalEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.