Interface QueueConstrainerNotificationSession

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

This session defines methods to receive notifications on adds/changes to QueueConstrainers in this Distributor . This also includes existing queue constrainers that may appear or disappear due to changes in the Distributor hi erarchy, 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 QueueConstrainerLookupSession .

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

    • canRegisterForQueueConstrainerNotifications

      boolean canRegisterForQueueConstrainerNotifications()
      Tests if this user can register for QueueConstrainer 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 queue constrainers 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.

    • reliableQueueConstrainerNotifications

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

    • unreliableQueueConstrainerNotifications

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

    • acknowledgeQueueConstrainerNotification

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

    • registerForNewQueueConstrainers

      void registerForNewQueueConstrainers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new queue constrainers. QueueConstrainerReceiver.newQueueConstrainers() is invoked when a new QueueConstrainer appears in this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedQueueConstrainers

      void registerForChangedQueueConstrainers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated queue constrainers. QueueConstrainerReceiver.changedQueueConstrainers() is invoked when a QueueConstrainer in this distributor is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedQueueConstrainer

      void registerForChangedQueueConstrainer(Id queueConstrainerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated queue constrainer. QueueConstrainerReceiver.changedQueueConstrainers() is invoked when the specified QueueConstrainer in this distributor is changed.
      Parameters:
      queueConstrainerId - the Id of the QueueConstrainer to monitor
      Throws:
      NullArgumentException - queueConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedQueueConstrainers

      void registerForDeletedQueueConstrainers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted queue constrainers. QueueConstrainerReceiver.deletedQueueConstrainers() is invoked when a queue constrainer is deleted or removed from this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedQueueConstrainer

      void registerForDeletedQueueConstrainer(Id queueConstrainerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted queue constrainer. QueueConstrainerReceiver.deletedQueueConstrainer() is invoked when the specified queue constrainer is deleted or removed from this distributor.
      Parameters:
      queueConstrainerId - the Id of the QueueConstrainer to monitor
      Throws:
      NullArgumentException - queueConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.