org.osid.authorization.batch

Interface AuthorizationBatchAdminSession

All Superinterfaces:

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

public interface AuthorizationBatchAdminSession
extends AuthorizationAdminSession

This session creates, updates, and deletes Authorizations 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 an Authorization, an AuthorizationForm is requested using getAuthorizationFormsForCreate() specifying the desired qualifier, resource, and record Types or none if no record Types are needed. Each of the returned AuthorizationForms 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 an AuthorizationForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each AuthorizationForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Authorizations in bulk. To unmap an Authorization from the current Vault, the AuthorizationVaultAssignmentSession should be used. These delete operations attempt to remove the Authorization itself thus removing it from all known Vault catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasAuthorizations(AliasRequestList aliasRequests) Adds an Id to an Authorization for the purpose of creating compatibility.
CreateResponseList	createAuthorizations(AuthorizationBatchFormList authorizationForms) Creates a new set of Authorizations.
DeleteResponseList	deleteAllAuthorizations() Deletes all Authorizations in this Vault .
DeleteResponseList	deleteAuthorizations(IdList authorizationIds) Deletes authorizations for the given Ids.
DeleteResponseList	deleteAuthorizationsForQualifier(Id qualifierId) Deletes all authorizations for the given qualifier.
DeleteResponseList	deleteAuthorizationsForResource(Id resourceId) Deletes all authorizations for the given resource.
DeleteResponseList	deleteIneffectiveAuthorizationsByDate(DateTime date) Deletes authorizations expired before the given date.
AuthorizationBatchFormList	getAuthorizationFormsForCreateForAgents(AuthorizationAgentPeerList peers, Type[] authorizationRecordTypes) Gets the authorization forms for creating a bunch of new authorizations using agents.
AuthorizationBatchFormList	getAuthorizationFormsForCreateForResources(AuthorizationResourcePeerList peers, Type[] authorizationRecordTypes) Gets the authorization forms for creating a bunch of new authorizations using resources.
AuthorizationBatchFormList	getAuthorizationFormsForCreateForResourcesAndTrusts(AuthorizationTrustPeerList peers, Type[] authorizationRecordTypes) Gets the authorization forms for creating a bunch of new authorizations using resources and trusts.
AuthorizationBatchFormList	getAuthorizationFormsForUpdate(IdList authorizationIds) Gets the authorization forms for updating an existing set of authorizations.
UpdateResponseList	updateAuthorizations(AuthorizationBatchFormList authorizationForms) Updates existing authorizations.

Methods inherited from interface org.osid.authorization.AuthorizationAdminSession

aliasAuthorization, canCreateAuthorizations, canCreateAuthorizationWithRecordTypes, canDeleteAuthorizations, canManageAuthorizationAliases, canUpdateAuthorizations, createAuthorization, deleteAuthorization, getAuthorizationFormForCreateForAgent, getAuthorizationFormForCreateForResource, getAuthorizationFormForCreateForResourceAndTrust, getAuthorizationFormForUpdate, getVault, getVaultId, updateAuthorization

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

getAuthorizationFormsForCreateForAgents

AuthorizationBatchFormList getAuthorizationFormsForCreateForAgents(AuthorizationAgentPeerList peers,
                                                                 Type[] authorizationRecordTypes)
                                                                   throws NotFoundException,
                                                                          OperationFailedException,
                                                                          PermissionDeniedException

Gets the authorization forms for creating a bunch of new authorizations using agents. An AuthorizationForm is returned for each qualifier and agent pair.

Parameters:

peers - the authorization peers

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

Returns:

the authorization forms

Throws:

NotFoundException - an agentId, functionId, or qualifierId is not found

NullArgumentException - peers or authorizationRecordTypes 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.

getAuthorizationFormsForCreateForResources

AuthorizationBatchFormList getAuthorizationFormsForCreateForResources(AuthorizationResourcePeerList peers,
                                                                    Type[] authorizationRecordTypes)
                                                                      throws NotFoundException,
                                                                             OperationFailedException,
                                                                             PermissionDeniedException

Gets the authorization forms for creating a bunch of new authorizations using resources. An AuthorizationForm is returned for each qualifier and agent pair.

Parameters:

peers - the authorization peers

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

Returns:

the authorization forms

Throws:

NotFoundException - a resourceId, functionId, or qualifierId is not found

NullArgumentException - peers or authorizationRecordTypes 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.

getAuthorizationFormsForCreateForResourcesAndTrusts

AuthorizationBatchFormList getAuthorizationFormsForCreateForResourcesAndTrusts(AuthorizationTrustPeerList peers,
                                                                             Type[] authorizationRecordTypes)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException,
                                                                                      PermissionDeniedException

Gets the authorization forms for creating a bunch of new authorizations using resources and trusts. An AuthorizationForm is returned for each qualifier and agent pair.

Parameters:

peers - the authorization peers

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

Returns:

the authorization forms

Throws:

NotFoundException - a resourceId, trustId, functionId, or qualifierId is not found

NullArgumentException - peers or authorizationRecordTypes 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.

createAuthorizations

CreateResponseList createAuthorizations(AuthorizationBatchFormList authorizationForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

authorizationForms - the authorization forms

Returns:

the create responses

Throws:

NullArgumentException - authorizationForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuthorizationFormsForUpdate

AuthorizationBatchFormList getAuthorizationFormsForUpdate(IdList authorizationIds)
                                                          throws NotFoundException,
                                                                 OperationFailedException,
                                                                 PermissionDeniedException

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

Parameters:

authorizationIds - the Ids of the Authorization

Returns:

the authorization form

Throws:

NotFoundException - an authorizationId is not found

NullArgumentException - authorizationIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateAuthorizations

UpdateResponseList updateAuthorizations(AuthorizationBatchFormList authorizationForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

authorizationForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - authorizationForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllAuthorizations

DeleteResponseList deleteAllAuthorizations()
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Deletes all Authorizations in this Vault .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAuthorizations

DeleteResponseList deleteAuthorizations(IdList authorizationIds)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Deletes authorizations for the given Ids.

Parameters:

authorizationIds - the Ids of the authorizations to delete

Returns:

the delete responses

Throws:

NullArgumentException - authorizationIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAuthorizationsForResource

DeleteResponseList deleteAuthorizationsForResource(Id resourceId)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Deletes all authorizations for the given resource.

Parameters:

resourceId - an Id of a resource

Returns:

the delete responses

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAuthorizationsForQualifier

DeleteResponseList deleteAuthorizationsForQualifier(Id qualifierId)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Deletes all authorizations for the given qualifier.

Parameters:

qualifierId - an Id of a qualifier

Returns:

the delete responses

Throws:

NullArgumentException - qualifierId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveAuthorizationsByDate

DeleteResponseList deleteIneffectiveAuthorizationsByDate(DateTime date)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

Deletes authorizations expired before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasAuthorizations

AliasResponseList aliasAuthorizations(AliasRequestList aliasRequests)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Adds an Id to an Authorization for the purpose of creating compatibility. The primary Id of the Authorization is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another authorization, it is reassigned to the given entry 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.