OSID Logo
OSID Specifications
authorization batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.batch.AuthorizationBatchAdminSession
Implementsosid.authorization.AuthorizationAdminSession
Description

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.

MethodgetAuthorizationFormsForCreateForAgents
Description

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

Parametersosid.authorization.batch.AuthorizationAgentPeerListpeersthe authorization peers
osid.type.Type[]authorizationRecordTypesarray of authorization record types to be included in each create operation or an empty list if none
Returnosid.authorization.batch.AuthorizationBatchFormListthe authorization forms
ErrorsNOT_FOUNDan agentId, functionId, or qualifierId is not found
NULL_ARGUMENT peers or authorizationRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationFormsForCreateForResources
Description

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

Parametersosid.authorization.batch.AuthorizationResourcePeerListpeersthe authorization peers
osid.type.Type[]authorizationRecordTypesarray of authorization record types to be included in each create operation or an empty list if none
Returnosid.authorization.batch.AuthorizationBatchFormListthe authorization forms
ErrorsNOT_FOUNDa resourceId, functionId, or qualifierId is not found
NULL_ARGUMENT peers or authorizationRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationFormsForCreateForResourcesAndTrusts
Description

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.

Parametersosid.authorization.batch.AuthorizationTrustPeerListpeersthe authorization peers
osid.type.Type[]authorizationRecordTypesarray of authorization record types to be included in each create operation or an empty list if none
Returnosid.authorization.batch.AuthorizationBatchFormListthe authorization forms
ErrorsNOT_FOUNDa resourceId, trustId, functionId, or qualifierId is not found
NULL_ARGUMENT peers or authorizationRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateAuthorizations
Description

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 .

Parametersosid.authorization.batch.AuthorizationBatchFormListauthorizationFormsthe authorization forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT authorizationForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationFormsForUpdate
Description

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

Parametersosid.id.IdListauthorizationIdsthe Ids of the Authorization
Returnosid.authorization.batch.AuthorizationBatchFormListthe authorization form
ErrorsNOT_FOUNDan authorizationId is not found
NULL_ARGUMENT authorizationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAuthorizations
Description

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 .

Parametersosid.authorization.batch.AuthorizationBatchFormListauthorizationFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT authorizationForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllAuthorizations
Description

Deletes all Authorizations in this Vault .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAuthorizations
Description

Deletes authorizations for the given Ids.

Parametersosid.id.IdListauthorizationIdsthe Ids of the authorizations to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT authorizationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAuthorizationsForResource
Description

Deletes all authorizations for the given resource.

Parametersosid.id.IdresourceIdan Id of a resource
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAuthorizationsForQualifier
Description

Deletes all authorizations for the given qualifier.

Parametersosid.id.IdqualifierIdan Id of a qualifier
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT qualifierId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveAuthorizationsByDate
Description

Deletes authorizations expired before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasAuthorizations
Description

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.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.