public interface AuthorizationEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to AuthorizationEnabler
objects in this Vault.
This also includes existing AuthorizationEnablers
that may appear or disappear due to changes in the Vault
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
AuthorizationEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeAuthorizationEnablerNotification(Id notificationId)
Acknowledge an authorization enabler notification.
|
boolean |
canRegisterForAuthorizationEnablerNotifications()
Tests if this user can register for
AuthorizationEnabler
notifications. |
Vault |
getVault()
Gets the
Vault associated with this session. |
Id |
getVaultId()
Gets the
Vault Id associated with this
session. |
void |
registerForChangedAuthorizationEnabler(Id authorizationEnablerId)
Registers for notification of an updated authorization enabler.
|
void |
registerForChangedAuthorizationEnablers()
Registers for notification of updated authorization enablers.
|
void |
registerForDeletedAuthorizationEnabler(Id authorizationEnablerId)
Registers for notification of a deleted authorization enabler.
|
void |
registerForDeletedAuthorizationEnablers()
Registers for notification of deleted authorization enablers.
|
void |
registerForNewAuthorizationEnablers()
Register for notifications of new authorization enablers.
|
void |
reliableAuthorizationEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableAuthorizationEnablerNotifications()
Unreliable notifications are desired.
|
void |
useFederatedVaultView()
Federates the view for methods in this session.
|
void |
useIsolatedVaultView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getVaultId()
Vault
Id
associated with this
session. Vault Id
associated with this sessionmandatory
- This method must be implemented. Vault getVault() throws OperationFailedException, PermissionDeniedException
Vault
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForAuthorizationEnablerNotifications()
AuthorizationEnabler
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 useFederatedVaultView()
mandatory
- This method is must be implemented. void useIsolatedVaultView()
mandatory
- This method is must be implemented. void reliableAuthorizationEnablerNotifications()
acknowledgeAuthorizationEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableAuthorizationEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeAuthorizationEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAuthorizationEnablers() throws OperationFailedException, PermissionDeniedException
AuthorizationEnablerReceiver.newAuthorizationEnablers()
is
invoked when a new AuthorizationEnabler
appears in this
vault.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAuthorizationEnablers() throws OperationFailedException, PermissionDeniedException
AuthorizationEnablerReceiver.changedAuthorizationEnablers()
is
invoked when an authorization enabler in this vault is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAuthorizationEnabler(Id authorizationEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedAuthorizationEnablers()
is
invoked when the specified authorization enabler in this vault is
changed.authorizationEnablerId
- the Id
of the
AuthorizationEnabler
to monitorNullArgumentException
- authorizationEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAuthorizationEnablers() throws OperationFailedException, PermissionDeniedException
AuthorizationEnablerReceiver.deletedAuthorizationEnablers()
is
invoked when an authorization enabler is deleted or removed from this
vault.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAuthorizationEnabler(Id authorizationEnablerId) throws OperationFailedException, PermissionDeniedException
AuthorizationEnablerReceiver.deletedAuthorizationEnablers()
is
invoked when the specified authorization enabler is deleted or removed
from this vault.authorizationEnablerId
- the Id
of the
AuthorizationEnabler
to monitorNullArgumentException
- authorizationEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.