Interface QueueProcessorEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to QueueProcessorEnablers in this Distributor . This also includes existing queue processor enablers 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 QueueProcessorEnablerLookupSession .

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

    • canRegisterForQueueProcessorEnablerNotifications

      boolean canRegisterForQueueProcessorEnablerNotifications()
      Tests if this user can register for QueueProcessorEnabler 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 processor enablers 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.

    • reliableQueueProcessorEnablerNotifications

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

    • unreliableQueueProcessorEnablerNotifications

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

    • acknowledgeQueueProcessorEnablerNotification

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

    • registerForNewQueueProcessorEnablers

      void registerForNewQueueProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new queue processor enablers. QueueProcessorEnablerReceiver.newQueueProcessorEnablers() is invoked when a new QueueProcessorEnabler appears in this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedQueueProcessorEnablers

      void registerForChangedQueueProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated queue processor enablers. QueueProcessorEnablerReceiver.changedQueueProcessorEnablers() is invoked when a QueueProcessorEnabler in this distributor is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedQueueProcessorEnabler

      void registerForChangedQueueProcessorEnabler(Id queueProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated queue processor enabler. QueueProcessorEnablerReceiver.changedQueueProcessorEnablers() is invoked when the specified QueueProcessorEnabler in this distributor is changed.
      Parameters:
      queueProcessorEnablerId - the Id of the QueueProcessorEnabler to monitor
      Throws:
      NullArgumentException - queueProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedQueueProcessorEnablers

      void registerForDeletedQueueProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted queue processor enablers. QueueProcessorEnablerReceiver.deletedQueueProcessorEnablers() is invoked when a queue processor enabler is deleted or removed from this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedQueueProcessorEnabler

      void registerForDeletedQueueProcessorEnabler(Id queueProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted queue processor enabler. QueueProcessorEnablerReceiver.deletedQueueProcessorEnabler() is invoked when the specified queue processor enabler is deleted or removed from this distributor.
      Parameters:
      queueProcessorEnablerId - the Id of the QueueProcessorEnabler to monitor
      Throws:
      NullArgumentException - queueProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.