Interface PoolProcessorEnablerNotificationSession

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

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

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

    • canRegisterForPoolProcessorEnablerNotifications

      boolean canRegisterForPoolProcessorEnablerNotifications()
      Tests if this user can register for PoolProcessorEnabler 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 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.

    • reliablePoolProcessorEnablerNotifications

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

    • unreliablePoolProcessorEnablerNotifications

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

    • acknowledgePoolProcessorEnablerNotification

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

    • registerForNewPoolProcessorEnablers

      void registerForNewPoolProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new pool processor enablers. PoolProcessorEnablerReceiver.newPoolProcessorEnablers() is invoked when a new PoolProcessorEnabler appears in this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedPoolProcessorEnablers

      void registerForChangedPoolProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated pool processor enablers. PoolProcessorEnablerReceiver.changedPoolProcessorEnablers() is invoked when a PoolProcessorEnabler in this distributor is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedPoolProcessorEnabler

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

    • registerForDeletedPoolProcessorEnablers

      void registerForDeletedPoolProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted pool processor enablers. PoolProcessorEnablerReceiver.deletedPoolProcessorEnablers() is invoked when a pool 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.

    • registerForDeletedPoolProcessorEnabler

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