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.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeVaultNotification(Id notificationId)
Acknowledge a vault notification.
|
boolean |
canRegisterForVaultNotifications()
Tests if this user can register for
Vault
notifications. |
void |
registerForChangedVault(Id vaultId)
Registers for notification of an updated vault.
|
void |
registerForChangedVaultHierarchy()
Registers for notification of an updated vault hierarchy structure.
|
void |
registerForChangedVaultHierarchyForAncestors(Id vaultId)
Registers for notification of an updated vault hierarchy structure.
|
void |
registerForChangedVaultHierarchyForDescendants(Id vaultId)
Registers for notification of an updated vault hierarchy structure.
|
void |
registerForChangedVaults()
Registers for notification of updated vaults.
|
void |
registerForDeletedVault(Id vaultId)
Registers for notification of a deleted vault.
|
void |
registerForDeletedVaults()
Registers for notification of deleted vaults.
|
void |
registerForNewVaults()
Register for notifications of new vaults.
|
void |
reliableVaultNotifications()
Reliable notifications are desired.
|
void |
unreliableVaultNotifications()
Unreliable notifications are desired.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForVaultNotifications()
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void reliableVaultNotifications()
acknowledgeVaultNotification()
.mandatory
- This method is must be implemented. void unreliableVaultNotifications()
mandatory
- This method is must be implemented. void acknowledgeVaultNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewVaults() throws OperationFailedException, PermissionDeniedException
VaultReceiver.newVaults()
is invoked when a new Vault
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedVaults() throws OperationFailedException, PermissionDeniedException
VaultReceiver.changedVaults()
is invoked when a vault is
changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedVault(Id vaultId) throws OperationFailedException, PermissionDeniedException
VaultReceiver.changedVaults()
is invoked when the specified
vault is changed.vaultId
- the Id of the vault to monitorNullArgumentException
- vaultId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedVaults() throws OperationFailedException, PermissionDeniedException
VaultReceiver.deletedVaults()
is invoked when a vault is
deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedVault(Id vaultId) throws OperationFailedException, PermissionDeniedException
VaultReceiver.deletedVaults()
is invoked when the specified
vault is deleted.vaultId
- the Id of the vault to monitorNullArgumentException
- vaultId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedVaultHierarchy() throws OperationFailedException, PermissionDeniedException
VaultReceiver.changedChildOfVaults()
is invoked when a
node experiences a change in its children.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedVaultHierarchyForAncestors(Id vaultId) throws OperationFailedException, PermissionDeniedException
VaultReceiver.changedChildOfVaults()
is invoked when
the specified node or any of its ancestors experiences a change in its
children.vaultId
- the Id
of the Vault
node
to monitorNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedVaultHierarchyForDescendants(Id vaultId) throws OperationFailedException, PermissionDeniedException
VaultReceiver.changedChildOfVaults()
is invoked when
the specified node or any of its descendants experiences a change in
its children.vaultId
- the Id
of the Vault
node
to monitorNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.