Interface RequestNotificationSession

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

This session defines methods to receive notifications on adds/changes to Request objects in this Distributor . This also includes existing requests that may appear or disappear due to changes in the Dstributor 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 RequestLookupSession .

  • Method Details

    • getDistributorId

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

    • getDistributor

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

    • canRegisterForRequestNotifications

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

    • useFederatedDistributorView

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

    • useIsolatedDistributorView

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

    • reliableRequestNotifications

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

    • unreliableRequestNotifications

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

    • acknowledgeRequestNotification

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

    • registerForNewRequests

      void registerForNewRequests() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new requests. RequestReceiver.newRequests() is invoked when a new Request appears in this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewRequestsForResource

      void registerForNewRequestsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new requests for the given resource Id . RequestReceiver.newRequests() is invoked when a new Request is created.
      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.

    • registerForNewRequestsForQueue

      void registerForNewRequestsForQueue(Id queueId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new requests for the given queue Id . RequestReceiver.newRequests() is invoked when a new Request is created.
      Parameters:
      queueId - the Id of the queue to monitor
      Throws:
      NullArgumentException - queueId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRequests

      void registerForChangedRequests() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated requests. RequestReceiver.changedRequests() is invoked when a request in this distributor is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRequestsForResource

      void registerForChangedRequestsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated requests for the given resource Id . RequestReceiver.changedRequests() is invoked when a Request in this distributor 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.

    • registerForChangedRequestsForQueue

      void registerForChangedRequestsForQueue(Id queueId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated requests for the given queue Id . RequestReceiver.changedRequests() is invoked when a Request in this distributor is changed.
      Parameters:
      queueId - the Id of the queue to monitor
      Throws:
      NullArgumentException - queueId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRequest

      void registerForChangedRequest(Id requestId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated request. RequestReceiver.changedRequests() is invoked when the specified request in this distributor is changed.
      Parameters:
      requestId - the Id of the Request to monitor
      Throws:
      NullArgumentException - requestId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedRequests

      void registerForDeletedRequests() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted requests. RequestReceiver.deletedRequests() is invoked when a request is deleted or removed from this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedRequestsForResource

      void registerForDeletedRequestsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of deleted requests for the given resource Id . RequestReceiver.deletedRequests() is invoked when a Request is deleted or removed from this distributor.
      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.

    • registerForDeletedRequestsForQueue

      void registerForDeletedRequestsForQueue(Id queueId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of deleted requests for the given queue Id . RequestReceiver.deletedRequests() is invoked when a Request is deleted or removed from this distributor.
      Parameters:
      queueId - the Id of the queue to monitor
      Throws:
      NullArgumentException - queueId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedRequest

      void registerForDeletedRequest(Id requestId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted request. RequestReceiver.deletedRequests() is invoked when the specified request is deleted or removed from this distributor.
      Parameters:
      requestId - the Id of the Request to monitor
      Throws:
      NullArgumentException - requestId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.