Interface PoolProcessorNotificationSession

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

This session defines methods to receive notifications on adds/changes to PoolProcessors in this Distributor. This also includes existing pool processors 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 PoolProcessorLookupSession.

Like all OsidSessions, PoolProcessorNotificationSessions are dedicated to single processing threads and a single authenticated user.

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

    • canRegisterForPoolProcessorNotifications

      boolean canRegisterForPoolProcessorNotifications()
      Tests if this user can register for PoolProcessor 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 pool processors in distributors which are children of this distributor in the distributor hierarchy.
      Compliance:
      mandatory - This method 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 must be implemented.

    • reliablePoolProcessorNotifications

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

    • unreliablePoolProcessorNotifications

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

    • acknowledgePoolProcessorNotification

      void acknowledgePoolProcessorNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a pool 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.

    • registerForNewPoolProcessors

      void registerForNewPoolProcessors() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new pool processors. PoolProcessorReceiver.newPoolProcessors() is invoked when a new PoolProcessor appears in this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedPoolProcessors

      void registerForChangedPoolProcessors() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated pool processors. PoolProcessorReceiver.changedPoolProcessors() is invoked when a PoolProcessor in this distributor is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedPoolProcessor

      void registerForChangedPoolProcessor(Id poolProcessorId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated pool processor. PoolProcessorReceiver.changedPoolProcessors() is invoked when the specified PoolProcessor in this distributor is changed.
      Parameters:
      poolProcessorId - the Id of the PoolProcessor to monitor
      Throws:
      NullArgumentException - poolProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedPoolProcessors

      void registerForDeletedPoolProcessors() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted pool processors. PoolProcessorReceiver.deletedPoolProcessors() is invoked when a pool processor is deleted or removed from this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedPoolProcessor

      void registerForDeletedPoolProcessor(Id poolProcessorId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted pool processor. PoolProcessorReceiver.deletedPoolProcessor() is invoked when the specified pool processor is deleted or removed from this distributor.
      Parameters:
      poolProcessorId - the Id of the PoolProcessor to monitor
      Throws:
      NullArgumentException - poolProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.