OSID Logo
OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.VaultNotificationSession
Implementsosid.OsidSession
Description

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.

MethodcanRegisterForVaultNotifications
Description

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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodreliableVaultNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeVaultNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableVaultNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeVaultNotification
Description

Acknowledge a vault notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewVaults
Description

Register for notifications of new vaults. VaultReceiver.newVaults() is invoked when a new Vault is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedVaults
Description

Registers for notification of updated vaults. VaultReceiver.changedVaults() is invoked when a vault is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedVault
Description

Registers for notification of an updated vault. VaultReceiver.changedVaults() is invoked when the specified vault is changed.

Parametersosid.id.IdvaultIdthe Id of the vault to monitor
ErrorsNULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedVaults
Description

Registers for notification of deleted vaults. VaultReceiver.deletedVaults() is invoked when a vault is deleted.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedVault
Description

Registers for notification of a deleted vault. VaultReceiver.deletedVaults() is invoked when the specified vault is deleted.

Parametersosid.id.IdvaultIdthe Id of the vault to monitor
ErrorsNULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedVaultHierarchy
Description

Registers for notification of an updated vault hierarchy structure. VaultReceiver.changedChildOfVaults() is invoked when a node experiences a change in its children.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedVaultHierarchyForAncestors
Description

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.

Parametersosid.id.IdvaultIdthe Id of the Vault node to monitor
ErrorsNULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedVaultHierarchyForDescendants
Description

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.

Parametersosid.id.IdvaultIdthe Id of the Vault node to monitor
ErrorsNULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.