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

This session defines methods to receive asynchronous notifications on adds/changes to Authorizations. 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 views defined in this session correspond to the views in the AuthorizationLookupSession.

MethodgetVaultId
Description

Gets the Vault Id associated with this session.

Returnosid.id.Idthe Vault Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetVault
Description

Gets the Vault associated with this session.

Returnosid.authorization.Vaultthe Vault associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForAuthorizationNotifications
Description

Tests if this user can register for Authorization 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.
MethoduseFederatedVaultView
Description

Federates the view for methods in this session. A federated view will include authorizations in vaults which are children of this vault in the vault hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedVaultView
Description

Isolates the view for methods in this session. An isolated view restricts notifications for authorizations in this vault only.

CompliancemandatoryThis method is must be implemented.
MethodreliableAuthorizationNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableAuthorizationNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeAuthorizationNotification
Description

Acknowledge an authorization notification.

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

Sets the view for methods in this session to implicit authorizations. An implicit view will include authorizations derived from other authorizations as a result of the Qualifier, Function or Resource hierarchies. This method is the opposite of explicitAuthorizationView().

CompliancemandatoryThis method is must be implemented.
MethoduseExplicitAuthorizationView
Description

Sets the view for methods in this session to explicit authorizations. An explicit view includes only those authorizations that were explicitly defined and not implied. This method is the opposite of implicitAuthorizationView().

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewAuthorizations
Description

Register for notifications of new authorizations. AuthorizationReceiver.newAuthorizations() is invoked when a new Authorization appears in this vault.

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

Registers for notification of new authorizations for the given resource including any authorizations related to the resource through an agent. AuthorizationReceiver.newAuthorizations() is invoked when an authorization appears in this vault.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewAuthorizationsForFunction
Description

Register for notifications of new authorizations for the given function. AuthorizationReceiver.newAuthorizations() is invoked when a new Authorization appears in this vault.

Parametersosid.id.IdfunctionIdthe Id of the Function to monitor
ErrorsNULL_ARGUMENT functionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAuthorizations
Description

Registers for notification of updated authorizations. AuthorizationReceiver.changedAuthorizations() is invoked when an authorization in this vault is changed.

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

Registers for notification of updated authorizations for the given resource including any authorizations related to the resource through an agent. AuthorizationReceiver.changedAuthorizations() is invoked when an authorization in this vault is changed.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAuthorizationsForFunction
Description

Registers for notification of updated authorizations for the given function. AuthorizationReceiver.changedAuthorizations() is invoked when an authorization in this vault is changed.

Parametersosid.id.IdfunctionIdthe Id of the Function to monitor
ErrorsNULL_ARGUMENT functionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAuthorization
Description

Registers for notification of an updated authorization. AuthorizationReceiver.changedAuthorizations() is invoked when the specified authorization in this vault is changed.

Parametersosid.id.IdauthorizationIdthe Id of the Authorization to monitor
ErrorsNULL_ARGUMENT authorizationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAuthorizations
Description

Registers for notification of deleted authorizations. AuthorizationReceiver.deletedAuthorizations() is invoked when an authorization is removed from this vault.

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

Registers for notification of deleted authorizations for the given resource including any authorizations related to the resource through an agent. AuthorizationReceiver.deletedAuthorizations() is invoked when an authorization is removed from this vault.

Parametersosid.id.IdresourceIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAuthorizationsForFunction
Description

Registers for notification of deleted authorizations for the given function. AuthorizationReceiver.deletedAuthorizations() is invoked when an authorization is removed from this vault.

Parametersosid.id.IdfunctionIdthe Id of the Function to monitor
ErrorsNULL_ARGUMENT functionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAuthorization
Description

Registers for notification of a deleted authorization. AuthorizationReceiver.deletedAuthorizations() is invoked when the specified authorization is removed from this vault.

Parametersosid.id.IdauthorizationIdthe Id of the Authorization to monitor
ErrorsNULL_ARGUMENT authorizationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.