Interface VaultNotificationSession

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

This session defines methods to receive notifications on adds/changes to Vault objects. 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.

  • Method Details

    • canRegisterForVaultNotifications

      boolean canRegisterForVaultNotifications()
      Tests if this user can register for Vault 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.

    • reliableVaultNotifications

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

    • unreliableVaultNotifications

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

    • acknowledgeVaultNotification

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

    • registerForNewVaults

      void registerForNewVaults() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new vaults. VaultReceiver.newVaults() is invoked when a new Vault is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedVaults

      void registerForChangedVaults() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated vaults. VaultReceiver.changedVaults() is invoked when a vault is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedVault

      void registerForChangedVault(Id vaultId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated vault. VaultReceiver.changedVaults() is invoked when the specified vault is changed.
      Parameters:
      vaultId - the Id of the vault to monitor
      Throws:
      NullArgumentException - vaultId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedVaults

      void registerForDeletedVaults() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted vaults. VaultReceiver.deletedVaults() is invoked when a vault is deleted.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedVault

      void registerForDeletedVault(Id vaultId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted vault. VaultReceiver.deletedVaults() is invoked when the specified vault is deleted.
      Parameters:
      vaultId - the Id of the vault to monitor
      Throws:
      NullArgumentException - vaultId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedVaultHierarchy

      void registerForChangedVaultHierarchy() throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated vault hierarchy structure. VaultReceiver.changedChildOfVaults() is invoked when a node experiences a change in its children.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedVaultHierarchyForAncestors

      void registerForChangedVaultHierarchyForAncestors(Id vaultId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated vault hierarchy structure. VaultReceiver.changedChildOfVaults() is invoked when the specified node or any of its ancestors experiences a change in its children.
      Parameters:
      vaultId - the Id of the Vault node to monitor
      Throws:
      NullArgumentException - vaultId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedVaultHierarchyForDescendants

      void registerForChangedVaultHierarchyForDescendants(Id vaultId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated vault hierarchy structure. VaultReceiver.changedChildOfVaults() is invoked when the specified node or any of its descendants experiences a change in its children.
      Parameters:
      vaultId - the Id of the Vault node to monitor
      Throws:
      NullArgumentException - vaultId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.