public interface ProvisioningBatchProxyManager extends OsidProxyManager, ProvisioningBatchProfile
The provisioning batch proxy manager provides access to provisioning
batch sessions and provides interoperability tests for various aspects of
this service. Methods in this manager support the passing of a
Proxy
object. The sessions included in this manager are:
ProvisionBatchAdminSession:
a session to create,
modify and delete provisions in bulk QueueBatchSession:
a session to create, modify and
delete queues in bulk RequestBatchAdminSession:
a session to create,
modify and delete requests in bulk RequestTransactionBatchAdminSession:
a session to
create, modify and delete request transactions in bulk PoolBatchAdminSession:
a session to create, modify
and delete pools in bulk ProvisionableBatchAdminSession:
a session to
create, modify and delete provisionables in bulk BrokerBatchAdminSession:
a session to create,
modify and delete brokers in bulk DistributorBatchAdminSession:
a session to create,
modify and delete distributors in bulk Modifier and Type | Method and Description |
---|---|
BrokerBatchAdminSession |
getBrokerBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk broker
administration service. |
BrokerBatchAdminSession |
getBrokerBatchAdminSessionForDistributor(Id distributorId,
Proxy proxy)
Gets the
OsidSession associated with the bulk broker
administration service for the given distributor. |
DistributorBatchAdminSession |
getDistributorBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk
distributor administration service. |
PoolBatchAdminSession |
getPoolBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk pool
administration service. |
PoolBatchAdminSession |
getPoolBatchAdminSessionForDistributor(Id distributorId,
Proxy proxy)
Gets the
OsidSession associated with the bulk pool
administration service for the given distributor. |
ProvisionableBatchAdminSession |
getProvisionableBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk
provisionable administration service. |
ProvisionableBatchAdminSession |
getProvisionableBatchAdminSessionForDistributor(Id distributorId,
Proxy proxy)
Gets the
OsidSession associated with the bulk
provisionable administration service for the given distributor. |
ProvisionBatchAdminSession |
getProvisionBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk provision
administration service. |
ProvisionBatchAdminSession |
getProvisionBatchAdminSessionForDistributor(Id distributorId,
Proxy proxy)
Gets the
OsidSession associated with the bulk provision
administration service for the given distributor. |
QueueBatchAdminSession |
getQueueBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk queue
administration service. |
QueueBatchAdminSession |
getQueueBatchAdminSessionForDistributor(Id distributorId,
Proxy proxy)
Gets the
OsidSession associated with the bulk queue
administration service for the given distributor. |
RequestBatchAdminSession |
getRequestBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk request
administration service. |
RequestBatchAdminSession |
getRequestBatchAdminSessionForDistributor(Id distributorId,
Proxy proxy)
Gets the
OsidSession associated with the bulk request
administration service for the given distributor. |
RequestTransactionBatchAdminSession |
getRequestTransactionBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk request
transaction administration service. |
RequestTransactionBatchAdminSession |
getRequestTransactionBatchAdminSessionForDistributor(Id distributorId,
Proxy proxy)
Gets the
OsidSession associated with the bulk request
transaction administration service for the given distributor. |
changeBranch, initialize, rollbackService
close
supportsBrokerBatchAdmin, supportsDistributorBatchAdmin, supportsPoolBatchAdmin, supportsProvisionableBatchAdmin, supportsProvisionBatchAdmin, supportsQueueBatchAdmin, supportsRequestBatchAdmin, supportsRequestTransactionBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
ProvisionBatchAdminSession getProvisionBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk provision
administration service.proxy
- a proxy ProvisionBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionBatchAdmin()
is false
optional
- This method must be implemented if
supportsProvisionBatchAdmin()
is true.
ProvisionBatchAdminSession getProvisionBatchAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk provision
administration service for the given distributor.distributorId
- the Id
of the Distributor
proxy
- a proxy ProvisionBatchAdminSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProvisionBatchAdmin()
and
supportsVisibleFederation()
are true
QueueBatchAdminSession getQueueBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk queue
administration service.proxy
- a proxy QueueBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQueueBatchAdmin()
is false
optional
- This method must be implemented if
supportsQueueBatchAdmin()
is true.
QueueBatchAdminSession getQueueBatchAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk queue
administration service for the given distributor.distributorId
- the Id
of the Distributor
proxy
- a proxy QueueBatchAdminSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQueueBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsQueueBatchAdmin()
and
supportsVisibleFederation()
are true
RequestBatchAdminSession getRequestBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk request
administration service.proxy
- a proxy RequestBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequestBatchAdmin()
is false
optional
- This method must be implemented if
supportsRequestBatchAdmin()
is true.
RequestBatchAdminSession getRequestBatchAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk request
administration service for the given distributor.distributorId
- the Id
of the Distributor
proxy
- a proxy RequestBatchAdminSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequestBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRequestBatchAdmin()
and
supportsVisibleFederation()
are true
RequestTransactionBatchAdminSession getRequestTransactionBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk request
transaction administration service.proxy
- a proxy RequestTransactionBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequestTransactionBatchAdmin()
is false
optional
- This method must be implemented if
supportsRequestTransactionBatchAdmin()
is
true.
RequestTransactionBatchAdminSession getRequestTransactionBatchAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk request
transaction administration service for the given distributor.distributorId
- the Id
of the Distributor
proxy
- a proxy RequestTransactionBatchAdminSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequestTransactionBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRequestTransactionBatchAdmin()
and
supportsVisibleFederation()
are true
PoolBatchAdminSession getPoolBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk pool
administration service.proxy
- a proxy PoolBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPoolBatchAdmin()
is false
optional
- This method must be implemented if
supportsPoolBatchAdmin()
is true.
PoolBatchAdminSession getPoolBatchAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk pool
administration service for the given distributor.distributorId
- the Id
of the Distributor
proxy
- a proxy PoolBatchAdminSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPoolBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPoolBatchAdmin()
and
supportsVisibleFederation()
are true
ProvisionableBatchAdminSession getProvisionableBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk
provisionable administration service.proxy
- a proxy ProvisionableBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionableBatchAdmin()
is false
optional
- This method must be implemented if
supportsProvisionableBatchAdmin()
is true.
ProvisionableBatchAdminSession getProvisionableBatchAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk
provisionable administration service for the given distributor.distributorId
- the Id
of the Distributor
proxy
- a proxy ProvisionableBatchAdminSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionableBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProvisionableBatchAdmin()
and
supportsVisibleFederation()
are true
BrokerBatchAdminSession getBrokerBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk broker
administration service.proxy
- a proxy BrokerBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBrokerBatchAdmin()
is false
optional
- This method must be implemented if
supportsBrokerBatchAdmin()
is true.
BrokerBatchAdminSession getBrokerBatchAdminSessionForDistributor(Id distributorId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk broker
administration service for the given distributor.distributorId
- the Id
of the Distributor
proxy
- a proxy BrokerBatchAdminSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBrokerBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBrokerBatchAdmin()
and
supportsVisibleFederation()
are true
DistributorBatchAdminSession getDistributorBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk
distributor administration service.proxy
- a proxy DistributorBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDistributorBatchAdmin()
is false
optional
- This method must be implemented if
supportsDistributorBatchAdmin()
is true.