org.osid.provisioning.batch

Interface BrokerBatchAdminSession

All Superinterfaces:

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

public interface BrokerBatchAdminSession
extends BrokerAdminSession

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

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

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

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

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

The delete operations delete Brokers in bulk. To unmap a Broker from the current Distributor, the BrokerDistributorAssignmentSession should be used. These delete operations attempt to remove the Broker 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	aliasBrokers(AliasRequestList aliasRequests) Adds an Id to a Broker for the purpose of creating compatibility.
CreateResponseList	createBrokers(BrokerBatchFormList brokerForms) Creates a new set of Brokers.
DeleteResponseList	deleteAllBrokers() Deletes all Brokers in this Distributor .
DeleteResponseList	deleteBrokers(IdList brokerIds) Deletes brokers for the given Ids.
BrokerBatchFormList	getBrokerFormsForCreate(long number, Type[] brokerRecordTypes) Gets the broker forms for creating a bunch of new brokers.
BrokerBatchFormList	getBrokerFormsForUpdate(IdList brokerIds) Gets the broker forms for updating an existing set of brokers.
UpdateResponseList	updateBrokers(BrokerBatchFormList brokerForms) Updates existing brokers.

Methods inherited from interface org.osid.provisioning.BrokerAdminSession

addQueue, aliasBroker, canAssignQueues, canCreateBrokers, canCreateBrokerWithRecordTypes, canDeleteBrokers, canManageBrokerAliases, canUpdateBrokers, createBroker, deleteBroker, getBrokerFormForCreate, getBrokerFormForUpdate, getDistributor, getDistributorId, removeQueue, updateBroker

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

getBrokerFormsForCreate

BrokerBatchFormList getBrokerFormsForCreate(long number,
                                          Type[] brokerRecordTypes)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets the broker forms for creating a bunch of new brokers.

Parameters:

number - the number of forms to retrieve

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

Returns:

the broker forms

Throws:

NullArgumentException - brokerRecordTypes 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.

createBrokers

CreateResponseList createBrokers(BrokerBatchFormList brokerForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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

Parameters:

brokerForms - the broker forms

Returns:

the create responses

Throws:

NullArgumentException - brokerForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBrokerFormsForUpdate

BrokerBatchFormList getBrokerFormsForUpdate(IdList brokerIds)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

brokerIds - the Ids of the Broker

Returns:

the broker form

Throws:

NotFoundException - a brokerId is not found

NullArgumentException - brokerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateBrokers

UpdateResponseList updateBrokers(BrokerBatchFormList brokerForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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

Parameters:

brokerForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - brokerForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllBrokers

DeleteResponseList deleteAllBrokers()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes all Brokers in this Distributor .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteBrokers

DeleteResponseList deleteBrokers(IdList brokerIds)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Deletes brokers for the given Ids.

Parameters:

brokerIds - the Ids of the brokers to delete

Returns:

the delete responses

Throws:

NullArgumentException - brokerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasBrokers

AliasResponseList aliasBrokers(AliasRequestList aliasRequests)
                               throws OperationFailedException,
                                      PermissionDeniedException

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