Interface QueueNotificationSession

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

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

  • Method Details

    • getFrontOfficeId

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

    • getFrontOffice

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

    • canRegisterForQueueNotifications

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

    • useFederatedFrontOfficeView

      void useFederatedFrontOfficeView()
      Federates the view for methods in this session. A federated view will include queues in front offices which are children of this front office in the front office hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedFrontOfficeView

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

    • reliableQueueNotifications

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

    • unreliableQueueNotifications

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

    • acknowledgeQueueNotification

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

    • registerForNewQueues

      void registerForNewQueues() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new queues. QueueReceiver.newQueues() is invoked when a new Queue appears in this front office.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedQueues

      void registerForChangedQueues() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated queues. QueueReceiver.changedQueues() is invoked when a queue in this front office is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedQueue

      void registerForChangedQueue(Id queueId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated queue. QueueReceiver.changedQueues() is invoked when the specified queue in this front office 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.

    • registerForDeletedQueues

      void registerForDeletedQueues() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted queues. QueueReceiver.deletedQueues() is invoked when a queue is deleted or removed from this front office.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedQueue

      void registerForDeletedQueue(Id queueId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted queue. QueueReceiver.deletedQueues() is invoked when the specified queue is deleted or removed from this front office.
      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.