Interface AuthenticationKeysManager

All Superinterfaces:

AuthenticationKeysProfile, AutoCloseable, Closeable, OsidManager, 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

Modifier and Type	Method	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 AuthenticationKeysProfile

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

Modifier and Type	Method	Description
TypeList	getKeyRecordTypes()	Gets the supported Key record types.
TypeList	getKeySearchRecordTypes()	Gets the supported key search record types.
boolean	supportsKeyAdmin()	Tests if a key administrative service is supported.
boolean	supportsKeyAgency()	Tests if retrieving mappings of keys and agencies is supported.
boolean	supportsKeyAgencyAssignment()	Tests if managing mappings of keys and agencies is supported.
boolean	supportsKeyLookup()	Tests if a key lookup service is supported.
boolean	supportsKeyNotification()	Tests if key notification is supported.
boolean	supportsKeyRecordType(Type keyRecordType)	Tests if the given Key record type is supported.
boolean	supportsKeySearch()	Tests if a key search service is supported.
boolean	supportsKeySearchRecordType(Type keySearchRecordType)	Tests if the given key search record type is supported.
boolean	supportsKeySmartAgency()	Tests if key smart agency is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsKeyLookup()} is {@code 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 {@code supportsKeyLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsKeySearch()} is {@code 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 {@code supportsKeySearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsKeyAdmin()} is {@code 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 {@code supportsKeyAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsKeyNotification()} is {@code 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 {@code supportsKeyNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsKeyAgency()} is {@code 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 {@code supportsKeyAgencyAssignment()} is {@code 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 {@code supportsKeySmartAgency()} and {@code supportsVisibeFederation()} is {@code true} .