Interface SignalNotificationSession

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

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

  • 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.

    • canRegisterForSignalNotifications

      boolean canRegisterForSignalNotifications()
      Tests if this user can register for Signal 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 signals 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.

    • acknowledgeSignalNotification

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

    • registerForNewSignals

      void registerForNewSignals() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new signals. SignalReceiver.newSignals() is invoked when a new Signal appears in this map.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewSignalsForPath

      void registerForNewSignalsForPath(Id pathId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of new signals for the given path. SignalReceiver.newSignals() is invoked when a signal appears in this map.
      Parameters:
      pathId - the Id of the path to monitor
      Throws:
      NullArgumentException - pathId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSignals

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

    • registerForChangedSignalsForPath

      void registerForChangedSignalsForPath(Id pathId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated signals for the given path. SignalReceiver.changedSignals() is invoked when a signal in this map is changed.
      Parameters:
      pathId - the Id of the path to monitor
      Throws:
      NullArgumentException - pathId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSignal

      void registerForChangedSignal(Id signalId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated signal. SignalReceiver.changedSignals() is invoked when the specified signal in this map is changed.
      Parameters:
      signalId - the Id of the Signal to monitor
      Throws:
      NullArgumentException - signalId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedSignals

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

    • registerForDeletedSignal

      void registerForDeletedSignal(Id signalId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted signal. SignalReceiver.deletedSignals() is invoked when the specified signal is deleted or removed from this map.
      Parameters:
      signalId - the Id of the Signal to monitor
      Throws:
      NullArgumentException - signalId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedSignalsForPath

      void registerForDeletedSignalsForPath(Id pathId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted signals for the given path. SignalReceiver.deletedSignals() is invoked when a signal is deleted or removed from this map.
      Parameters:
      pathId - the Id of the path to monitor
      Throws:
      NullArgumentException - pathId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.