OSID Logo
OSID Specifications
authentication package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.AuthenticationManager
Implementsosid.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:

  • AgentLookupSession: a session to look up Agents
  • AgentQuerySession: a session to query Agents
  • AgentSearchSession: a session to search Agents
  • AgentAdminSession: a session to create, modify and delete Agents
  • AgentNotificationSession: a session to receive messages pertaining to Agent changes
  • AgentAgencySession: a session to retrieve Agent to Agency mappings
  • AgentAgencyAssignmentSession: a session to manage Agent to Agency mappings
  • AgentSmartAgencySession: a session to create dynamic agencies
  • AgencyLookupSession: a session to lookup agencies
  • AgencyQuerySession: a session to query agencies
  • AgencySearchSession : a session to search agencies
  • AgencyAdminSession : a session to create, modify and delete agencies
  • AgencyNotificationSession : a session to receive messages pertaining to Agency changes
  • AgencyHierarchySession : a session to traverse the Agency hierarchy
  • AgencyHierarchyDesignSession : a session to manage the Agency hierarchy
MethodgetAgentLookupSession
Description

Gets the OsidSession associated with the agent lookup service.

Returnosid.authentication.AgentLookupSessionan AgentLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgentLookup() is false
ComplianceoptionalThis method must be implemented if supportsAgentLookup() is true.
MethodgetAgentLookupSessionForAgency
Description

Gets the OsidSession associated with the agent lookup service for the given agency.

Parametersosid.id.IdagencyIdthe Id of the agency
Returnosid.authentication.AgentLookupSession an AgentLookupSession
ErrorsNOT_FOUND agencyId not found
NULL_ARGUMENT agencyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgentLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAgentLookup() and supportsVisibleFederation() are true.
MethodgetAgentQuerySession
Description

Gets the OsidSession associated with the agent query service.

Returnosid.authentication.AgentQuerySessionan AgentQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgentQuery() is false
ComplianceoptionalThis method must be implemented if supportsAgentQuery() is true.
MethodgetAgentQuerySessionForAgency
Description

Gets the OsidSession associated with the agent query service for the given agency.

Parametersosid.id.IdagencyIdthe Id of the agency
Returnosid.authentication.AgentQuerySession an AgentQuerySession
ErrorsNOT_FOUND agencyId not found
NULL_ARGUMENT agencyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgentQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAgentQuery() and supportsVisibleFederation() are true.
MethodgetAgentSearchSession
Description

Gets the OsidSession associated with the agent search service.

Returnosid.authentication.AgentSearchSessionan AgentSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgentSearch() is false
ComplianceoptionalThis method must be implemented if supportsAgentSearch() is true.
MethodgetAgentSearchSessionForAgency
Description

Gets the OsidSession associated with the agent search service for the given agency.

Parametersosid.id.IdagencyIdthe Id of the agency
Returnosid.authentication.AgentSearchSession an AgentSearchSession
ErrorsNOT_FOUND agencyId not found
NULL_ARGUMENT agencyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgentSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAgentSearch() and supportsVisibleFederation() are true.
MethodgetAgentAdminSession
Description

Gets the OsidSession associated with the agent administration service.

Returnosid.authentication.AgentAdminSessionan AgentAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgentAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAgentAdmin() is true.
MethodgetAgentAdminSessionForAgency
Description

Gets the OsidSession associated with the agent admin service for the given agency.

Parametersosid.id.IdagencyIdthe Id of the agency
Returnosid.authentication.AgentAdminSession an AgentAdminSession
ErrorsNOT_FOUND agencyId not found
NULL_ARGUMENT agencyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgentAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAgentAdmin() and supportsVisibleFederation() are true.
MethodgetAgentNotificationSession
Description

Gets the notification session for notifications pertaining to service changes.

Parametersosid.authentication.AgentReceiveragentReceiverthe agent receiver
Returnosid.authentication.AgentNotificationSessionan AgentNotificationSession
ErrorsNULL_ARGUMENT agentReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgentNotification() is false
ComplianceoptionalThis method must be implemented if supportsAgentNotification() is true.
MethodgetAgentNotificationSessionForAgency
Description

