org.osid.provisioning

Interface ProvisioningProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidProfile, OsidProxyManager, ProvisioningProfile, Sourceable

public interface ProvisioningProxyManager
extends OsidProxyManager, ProvisioningProfile

The provisioning proxy manager provides access to provisioning sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. 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

Method Summary

Methods

Modifier and Type	Method and Description
BrokerAdminSession	getBrokerAdminSession(Proxy proxy) Gets the OsidSession associated with the broker administration service.
BrokerAdminSession	getBrokerAdminSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the broker administration service for the given distributor.
BrokerDistributorAssignmentSession	getBrokerDistributorAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning brokers to distributors.
BrokerDistributorSession	getBrokerDistributorSession(Proxy proxy) Gets the OsidSession to lookup broker/distributor mappings.
BrokerLookupSession	getBrokerLookupSession(Proxy proxy) Gets the OsidSession associated with the broker lookup service.
BrokerLookupSession	getBrokerLookupSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the broker lookup service for the given distributor.
BrokerNotificationSession	getBrokerNotificationSession(BrokerReceiver brokerReceiver, Proxy proxy) Gets the OsidSession associated with the broker notification service.
BrokerNotificationSession	getBrokerNotificationSessionForDistributor(BrokerReceiver brokerReceiver, Id distributorId, Proxy proxy) Gets the OsidSession associated with the broker notification service for the given distributor.
BrokerQuerySession	getBrokerQuerySession(Proxy proxy) Gets the OsidSession associated with the broker query service.
BrokerQuerySession	getBrokerQuerySessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the broker query service for the given distributor.
BrokerSearchSession	getBrokerSearchSession(Proxy proxy) Gets the OsidSession associated with the broker search service.
BrokerSearchSession	getBrokerSearchSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the broker search service for the given distributor.
BrokerSmartDistributorSession	getBrokerSmartDistributorSession(Id distributorId, Proxy proxy) Gets the OsidSession to manage broker smart distributors.
DistributorAdminSession	getDistributorAdminSession(Proxy proxy) Gets the OsidSession associated with the distributor administrative service.
DistributorHierarchyDesignSession	getDistributorHierarchyDesignSession(Proxy proxy) Gets the OsidSession associated with the distributor hierarchy design service.
DistributorHierarchySession	getDistributorHierarchySession(Proxy proxy) Gets the OsidSession associated with the distributor hierarchy service.
DistributorLookupSession	getDistributorLookupSession(Proxy proxy) Gets the OsidSession associated with the distributor lookup service.
DistributorNotificationSession	getDistributorNotificationSession(DistributorReceiver distributorReceiver, Proxy proxy) Gets the OsidSession associated with the distributor notification service.
DistributorQuerySession	getDistributorQuerySession(Proxy proxy) Gets the OsidSession associated with the distributor query service.
DistributorSearchSession	getDistributorSearchSession(Proxy proxy) Gets the OsidSession associated with the distributor search service.
ExchangeSession	getExchangeSession(Proxy proxy) Gets the OsidSession associated with the exchange service.
ExchangeSession	getExchangeSessionForQueue(Id queueId, Proxy proxy) Gets the OsidSession associated with the exchange service for the given queue.
MyProvisionNotificationSession	getMyProvisionNotificationSession(ProvisionReceiver provisionReceiver, Proxy proxy) Gets the OsidSession associated with the my provision notification service for resources related to the authenticated agent.
MyProvisionNotificationSession	getMyProvisionNotificationSessionForDistributor(ProvisionReceiver provisionReceiver, Id distributorId, Proxy proxy) Gets the OsidSession associated with the my provision notification service for the given distributor for resources related to the authenticated agent.
MyProvisionSession	getMyProvisionSession(Proxy proxy) Gets the OsidSession associated with the my provision service.
MyProvisionSession	getMyProvisionSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the my provision service for the given distributor.
MySupplierSession	getMySupplierSession(Proxy proxy) Gets the OsidSession associated with the my supplier service.
MySupplierSession	getMySupplierSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the my Supplier service for the given distributor.
PoolAdminSession	getPoolAdminSession(Proxy proxy) Gets the OsidSession associated with the pool administration service.
PoolAdminSession	getPoolAdminSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the pool administration service for the given distributor.
PoolDistributorAssignmentSession	getPoolDistributorAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning pools to distributors.
PoolDistributorSession	getPoolDistributorSession(Proxy proxy) Gets the OsidSession to lookup pool/distributor mappings.
PoolLookupSession	getPoolLookupSession(Proxy proxy) Gets the OsidSession associated with the pool lookup service.
PoolLookupSession	getPoolLookupSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the pool lookup service for the given distributor.
PoolNotificationSession	getPoolNotificationSession(PoolReceiver poolReceiver, Proxy proxy) Gets the OsidSession associated with the pool notification service.
PoolNotificationSession	getPoolNotificationSessionForDistributor(PoolReceiver poolReceiver, Id distributorId, Proxy proxy) Gets the OsidSession associated with the pool notification service for the given distributor.
PoolQuerySession	getPoolQuerySession(Proxy proxy) Gets the OsidSession associated with the pool query service.
PoolQuerySession	getPoolQuerySessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the pool query service for the given distributor.
PoolSearchSession	getPoolSearchSession(Proxy proxy) Gets the OsidSession associated with the pool search service.
PoolSearchSession	getPoolSearchSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the pool search service for the given distributor.
PoolDistributorSession	getPoolSmartDistributorSession(Id distributorId, Proxy proxy) Gets the OsidSession to manage pool smart distributors.
RequestAdminSession	getProvisionableAdminSession(Proxy proxy) Gets the OsidSession associated with the provisionable administration service.
RequestAdminSession	getProvisionableAdminSessionForPool(Id poolId, Proxy proxy) Gets the OsidSession associated with the provisionable administration service for the given pool.
RequestDistributorAssignmentSession	getProvisionableDistributorAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning provisionables to distributors.
RequestDistributorSession	getProvisionableDistributorSession(Proxy proxy) Gets the OsidSession to lookup provisionable/distributor mappings.
RequestLookupSession	getProvisionableLookupSession(Proxy proxy) Gets the OsidSession associated with the provisionable lookup service.
RequestLookupSession	getProvisionableLookupSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the provisionable lookup service for the given distributor.
RequestNotificationSession	getProvisionableNotificationSession(RequestReceiver provisionableReceiver, Proxy proxy) Gets the OsidSession associated with the provisionable notification service.
RequestNotificationSession	getProvisionableNotificationSessionForDistributor(RequestReceiver provisionableReceiver, Id distributorId, Proxy proxy) Gets the OsidSession associated with the provisionable notification service for the given distributor.
RequestQuerySession	getProvisionableQuerySession(Proxy proxy) Gets the OsidSession associated with the provisionable query service.
RequestQuerySession	getProvisionableQuerySessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the provisionable query service for the given distributor.
RequestSearchSession	getProvisionableSearchSession(Proxy proxy) Gets the OsidSession associated with the provisionable search service.
RequestSearchSession	getProvisionableSearchSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the provisionable search service for the given distributor.
RequestSmartDistributorSession	getProvisionableSmartDistributorSession(Id distributorId, Proxy proxy) Gets the OsidSession to manage locatin smart distributors.
ProvisionAdminSession	getProvisionAdminSession(Proxy proxy) Gets the OsidSession associated with the provision administration service.
ProvisionAdminSession	getProvisionAdminSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the provision administration service for the given distributor.
ProvisionDistributorAssignmentSession	getProvisionDistributorAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning provisions to distributors.
ProvisionDistributorSession	getProvisionDistributorSession(Proxy proxy) Gets the OsidSession to lookup provision/distributor mappings.
ProvisioningBatchProxyManager	getProvisioningBatchProxyManager() Gets the ProvisioningBatchProxyManager.
ProvisioningRulesProxyManager	getProvisioningRulesProxyManager() Gets the ProvisioningRulesPorxyManager.
ProvisionLookupSession	getProvisionLookupSession(Proxy proxy) Gets the OsidSession associated with the provision lookup service.
ProvisionLookupSession	getProvisionLookupSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the provision lookup service for the given distributor.
ProvisionNotificationSession	getProvisionNotificationSession(ProvisionReceiver provisionReceiver, Proxy proxy) Gets the OsidSession associated with the provision notification service.
ProvisionNotificationSession	getProvisionNotificationSessionForDistributor(ProvisionReceiver provisionReceiver, Id distributorId, Proxy proxy) Gets the OsidSession associated with the provision notification service for the given distributor.
ProvisionQuerySession	getProvisionQuerySession(Proxy proxy) Gets the OsidSession associated with the provision query service.
ProvisionQuerySession	getProvisionQuerySessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the provision query service for the given distributor.
ProvisionReturnSession	getProvisionReturnSession(Proxy proxy) Gets the OsidSession associated with the provision return service.
ProvisionReturnSession	getProvisionReturnSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the provision return service for the given distributor.
ProvisionSearchSession	getProvisionSearchSession(Proxy proxy) Gets the OsidSession associated with the provision search service.
ProvisionSearchSession	getProvisionSearchSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the provision search service for the given distributor.
ProvisionDistributorSession	getProvisionSmartDistributorSession(Id distributorId, Proxy proxy) Gets the OsidSession to manage provision smart distributors.
QueueAdminSession	getQueueAdminSession(Proxy proxy) Gets the OsidSession associated with the queue administration service.
QueueAdminSession	getQueueAdminSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the queue administration service for the given distributor.
QueueDistributorAssignmentSession	getQueueDistributorAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning queues to distributors.
QueueDistributorSession	getQueueDistributorSession(Proxy proxy) Gets the OsidSession to lookup queue/distributor mappings.
QueueLookupSession	getQueueLookupSession(Proxy proxy) Gets the OsidSession associated with the queue lookup service.
QueueLookupSession	getQueueLookupSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the queue lookup service for the given distributor.
QueueNotificationSession	getQueueNotificationSession(QueueReceiver queueReceiver, Proxy proxy) Gets the OsidSession associated with the queue notification service.
QueueNotificationSession	getQueueNotificationSessionForDistributor(QueueReceiver queueReceiver, Id distributorId, Proxy proxy) Gets the OsidSession associated with the queue notification service for the given distributor.
QueueQuerySession	getQueueQuerySession(Proxy proxy) Gets the OsidSession associated with the queue query service.
QueueQuerySession	getQueueQuerySessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the queue query service for the given distributor.
QueueSearchSession	getQueueSearchSession(Proxy proxy) Gets the OsidSession associated with the queue search service.
QueueSearchSession	getQueueSearchSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the queue search service for the given distributor.
QueueSmartDistributorSession	getQueueSmartDistributorSession(Id distributorId, Proxy proxy) Gets the OsidSession to manage queue smart distributors.
RequestAdminSession	getRequestAdminSession(Proxy proxy) Gets the OsidSession associated with the request administrative service.
RequestAdminSession	getRequestAdminSessionForQueue(Id queueId, Proxy proxy) Gets the OsidSession associated with the request administrative service for the given queue.
RequestDistributorAssignmentSession	getRequestDistributorAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning queues to distributors.
RequestDistributorSession	getRequestDistributorSession(Proxy proxy) Gets the OsidSession to lookup request/distributor mappings.
RequestLookupSession	getRequestLookupSession(Proxy proxy) Gets the OsidSession associated with the request lookup service.
RequestLookupSession	getRequestLookupSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the request lookup service for the given distributor.
RequestNotificationSession	getRequestNotificationSession(RequestReceiver requestReceiver, Proxy proxy) Gets the OsidSession associated with the request notification service.
RequestNotificationSession	getRequestNotificationSessionForDistributor(RequestReceiver requestReceiver, Id distributorId, Proxy proxy) Gets the OsidSession associated with the request notification service for the given distributor.
RequestQuerySession	getRequestQuerySession(Proxy proxy) Gets the OsidSession associated with the request query service.
RequestQuerySession	getRequestQuerySessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the request query service for the given distributor.
RequestSearchSession	getRequestSearchSession(Proxy proxy) Gets the OsidSession associated with the request search service.
RequestSearchSession	getRequestSearchSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the request search service for the given distributor.
RequestSmartDistributorSession	getRequestSmartDistributorSession(Id distributorId, Proxy proxy) Gets the OsidSession to manage request smart distributors.
RequestTransactionAdminSession	getRequestTransactionAdminSession(Proxy proxy) Gets the OsidSession associated with the request transaction administrative service.
RequestTransactionAdminSession	getRequestTransactionAdminSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the request transaction administrative service for the given distributor.
RequestTransactionLookupSession	getRequestTransactionLookupSession(Proxy proxy) Gets the OsidSession associated with the request transaction lookup service.
RequestTransactionLookupSession	getRequestTransactionLookupSessionForDistributor(Id distributorId, Proxy proxy) Gets the OsidSession associated with the request transaction lookup service for the given distributor.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.provisioning.ProvisioningProfile

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

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getMyProvisionSession

