Interface ProvisionNotificationSession

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

This session defines methods to receive notifications on adds/changes to Provision objects in this Distributor . This also includes existing provisions 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 ProvisionLookupSession .

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

    • canRegisterForProvisionNotifications

      boolean canRegisterForProvisionNotifications()
      Tests if this user can register for Provision 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 provisions 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.

    • reliableProvisionNotifications

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

    • unreliableProvisionNotifications

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

    • acknowledgeProvisionNotification

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

    • registerForNewProvisions

      void registerForNewProvisions() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new provisions. ProvisionReceiver.newProvisions() is invoked when a new Provision appears in this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewProvisionsForRequest

      void registerForNewProvisionsForRequest(Id requestId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new provisions for the given request Id . ProvisionReceiver.newProvisions() is invoked when a new Provision is created.
      Parameters:
      requestId - the Id of the request to monitor
      Throws:
      NullArgumentException - requestId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewProvisionsForBroker

      void registerForNewProvisionsForBroker(Id brokerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new provisions for the given broker Id . ProvisionReceiver.newProvisions() is invoked when a new Provision is created.
      Parameters:
      brokerId - the Id of the broker to monitor
      Throws:
      NullArgumentException - brokerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewProvisionsForProvisionable

      void registerForNewProvisionsForProvisionable(Id provisionableId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new provisions for the given provisionable Id . ProvisionReceiver.newProvisions() is invoked when a new Provision is created.
      Parameters:
      provisionableId - the Id of the provisionable to monitor
      Throws:
      NullArgumentException - provisionableId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewProvisionsForRecipient

      void registerForNewProvisionsForRecipient(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new provisions for the given resource Id . ProvisionReceiver.newProvisions() is invoked when a new Provision is created.
      Parameters:
      resourceId - the Id of the recipient to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProvisions

      void registerForChangedProvisions() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated provisions. ProvisionReceiver.changedProvisions() is invoked when a provision in this distributor is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProvisionsForRequest

      void registerForChangedProvisionsForRequest(Id requestId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated provisions for the given request Id . ProvisionReceiver.changedProvisions() is invoked when a provision in this distributor is changed.
      Parameters:
      requestId - the Id of the request to monitor
      Throws:
      NullArgumentException - requestId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProvisionsForBroker

      void registerForChangedProvisionsForBroker(Id brokerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated provisions for the given broker Id . ProvisionReceiver.changedProvisions() is invoked when a provision in this distributor is changed.
      Parameters:
      brokerId - the Id of the broker to monitor
      Throws:
      NullArgumentException - brokerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProvisionsForProvisionable

      void registerForChangedProvisionsForProvisionable(Id provisionableId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated provisions for the given provisionable Id . ProvisionReceiver.changedProvisions() is invoked when a provision in this distributor is changed.
      Parameters:
      provisionableId - the Id of the provisionable to monitor
      Throws:
      NullArgumentException - provisionableId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProvisionsForRecipient

      void registerForChangedProvisionsForRecipient(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated provisions for the given recipient Id . ProvisionReceiver.changedProvisions() is invoked when a provision in this distributor is changed.
      Parameters:
      resourceId - the Id of the recipient to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProvision

      void registerForChangedProvision(Id provisionId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated provision. ProvisionReceiver.changedProvisions() is invoked when the specified provision in this distributor is changed.
      Parameters:
      provisionId - the Id of the Provision to monitor
      Throws:
      NullArgumentException - provisionId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedProvisions

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

    • registerForDeletedProvisionsForRequest

      void registerForDeletedProvisionsForRequest(Id requestId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of deleted provisions for the given request Id . ProvisionReceiver.deletedProvisions() is invoked when a provision in this distributor is removed or deleted.
      Parameters:
      requestId - the Id of the request to monitor
      Throws:
      NullArgumentException - requestId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedProvisionsForBroker

      void registerForDeletedProvisionsForBroker(Id brokerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of deleted provisions for the given broker Id . ProvisionReceiver.deletedProvisions() is invoked when a provision in this distributor is removed or deleted.
      Parameters:
      brokerId - the Id of the broker to monitor
      Throws:
      NullArgumentException - brokerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedProvisionsForProvisionable

      void registerForDeletedProvisionsForProvisionable(Id provisionableId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of deleted provisions for the given provisionable Id . ProvisionReceiver.deletedProvisions() is invoked when a provision in this distributor is removed or deleted.
      Parameters:
      provisionableId - the Id of the provisionable to monitor
      Throws:
      NullArgumentException - provisionableId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedProvisionsForRecipient

      void registerForDeletedProvisionsForRecipient(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of deleted provisions for the given recipient Id . ProvisionReceiver.deletedProvisions() is invoked when a provision in this distributor is removed or deleted.
      Parameters:
      resourceId - the Id of the recipient to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedProvision

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