OSID Logo
OSID Specifications
authentication package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.AgentNotificationSession
Implementsosid.OsidSession
Description

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

MethodgetAgencyId
Description

Gets the Agency Id associated with this session.

Returnosid.id.Idthe Agency Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAgency
Description

Gets the Agency associated with this session.

Returnosid.authentication.Agencythe Agency associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForAgentNotifications
Description

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

Federates the view for methods in this session. A federated view will include agents in agencies which are children of this agency in the agency hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedAgencyView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this agency only.

CompliancemandatoryThis method is must be implemented.
MethodreliableAgentNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableAgentNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeAgentNotification
Description

Acknowledge an agent notification.

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

Register for notifications of new agents. AgentReceiver.newAgents() is invoked when a new Agent is created.

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

Registers for notification of updated agents. AgentReceiver.changedAgents() is invoked when an agent is changed.

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

Registers for notification of an updated agent. AgentReceiver.changedAgents() is invoked when the specified agent is changed.

Parametersosid.id.IdagentIdthe Id of the Agent to monitor
ErrorsNULL_ARGUMENT agentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAgents
Description

Registers for notification of deleted agents. AgentReceiver.deletedAgents() is invoked when an agent is removed from this agency.

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

Registers for notification of a deleted agent. AgentReceiver.deletedAgents() is invoked when the specified agent is removed from this agency.

Parametersosid.id.IdagentIdthe Id of the Agent to monitor
ErrorsNULL_ARGUMENT agentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.