Interface ResourceNotificationSession

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

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

  • Method Details

    • getBinId

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

    • getBin

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

    • canRegisterForResourceNotifications

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

    • useFederatedBinView

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

    • useIsolatedBinView

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

    • reliableResourceNotifications

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

    • unreliableResourceNotifications

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

    • acknowledgeResourceNotification

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

    • registerForNewResources

      void registerForNewResources() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new resources. ResourceReceiver.newResources() is invoked when a new Resource is appears in this bin.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedResources

      void registerForChangedResources() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated resources. ResourceReceiver.changedResources() is invoked when a resource in this bin is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedResource

      void registerForChangedResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated resource. ResourceReceiver.changedResources() is invoked when the specified resource in this bin is changed.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedResources

      void registerForDeletedResources() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted resources. ResourceReceiver.deletedResources() is invoked when a resource is deleted or removed from this bin.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedResource

      void registerForDeletedResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted resource. ResourceReceiver.deletedResources() is invoked when the specified resource is deleted or removed from this bin.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.