Interface QueueProcessorEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to QueueProcessorEnabler objects in this FrontFront Office . This also includes existing QueueProcessorEnablers 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 QueueProcessorEnablerLookupSession .

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

    • useFederatedFrontOfficeView

      void useFederatedFrontOfficeView()
      Federates the view for methods in this session. A federated view will include enablers 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.

    • 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 front office.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedQueueProcessorEnablers

      void registerForChangedQueueProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated front office enabelrs. QueueProcessorEnablerReceiver.changedQueueProcessorEnablers() is invoked when a queue processor enabler in this front office is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedQueueProcessorEnabler

      void registerForChangedQueueProcessorEnabler(Id queueProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of an updated queue processor enabler. ProvisionableReceiver.changedQueueProcessorEnablers() is invoked when the specified queue processor enabler in this front office is changed.
      Parameters:
      queueProcessorEnablerId - the Id of the QueueProcessorEnabler to monitor
      Throws:
      NotFoundException - a queue processor enabler was not found in this queue matchmaker identified by the given Id
      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 front office.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedQueueProcessorEnabler

      void registerForDeletedQueueProcessorEnabler(Id queueProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted queue processor enabler. QueueProcessorEnablerReceiver.deletedQueueProcessorEnablers() is invoked when the specified queue processor enabler is deleted or removed from this front office.
      Parameters:
      queueProcessorEnablerId - the Id of the QueueProcessorEnabler to monitor
      Throws:
      NotFoundException - a queue processor enabler was not found in this queue matchmaker identified by the given Id
      NullArgumentException - queueProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.