Interface PoolConstrainerEnablerNotificationSession

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

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

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

    • canRegisterForPoolConstrainerEnablerNotifications

      boolean canRegisterForPoolConstrainerEnablerNotifications()
      Tests if this user can register for PoolConstrainerEnabler 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 constrainer 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.

    • reliablePoolConstrainerEnablerNotifications

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

    • unreliablePoolConstrainerEnablerNotifications

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

    • acknowledgePoolConstrainerEnablerNotification

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

    • registerForNewPoolConstrainerEnablers

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

    • registerForChangedPoolConstrainerEnablers

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

    • registerForChangedPoolConstrainerEnabler

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

    • registerForDeletedPoolConstrainerEnablers

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

    • registerForDeletedPoolConstrainerEnabler

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