MyProvisionSession getMyProvisionSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the my provision service.

Parameters:

proxy - a proxy

Returns:

a MyProvisionSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyProvision() is false

Compliance:

optional - This method must be implemented if supportsMyProvision() is true.

getMyProvisionSessionForDistributor

MyProvisionSession getMyProvisionSessionForDistributor(Id distributorId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the my provision service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a MyProvisionSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyProvision() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsMyProvision() and supportsVisibleFederation() are true

getMySupplierSession

MySupplierSession getMySupplierSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the my supplier service.

Parameters:

proxy - a proxy

Returns:

a MySupplierSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMySupplier() is false

Compliance:

optional - This method must be implemented if supportsMySupplier() is true.

getMySupplierSessionForDistributor

MySupplierSession getMySupplierSessionForDistributor(Id distributorId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the my Supplier service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a MySupplierSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMySupplier() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsMySupplier() and supportsVisibleFederation() are true

getMyProvisionNotificationSession

MyProvisionNotificationSession getMyProvisionNotificationSession(ProvisionReceiver provisionReceiver,
                                                               Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the my provision notification service for resources related to the authenticated agent.

Parameters:

provisionReceiver - the notification callback

proxy - a proxy

Returns:

a MyProvisionNotificationSession

Throws:

NullArgumentException - provisionReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyProvisionNotification() is false

Compliance:

optional - This method must be implemented if supportsMyProvisionNotification() is true.

getMyProvisionNotificationSessionForDistributor

MyProvisionNotificationSession getMyProvisionNotificationSessionForDistributor(ProvisionReceiver provisionReceiver,
                                                                             Id distributorId,
                                                                             Proxy proxy)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

Gets the OsidSession associated with the my provision notification service for the given distributor for resources related to the authenticated agent.

Parameters:

provisionReceiver - the notification callback

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a MyProvisionNotificationSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - provisionReceiver, distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyProvisionNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsMyProvisionNotification() and supportsVisibleFederation() are true

getProvisionLookupSession

ProvisionLookupSession getProvisionLookupSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the provision lookup service.

Parameters:

proxy - a proxy

Returns:

a ProvisionLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionLookup() is false

Compliance:

optional - This method must be implemented if supportsProvisionLookup() is true.

getProvisionLookupSessionForDistributor

ProvisionLookupSession getProvisionLookupSessionForDistributor(Id distributorId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the provision lookup service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionLookupSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProvisionLookup() and supportsVisibleFederation() are true

getProvisionQuerySession

ProvisionQuerySession getProvisionQuerySession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the provision query service.

Parameters:

proxy - a proxy

Returns:

a ProvisionQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionQuery() is false

Compliance:

optional - This method must be implemented if supportsProvisionQuery() is true.

getProvisionQuerySessionForDistributor

ProvisionQuerySession getProvisionQuerySessionForDistributor(Id distributorId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the provision query service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionQuerySession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProvisionQuery() and supportsVisibleFederation() are true

getProvisionSearchSession

ProvisionSearchSession getProvisionSearchSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the provision search service.

Parameters:

proxy - a proxy

Returns:

a ProvisionSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionSearch() is false

Compliance:

optional - This method must be implemented if supportsProvisionSearch() is true.

getProvisionSearchSessionForDistributor

ProvisionSearchSession getProvisionSearchSessionForDistributor(Id distributorId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the provision search service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionSearchSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProvisionSearch() and supportsVisibleFederation() are true

getProvisionAdminSession

ProvisionAdminSession getProvisionAdminSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the provision administration service.

Parameters:

proxy - a proxy

Returns:

a ProvisionAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionAdmin() is false

Compliance:

optional - This method must be implemented if supportsProvisionAdmin() is true.

getProvisionAdminSessionForDistributor

ProvisionAdminSession getProvisionAdminSessionForDistributor(Id distributorId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the provision administration service for the given distributor.

Parameters:

distributorId - the Id of the distributor

proxy - a proxy

Returns:

a ProvisionAdminSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProvisionAdmin() and supportsVisibleFederation() are true

getProvisionNotificationSession

ProvisionNotificationSession getProvisionNotificationSession(ProvisionReceiver provisionReceiver,
                                                           Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the provision notification service.

Parameters:

provisionReceiver - the notification callback

proxy - a proxy

Returns:

a ProvisionNotificationSession

Throws:

NullArgumentException - provisionReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionNotification() is false

Compliance:

optional - This method must be implemented if supportsProvisionNotification() is true.

getProvisionNotificationSessionForDistributor

ProvisionNotificationSession getProvisionNotificationSessionForDistributor(ProvisionReceiver provisionReceiver,
                                                                         Id distributorId,
                                                                         Proxy proxy)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

Gets the OsidSession associated with the provision notification service for the given distributor.

Parameters:

provisionReceiver - the notification callback

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionNotificationSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - provisionReceiver, distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProvisionNotification() and supportsVisibleFederation() are true

getProvisionDistributorSession

ProvisionDistributorSession getProvisionDistributorSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession to lookup provision/distributor mappings.

Parameters:

proxy - a proxy

Returns:

a ProvisionDistributorSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionDistributor() is false

Compliance:

optional - This method must be implemented if supportsProvisionDistributor() is true.

getProvisionDistributorAssignmentSession

ProvisionDistributorAssignmentSession getProvisionDistributorAssignmentSession(Proxy proxy)
                                                                               throws OperationFailedException

Gets the OsidSession associated with assigning provisions to distributors.

Parameters:

proxy - a proxy

Returns:

a ProvisionDistributorAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionDistributorAssignment() is false

Compliance:

optional - This method must be implemented if supportsProvisionDistributorAssignment() is true.

getProvisionSmartDistributorSession

ProvisionDistributorSession getProvisionSmartDistributorSession(Id distributorId,
                                                              Proxy proxy)
                                                                throws NotFoundException,
                                                                       OperationFailedException

Gets the OsidSession to manage provision smart distributors.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionSmartDistributorSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionSmartDistributor() is false

Compliance:

optional - This method must be implemented if supportsProvisionSmartDistributor() is true.

getProvisionReturnSession

ProvisionReturnSession getProvisionReturnSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the provision return service.

Parameters:

proxy - a proxy

Returns:

a ProvisionReturnSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionReturn() is false

Compliance:

optional - This method must be implemented if supportsProvisionReturn() is true.

getProvisionReturnSessionForDistributor

ProvisionReturnSession getProvisionReturnSessionForDistributor(Id distributorId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the provision return service for the given distributor.

Parameters:

distributorId - the Id of the distributor

proxy - a proxy

Returns:

a ProvisionReturnSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy s null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionReturn() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProvisionReturn() and supportsVisibleFederation() are true

getQueueLookupSession

QueueLookupSession getQueueLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the queue lookup service.

Parameters:

proxy - a proxy

Returns:

a QueueLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueLookup() is false

Compliance:

optional - This method must be implemented if supportsQueueLookup() is true.

getQueueLookupSessionForDistributor

QueueLookupSession getQueueLookupSessionForDistributor(Id distributorId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the queue lookup service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a QueueLookupSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsQueueLookup() and supportsVisibleFederation() are true

getQueueQuerySession

QueueQuerySession getQueueQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the queue query service.

Parameters:

proxy - a proxy

Returns:

a QueueQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueQuery() is false

Compliance:

optional - This method must be implemented if supportsQueueQuery() is true.

getQueueQuerySessionForDistributor

QueueQuerySession getQueueQuerySessionForDistributor(Id distributorId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the queue query service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a QueueQuerySession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsQueueQuery() and supportsVisibleFederation() are true

getQueueSearchSession

QueueSearchSession getQueueSearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the queue search service.

Parameters:

proxy - a proxy

Returns:

a QueueSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueSearch() is false

Compliance:

optional - This method must be implemented if supportsQueueSearch() is true.

getQueueSearchSessionForDistributor

QueueSearchSession getQueueSearchSessionForDistributor(Id distributorId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the queue search service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a QueueSearchSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsQueueSearch() and supportsVisibleFederation() are true

getQueueAdminSession

QueueAdminSession getQueueAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the queue administration service.

Parameters:

proxy - a proxy

Returns:

a QueueAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueAdmin() is false

Compliance:

optional - This method must be implemented if supportsQueueAdmin() is true.

getQueueAdminSessionForDistributor

QueueAdminSession getQueueAdminSessionForDistributor(Id distributorId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the queue administration service for the given distributor.

Parameters:

distributorId - the Id of the distributor

proxy - a proxy

Returns:

a QueueAdminSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsQueueAdmin() and supportsVisibleFederation() are true

getQueueNotificationSession

QueueNotificationSession getQueueNotificationSession(QueueReceiver queueReceiver,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the queue notification service.

Parameters:

queueReceiver - the notification callback

proxy - a proxy

Returns:

a QueueNotificationSession

Throws:

NullArgumentException - queueReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueNotification() is false

Compliance:

optional - This method must be implemented if supportsQueueNotification() is true.

getQueueNotificationSessionForDistributor

QueueNotificationSession getQueueNotificationSessionForDistributor(QueueReceiver queueReceiver,
                                                                 Id distributorId,
                                                                 Proxy proxy)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

Gets the OsidSession associated with the queue notification service for the given distributor.

Parameters:

queueReceiver - the notification callback

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a QueueNotificationSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - queueReceiver, distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsQueueNotification() and supportsVisibleFederation() are true

getQueueDistributorSession

QueueDistributorSession getQueueDistributorSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession to lookup queue/distributor mappings.

Parameters:

proxy - a proxy

Returns:

a QueueDistributorSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueDistributor() is false

Compliance:

optional - This method must be implemented if supportsQueueDistributor() is true.

getQueueDistributorAssignmentSession

QueueDistributorAssignmentSession getQueueDistributorAssignmentSession(Proxy proxy)
                                                                       throws OperationFailedException

Gets the OsidSession associated with assigning queues to distributors.

Parameters:

proxy - a proxy

Returns:

a QueueDistributorAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueDistributorAssignment() is false

Compliance:

optional - This method must be implemented if supportsQueueDistributorAssignment() is true.

getQueueSmartDistributorSession

QueueSmartDistributorSession getQueueSmartDistributorSession(Id distributorId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession to manage queue smart distributors.

Parameters:

distributorId - the Id of the distributor

proxy - a proxy

Returns:

a QueueSmartDistributorSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueSmartDistributor() is false

Compliance:

optional - This method must be implemented if supportsQueueSmartDistributor() is true.

getRequestLookupSession

RequestLookupSession getRequestLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the request lookup service.

Parameters:

proxy - a proxy

Returns:

a RequestLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestLookup() is false

Compliance:

optional - This method must be implemented if supportsRequestLookup() is true.

getRequestLookupSessionForDistributor

RequestLookupSession getRequestLookupSessionForDistributor(Id distributorId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the request lookup service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a RequestLookupSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRequestLookup() and supportsVisibleFederation() are true

getRequestQuerySession

RequestQuerySession getRequestQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the request query service.

Parameters:

proxy - a proxy

Returns:

a RequestQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestQuery() is false

Compliance:

optional - This method must be implemented if supportsRequestQuery() is true.

getRequestQuerySessionForDistributor

RequestQuerySession getRequestQuerySessionForDistributor(Id distributorId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession associated with the request query service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a RequestQuerySession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRequestQuery() and supportsVisibleFederation() are true

getRequestSearchSession

RequestSearchSession getRequestSearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the request search service.

Parameters:

proxy - a proxy

Returns:

a RequestSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestSearch() is false

Compliance:

optional - This method must be implemented if supportsRequestSearch() is true.

getRequestSearchSessionForDistributor

RequestSearchSession getRequestSearchSessionForDistributor(Id distributorId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the request search service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a RequestSearchSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRequestSearch() and supportsVisibleFederation() are true

getRequestAdminSession

RequestAdminSession getRequestAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the request administrative service.

Parameters:

proxy - a proxy

Returns:

a RequestAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestAdmin() is false

Compliance:

optional - This method must be implemented if supportsRequestAdmin() is true.

getRequestAdminSessionForQueue

RequestAdminSession getRequestAdminSessionForQueue(Id queueId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the request administrative service for the given queue.

Parameters:

queueId - the Id of the Queue

proxy - a proxy

Returns:

a RequestAdminSession

Throws:

NotFoundException - no Queue found by the given Id

NullArgumentException - queueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRequestAdmin() and supportsVisibleFederation() are true

getRequestNotificationSession

RequestNotificationSession getRequestNotificationSession(RequestReceiver requestReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the request notification service.

Parameters:

requestReceiver - the notification callback

proxy - a proxy

Returns:

a RequestNotificationSession

Throws:

NullArgumentException - requestReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestNotification() is false

Compliance:

optional - This method must be implemented if supportsRequestNotification() is true.

getRequestNotificationSessionForDistributor

RequestNotificationSession getRequestNotificationSessionForDistributor(RequestReceiver requestReceiver,
                                                                     Id distributorId,
                                                                     Proxy proxy)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets the OsidSession associated with the request notification service for the given distributor.

Parameters:

requestReceiver - the notification callback

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a RequestNotificationSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - requestReceiver, distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRequestNotification() and supportsVisibleFederation() are true.

getRequestDistributorSession

RequestDistributorSession getRequestDistributorSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession to lookup request/distributor mappings.

Parameters:

proxy - a proxy

Returns:

a RequestDistributorSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestDistributor() is false

Compliance:

optional - This method must be implemented if supportsRequestyDistributor() is true.

getRequestDistributorAssignmentSession

RequestDistributorAssignmentSession getRequestDistributorAssignmentSession(Proxy proxy)
                                                                           throws OperationFailedException

Gets the OsidSession associated with assigning queues to distributors.

Parameters:

proxy - a proxy

Returns:

a RequestyDistributorAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestDistributorAssignment() is false

Compliance:

optional - This method must be implemented if supportsRequestDistributorAssignment() is true.

getRequestSmartDistributorSession

RequestSmartDistributorSession getRequestSmartDistributorSession(Id distributorId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession to manage request smart distributors.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a RequestSmartDistributorSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestSmartDistributor() is false

Compliance:

optional - This method must be implemented if supportsRequestSmartDistributor() is true.

getRequestTransactionLookupSession

RequestTransactionLookupSession getRequestTransactionLookupSession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the request transaction lookup service.

Parameters:

proxy - a proxy

Returns:

a RequestTransactionLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestTransactionLookup() is false

Compliance:

optional - This method must be implemented if supportsRequestTransactionLookup() is true.

getRequestTransactionLookupSessionForDistributor

RequestTransactionLookupSession getRequestTransactionLookupSessionForDistributor(Id distributorId,
                                                                               Proxy proxy)
                                                                                 throws NotFoundException,
                                                                                        OperationFailedException

Gets the OsidSession associated with the request transaction lookup service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a RequestTransactionLookupSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestTransactionLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRequestTransactionLookup() and supportsVisibleFederation() are true

getRequestTransactionAdminSession

RequestTransactionAdminSession getRequestTransactionAdminSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the request transaction administrative service.

Parameters:

proxy - a proxy

Returns:

a RequestTransactionAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestTransactionAdmin() is false

Compliance:

optional - This method must be implemented if supportsRequestTransactionAdmin() is true.

getRequestTransactionAdminSessionForDistributor

RequestTransactionAdminSession getRequestTransactionAdminSessionForDistributor(Id distributorId,
                                                                             Proxy proxy)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

Gets the OsidSession associated with the request transaction administrative service for the given distributor.

Parameters:

distributorId - the Id of the distributor

proxy - a proxy

Returns:

a RequestTransactionAdminSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestTransactionAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRequestTransactionAdmin() and supportsVisibleFederation() are true

getExchangeSession

ExchangeSession getExchangeSession(Proxy proxy)
                                   throws OperationFailedException

Gets the OsidSession associated with the exchange service.

Parameters:

proxy - a proxy

Returns:

an ExchangeSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsExchange() is false

Compliance:

optional - This method must be implemented if supportsExchange() is true.

getExchangeSessionForQueue

ExchangeSession getExchangeSessionForQueue(Id queueId,
                                         Proxy proxy)
                                           throws NotFoundException,
                                                  OperationFailedException

Gets the OsidSession associated with the exchange service for the given queue.

Parameters:

queueId - the Id of the Queue

proxy - a proxy

Returns:

an ExchangeSession

Throws:

NotFoundException - no Queue found by the given Id

NullArgumentException - queueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsExchange() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsExchange() and supportsVisibleFederation() are true

getPoolLookupSession

PoolLookupSession getPoolLookupSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the pool lookup service.

Parameters:

proxy - a proxy

Returns:

a PoolLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolLookup() is false

Compliance:

optional - This method must be implemented if supportsPoolLookup() is true.

getPoolLookupSessionForDistributor

PoolLookupSession getPoolLookupSessionForDistributor(Id distributorId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the pool lookup service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a PoolLookupSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPoolLookup() and supportsVisibleFederation() are true.

getPoolQuerySession

PoolQuerySession getPoolQuerySession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the pool query service.

Parameters:

proxy - a proxy

Returns:

a PoolQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolQuery() is false

Compliance:

optional - This method must be implemented if supportsPoolQuery() is true.

getPoolQuerySessionForDistributor

PoolQuerySession getPoolQuerySessionForDistributor(Id distributorId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the pool query service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a PoolQuerySession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPoolQuery() and supportsVisibleFederation() are true.

getPoolSearchSession

PoolSearchSession getPoolSearchSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the pool search service.

Parameters:

proxy - a proxy

Returns:

a PoolSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolSearch() is false

Compliance:

optional - This method must be implemented if supportsPoolSearch() is true.

getPoolSearchSessionForDistributor

PoolSearchSession getPoolSearchSessionForDistributor(Id distributorId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the pool search service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a PoolSearchSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPoolSearch() and supportsVisibleFederation() are true

getPoolAdminSession

PoolAdminSession getPoolAdminSession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the pool administration service.

Parameters:

proxy - a proxy

Returns:

a PoolAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolAdmin() is false

Compliance:

optional - This method must be implemented if supportsPoolAdmin() is true.

getPoolAdminSessionForDistributor

PoolAdminSession getPoolAdminSessionForDistributor(Id distributorId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the pool administration service for the given distributor.

Parameters:

distributorId - the Id of the distributor

proxy - a proxy

Returns:

a PoolAdminSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPoolAdmin() and supportsVisibleFederation() are true

getPoolNotificationSession

PoolNotificationSession getPoolNotificationSession(PoolReceiver poolReceiver,
                                                 Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the pool notification service.

Parameters:

poolReceiver - the notification callback

proxy - a proxy

Returns:

a PoolNotificationSession

Throws:

NullArgumentException - poolReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolNotification() is false

Compliance:

optional - This method must be implemented if supportsPoolNotification() is true.

getPoolNotificationSessionForDistributor

PoolNotificationSession getPoolNotificationSessionForDistributor(PoolReceiver poolReceiver,
                                                               Id distributorId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the pool notification service for the given distributor.

Parameters:

poolReceiver - the notification callback

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a PoolNotificationSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - poolReceiver, distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPoolNotification() and supportsVisibleFederation() are true.

getPoolDistributorSession

PoolDistributorSession getPoolDistributorSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession to lookup pool/distributor mappings.

Parameters:

proxy - a proxy

Returns:

a PoolDistributorSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolDistributor() is false

Compliance:

optional - This method must be implemented if supportsPoolDistributor() is true.

getPoolDistributorAssignmentSession

PoolDistributorAssignmentSession getPoolDistributorAssignmentSession(Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession associated with assigning pools to distributors.

Parameters:

proxy - a proxy

Returns:

a PoolDistributorAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolDistributorAssignment() is false

Compliance:

optional - This method must be implemented if supportsPoolDistributorAssignment() is true.

getPoolSmartDistributorSession

PoolDistributorSession getPoolSmartDistributorSession(Id distributorId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

Gets the OsidSession to manage pool smart distributors.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a PoolSmartDistributorSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolSmartDistributor() is false

Compliance:

optional - This method must be implemented if supportsPoolSmartDistributor() is true.

getProvisionableLookupSession

RequestLookupSession getProvisionableLookupSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the provisionable lookup service.

Parameters:

proxy - a proxy

Returns:

a ProvisionableLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableLookup() is false

Compliance:

optional - This method must be implemented if supportsProvisionableLookup() is true.

getProvisionableLookupSessionForDistributor

RequestLookupSession getProvisionableLookupSessionForDistributor(Id distributorId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the provisionable lookup service for the given distributor.

Parameters:

distributorId - the Id of the distributor

proxy - a proxy

Returns:

a ProvisionableLookupSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProvisionableLookup() and supportsVisibleFederation() are true.

getProvisionableQuerySession

RequestQuerySession getProvisionableQuerySession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the provisionable query service.

Parameters:

proxy - a proxy

Returns:

a ProvisionableQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableQuery() is false

Compliance:

optional - This method must be implemented if supportsProvisionableQuery() is true.

getProvisionableQuerySessionForDistributor

RequestQuerySession getProvisionableQuerySessionForDistributor(Id distributorId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the provisionable query service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionableQuerySession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProvisionableQuery() and supportsVisibleFederation() are true.

getProvisionableSearchSession

RequestSearchSession getProvisionableSearchSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the provisionable search service.

Parameters:

proxy - a proxy

Returns:

a ProvisionableSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableSearch() is false

Compliance:

optional - This method must be implemented if supportsProvisionableSearch() is true.

getProvisionableSearchSessionForDistributor

RequestSearchSession getProvisionableSearchSessionForDistributor(Id distributorId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the provisionable search service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionableSearchSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProvisionableSearch() and supportsVisibleFederation() are true.

getProvisionableAdminSession

RequestAdminSession getProvisionableAdminSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the provisionable administration service.

Parameters:

proxy - a proxy

Returns:

a ProvisionableAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableAdmin() is false

Compliance:

optional - This method must be implemented if supportsProvisionableAdmin() is true.

getProvisionableAdminSessionForPool

RequestAdminSession getProvisionableAdminSessionForPool(Id poolId,
                                                      Proxy proxy)
                                                        throws NotFoundException,
                                                               OperationFailedException

Gets the OsidSession associated with the provisionable administration service for the given pool.

Parameters:

poolId - the Id of the Pool

proxy - a proxy

Returns:

a ProvisionableAdminSession

Throws:

NotFoundException - no pool found by the given Id

NullArgumentException - poolId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProvisionableAdmin() and supportsVisibleFederation() are true.

getProvisionableNotificationSession

RequestNotificationSession getProvisionableNotificationSession(RequestReceiver provisionableReceiver,
                                                             Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the provisionable notification service.

Parameters:

provisionableReceiver - the notification callback

proxy - a proxy

Returns:

a ProvisionableNotificationSession

Throws:

NullArgumentException - provisionableReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableNotification() is false

Compliance:

optional - This method must be implemented if supportsProvisionableNotification() is true.

getProvisionableNotificationSessionForDistributor

RequestNotificationSession getProvisionableNotificationSessionForDistributor(RequestReceiver provisionableReceiver,
                                                                           Id distributorId,
                                                                           Proxy proxy)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

Gets the OsidSession associated with the provisionable notification service for the given distributor.

Parameters:

provisionableReceiver - the notification callback

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionableNotificationSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - provisionableReceiver, distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProvisionableNotification() and supportsVisibleFederation() are true.

getProvisionableDistributorSession

RequestDistributorSession getProvisionableDistributorSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession to lookup provisionable/distributor mappings.

Parameters:

proxy - a proxy

Returns:

a ProvisionableDistributorSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableDistributor() is false

Compliance:

optional - This method must be implemented if supportsProvisionableDistributor() is true.

getProvisionableDistributorAssignmentSession

RequestDistributorAssignmentSession getProvisionableDistributorAssignmentSession(Proxy proxy)
                                                                                 throws OperationFailedException

Gets the OsidSession associated with assigning provisionables to distributors.

Parameters:

proxy - a proxy

Returns:

a ProvisionableDistributorAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableDistributorAssignment() is false

Compliance:

optional - This method must be implemented if supportsProvisionableDistributorAssignment() is true.

getProvisionableSmartDistributorSession

RequestSmartDistributorSession getProvisionableSmartDistributorSession(Id distributorId,
                                                                     Proxy proxy)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets the OsidSession to manage locatin smart distributors.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionableSmartDistributorSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableSmartDistributor() is false

Compliance:

optional - This method must be implemented if supportsProvisionableSmartDistributor() is true.

getBrokerLookupSession

BrokerLookupSession getBrokerLookupSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the broker lookup service.

Parameters:

proxy - a proxy

Returns:

a BrokerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerLookup() is false

Compliance:

optional - This method must be implemented if supportsBrokerLookup() is true.

getBrokerLookupSessionForDistributor

BrokerLookupSession getBrokerLookupSessionForDistributor(Id distributorId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession associated with the broker lookup service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a BrokerLookupSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsBrokerLookup() and supportsVisibleFederation() are true

getBrokerQuerySession

BrokerQuerySession getBrokerQuerySession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the broker query service.

Parameters:

proxy - a proxy

Returns:

a BrokerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerQuery() is false

Compliance:

optional - This method must be implemented if supportsBrokerQuery() is true.

getBrokerQuerySessionForDistributor

BrokerQuerySession getBrokerQuerySessionForDistributor(Id distributorId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the broker query service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a BrokerQuerySession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsBrokerQuery() and supportsVisibleFederation() are true

getBrokerSearchSession

BrokerSearchSession getBrokerSearchSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the broker search service.

Parameters:

proxy - a proxy

Returns:

a BrokerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerSearch() is false

Compliance:

optional - This method must be implemented if supportsBrokerSearch() is true.

getBrokerSearchSessionForDistributor

BrokerSearchSession getBrokerSearchSessionForDistributor(Id distributorId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession associated with the broker search service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a BrokerSearchSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsBrokerSearch() and supportsVisibleFederation() are true

getBrokerAdminSession

BrokerAdminSession getBrokerAdminSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the broker administration service.

Parameters:

proxy - a proxy

Returns:

a BrokerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerAdmin() is false

Compliance:

optional - This method must be implemented if supportsBrokerAdmin() is true.

getBrokerAdminSessionForDistributor

BrokerAdminSession getBrokerAdminSessionForDistributor(Id distributorId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the broker administration service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a BrokerAdminSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsBrokerAdmin() and supportsVisibleFederation() are true

getBrokerNotificationSession

BrokerNotificationSession getBrokerNotificationSession(BrokerReceiver brokerReceiver,
                                                     Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the broker notification service.

Parameters:

brokerReceiver - the notification callback

proxy - a proxy

Returns:

a BrokerNotificationSession

Throws:

NullArgumentException - brokerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerNotification() is false

Compliance:

optional - This method must be implemented if supportsBrokerNotification() is true.

getBrokerNotificationSessionForDistributor

BrokerNotificationSession getBrokerNotificationSessionForDistributor(BrokerReceiver brokerReceiver,
                                                                   Id distributorId,
                                                                   Proxy proxy)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

Gets the OsidSession associated with the broker notification service for the given distributor.

Parameters:

brokerReceiver - the notification callback

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a BrokerNotificationSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - brokerReceiver, distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsBrokerNotification() and supportsVisibleFederation() are true

getBrokerDistributorSession

BrokerDistributorSession getBrokerDistributorSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession to lookup broker/distributor mappings.

Parameters:

proxy - a proxy

Returns:

a BrokerDistributorSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerDistributor() is false

Compliance:

optional - This method must be implemented if supportsBrokerDistributor() is true.

getBrokerDistributorAssignmentSession

BrokerDistributorAssignmentSession getBrokerDistributorAssignmentSession(Proxy proxy)
                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning brokers to distributors.

Parameters:

proxy - a proxy

Returns:

a BrokerDistributorAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerDistributorAssignment() is false

Compliance:

optional - This method must be implemented if supportsBrokerDistributorAssignment() is true.

getBrokerSmartDistributorSession

BrokerSmartDistributorSession getBrokerSmartDistributorSession(Id distributorId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession to manage broker smart distributors.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a BrokerSmartDistributorSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerSmartDistributor() is false

Compliance:

optional - This method must be implemented if supportsBrokerSmartDistributor() is true.

getDistributorLookupSession

DistributorLookupSession getDistributorLookupSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the distributor lookup service.

Parameters:

proxy - a proxy

Returns:

a DistributorLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDistributorLookup() is false

Compliance:

optional - This method must be implemented if supportsDistributorLookup() is true.

getDistributorQuerySession

DistributorQuerySession getDistributorQuerySession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the distributor query service.

Parameters:

proxy - a proxy

Returns:

a DistributorQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDistributorQuery() is false

Compliance:

optional - This method must be implemented if supportsDistributorQuery() is true.

getDistributorSearchSession

DistributorSearchSession getDistributorSearchSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the distributor search service.

Parameters:

proxy - a proxy

Returns:

a DistributorSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDistributorSearch() is false

Compliance:

optional - This method must be implemented if supportsDistributorSearch() is true.

getDistributorAdminSession

DistributorAdminSession getDistributorAdminSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the distributor administrative service.

Parameters:

proxy - a proxy

Returns:

a DistributorAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDistributorAdmin() is false

Compliance:

optional - This method must be implemented if supportsDistributorAdmin() is true.

getDistributorNotificationSession

DistributorNotificationSession getDistributorNotificationSession(DistributorReceiver distributorReceiver,
                                                               Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the distributor notification service.

Parameters:

distributorReceiver - the notification callback

proxy - a proxy

Returns:

a DistributorNotificationSession

Throws:

NullArgumentException - distributorReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDistributorNotification() is false

Compliance:

optional - This method must be implemented if supportsDistributorNotification() is true.

getDistributorHierarchySession

DistributorHierarchySession getDistributorHierarchySession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the distributor hierarchy service.

Parameters:

proxy - a proxy

Returns:

a DistributorHierarchySession for distributors

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDistributorHierarchy() is false

Compliance:

optional - This method must be implemented if supportsDistributorHierarchy() is true.

getDistributorHierarchyDesignSession

DistributorHierarchyDesignSession getDistributorHierarchyDesignSession(Proxy proxy)
                                                                       throws OperationFailedException

Gets the OsidSession associated with the distributor hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a HierarchyDesignSession for distributors

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDistributorHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsDistributorHierarchyDesign() is true.

getProvisioningBatchProxyManager

ProvisioningBatchProxyManager getProvisioningBatchProxyManager()
                                                               throws OperationFailedException

Gets the ProvisioningBatchProxyManager.

Returns:

a ProvisioningBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisioningBatch() is false

Compliance:

optional - This method must be implemented if supportsProvisioningBatch() is true.

getProvisioningRulesProxyManager

ProvisioningRulesProxyManager getProvisioningRulesProxyManager()
                                                               throws OperationFailedException

Gets the ProvisioningRulesPorxyManager.

Returns:

a ProvisioningRulesProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisioningRules() is false

Compliance:

optional - This method must be implemented if supportsProvisioningRules() is true.