OSID Logo
OSID Specifications
authentication keys package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.keys.AuthenticationKeysProxyManager
Implementsosid.OsidProxyManager
osid.authentication.keys.AuthenticationKeysProfile
Description

The authentication proxy manager provides access to authentication sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

  • KeyLookupSession: a session to access the keys of Agents
  • KeyQuerySession: a session to query keys
  • KeySearchSession : a session to search for keys
  • KeyAdminSession: a session to update the keys of Agents
  • KeyNotificationSession: a session to receive messages pertaining to Key changes
  • KeyAgencySession: a session to retrieve Key to Agency mappings
  • KeyAgencyAssignmentSession: a session to manage Key to Agency mappings
  • KeySmartAgencySession: a session to create dynamic agencies of keys
MethodgetKeyLookupSession
Description

Gets the OsidSession associated with the key lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.authentication.keys.KeyLookupSessiona KeyLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsKeyLookup() is false
ComplianceoptionalThis method must be implemented if supportsKeyLookup() is true.
MethodgetKeyLookupSessionForAgency
Description

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

Parametersosid.id.IdagencyIdthe Id of the agency
osid.proxy.Proxyproxya proxy
Returnosid.authentication.keys.KeyLookupSession a KeyLookupSession
ErrorsNOT_FOUND agencyId not found
NULL_ARGUMENT agencyId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsKeyLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsKeyLookup() and supportsVisibleFederation() are true.
MethodgetKeySearchSession
Description

Gets the OsidSession associated with the key search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.authentication.keys.KeySearchSessiona KeySearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsKeySearch() is false
ComplianceoptionalThis method must be implemented if supportsKeySearch() is true.
MethodgetKeySearchSessionForAgency
Description

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

Parametersosid.id.IdagencyIdthe Id of the agency
osid.proxy.Proxyproxya proxy
Returnosid.authentication.keys.KeySearchSession a KeySearchSession
ErrorsNOT_FOUND agencyId not found
NULL_ARGUMENT agencyId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsKeySearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsKeySearch() and supportsVisibleFederation() are true.
MethodgetKeyAdminSession
Description

Gets the OsidSession associated with the key administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.authentication.keys.KeyAdminSessiona KeyAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsKeyAdmin() is false
ComplianceoptionalThis method must be implemented if supportsKeyAdmin() is true.
MethodgetKeyAdminSessionForAgency
Description

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

Parametersosid.id.IdagencyIdthe Id of the agency
osid.proxy.Proxyproxya proxy
Returnosid.authentication.keys.KeyAdminSession a KeyAdminSession
ErrorsNOT_FOUND agencyId not found
NULL_ARGUMENT agencyId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsKeyAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsKeyAdmin() and supportsVisibleFederation() are true.
MethodgetKeyNotificationSession
Description

Gets the messaging receiver session for notifications pertaining to key changes.

Parametersosid.authentication.keys.KeyReceiverkeyReceiverthe key receiver
osid.proxy.Proxyproxya proxy
Returnosid.authentication.keys.KeyNotificationSessionan KeyNotificationSession
ErrorsNULL_ARGUMENT proxy or keyReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsKeyNotification() is false
ComplianceoptionalThis method must be implemented if supportsKeyNotification() is true.
MethodgetKeyNotificationSessionForAgency
Description

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

Parametersosid.authentication.keys.KeyReceiverkeyReceiverthe key receiver
osid.id.IdagencyIdthe Id of the agency
osid.proxy.Proxyproxya proxy
Returnosid.authentication.keys.KeyNotificationSession an KeyNotificationSession
ErrorsNOT_FOUND agencyId not found
NULL_ARGUMENT keyReceiver, agencyId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsKeyNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsKeyNotification() and supportsVisibleFederation() are true.
MethodgetKeyAgencySession
Description

Gets the session for retrieving key to agency mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.authentication.keys.KeyAgencySessionan KeyAgencySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsKeyAgency() is false
ComplianceoptionalThis method must be implemented if supportsKeyAgency() is true.
MethodgetKeyAgencyAssignmentSession
Description

Gets the session for assigning key to agency mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.authentication.keys.KeyAgencyAssignmentSessionan KeyAgencyAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsKeyAgencyAssignment() is false
ComplianceoptionalThis method must be implemented if supportsKeyAgencyAssignment() is true.
MethodgetKeySmartAgencySession
Description

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

Parametersosid.id.IdagencyIdthe Id of the bank
osid.proxy.Proxyproxya proxy
Returnosid.authentication.keys.KeySmartAgencySessionan KeySmartAgencySession
ErrorsNOT_FOUND agencyId not found
NULL_ARGUMENT agencyId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsKeySmartAgency() is false
ComplianceoptionalThis method must be implemented if supportsKeySmartAgency() and supportsVisibeFederation() is true.