Interface ProvisionableEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to ProvisionableEnablers in this Distributor . This also includes existing provisionable enablers that may appear or disappear due to changes in the Distributor hierarchy, 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 ProvisionableEnablerLookupSession .

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

    • canRegisterForProvisionableEnablerNotifications

      boolean canRegisterForProvisionableEnablerNotifications()
      Tests if this user can register for ProvisionableEnabler 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 provisionable 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.

    • reliableProvisionableEnablerNotifications

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

    • unreliableProvisionableEnablerNotifications

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

    • acknowledgeProvisionableEnablerNotification

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

    • registerForNewProvisionableEnablers

      void registerForNewProvisionableEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new provisionable enablers. ProvisionableEnablerReceiver.newProvisionableEnablers() is invoked when a new ProvisionableEnabler appears in this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProvisionableEnablers

      void registerForChangedProvisionableEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated provisionable enablers. ProvisionableEnablerReceiver.changedProvisionableEnablers() is invoked when a ProvisionableEnabler in this distributor is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProvisionableEnabler

      void registerForChangedProvisionableEnabler(Id provisionableEnablerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated provisionable enabler. ProvisionableEnablerReceiver.changedProvisionableEnablers() is invoked when the specified ProvisionableEnabler in this distributor is changed.
      Parameters:
      provisionableEnablerId - the Id of the ProvisionableEnabler to monitor
      Throws:
      NullArgumentException - provisionableEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedProvisionableEnablers

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

    • registerForDeletedProvisionableEnabler

      void registerForDeletedProvisionableEnabler(Id provisionableEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted provisionable enabler. ProvisionableEnablerReceiver.deletedProvisionableEnabler() is invoked when the specified provisionable enabler is deleted or removed from this distributor.
      Parameters:
      provisionableEnablerId - the Id of the ProvisionableEnabler to monitor
      Throws:
      NullArgumentException - provisionableEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.