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

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

The two views defined in this session correspond to the views in the FunctionLookupSession.

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.
MethodcanRegisterForFunctionNotifications
Description

Tests if this user can register for Function 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 functions 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 to this vault only.

CompliancemandatoryThis method is must be implemented.
MethodreliableFunctionNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableFunctionNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeFunctionNotification
Description

Acknowledge a function notification.

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

Register for notifications of new functions. FunctionReceiver.newFunctions() is invoked when a new Function is created.

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

Registers for notification of updated functions. FunctionReceiver.changedFunctions() is invoked when a function is changed.

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

Registers for notification of an updated function. FunctionReceiver.changedFunctions() is invoked when the specified function 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.
MethodregisterForDeletedFunctions
Description

Registers for notification of deleted functions. FunctionReceiver.deletedFunctions() is invoked when a function is removed from this vault.

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

Registers for notification of a deleted function. FunctionReceiver.changedFunctions() is invoked when the specified function 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.