Interface PoolEnablerNotificationSession

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

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

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

    • canRegisterForPoolEnablerNotifications

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

    • reliablePoolEnablerNotifications

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

    • unreliablePoolEnablerNotifications

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

    • acknowledgePoolEnablerNotification

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

    • registerForNewPoolEnablers

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

    • registerForChangedPoolEnablers

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

    • registerForChangedPoolEnabler

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

    • registerForDeletedPoolEnablers

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

    • registerForDeletedPoolEnabler

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