Interface PoolConstrainerNotificationSession

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

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

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

    • canRegisterForPoolConstrainerNotifications

      boolean canRegisterForPoolConstrainerNotifications()
      Tests if this user can register for PoolConstrainer 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 constrainers 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.

    • reliablePoolConstrainerNotifications

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

    • unreliablePoolConstrainerNotifications

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

    • acknowledgePoolConstrainerNotification

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

    • registerForNewPoolConstrainers

      void registerForNewPoolConstrainers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new pool constrainers. PoolConstrainerReceiver.newPoolConstrainers() is invoked when a new PoolConstrainer appears in this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedPoolConstrainers

      void registerForChangedPoolConstrainers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated pool constrainers. PoolConstrainerReceiver.changedPoolConstrainers() is invoked when a PoolConstrainer in this distributor is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedPoolConstrainer

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

    • registerForDeletedPoolConstrainers

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

    • registerForDeletedPoolConstrainer

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