Interface | osid.authentication.AuthenticationManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.authentication.AuthenticationProfile | |||
Description |
The authentication manager provides access to authentication sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getAgentLookupSession | ||
Description |
Gets the | ||
Return | osid.authentication.AgentLookupSession | an AgentLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAgentLookup() is false | ||
Compliance | optional | This method must be implemented if supportsAgentLookup() is
true. | |
Method | getAgentLookupSessionForAgency | ||
Description |
Gets the | ||
Parameters | osid.id.Id | agencyId | the Id of the agency |
Return | osid.authentication.AgentLookupSession | an AgentLookupSession | |
Errors | NOT_FOUND | agencyId not found | |
NULL_ARGUMENT | agencyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAgentLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsAgentLookup() and
supportsVisibleFederation() are true. | |
Method | getAgentQuerySession | ||
Description |
Gets the | ||
Return | osid.authentication.AgentQuerySession | an AgentQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAgentQuery() is false | ||
Compliance | optional | This method must be implemented if supportsAgentQuery() is
true. | |
Method | getAgentQuerySessionForAgency | ||
Description |
Gets the | ||
Parameters | osid.id.Id | agencyId | the Id of the agency |
Return | osid.authentication.AgentQuerySession | an AgentQuerySession | |
Errors | NOT_FOUND | agencyId not found | |
NULL_ARGUMENT | agencyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAgentQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsAgentQuery() and
supportsVisibleFederation() are true. | |
Method | getAgentSearchSession | ||
Description |
Gets the | ||
Return | osid.authentication.AgentSearchSession | an AgentSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAgentSearch() is false | ||
Compliance | optional | This method must be implemented if supportsAgentSearch() is
true. | |
Method | getAgentSearchSessionForAgency | ||
Description |
Gets the | ||
Parameters | osid.id.Id | agencyId | the Id of the agency |
Return | osid.authentication.AgentSearchSession | an AgentSearchSession | |
Errors | NOT_FOUND | agencyId not found | |
NULL_ARGUMENT | agencyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAgentSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsAgentSearch() and
supportsVisibleFederation() are true. | |
Method | getAgentAdminSession | ||
Description |
Gets the | ||
Return | osid.authentication.AgentAdminSession | an AgentAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAgentAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsAgentAdmin() is
true. | |
Method | getAgentAdminSessionForAgency | ||
Description |
Gets the | ||
Parameters | osid.id.Id | agencyId | the Id of the agency |
Return | osid.authentication.AgentAdminSession | an AgentAdminSession | |
Errors | NOT_FOUND | agencyId not found | |
NULL_ARGUMENT | agencyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAgentAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsAgentAdmin() and
supportsVisibleFederation() are true. | |
Method | getAgentNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to service changes. | ||
Parameters | osid.authentication.AgentReceiver | agentReceiver | the agent receiver |
Return | osid.authentication.AgentNotificationSession | an AgentNotificationSession | |
Errors | NULL_ARGUMENT | agentReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAgentNotification() is false | ||
Compliance | optional | This method must be implemented if supportsAgentNotification()
is true. | |
Method | getAgentNotificationSessionForAgency | ||
Description |
Gets the | ||
Parameters | osid.authentication.AgentReceiver | agentReceiver | the agent receiver |
osid.id.Id | agencyId | the Id of the agency | |
Return | osid.authentication.AgentNotificationSession | an AgentNotificationSession | |
Errors | NOT_FOUND | agencyId not found | |
NULL_ARGUMENT | agentReceiver or agencyId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAgentNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsAgentNotification()
and supportsVisibleFederation() are true.
| |
Method | getAgentAgencySession | ||
Description |
Gets the session for retrieving agent to agency mappings. | ||
Return | osid.authentication.AgentAgencySession | an AgentAgencySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAgentAgency() is false | ||
Compliance | optional | This method must be implemented if supportsAgentAgency() is
true. | |
Method | getAgentAgencyAssignmentSession | ||
Description |
Gets the session for assigning agent to agency mappings. | ||
Return | osid.authentication.AgentAgencyAssignmentSession | a AgentAgencyAsignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAgentAgencyAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsAgentAgencyAssignment()
is true. | |
Method | getAgentSmartAgencySession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | agencyId | the Id of the agency |
Return | osid.authentication.AgentSmartAgencySession | an AgentSmartAgencySession | |
Errors | NOT_FOUND | agencyId not found | |
NULL_ARGUMENT | agencyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAgentSmartAgency() is false | ||
Compliance | optional | This method must be implemented if supportsAgentSmartAgency()
and supportsVisibeFederation() is true. | |
Method | getAgencyLookupSession | ||
Description |
Gets the | ||
Return | osid.authentication.AgencyLookupSession | an AgencyLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAgencyLookup() is false | ||
Compliance | optional | This method must be implemented if supportsAgencyLookup() is
true. | |
Method | getAgencySearchSession | ||
Description |
Gets the | ||
Return | osid.authentication.AgencySearchSession | an AgencySearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAgencySearch() is false | ||
Compliance | optional | This method must be implemented if supportsAgencySearch() is
true. | |
Method | getAgencyAdminSession | ||
Description |
Gets the | ||
Return | osid.authentication.AgencyAdminSession | an AgencyAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAgencyAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsAgencyAdmin() is
true. | |
Method | getAgencyNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to agency service changes. | ||
Parameters | osid.authentication.AgencyReceiver | agencyReceiver | the agency receiver |
Return | osid.authentication.AgencyNotificationSession | an AgencyNotificationSession | |
Errors | NULL_ARGUMENT | agencyReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAgencyNotification() is false | ||
Compliance | optional | This method must be implemented if supportsAgencyNotification()
is true. | |
Method | getAgencyHierarchySession | ||
Description |
Gets the session traversing agency hierarchies. | ||
Return | osid.authentication.AgencyHierarchySession | an AgencyHierarchySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAgencyHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsAgencyHierarchy()
is true. | |
Method | getAgencyHierarchyDesignSession | ||
Description |
Gets the session designing agency hierarchies. | ||
Return | osid.authentication.AgencyHierarchyDesignSession | an AgencyHierarchyDesignSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAgencyHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsAgencyHierarchyDesign()
is true. | |
Method | getAuthenticationBatchManager | ||
Description |
Gets an | ||
Return | osid.authentication.batch.AuthenticationBatchManager | an AuthenticationBatchManager. | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAuthenticationBatch() is false | ||
Compliance | optional | This method must be implemented if supportsAuthenticationBatch()
is true. | |
Method | getAuthenticationKeysManager | ||
Description |
Gets an | ||
Return | osid.authentication.keys.AuthenticationKeysManager | an AuthenticationKeysManager. | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAuthenticationKeys() is false | ||
Compliance | optional | This method must be implemented if supportsAuthenticationKeys()
is true. | |
Method | getAuthenticationProcessManager | ||
Description |
Gets an | ||
Return | osid.authentication.process.AuthenticationProcessManager | an AuthenticationProcessManager. | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAuthenticationProcess() is false | ||
Compliance | optional | This method must be implemented if supportsAuthenticationProcess()
is true. |