org.osid.authentication.keys.batch

Interface AuthenticationKeysBatchManager

All Superinterfaces:

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

public interface AuthenticationKeysBatchManager
extends OsidManager, AuthenticationKeysBatchProfile

The authentication keys batch manager provides access to authentication keys batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• KeyBatchAdminSession: a session to create, modify and delete keys in bulk

Method Summary

Methods

Modifier and Type	Method and Description
KeyBatchAdminSession	getKeyBatchAdminSession() Gets the OsidSession associated with the bulk key administration service.
KeyBatchAdminSession	getKeyBatchAdminSessionForAgency(Id agencyId) Gets the OsidSession associated with the bulk key administration 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.batch.AuthenticationKeysBatchProfile

supportsKeyBatchAdmin, 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

getKeyBatchAdminSession

KeyBatchAdminSession getKeyBatchAdminSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the bulk key administration service.

Returns:

a KeyBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsKeyBatchAdmin() is false

Compliance:

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

getKeyBatchAdminSessionForAgency

KeyBatchAdminSession getKeyBatchAdminSessionForAgency(Id agencyId)
                                                      throws NotFoundException,
                                                             OperationFailedException

Gets the OsidSession associated with the bulk key administration service for the given agency.

Parameters:

agencyId - the Id of the Agency

Returns:

a KeyBatchAdminSession

Throws:

NotFoundException - no Agency found by the given Id

NullArgumentException - agencyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsKeyBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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