Interface | osid.authentication.keys.AuthenticationKeysProxyManager | ||
---|---|---|---|
Implements | osid.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
| ||
Method | getKeyLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.authentication.keys.KeyLookupSession | a KeyLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsKeyLookup() is false | ||
Compliance | optional | This method must be implemented if supportsKeyLookup() is
true. | |
Method | getKeyLookupSessionForAgency | ||
Description |
Gets the | ||
Parameters | osid.id.Id | agencyId | the Id of the agency |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.authentication.keys.KeyLookupSession | a KeyLookupSession | |
Errors | NOT_FOUND | agencyId not found | |
NULL_ARGUMENT | agencyId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsKeyLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsKeyLookup() and
supportsVisibleFederation() are true. | |
Method | getKeySearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.authentication.keys.KeySearchSession | a KeySearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsKeySearch() is false | ||
Compliance | optional | This method must be implemented if supportsKeySearch() is
true. | |
Method | getKeySearchSessionForAgency | ||
Description |
Gets the | ||
Parameters | osid.id.Id | agencyId | the Id of the agency |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.authentication.keys.KeySearchSession | a KeySearchSession | |
Errors | NOT_FOUND | agencyId not found | |
NULL_ARGUMENT | agencyId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsKeySearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsKeySearch() and
supportsVisibleFederation() are true. | |
Method | getKeyAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.authentication.keys.KeyAdminSession | a KeyAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsKeyAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsKeyAdmin() is
true. | |
Method | getKeyAdminSessionForAgency | ||
Description |
Gets the | ||
Parameters | osid.id.Id | agencyId | the Id of the agency |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.authentication.keys.KeyAdminSession | a KeyAdminSession | |
Errors | NOT_FOUND | agencyId not found | |
NULL_ARGUMENT | agencyId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsKeyAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsKeyAdmin() and
supportsVisibleFederation() are true. | |
Method | getKeyNotificationSession | ||
Description |
Gets the messaging receiver session for notifications pertaining to key changes. | ||
Parameters | osid.authentication.keys.KeyReceiver | keyReceiver | the key receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.authentication.keys.KeyNotificationSession | an KeyNotificationSession | |
Errors | NULL_ARGUMENT | proxy or keyReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsKeyNotification() is false | ||
Compliance | optional | This method must be implemented if supportsKeyNotification()
is true. | |
Method | getKeyNotificationSessionForAgency | ||
Description |
Gets the | ||
Parameters | osid.authentication.keys.KeyReceiver | keyReceiver | the key receiver |
osid.id.Id | agencyId | the Id of the agency | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.authentication.keys.KeyNotificationSession | an KeyNotificationSession | |
Errors | NOT_FOUND | agencyId not found | |
NULL_ARGUMENT | keyReceiver, agencyId or proxy is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsKeyNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsKeyNotification()
and supportsVisibleFederation() are true. | |
Method | getKeyAgencySession | ||
Description |
Gets the session for retrieving key to agency mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.authentication.keys.KeyAgencySession | an KeyAgencySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsKeyAgency() is false | ||
Compliance | optional | This method must be implemented if supportsKeyAgency() is
true. | |
Method | getKeyAgencyAssignmentSession | ||
Description |
Gets the session for assigning key to agency mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.authentication.keys.KeyAgencyAssignmentSession | an KeyAgencyAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsKeyAgencyAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsKeyAgencyAssignment()
is true. | |
Method | getKeySmartAgencySession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | agencyId | the Id of the bank |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.authentication.keys.KeySmartAgencySession | an KeySmartAgencySession | |
Errors | NOT_FOUND | agencyId not found | |
NULL_ARGUMENT | agencyId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsKeySmartAgency() is false | ||
Compliance | optional | This method must be implemented if supportsKeySmartAgency()
and supportsVisibeFederation() is true. |