Interface DeviceNotificationSession

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

This session defines methods to receive notifications on adds/changes to Devices in this System . This also includes existing devices 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 DeviceLookupSession .

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

    • canRegisterForDeviceNotifications

      boolean canRegisterForDeviceNotifications()
      Tests if this user can register for Device 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 devices 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.

    • reliableDeviceNotifications

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

    • unreliableDeviceNotifications

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

    • acknowledgeDeviceNotification

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

    • registerForNewDevices

      void registerForNewDevices() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new devices. DeviceReceiver.newDevices() is invoked when a new Device appears in this system.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedDevices

      void registerForChangedDevices() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated devices. DeviceReceiver.changedDevices() is invoked when a device in this system is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedDevice

      void registerForChangedDevice(Id deviceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated device. DeviceReceiver.changedDevices() is invoked when the specified device in this system is changed.
      Parameters:
      deviceId - the Id of the Device to monitor
      Throws:
      NullArgumentException - deviceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedDevices

      void registerForDeletedDevices() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted devices. DeviceReceiver.deletedDevices() is invoked when a device is deleted or removed from this system.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedDevice

      void registerForDeletedDevice(Id deviceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted device. DeviceReceiver.deletedDevices() is invoked when the specified device is deleted or removed from this system.
      Parameters:
      deviceId - the Id of the Device to monitor
      Throws:
      NullArgumentException - deviceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.