Interface ProvisionEnablerNotificationSession

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

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

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

    • canRegisterForProvisionEnablerNotifications

      boolean canRegisterForProvisionEnablerNotifications()
      Tests if this user can register for ProvisionEnabler 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 provision 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.

    • reliableProvisionEnablerNotifications

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

    • unreliableProvisionEnablerNotifications

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

    • acknowledgeProvisionEnablerNotification

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

    • registerForNewProvisionEnablers

      void registerForNewProvisionEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new provision enablers. ProvisionEnablerReceiver.newProvisionEnablers() is invoked when a new ProvisionEnabler appears in this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProvisionEnablers

      void registerForChangedProvisionEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated provision enablers. ProvisionEnablerReceiver.changedProvisionEnablers() is invoked when a ProvisionEnabler in this distributor is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProvisionEnabler

      void registerForChangedProvisionEnabler(Id provisionEnablerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated provision enabler. ProvisionEnablerReceiver.changedProvisionEnablers() is invoked when the specified ProvisionEnabler in this distributor is changed.
      Parameters:
      provisionEnablerId - the Id of the ProvisionEnabler to monitor
      Throws:
      NullArgumentException - provisionEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedProvisionEnablers

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

    • registerForDeletedProvisionEnabler

      void registerForDeletedProvisionEnabler(Id provisionEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted provision enabler. ProvisionEnablerReceiver.deletedProvisionEnabler() is invoked when the specified provision enabler is deleted or removed from this distributor.
      Parameters:
      provisionEnablerId - the Id of the ProvisionEnabler to monitor
      Throws:
      NullArgumentException - provisionEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.