public interface ProvisioningManager extends OsidManager, ProvisioningProfile
The provisioning manager provides access to provisioning sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
MyProvisionSession:
a session for looking up queue
information for authenticated agent MySupplierSession:
a session for looking up pool
information for authenticated agent MyProvisionNotificationSession:
a session for
subscribing to provision changes for authenticated agent ProvisionLookupSession:
a session to retrieve
provisions ProvisionQuerySession:
a session to query for
provisionss ProvisionSearchSession:
a session to search for
provisions ProvisionAdminSession:
a session to create and
delete provisions ProvisionNotificationSession:
a session to receive
notifications pertaining to provision changes ProvisionDistributorSession:
a session to look up
provision distributor mappings ProvisionDistributorAssignmentSession:
a session
to manage provision to distributor mappings ProvisionSmartDistributorSession:
a session to
manage dynamic distributors of provisions ProvisionReturnSession:
a session to return
provisions QueueLookupSession:
a session to retrieve queues
QueueQuerySession:
a session to query for queues
QueueSearchSession:
a session to search for queues
QueueAdminSession:
a session to create and delete
queues QueueNotificationSession:
a session to receive
notifications pertaining to queue changes QueueDistributorSession:
a session to look up
queue distributor mappings QueueDistributorAssignmentSession:
a session to
manage queue to distributor mappings QueueSmartDistributorSession:
a session to manage
dynamic distributors of queues RequestLookupSession:
a session to retrieve
requests RequestQuerySession:
a session to query for
requests RequestSearchSession:
a session to search for
requests RequestAdminSession:
a session to create and
delete requests RequestNotificationSession:
a session to receive
notifications pertaining to request changes RequestDistributorSession:
a session to look up
request distributor mappings RequestDistributorAssignmentSession:
a session to
manage request to distributor mappings RequestSmartDistributorSession:
a session to
manage dynamic distributors of requests RequestTransactionLookupSession:
a session to
retrieve request transactions RequestTransactionAdminSession:
a session to
create and delete request transactions ExchangeSession:
a session to exchange provisions
PoolLookupSession:
a session to retrieve pools
PoolQuerySession:
a session to query for pools
PoolSearchSession:
a session to search for pools
PoolAdminSession:
a session to create and delete
pools PoolNotificationSession:
a session to receive
notifications pertaining to pool changes PoolDistributorSession:
a session to look up pool
distributor mappings PoolDistributorAssignmentSession:
a session to
manage pools to distributor mappings PoolSmartDistributorSession:
a session to manage
dynamic distributors of pools ProvisionableLookupSession:
a session to retrieve
provisionables ProvisionableQuerySession:
a session to query for
provisionables ProvisionableSearchSession:
a session to search
for provisionables ProvisionableAdminSession:
a session to create and
delete provisionables ProvisionableNotificationSession:
a session to
receive notifications pertaining to provisionable changes ProvisionableDistributorsSession:
a session to
look up provisionable distributors mappings ProvisionableDistributorAssignmentSession:
a
session to manage provisionable to distributor mappings ProvisionableSmartDistributorSession:
a session to
manage dynamic distributors of provisionables BrokerLookupSession:
a session to retrieve brokers
BrokerQuerySession:
a session to query for brokers
BrokerSearchSession:
a session to search for
brokers BrokerAdminSession:
a session to create and delete
brokers BrokerNotificationSession:
a session to receive
notifications pertaining to broker changes BrokerDistributorSession:
a session to look up
mappings of brokers to distributors BrokerDistributorAssignmentSession:
a session to
manage broker to distributor mappings BrokerSmartDistributorSession:
a session to manage
dynamic distributors of brokers DistributorLookupSession:
a session to retrieve
distributors DistributorQuerySession:
a session to search for
distributors DistributorSearchSession:
a session to search for
distributors DistributorAdminSession:
a session to create and
delete distributors DistributorNotificationSession:
a session to
receive notifications pertaining to distributor changes DistributorHierarchySession:
a session to traverse
a hierarchy of distributor DistributorHierarchyDesignSession:
a session to
manage a distributor hierarchy Modifier and Type | Method and Description |
---|---|
BrokerAdminSession |
getBrokerAdminSession()
Gets the
OsidSession associated with the broker
administration service. |
BrokerAdminSession |
getBrokerAdminSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the broker
administration service for the given distributor. |
BrokerDistributorAssignmentSession |
getBrokerDistributorAssignmentSession()
Gets the
OsidSession associated with assigning brokers
to distributors. |
BrokerDistributorSession |
getBrokerDistributorSession()
Gets the
OsidSession to lookup broker/distributor
mappings. |
BrokerLookupSession |
getBrokerLookupSession()
Gets the
OsidSession associated with the broker lookup
service. |
BrokerLookupSession |
getBrokerLookupSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the broker lookup
service for the given distributor. |
BrokerNotificationSession |
getBrokerNotificationSession(BrokerReceiver brokerReceiver)
Gets the
OsidSession associated with the broker
notification service. |
BrokerNotificationSession |
getBrokerNotificationSessionForDistributor(BrokerReceiver brokerReceiver,
Id distributorId)
Gets the
OsidSession associated with the broker
notification service for the given distributor. |
BrokerQuerySession |
getBrokerQuerySession()
Gets the
OsidSession associated with the broker query
service. |
BrokerQuerySession |
getBrokerQuerySessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the broker query
service for the given distributor. |
BrokerSearchSession |
getBrokerSearchSession()
Gets the
OsidSession associated with the broker search
service. |
BrokerSearchSession |
getBrokerSearchSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the broker search
service for the given distributor. |
BrokerSmartDistributorSession |
getBrokerSmartDistributorSession(Id distributorId)
Gets the
OsidSession to manage broker smart
distributors. |
DistributorAdminSession |
getDistributorAdminSession()
Gets the
OsidSession associated with the distributor
administrative service. |
DistributorHierarchyDesignSession |
getDistributorHierarchyDesignSession()
Gets the
OsidSession associated with the distributor
hierarchy design service. |
DistributorHierarchySession |
getDistributorHierarchySession()
Gets the
OsidSession associated with the distributor
hierarchy service. |
DistributorLookupSession |
getDistributorLookupSession()
Gets the
OsidSession associated with the distributor
lookup service. |
DistributorNotificationSession |
getDistributorNotificationSession(DistributorReceiver distributorReceiver)
Gets the
OsidSession associated with the distributor
notification service. |
DistributorQuerySession |
getDistributorQuerySession()
Gets the
OsidSession associated with the distributor
query service. |
DistributorSearchSession |
getDistributorSearchSession()
Gets the
OsidSession associated with the distributor
search service. |
ExchangeSession |
getExchangeSession()
Gets the
OsidSession associated with the exchange
service. |
ExchangeSession |
getExchangeSessionForQueue(Id queueId)
Gets the
OsidSession associated with the exchange
service for the given queue. |
MyProvisionNotificationSession |
getMyProvisionNotificationSession(ProvisionReceiver provisionReceiver)
Gets the
OsidSession associated with the provision
notification service for resources related to the authentciated agent. |
MyProvisionNotificationSession |
getMyProvisionNotificationSessionForDistributor(ProvisionReceiver provisionReceiver,
Id distributorId)
Gets the
OsidSession associated with the provision
notification service for the given distributor for resources related
to the authentciated agent. |
MyProvisionSession |
getMyProvisionSession()
Gets the
OsidSession associated with the my provision
service. |
MyProvisionSession |
getMyProvisionSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the my provision
service for the given distributor. |
MySupplierSession |
getMySupplierSession()
Gets the
OsidSession associated with the my supplier
service. |
MySupplierSession |
getMySupplierSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the my Supplier
service for the given distributor. |
PoolAdminSession |
getPoolAdminSession()
Gets the
OsidSession associated with the pool
administration service. |
PoolAdminSession |
getPoolAdminSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the pool
administration service for the given distributor. |
PoolDistributorAssignmentSession |
getPoolDistributorAssignmentSession()
Gets the
OsidSession associated with assigning pools to
distributors. |
PoolDistributorSession |
getPoolDistributorSession()
Gets the
OsidSession to lookup pool/distributor
mappings. |
PoolLookupSession |
getPoolLookupSession()
Gets the
OsidSession associated with the pool lookup
service. |
PoolLookupSession |
getPoolLookupSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the pool lookup
service for the given distributor. |
PoolNotificationSession |
getPoolNotificationSession(PoolReceiver poolReceiver)
Gets the
OsidSession associated with the pool
notification service. |
PoolNotificationSession |
getPoolNotificationSessionForDistributor(PoolReceiver poolReceiver,
Id distributorId)
Gets the
OsidSession associated with the pool
notification service for the given distributor. |
PoolQuerySession |
getPoolQuerySession()
Gets the
OsidSession associated with the pool query
service. |
PoolQuerySession |
getPoolQuerySessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the pool query
service for the given distributor. |
PoolSearchSession |
getPoolSearchSession()
Gets the
OsidSession associated with the pool search
service. |
PoolSearchSession |
getPoolSearchSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the pool search
service for the given distributor. |
PoolSmartDistributorSession |
getPoolSmartDistributorSession(Id distributorId)
Gets the
OsidSession to manage pool smart distributors. |
RequestAdminSession |
getProvisionableAdminSession()
Gets the
OsidSession associated with the provisionable
administration service. |
RequestAdminSession |
getProvisionableAdminSessionForPool(Id distributorId)
Gets the
OsidSession associated with the provisionable
administration service for the given distributor. |
RequestDistributorAssignmentSession |
getProvisionableDistributorAssignmentSession()
Gets the
OsidSession associated with assigning
provisionables to distributors. |
RequestDistributorSession |
getProvisionableDistributorSession()
Gets the
OsidSession to lookup
provisionable/distributor mappings. |
RequestLookupSession |
getProvisionableLookupSession()
Gets the
OsidSession associated with the provisionable
lookup service. |
RequestLookupSession |
getProvisionableLookupSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the provisionable
lookup service for the given distributor. |
RequestNotificationSession |
getProvisionableNotificationSession(RequestReceiver provisionableReceiver)
Gets the
OsidSession associated with the provisionable
notification service. |
RequestNotificationSession |
getProvisionableNotificationSessionForDistributor(RequestReceiver provisionableReceiver,
Id distributorId)
Gets the
OsidSession associated with the provisionable
notification service for the given distributor. |
RequestQuerySession |
getProvisionableQuerySession()
Gets the
OsidSession associated with the provisionable
query service. |
RequestQuerySession |
getProvisionableQuerySessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the provisionable
query service for the given distributor. |
RequestSearchSession |
getProvisionableSearchSession()
Gets the
OsidSession associated with the provisionable
search service. |
RequestSearchSession |
getProvisionableSearchSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the provisionable
search service for the given distributor. |
RequestSmartDistributorSession |
getProvisionableSmartDistributorSession(Id distributorId)
Gets the
OsidSession to manage locatin smart
distributors. |
ProvisionAdminSession |
getProvisionAdminSession()
Gets the
OsidSession associated with the provision
administration service. |
ProvisionAdminSession |
getProvisionAdminSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the provision
administration service for the given distributor. |
ProvisionDistributorAssignmentSession |
getProvisionDistributorAssignmentSession()
Gets the
OsidSession associated with assigning
provisions to distributors. |
ProvisionDistributorSession |
getProvisionDistributorSession()
Gets the
OsidSession to lookup provision/distributor
mappings. |
ProvisioningBatchManager |
getProvisioningBatchManager()
Gets the
ProvisioningBatchManager. |
ProvisioningRulesManager |
getProvisioningRulesManager()
Gets the
ProvisioningRulesManager. |
ProvisionLookupSession |
getProvisionLookupSession()
Gets the
OsidSession associated with the provision
lookup service. |
ProvisionLookupSession |
getProvisionLookupSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the provision
lookup service for the given distributor. |
ProvisionNotificationSession |
getProvisionNotificationSession(ProvisionReceiver provisionReceiver)
Gets the
OsidSession associated with the provision
notification service. |
ProvisionNotificationSession |
getProvisionNotificationSessionForDistributor(ProvisionReceiver provisionReceiver,
Id distributorId)
Gets the
OsidSession associated with the provision
notification service for the given distributor. |
ProvisionQuerySession |
getProvisionQuerySession()
Gets the
OsidSession associated with the provision
query service. |
ProvisionQuerySession |
getProvisionQuerySessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the provision
query service for the given distributor. |
ProvisionReturnSession |
getProvisionReturnSession()
Gets the
OsidSession associated with the provision
return service. |
ProvisionReturnSession |
getProvisionReturnSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the provision
return service for the given distributor. |
ProvisionSearchSession |
getProvisionSearchSession()
Gets the
OsidSession associated with the provision
search service. |
ProvisionSearchSession |
getProvisionSearchSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the provision
search service for the given distributor. |
ProvisionDistributorSession |
getProvisionSmartDistributorSession(Id distributorId)
Gets the
OsidSession to manage provision smart
distributors. |
QueueAdminSession |
getQueueAdminSession()
Gets the
OsidSession associated with the queue
administration service. |
QueueAdminSession |
getQueueAdminSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the queue
administration service for the given distributor. |
QueueDistributorAssignmentSession |
getQueueDistributorAssignmentSession()
Gets the
OsidSession associated with assigning queues
to distributors. |
QueueDistributorSession |
getQueueDistributorSession()
Gets the
OsidSession to lookup queue/distributor
mappings. |
QueueLookupSession |
getQueueLookupSession()
Gets the
OsidSession associated with the queue lookup
service. |
QueueLookupSession |
getQueueLookupSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the queue lookup
service for the given distributor. |
QueueNotificationSession |
getQueueNotificationSession(QueueReceiver queueReceiver)
Gets the
OsidSession associated with the queue
notification service. |
QueueNotificationSession |
getQueueNotificationSessionForDistributor(QueueReceiver queueReceiver,
Id distributorId)
Gets the
OsidSession associated with the queue
notification service for the given distributor. |
QueueQuerySession |
getQueueQuerySession()
Gets the
OsidSession associated with the queue query
service. |
QueueQuerySession |
getQueueQuerySessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the queue query
service for the given distributor. |
QueueSearchSession |
getQueueSearchSession()
Gets the
OsidSession associated with the queue search
service. |
QueueSearchSession |
getQueueSearchSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the queue search
service for the given distributor. |
QueueSmartDistributorSession |
getQueueSmartDistributorSession(Id distributorId)
Gets the
OsidSession to manage queue smart
distributors. |
RequestAdminSession |
getRequestAdminSession()
Gets the
OsidSession associated with the request
administrative service. |
RequestAdminSession |
getRequestAdminSessionForQueue(Id queueId)
Gets the
OsidSession associated with the request
administrative service for the given queue. |
RequestDistributorAssignmentSession |
getRequestDistributorAssignmentSession()
Gets the
OsidSession associated with assigning queues
to distributors. |
RequestDistributorSession |
getRequestDistributorSession()
Gets the
OsidSession to lookup request/distributor
mappings. |
RequestLookupSession |
getRequestLookupSession()
Gets the
OsidSession associated with the request lookup
service. |
RequestLookupSession |
getRequestLookupSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the request lookup
service for the given distributor. |
RequestNotificationSession |
getRequestNotificationSession(RequestReceiver requestReceiver)
Gets the
OsidSession associated with the request
notification service. |
RequestNotificationSession |
getRequestNotificationSessionForDistributor(RequestReceiver requestReceiver,
Id distributorId)
Gets the
OsidSession associated with the request
notification service for the given distributor. |
RequestQuerySession |
getRequestQuerySession()
Gets the
OsidSession associated with the request query
service. |
RequestQuerySession |
getRequestQuerySessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the request query
service for the given distributor. |
RequestSearchSession |
getRequestSearchSession()
Gets the
OsidSession associated with the request search
service. |
RequestSearchSession |
getRequestSearchSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the request search
service for the given distributor. |
RequestSmartDistributorSession |
getRequestSmartDistributorSession(Id distributorId)
Gets the
OsidSession to manage request smart
distributors. |
RequestTransactionAdminSession |
getRequestTransactionAdminSession()
Gets the
OsidSession associated with the request
transaction administrative service. |
RequestTransactionAdminSession |
getRequestTransactionAdminSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the request
transaction administrative service for the given distributor. |
RequestTransactionLookupSession |
getRequestTransactionLookupSession()
Gets the
OsidSession associated with the request
transaction lookup service. |
RequestTransactionLookupSession |
getRequestTransactionLookupSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the request
transaction lookup service for the given distributor. |
changeBranch, initialize, rollbackService
close
getBrokerRecordTypes, getBrokerSearchRecordTypes, getDistributorRecordTypes, getDistributorSearchRecordTypes, getPoolRecordTypes, getPoolSearchRecordTypes, getProvisionableRecordTypes, getProvisionableSearchRecordTypes, getProvisionRecordTypes, getProvisionReturnRecordTypes, getProvisionSearchRecordTypes, getQueueRecordTypes, getQueueSearchRecordTypes, getRequestRecordTypes, getRequestSearchRecordTypes, getRequestTransactionRecordTypes, supportsBrokerAdmin, supportsBrokerDistributor, supportsBrokerDistributorAssignment, supportsBrokerLookup, supportsBrokerNotification, supportsBrokerQuery, supportsBrokerRecordType, supportsBrokerSearch, supportsBrokerSearchRecordType, supportsBrokerSmartDistributor, supportsDistributorAdmin, supportsDistributorHierarchy, supportsDistributorHierarchyDesign, supportsDistributorLookup, supportsDistributorNotification, supportsDistributorQuery, supportsDistributorRecordType, supportsDistributorSearch, supportsDistributorSearchRecordType, supportsExchange, supportsMyProvision, supportsMyProvisionNotification, supportsMySupplier, supportsPoolAdmin, supportsPoolDistributor, supportsPoolDistributorAssignment, supportsPoolLookup, supportsPoolNotification, supportsPoolQuery, supportsPoolRecordType, supportsPoolSearch, supportsPoolSearchRecordType, supportsPoolSmartDistributor, supportsProvisionableAdmin, supportsProvisionableDistributor, supportsProvisionableDistributorAssignment, supportsProvisionableLookup, supportsProvisionableNotification, supportsProvisionableQuery, supportsProvisionableRecordType, supportsProvisionableSearch, supportsProvisionableSearchRecordType, supportsProvisionableSmartDistributor, supportsProvisionAdmin, supportsProvisionDistributor, supportsProvisionDistributorAssignment, supportsProvisioningBatch, supportsProvisioningRules, supportsProvisionLookup, supportsProvisionNotification, supportsProvisionQuery, supportsProvisionRecordType, supportsProvisionReturn, supportsProvisionReturnRecordType, supportsProvisionSearch, supportsProvisionSearchRecordType, supportsProvisionSmartDistributor, supportsQueueAdmin, supportsQueueBroker, supportsQueueBrokerAssignment, supportsQueueLookup, supportsQueueNotification, supportsQueueQuery, supportsQueueRecordType, supportsQueueSearch, supportsQueueSearchRecordType, supportsQueueSmartBroker, supportsRequestAdmin, supportsRequestDistributor, supportsRequestDistributorAssignment, supportsRequestLookup, supportsRequestNotification, supportsRequestQuery, supportsRequestRecordType, supportsRequestSearch, supportsRequestSearchRecordType, supportsRequestSmartDistributor, supportsRequestTransactionAdmin, supportsRequestTransactionLookup, supportsRequestTransactionRecordType, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
MyProvisionSession getMyProvisionSession() throws OperationFailedException
OsidSession
associated with the my provision
service. MyProvisionSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMyProvision()
is false
optional
- This method must be implemented if
supportsMyProvision()
is true.
MyProvisionSession getMyProvisionSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the my provision
service for the given distributor.distributorId
- the Id
of the distrivutor MyProvisionSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distriobutor
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMyProvision()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsMyProvision()
and
supportsVisibleFederation()
are true
MySupplierSession getMySupplierSession() throws OperationFailedException
OsidSession
associated with the my supplier
service. MySupplierSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMySupplier()
is false
optional
- This method must be implemented if
supportsMySupplier()
is true.
MySupplierSession getMySupplierSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the my Supplier
service for the given distributor.distributorId
- the Id
of the distrivutor MySupplierSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distriobutor
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMySupplier()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsMySupplier()
and
supportsVisibleFederation()
are true
MyProvisionNotificationSession getMyProvisionNotificationSession(ProvisionReceiver provisionReceiver) throws OperationFailedException
OsidSession
associated with the provision
notification service for resources related to the authentciated agent.provisionReceiver
- the notification callback MyProvisionNotificationSession
NullArgumentException
- provisionReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMyProvisionNotification()
is false
optional
- This method must be implemented if
supportsMyProvisionNotification()
is true.
MyProvisionNotificationSession getMyProvisionNotificationSessionForDistributor(ProvisionReceiver provisionReceiver, Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the provision
notification service for the given distributor for resources related
to the authentciated agent.provisionReceiver
- the notification callbackdistributorId
- the Id
of the Distributor
MyProvisionNotificationSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- provisionReceiver
or distributorId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMyProvisionNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsMyProvisionNotification()
and
supportsVisibleFederation()
are true
ProvisionLookupSession getProvisionLookupSession() throws OperationFailedException
OsidSession
associated with the provision
lookup service. ProvisionLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionLookup()
is false
optional
- This method must be implemented if
supportsProvisionLookup()
is true.
ProvisionLookupSession getProvisionLookupSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the provision
lookup service for the given distributor.distributorId
- the Id
of the Distributor
ProvisionLookupSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProvisionLookup()
and
supportsVisibleFederation()
are true
ProvisionQuerySession getProvisionQuerySession() throws OperationFailedException
OsidSession
associated with the provision
query service. ProvisionQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionQuery()
is false
optional
- This method must be implemented if
supportsProvisionQuery()
is true.
ProvisionQuerySession getProvisionQuerySessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the provision
query service for the given distributor.distributorId
- the Id
of the Distributor
ProvisionQuerySession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProvisionQuery()
and
supportsVisibleFederation()
are true
ProvisionSearchSession getProvisionSearchSession() throws OperationFailedException
OsidSession
associated with the provision
search service. ProvisionSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionSearch()
is false
optional
- This method must be implemented if
supportsProvisionSearch()
is true.
ProvisionSearchSession getProvisionSearchSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the provision
search service for the given distributor.distributorId
- the Id
of the Distributor
ProvisionSearchSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProvisionSearch()
and
supportsVisibleFederation()
are true
ProvisionAdminSession getProvisionAdminSession() throws OperationFailedException
OsidSession
associated with the provision
administration service. ProvisionAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionAdmin()
is false
optional
- This method must be implemented if
supportsProvisionAdmin()
is true.
ProvisionAdminSession getProvisionAdminSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the provision
administration service for the given distributor.distributorId
- the Id
of the Distributor
ProvisionAdminSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProvisionAdmin()
and
supportsVisibleFederation()
are true
ProvisionNotificationSession getProvisionNotificationSession(ProvisionReceiver provisionReceiver) throws OperationFailedException
OsidSession
associated with the provision
notification service.provisionReceiver
- the notification callback ProvisionNotificationSession
NullArgumentException
- provisionReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionNotification()
is false
optional
- This method must be implemented if
supportsProvisionNotification()
is true.
ProvisionNotificationSession getProvisionNotificationSessionForDistributor(ProvisionReceiver provisionReceiver, Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the provision
notification service for the given distributor.provisionReceiver
- the notification callbackdistributorId
- the Id
of the Distributor
ProvisionNotificationSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- provisionReceiver
or distributorId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProvisionNotification()
and
supportsVisibleFederation()
are true
ProvisionDistributorSession getProvisionDistributorSession() throws OperationFailedException
OsidSession
to lookup provision/distributor
mappings. ProvisionDistributorSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionDistributor()
is false
optional
- This method must be implemented if
supportsProvisionDistributor()
is true.
ProvisionDistributorAssignmentSession getProvisionDistributorAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning
provisions to distributors. ProvisionDistributorAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionDistributorAssignment()
is
false
optional
- This method must be implemented if
supportsProvisionDistributorAssignment()
is
true.
ProvisionDistributorSession getProvisionSmartDistributorSession(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
to manage provision smart
distributors.distributorId
- the Id
of the Distributor
ProvisionSmartDistributorSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionSmartDistributor()
is false
optional
- This method must be implemented if
supportsProvisionSmartDistributor()
is
true.
ProvisionReturnSession getProvisionReturnSession() throws OperationFailedException
OsidSession
associated with the provision
return service. ProvisionReturnSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionReturn()
is false
optional
- This method must be implemented if
supportsProvisionReturn()
is true.
ProvisionReturnSession getProvisionReturnSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the provision
return service for the given distributor.distributorId
- the Id
of the Distributor
ProvisionReturnSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionReturn()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProvisionReturn()
and
supportsVisibleFederation()
are true
QueueLookupSession getQueueLookupSession() throws OperationFailedException
OsidSession
associated with the queue lookup
service. QueueLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsQueueLookup()
is false
optional
- This method must be implemented if
supportsQueueLookup()
is true.
QueueLookupSession getQueueLookupSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the queue lookup
service for the given distributor.distributorId
- the Id
of the Distributor
QueueLookupSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsQueueLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsQueueLookup()
and
supportsVisibleFederation()
are true
QueueQuerySession getQueueQuerySession() throws OperationFailedException
OsidSession
associated with the queue query
service. QueueQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsQueueQuery()
is false
optional
- This method must be implemented if
supportsQueueQuery()
is true.
QueueQuerySession getQueueQuerySessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the queue query
service for the given distributor.distributorId
- the Id
of the Distributor
QueueQuerySession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsQueueQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsQueueQuery()
and
supportsVisibleFederation()
are true
QueueSearchSession getQueueSearchSession() throws OperationFailedException
OsidSession
associated with the queue search
service. QueueSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsQueueSearch()
is false
optional
- This method must be implemented if
supportsQueueSearch()
is true.
QueueSearchSession getQueueSearchSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the queue search
service for the given distributor.distributorId
- the Id
of the Distributor
QueueSearchSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsQueueSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsQueueSearch()
and
supportsVisibleFederation()
are true
QueueAdminSession getQueueAdminSession() throws OperationFailedException
OsidSession
associated with the queue
administration service. QueueAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsQueueAdmin()
is false
optional
- This method must be implemented if
supportsQueueAdmin()
is true.
QueueAdminSession getQueueAdminSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the queue
administration service for the given distributor.distributorId
- the Id
of the Distributor
QueueAdminSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsQueueAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsQueueAdmin()
and
supportsVisibleFederation()
are true
QueueNotificationSession getQueueNotificationSession(QueueReceiver queueReceiver) throws OperationFailedException
OsidSession
associated with the queue
notification service.queueReceiver
- the notification callback QueueNotificationSession
NullArgumentException
- queueReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQueueNotification()
is false
optional
- This method must be implemented if
supportsQueueNotification()
is true.
QueueNotificationSession getQueueNotificationSessionForDistributor(QueueReceiver queueReceiver, Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the queue
notification service for the given distributor.queueReceiver
- the notification callbackdistributorId
- the Id
of the Distributor
QueueNotificationSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- queueReceiver
or
distributorId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQueueNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsQueueNotification()
and
supportsVisibleFederation()
are true
QueueDistributorSession getQueueDistributorSession() throws OperationFailedException
OsidSession
to lookup queue/distributor
mappings. QueueDistributorSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQueueDistributor()
is false
optional
- This method must be implemented if
supportsQueueDistributor()
is true.
QueueDistributorAssignmentSession getQueueDistributorAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning queues
to distributors. QueueDistributorAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQueueDistributorAssignment()
is false
optional
- This method must be implemented if
supportsQueueDistributorAssignment()
is
true.
QueueSmartDistributorSession getQueueSmartDistributorSession(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
to manage queue smart
distributors.distributorId
- the Id
of the distributor QueueSmartDistributorSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQueueSmartDistributor()
is false
optional
- This method must be implemented if
supportsQueueSmartDistributor()
is true.
RequestLookupSession getRequestLookupSession() throws OperationFailedException
OsidSession
associated with the request lookup
service. RequestLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRequestLookup()
is false
optional
- This method must be implemented if
supportsRequestLookup()
is true.
RequestLookupSession getRequestLookupSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the request lookup
service for the given distributor.distributorId
- the Id
of the Distributor
RequestLookupSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRequestLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRequestLookup()
and
supportsVisibleFederation()
are true
RequestQuerySession getRequestQuerySession() throws OperationFailedException
OsidSession
associated with the request query
service. RequestQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRequestQuery()
is false
optional
- This method must be implemented if
supportsRequestQuery()
is true.
RequestQuerySession getRequestQuerySessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the request query
service for the given distributor.distributorId
- the Id
of the Distributor
CRequestQuerySession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRequestQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRequestQuery()
and
supportsVisibleFederation()
are true
RequestSearchSession getRequestSearchSession() throws OperationFailedException
OsidSession
associated with the request search
service. RequestSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRequestSearch()
is false
optional
- This method must be implemented if
supportsRequestSearch()
is true.
RequestSearchSession getRequestSearchSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the request search
service for the given distributor.distributorId
- the Id
of the Distributor
RequestSearchSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRequestSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRequestSearch()
and
supportsVisibleFederation()
are true
RequestAdminSession getRequestAdminSession() throws OperationFailedException
OsidSession
associated with the request
administrative service. RequestAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRequestAdmin()
is false
optional
- This method must be implemented if
supportsRequestAdmin()
is true.
RequestAdminSession getRequestAdminSessionForQueue(Id queueId) throws NotFoundException, OperationFailedException
OsidSession
associated with the request
administrative service for the given queue.queueId
- the Id
of the Queue
RequestAdminSession
NotFoundException
- no Queue
found by
the given Id
NullArgumentException
- queueId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRequestAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRequestAdmin()
and
supportsVisibleFederation()
are true
RequestNotificationSession getRequestNotificationSession(RequestReceiver requestReceiver) throws OperationFailedException
OsidSession
associated with the request
notification service.requestReceiver
- the notification callback RequestNotificationSession
NullArgumentException
- requestReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequestNotification()
is false
optional
- This method must be implemented if
supportsRequestNotification()
is true.
RequestNotificationSession getRequestNotificationSessionForDistributor(RequestReceiver requestReceiver, Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the request
notification service for the given distributor.requestReceiver
- the notification callbackdistributorId
- the Id
of the Distributor
RequestNotificationSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- requestReceiver
or distributorId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequestNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRequestNotification()
and
supportsVisibleFederation()
are true
RequestDistributorSession getRequestDistributorSession() throws OperationFailedException
OsidSession
to lookup request/distributor
mappings. RequestDistributorSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequestDistributor()
is false
optional
- This method must be implemented if
supportsRequestyDistributor()
is true.
RequestDistributorAssignmentSession getRequestDistributorAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning queues
to distributors. RequestyDistributorAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequestDistributorAssignment()
is false
optional
- This method must be implemented if
supportsRequestDistributorAssignment()
is
true.
RequestSmartDistributorSession getRequestSmartDistributorSession(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
to manage request smart
distributors.distributorId
- the Id
of the Distributor
RequestSmartDistributorSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequestSmartDistributor()
is false
optional
- This method must be implemented if
supportsRequestSmartDistributor()
is true.
RequestTransactionLookupSession getRequestTransactionLookupSession() throws OperationFailedException
OsidSession
associated with the request
transaction lookup service. RequestTransactionLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequestTransactionLookup()
is false
optional
- This method must be implemented if
supportsRequestTransactionLookup()
is true.
RequestTransactionLookupSession getRequestTransactionLookupSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the request
transaction lookup service for the given distributor.distributorId
- the Id
of the Distributor
RequestTransactionLookupSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequestTransactionLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRequestTransactionLookup()
and
supportsVisibleFederation()
are true
RequestTransactionAdminSession getRequestTransactionAdminSession() throws OperationFailedException
OsidSession
associated with the request
transaction administrative service. RequestTransactionAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequestTransactionAdmin()
is false
optional
- This method must be implemented if
supportsRequestTransactionAdmin()
is true.
RequestTransactionAdminSession getRequestTransactionAdminSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the request
transaction administrative service for the given distributor.distributorId
- the Id
of the Distributor
RequestTransactionAdminSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequestTransactionAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRequestTransactionAdmin()
and
supportsVisibleFederation()
are true
ExchangeSession getExchangeSession() throws OperationFailedException
OsidSession
associated with the exchange
service. ExchangeSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsExchange()
is false
optional
- This method must be implemented if
supportsExchange()
is true.
ExchangeSession getExchangeSessionForQueue(Id queueId) throws NotFoundException, OperationFailedException
OsidSession
associated with the exchange
service for the given queue.queueId
- the Id
of the Queue
ExchangeSession
NotFoundException
- no Queue
found by
the given Id
NullArgumentException
- queueId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsExchange()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsExchange()
and
supportsVisibleFederation()
are true
PoolLookupSession getPoolLookupSession() throws OperationFailedException
OsidSession
associated with the pool lookup
service. PoolLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPoolLookup()
is false
optional
- This method must be implemented if
supportsPoolLookup()
is true.
PoolLookupSession getPoolLookupSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the pool lookup
service for the given distributor.distributorId
- the Id
of the Distributor
PoolLookupSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPoolLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPoolLookup()
and
supportsVisibleFederation()
are true
PoolQuerySession getPoolQuerySession() throws OperationFailedException
OsidSession
associated with the pool query
service. PoolQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPoolQuery()
is false
optional
- This method must be implemented if
supportsPoolQuery()
is true.
PoolQuerySession getPoolQuerySessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the pool query
service for the given distributor.distributorId
- the Id
of the Distributor
PoolQuerySession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPoolQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPoolQuery()
and
supportsVisibleFederation()
are true
PoolSearchSession getPoolSearchSession() throws OperationFailedException
OsidSession
associated with the pool search
service. PoolSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPoolSearch()
is false
optional
- This method must be implemented if
supportsPoolSearch()
is true.
PoolSearchSession getPoolSearchSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the pool search
service for the given distributor.distributorId
- the Id
of the Distributor
PoolSearchSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPoolSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPoolSearch()
and
supportsVisibleFederation()
are true
PoolAdminSession getPoolAdminSession() throws OperationFailedException
OsidSession
associated with the pool
administration service. PoolAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPoolAdmin()
is false
optional
- This method must be implemented if
supportsPoolAdmin()
is true.
PoolAdminSession getPoolAdminSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the pool
administration service for the given distributor.distributorId
- the Id
of the Distributor
PoolAdminSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPoolAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPoolAdmin()
and
supportsVisibleFederation()
are true
PoolNotificationSession getPoolNotificationSession(PoolReceiver poolReceiver) throws OperationFailedException
OsidSession
associated with the pool
notification service.poolReceiver
- the notification callback PoolNotificationSession
NullArgumentException
- poolReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPoolNotification()
is false
optional
- This method must be implemented if
supportsPoolNotification()
is true.
PoolNotificationSession getPoolNotificationSessionForDistributor(PoolReceiver poolReceiver, Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the pool
notification service for the given distributor.poolReceiver
- the notification callbackdistributorId
- the Id
of the Distributor
PoolNotificationSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- poolReceiver
or
distributorId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPoolNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPoolNotification()
and
supportsVisibleFederation()
are true
PoolDistributorSession getPoolDistributorSession() throws OperationFailedException
OsidSession
to lookup pool/distributor
mappings. PoolDistributorSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPoolDistributor()
is false
optional
- This method must be implemented if
supportsPoolDistributor()
is true.
PoolDistributorAssignmentSession getPoolDistributorAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning pools to
distributors. PoolDistributorAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPoolDistributorAssignment()
is false
optional
- This method must be implemented if
supportsPoolDistributorAssignment()
is
true.
PoolSmartDistributorSession getPoolSmartDistributorSession(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
to manage pool smart distributors.distributorId
- the Id
of the Distributor
PoolSmartDistributorSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPoolSmartDistributor()
is false
optional
- This method must be implemented if
supportsPoolSmartDistributor()
is true.
RequestLookupSession getProvisionableLookupSession() throws OperationFailedException
OsidSession
associated with the provisionable
lookup service. ProvisionableLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionableLookup()
is false
optional
- This method must be implemented if
supportsProvisionableLookup()
is true.
RequestLookupSession getProvisionableLookupSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the provisionable
lookup service for the given distributor.distributorId
- the Id
of the distributor ProvisionableLookupSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionableLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProvisionableLookup()
and
supportsVisibleFederation()
are true
RequestQuerySession getProvisionableQuerySession() throws OperationFailedException
OsidSession
associated with the provisionable
query service. ProvisionableQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionableQuery()
is false
optional
- This method must be implemented if
supportsProvisionableQuery()
is true.
RequestQuerySession getProvisionableQuerySessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the provisionable
query service for the given distributor.distributorId
- the Id
of the Distributor
ProvisionableQuerySession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionableQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProvisionableQuery()
and
supportsVisibleFederation()
are true
RequestSearchSession getProvisionableSearchSession() throws OperationFailedException
OsidSession
associated with the provisionable
search service. ProvisionableSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionableSearch()
is false
optional
- This method must be implemented if
supportsProvisionableSearch()
is true.
RequestSearchSession getProvisionableSearchSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the provisionable
search service for the given distributor.distributorId
- the Id
of the Distributor
ProvisionableSearchSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionableSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProvisionableSearch()
and
supportsVisibleFederation()
are true
RequestAdminSession getProvisionableAdminSession() throws OperationFailedException
OsidSession
associated with the provisionable
administration service. ProvisionableAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionableAdmin()
is false
optional
- This method must be implemented if
supportsProvisionableAdmin()
is true.
RequestAdminSession getProvisionableAdminSessionForPool(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the provisionable
administration service for the given distributor.distributorId
- the Id
of the Dostributor
ProvisionableAdminSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionableAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProvisionableAdmin()
and
supportsVisibleFederation()
are true
RequestNotificationSession getProvisionableNotificationSession(RequestReceiver provisionableReceiver) throws OperationFailedException
OsidSession
associated with the provisionable
notification service.provisionableReceiver
- the notification callback ProvisionableNotificationSession
NullArgumentException
- provisionableReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionableNotification()
is false
optional
- This method must be implemented if
supportsProvisionableNotification()
is
true.
RequestNotificationSession getProvisionableNotificationSessionForDistributor(RequestReceiver provisionableReceiver, Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the provisionable
notification service for the given distributor.provisionableReceiver
- the notification callbackdistributorId
- the Id
of the Distributor
ProvisionableNotificationSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- provisionableReceiver
or distributorId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionableNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProvisionableNotification()
and
supportsVisibleFederation()
are true
RequestDistributorSession getProvisionableDistributorSession() throws OperationFailedException
OsidSession
to lookup
provisionable/distributor mappings. ProvisionableDistributorSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionableDistributor()
is false
optional
- This method must be implemented if
supportsProvisionableDistributor()
is true.
RequestDistributorAssignmentSession getProvisionableDistributorAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning
provisionables to distributors. ProvisionableDistributorAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionableDistributorAssignment()
is
false
optional
- This method must be implemented if
supportsProvisionableDistributorAssignment()
is
true.
RequestSmartDistributorSession getProvisionableSmartDistributorSession(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
to manage locatin smart
distributors.distributorId
- the Id
of the Distributor
ProvisionableSmartDistributorSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionableSmartDistributor()
is
false
optional
- This method must be implemented if
supportsProvisionableSmartDistributor()
is
true.
BrokerLookupSession getBrokerLookupSession() throws OperationFailedException
OsidSession
associated with the broker lookup
service. BrokerLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBrokerLookup()
is false
optional
- This method must be implemented if
supportsBrokerLookup()
is true.
BrokerLookupSession getBrokerLookupSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the broker lookup
service for the given distributor.distributorId
- the Id
of the Distributor
BrokerLookupSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBrokerLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsBrokerLookup()
and
supportsVisibleFederation()
are true
BrokerQuerySession getBrokerQuerySession() throws OperationFailedException
OsidSession
associated with the broker query
service. BrokerQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBrokerQuery()
is false
optional
- This method must be implemented if
supportsBrokerQuery()
is true.
BrokerQuerySession getBrokerQuerySessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the broker query
service for the given distributor.distributorId
- the Id
of the Distributor
BrokerQuerySession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBrokerQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsBrokerQuery()
and
supportsVisibleFederation()
are true
BrokerSearchSession getBrokerSearchSession() throws OperationFailedException
OsidSession
associated with the broker search
service. BrokerSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBrokerSearch()
is false
optional
- This method must be implemented if
supportsBrokerSearch()
is true.
BrokerSearchSession getBrokerSearchSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the broker search
service for the given distributor.distributorId
- the Id
of the Distributor
BrokerSearchSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBrokerSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsBrokerSearch()
and
supportsVisibleFederation()
are true
BrokerAdminSession getBrokerAdminSession() throws OperationFailedException
OsidSession
associated with the broker
administration service. BrokerAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBrokerAdmin()
is false
optional
- This method must be implemented if
supportsBrokerAdmin()
is true.
BrokerAdminSession getBrokerAdminSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the broker
administration service for the given distributor.distributorId
- the Id
of the Distributor
BrokerAdminSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBrokerAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsBrokerAdmin()
and
supportsVisibleFederation()
are true
BrokerNotificationSession getBrokerNotificationSession(BrokerReceiver brokerReceiver) throws OperationFailedException
OsidSession
associated with the broker
notification service.brokerReceiver
- the notification callback BrokerNotificationSession
NullArgumentException
- brokerReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBrokerNotification()
is false
optional
- This method must be implemented if
supportsBrokerNotification()
is true.
BrokerNotificationSession getBrokerNotificationSessionForDistributor(BrokerReceiver brokerReceiver, Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the broker
notification service for the given distributor.brokerReceiver
- the notification callbackdistributorId
- the Id
of the Distributor
BrokerNotificationSession
NotFoundException
- no distributor found by the given
Id
NullArgumentException
- brokerReceiver
or distributorId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBrokerNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBrokerNotification()
and
supportsVisibleFederation()
are true
BrokerDistributorSession getBrokerDistributorSession() throws OperationFailedException
OsidSession
to lookup broker/distributor
mappings. BrokerDistributorSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBrokerDistributor()
is false
optional
- This method must be implemented if
supportsBrokerDistributor()
is true.
BrokerDistributorAssignmentSession getBrokerDistributorAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning brokers
to distributors. BrokerDistributorAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBrokerDistributorAssignment()
is false
optional
- This method must be implemented if
supportsBrokerDistributorAssignment()
is
true.
BrokerSmartDistributorSession getBrokerSmartDistributorSession(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
to manage broker smart
distributors.distributorId
- the Id
of the Distributor
BrokerSmartDistributorSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBrokerSmartDistributor()
is false
optional
- This method must be implemented if
supportsBrokerSmartDistributor()
is true.
DistributorLookupSession getDistributorLookupSession() throws OperationFailedException
OsidSession
associated with the distributor
lookup service. DistributorLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDistributorLookup()
is false
optional
- This method must be implemented if
supportsDistributorLookup()
is true.
DistributorQuerySession getDistributorQuerySession() throws OperationFailedException
OsidSession
associated with the distributor
query service. DistributorQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDistributorQuery()
is false
optional
- This method must be implemented if
supportsDistributorQuery()
is true.
DistributorSearchSession getDistributorSearchSession() throws OperationFailedException
OsidSession
associated with the distributor
search service. DistributorSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDistributorSearch()
is false
optional
- This method must be implemented if
supportsDistributorSearch()
is true.
DistributorAdminSession getDistributorAdminSession() throws OperationFailedException
OsidSession
associated with the distributor
administrative service. DistributorAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDistributorAdmin()
is false
optional
- This method must be implemented if
supportsDistributorAdmin()
is true.
DistributorNotificationSession getDistributorNotificationSession(DistributorReceiver distributorReceiver) throws OperationFailedException
OsidSession
associated with the distributor
notification service.distributorReceiver
- the notification callback DistributorNotificationSession
NullArgumentException
- distributorReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDistributorNotification()
is false
optional
- This method must be implemented if
supportsDistributorNotification()
is true.
DistributorHierarchySession getDistributorHierarchySession() throws OperationFailedException
OsidSession
associated with the distributor
hierarchy service. DistributorHierarchySession
for distributorsOperationFailedException
- unable to complete requestUnimplementedException
-
supportsDistributorHierarchy()
is false
optional
- This method must be implemented if
supportsDistributorHierarchy()
is true.
DistributorHierarchyDesignSession getDistributorHierarchyDesignSession() throws OperationFailedException
OsidSession
associated with the distributor
hierarchy design service. HierarchyDesignSession
for distributorsOperationFailedException
- unable to complete requestUnimplementedException
-
supportsDistributorHierarchyDesign()
is false
optional
- This method must be implemented if
supportsDistributorHierarchyDesign()
is
true.
ProvisioningBatchManager getProvisioningBatchManager() throws OperationFailedException
ProvisioningBatchManager.
ProvisioningBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisioningBatch()
is false
optional
- This method must be implemented if
supportsProvisioningBatch()
is true.
ProvisioningRulesManager getProvisioningRulesManager() throws OperationFailedException
ProvisioningRulesManager.
ProvisioningRulesManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisioningRules()
is false
optional
- This method must be implemented if
supportsProvisioningRules()
is true.