Interface QueueProcessorNotificationSession

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

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

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

    • canRegisterForQueueProcessorNotifications

      boolean canRegisterForQueueProcessorNotifications()
      Tests if this user can register for QueueProcessor 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 in front office 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.

    • reliableQueueProcessorNotifications

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

    • unreliableQueueProcessorNotifications

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

    • acknowledgeQueueProcessorNotification

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

    • registerForNewQueueProcessors

      void registerForNewQueueProcessors() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new queue processors. QueueProcessorReceiver.newQueueProcessors() is invoked when a new QueueProcessor appears in this front office.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedQueueProcessors

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

    • registerForChangedQueueProcessor

      void registerForChangedQueueProcessor(Id queueProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of an updated queue processor. ProvisionableReceiver.changedQueueProcessors() is invoked when the specified queue processor in this front office is changed.
      Parameters:
      queueProcessorId - the Id of the QueueProcessor to monitor
      Throws:
      NotFoundException - a queue processor was not found in this queue matchmaker identified by the given Id
      NullArgumentException - queueProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedQueueProcessors

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

    • registerForDeletedQueueProcessor

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