org.osid.provisioning.batch

Interface QueueBatchAdminSession

All Superinterfaces:

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

public interface QueueBatchAdminSession
extends QueueAdminSession

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

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

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

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

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

The delete operations delete Queues in bulk. To unmap a Queue from the current Distributor, the QueueDistributorAssignmentSession should be used. These delete operations attempt to remove the Queue itself thus removing it from all known Distributor catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasQueues(AliasRequestList aliasRequests) Adds an Id to a Queue for the purpose of creating compatibility.
CreateResponseList	createQueues(QueueBatchFormList queueForms) Creates a new set of Queues.
DeleteResponseList	deleteAllQueues() Deletes all Queues in this Distributor .
DeleteResponseList	deleteQueues(IdList queueIds) Deletes queues for the given Ids.
DeleteResponseList	deleteQueuesForBroker(Id broekrId) Deletes queues for the given broker.
QueueBatchFormList	getQueueFormsForCreate(IdList brokerIds, Type[] queueRecordTypes) Gets the queue forms for creating a bunch of new queues.
QueueBatchFormList	getQueueFormsForUpdate(IdList queueIds) Gets the queue forms for updating an existing set of queues.
UpdateResponseList	updateQueues(QueueBatchFormList queueForms) Updates existing queues.

Methods inherited from interface org.osid.provisioning.QueueAdminSession

aliasQueue, canCreateQueue, canCreateQueueWithRecordTypes, canDeleteQueues, canManageQueueAliases, canUpdateQueues, createQueue, deleteQueue, getDistributor, getDistributorId, getQueueFormForCreate, getQueueFormForUpdate, updateQueue

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

getQueueFormsForCreate

QueueBatchFormList getQueueFormsForCreate(IdList brokerIds,
                                        Type[] queueRecordTypes)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Gets the queue forms for creating a bunch of new queues. A form is returned for each supplied broker.

Parameters:

brokerIds - a list of broker Ids

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

Returns:

the queue forms

Throws:

NotFoundException - a brokerId is not found

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

createQueues

CreateResponseList createQueues(QueueBatchFormList queueForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Parameters:

queueForms - the queue forms

Returns:

the create responses

Throws:

NullArgumentException - queueForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueFormsForUpdate

QueueBatchFormList getQueueFormsForUpdate(IdList queueIds)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

queueIds - the Ids of the Queue

Returns:

the queue form

Throws:

NotFoundException - a queueId is not found

NullArgumentException - queueIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateQueues

UpdateResponseList updateQueues(QueueBatchFormList queueForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Parameters:

queueForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - queueForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllQueues

DeleteResponseList deleteAllQueues()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes all Queues in this Distributor .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteQueues

DeleteResponseList deleteQueues(IdList queueIds)
                                throws OperationFailedException,
                                       PermissionDeniedException

Deletes queues for the given Ids.

Parameters:

queueIds - the Ids of the queues to delete

Returns:

the delete responses

Throws:

NullArgumentException - queueIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteQueuesForBroker

DeleteResponseList deleteQueuesForBroker(Id broekrId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Deletes queues for the given broker.

Parameters:

broekrId - the Id of a broker

Returns:

the delete responses

Throws:

NullArgumentException - brokerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasQueues

AliasResponseList aliasQueues(AliasRequestList aliasRequests)
                              throws OperationFailedException,
                                     PermissionDeniedException

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