Gets the OsidSession associated with the agent notification service for the given agency.

Parametersosid.authentication.AgentReceiveragentReceiverthe agent receiver
osid.id.IdagencyIdthe Id of the agency
Returnosid.authentication.AgentNotificationSession an AgentNotificationSession
ErrorsNOT_FOUND agencyId not found
NULL_ARGUMENT agentReceiver or agencyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgentNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAgentNotification() and supportsVisibleFederation() are true.
MethodgetAgentAgencySession
Description

Gets the session for retrieving agent to agency mappings.

Returnosid.authentication.AgentAgencySessionan AgentAgencySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgentAgency() is false
ComplianceoptionalThis method must be implemented if supportsAgentAgency() is true.
MethodgetAgentAgencyAssignmentSession
Description

Gets the session for assigning agent to agency mappings.

Returnosid.authentication.AgentAgencyAssignmentSessiona AgentAgencyAsignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgentAgencyAssignment() is false
ComplianceoptionalThis method must be implemented if supportsAgentAgencyAssignment() is true.
MethodgetAgentSmartAgencySession
Description

Gets the OsidSession associated with the agent smart agency service for the given agency.

Parametersosid.id.IdagencyIdthe Id of the agency
Returnosid.authentication.AgentSmartAgencySessionan AgentSmartAgencySession
ErrorsNOT_FOUND agencyId not found
NULL_ARGUMENT agencyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgentSmartAgency() is false
ComplianceoptionalThis method must be implemented if supportsAgentSmartAgency() and supportsVisibeFederation() is true.
MethodgetAgencyLookupSession
Description

Gets the OsidSession associated with the agency lookup service.

Returnosid.authentication.AgencyLookupSessionan AgencyLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgencyLookup() is false
ComplianceoptionalThis method must be implemented if supportsAgencyLookup() is true.
MethodgetAgencySearchSession
Description

Gets the OsidSession associated with the agency search service.

Returnosid.authentication.AgencySearchSessionan AgencySearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgencySearch() is false
ComplianceoptionalThis method must be implemented if supportsAgencySearch() is true.
MethodgetAgencyAdminSession
Description

Gets the OsidSession associated with the agency administration service.

Returnosid.authentication.AgencyAdminSessionan AgencyAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgencyAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAgencyAdmin() is true.
MethodgetAgencyNotificationSession
Description

Gets the notification session for notifications pertaining to agency service changes.

Parametersosid.authentication.AgencyReceiveragencyReceiverthe agency receiver
Returnosid.authentication.AgencyNotificationSessionan AgencyNotificationSession
ErrorsNULL_ARGUMENT agencyReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgencyNotification() is false
ComplianceoptionalThis method must be implemented if supportsAgencyNotification() is true.
MethodgetAgencyHierarchySession
Description

Gets the session traversing agency hierarchies.

Returnosid.authentication.AgencyHierarchySessionan AgencyHierarchySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgencyHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsAgencyHierarchy() is true.
MethodgetAgencyHierarchyDesignSession
Description

Gets the session designing agency hierarchies.

Returnosid.authentication.AgencyHierarchyDesignSessionan AgencyHierarchyDesignSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgencyHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsAgencyHierarchyDesign() is true.
MethodgetAuthenticationBatchManager
Description

Gets an AuthenticationBatchManager.

Returnosid.authentication.batch.AuthenticationBatchManageran AuthenticationBatchManager.
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthenticationBatch() is false
ComplianceoptionalThis method must be implemented if supportsAuthenticationBatch() is true.
MethodgetAuthenticationKeysManager
Description

Gets an AuthenticationKeysManager.

Returnosid.authentication.keys.AuthenticationKeysManageran AuthenticationKeysManager.
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthenticationKeys() is false
ComplianceoptionalThis method must be implemented if supportsAuthenticationKeys() is true.
MethodgetAuthenticationProcessManager
Description

Gets an AuthenticationProcessManager.

Returnosid.authentication.process.AuthenticationProcessManageran AuthenticationProcessManager.
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthenticationProcess() is false
ComplianceoptionalThis method must be implemented if supportsAuthenticationProcess() is true.