org.osid.authentication.keys.batch

Interface KeyBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, KeyAdminSession, OsidSession

public interface KeyBatchAdminSession
extends KeyAdminSession

This session creates, updates, and deletes Keys in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Key, a KeyForm is requested using getKeyFormsForCreate() specifying the desired agent and record Types or none if no record Types are needed. Each of the returned KeyForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a KeyForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each KeyForm corresponds to an attempted transaction.

The KeyForms returned from getKeyFormsForCreate() may be linked to the originating request through the peer Ids of the KeyForm. In the case where there may be duplicates, any KeyForm of the same peer Ids may be used for a create operation.

Once a batch of KeyForms are submitted for create, a CreateResponse is returned for each KeyForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createKeys(), errors specific to an individual KeyForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating KeyForm through the KeyForm Id .

For updates, KeyForms are requested to the Key Id that is to be updated using getKeyFormsForUpdate() where the reference Id in the KeyForm may be used to link the request. Similarly, the KeyForm has metadata about the data that can be updated and it can perform validation before submitting the update. The KeyForm can only be used once for a successful update and cannot be reused.

Once a batch of KeyForms are submitted for update, an UpdateResponse is returned for each KeyForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateKeys(), errors specific to an individual KeyForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating KeyForm through the KeyForm Id.

The delete operations delete Keys in bulk. To unmap a Key from the current Agency, the KeyAgencyAssignmentSession should be used. These delete operations attempt to remove the Key itself thus removing it from all known Agency catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasKeys(AliasRequestList aliasRequests) Adds an Id to a Key for the purpose of creating compatibility.
CreateResponseList	createKeys(KeyBatchFormList keyForms) Creates a new set of Keys.
DeleteResponseList	deleteAllKeys() Deletes all Keys in this Agency .
DeleteResponseList	deleteKeys(IdList keyIds) Deletes keys for the given Ids.
DeleteResponseList	deleteKeysForAgent(Id agentId) Deletes keys for the given agent Id.
KeyBatchFormList	getKeyFormsForCreate(IdList agentIds, Type[] keyRecordTypes) Gets the key forms for creating a bunch of new keys.
KeyBatchFormList	getKeyFormsForUpdate(IdList keyIds) Gets the key forms for updating an existing set of keys.
UpdateResponseList	updateKeys(KeyBatchFormList keyForms) Updates existing keys.

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

canCreateKeys, canCreateKeyWithRecordTypes, canDeleteKeys, canUpdateKeys, createKey, deleteKey, getAgency, getAgencyId, getKeyFormForCreate, getKeyFormForUpdate, updateKey

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

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

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getKeyFormsForCreate

KeyBatchFormList getKeyFormsForCreate(IdList agentIds,
                                    Type[] keyRecordTypes)
                                      throws NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Gets the key forms for creating a bunch of new keys. A key form is returned for each supplied agent.

Parameters:

agentIds - a list of agent Ids

keyRecordTypes - array of key record types to be included in each create operation or an empty list if none

Returns:

the key forms

Throws:

NotFoundException - an agentId is not found

NullArgumentException - agentIds or keyRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createKeys

CreateResponseList createKeys(KeyBatchFormList keyForms)
                              throws OperationFailedException,
                                     PermissionDeniedException

Creates a new set of Keys. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parameters:

keyForms - the key forms

Returns:

the create responses

Throws:

NullArgumentException - keyForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getKeyFormsForUpdate

KeyBatchFormList getKeyFormsForUpdate(IdList keyIds)
                                      throws NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Gets the key forms for updating an existing set of keys. A new key form should be requested for each update transaction.

Parameters:

keyIds - the Ids of the Key

Returns:

the key form

Throws:

NotFoundException - a keyId is not found

NullArgumentException - keyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateKeys

UpdateResponseList updateKeys(KeyBatchFormList keyForms)
                              throws OperationFailedException,
                                     PermissionDeniedException

Updates existing keys. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

keyForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - keyForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllKeys

DeleteResponseList deleteAllKeys()
                                 throws OperationFailedException,
                                        PermissionDeniedException

Deletes all Keys in this Agency .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteKeys

DeleteResponseList deleteKeys(IdList keyIds)
                              throws OperationFailedException,
                                     PermissionDeniedException

Deletes keys for the given Ids.

Parameters:

keyIds - the Ids of the keys to delete

Returns:

the delete responses

Throws:

NullArgumentException - keyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteKeysForAgent

DeleteResponseList deleteKeysForAgent(Id agentId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes keys for the given agent Id.

Parameters:

agentId - the Id of an agent

Returns:

the delete responses

Throws:

NullArgumentException - agentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasKeys

AliasResponseList aliasKeys(AliasRequestList aliasRequests)
                            throws OperationFailedException,
                                   PermissionDeniedException

Adds an Id to a Key for the purpose of creating compatibility. The primary Id of the Key is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another key, it is reassigned to the given key Id.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.