org.osid.authentication.keys

Interface AuthenticationKeysManager

All Superinterfaces:

AuthenticationKeysProfile, java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, Sourceable

public interface AuthenticationKeysManager
extends OsidManager, AuthenticationKeysProfile

The authentication keys manager provides access to authenticationkeys sessions and provides interoperability tests for various aspects of this service. 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

Method Summary

Methods

Modifier and Type	Method and Description
KeyAdminSession	getKeyAdminSession() Gets the OsidSession associated with the key administration service.
KeyAdminSession	getKeyAdminSessionForAgency(Id agencyId) Gets the OsidSession associated with the key admin service for the given agency.
KeyAgencyAssignmentSession	getKeyAgencyAssignmentSession() Gets the session for assigning key to agency mappings.
KeyAgencySession	getKeyAgencySession() Gets the session for retrieving key to agency mappings.
KeyLookupSession	getKeyLookupSession() Gets the OsidSession associated with the key lookup service.
KeyLookupSession	getKeyLookupSessionForAgency(Id agencyId) Gets the OsidSession associated with the key lookup service for the given agency.
KeyNotificationSession	getKeyNotificationSession(KeyReceiver keyReceiver) Gets the notification session for notifications pertaining to service changes.
KeyNotificationSession	getKeyNotificationSessionForAgency(KeyReceiver keyReceiver, Id agencyId) Gets the OsidSession associated with the key notification service for the given agency.
KeySearchSession	getKeySearchSession() Gets the OsidSession associated with the key search service.
KeySearchSession	getKeySearchSessionForAgency(Id agencyId) Gets the OsidSession associated with the key search service for the given agency.
KeySmartAgencySession	getKeySmartAgencySession(Id agencyId) Gets the OsidSession associated with the key smart agency service for the given agency.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.authentication.keys.AuthenticationKeysProfile

getKeyRecordTypes, getKeySearchRecordTypes, supportsKeyAdmin, supportsKeyAgency, supportsKeyAgencyAssignment, supportsKeyLookup, supportsKeyNotification, supportsKeyRecordType, supportsKeySearch, supportsKeySearchRecordType, supportsKeySmartAgency, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getKeyLookupSession

KeyLookupSession getKeyLookupSession()
                                     throws OperationFailedException

Gets the OsidSession associated with the key lookup service.

Returns:

a KeyLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsKeyLookup() is false

Compliance:

optional - This method must be implemented if supportsKeyLookup() is true.

getKeyLookupSessionForAgency

KeyLookupSession getKeyLookupSessionForAgency(Id agencyId)
                                              throws NotFoundException,
                                                     OperationFailedException

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

Parameters:

agencyId - the Id of the agency

Returns:

a KeyLookupSession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agencyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsKeyLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsKeyLookup() and supportsVisibleFederation() are true.

getKeySearchSession

KeySearchSession getKeySearchSession()
                                     throws OperationFailedException

Gets the OsidSession associated with the key search service.

Returns:

a KeySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsKeySearch() is false

Compliance:

optional - This method must be implemented if supportsKeySearch() is true.

getKeySearchSessionForAgency

KeySearchSession getKeySearchSessionForAgency(Id agencyId)
                                              throws NotFoundException,
                                                     OperationFailedException

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

Parameters:

agencyId - the Id of the agency

Returns:

a KeySearchSession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agencyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsKeySearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsKeySearch() and supportsVisibleFederation() are true.

getKeyAdminSession

KeyAdminSession getKeyAdminSession()
                                   throws OperationFailedException

Gets the OsidSession associated with the key administration service.

Returns:

a KeyAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsKeyAdmin() is false

Compliance:

optional - This method must be implemented if supportsKeyAdmin() is true.

getKeyAdminSessionForAgency

KeyAdminSession getKeyAdminSessionForAgency(Id agencyId)
                                            throws NotFoundException,
                                                   OperationFailedException

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

Parameters:

agencyId - the Id of the agency

Returns:

a KeyAdminSession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agencyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsKeyAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsKeyAdmin() and supportsVisibleFederation() are true.

getKeyNotificationSession

KeyNotificationSession getKeyNotificationSession(KeyReceiver keyReceiver)
                                                 throws OperationFailedException

Gets the notification session for notifications pertaining to service changes.

Parameters:

keyReceiver - the key receiver

Returns:

an KeyNotificationSession

Throws:

NullArgumentException - keyReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsKeyNotification() is false

Compliance:

optional - This method must be implemented if supportsKeyNotification() is true.

getKeyNotificationSessionForAgency

KeyNotificationSession getKeyNotificationSessionForAgency(KeyReceiver keyReceiver,
                                                        Id agencyId)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

keyReceiver - the key receiver

agencyId - the Id of the agency

Returns:

an KeyNotificationSession

Throws:

NotFoundException - agencyId not found

NullArgumentException - keyReceiver or agencyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsKeyNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsKeyNotification() and supportsVisibleFederation() are true.

getKeyAgencySession

KeyAgencySession getKeyAgencySession()
                                     throws OperationFailedException

Gets the session for retrieving key to agency mappings.

Returns:

an KeyAgencySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsKeyAgency() is false

Compliance:

optional - This method must be implemented if supportsKeyAgency() is true.

getKeyAgencyAssignmentSession

KeyAgencyAssignmentSession getKeyAgencyAssignmentSession()
                                                         throws OperationFailedException

Gets the session for assigning key to agency mappings.

Returns:

a KeyAgencyAsignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsKeyAgencyAssignment() is false

Compliance:

optional - This method must be implemented if supportsKeyAgencyAssignment() is true.

getKeySmartAgencySession

KeySmartAgencySession getKeySmartAgencySession(Id agencyId)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

agencyId - the Id of the agency

Returns:

an KeySmartAgencySession

Throws:

NotFoundException - agencyId not found

NullArgumentException - agencyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsKeySmartAgency() is false

Compliance:

optional - This method must be implemented if supportsKeySmartAgency() and supportsVisibeFederation() is true.