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.
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.
|
aliasQueue, canCreateQueue, canCreateQueueWithRecordTypes, canDeleteQueues, canManageQueueAliases, canUpdateQueues, createQueue, deleteQueue, getDistributor, getDistributorId, getQueueFormForCreate, getQueueFormForUpdate, updateQueue
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
QueueBatchFormList getQueueFormsForCreate(IdList brokerIds, Type[] queueRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
brokerIds
- a list of broker Ids
queueRecordTypes
- array of queue record types to be included in
each create operation or an empty list if noneNotFoundException
- a brokerId
is not
foundNullArgumentException
- peers
or
queueRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createQueues(QueueBatchFormList queueForms) throws OperationFailedException, PermissionDeniedException
Queues.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.queueForms
- the queue formsNullArgumentException
- queueForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueBatchFormList getQueueFormsForUpdate(IdList queueIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
queueIds
- the Ids
of the Queue
NotFoundException
- a queueId
is not
foundNullArgumentException
- queueIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateQueues(QueueBatchFormList queueForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.queueForms
- the form containing the elements to be updatedNullArgumentException
- queueForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllQueues() throws OperationFailedException, PermissionDeniedException
Queues
in this Distributor
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteQueues(IdList queueIds) throws OperationFailedException, PermissionDeniedException
Ids.
queueIds
- the Ids
of the queues to deleteNullArgumentException
- queueIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteQueuesForBroker(Id broekrId) throws OperationFailedException, PermissionDeniedException
broekrId
- the Id
of a brokerNullArgumentException
- brokerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasQueues(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.