public interface BrokerProcessorSmartDistributorSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
distributors. A BrokerProcessorQuery
can be retrieved from
this session and mapped to this Distributor
to create a
virtual collection of broker processors. The broker processor may be
sequenced using the BrokerProcessorSearchOrder
from this
session.
This Distributor
has a default query that matches any
broker processor and a default search order that specifies no sequencing.
The queries may be examined using a BrokerProcessorQueryInspector.
The query may be modified by converting the inspector back to a
BrokerProcessorQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyBrokerProcessorQuery(BrokerProcessorQuery brokerProcessorQuery)
Applies a broker processor query to this distributor.
|
void |
applyBrokerProcessorSequencing(BrokerProcessorSearchOrder brokerProcessorSearchOrder)
Applies a broker processor search order to this distributor.
|
boolean |
canManageSmartDistributors()
Tests if this user can manage smart distributors.
|
BrokerProcessorQuery |
getBrokerProcessorQuery()
Gets a broker processor query.
|
BrokerProcessorQuery |
getBrokerProcessorQueryFromInspector(BrokerProcessorQueryInspector brokerProcessorQueryInspector)
Gets a broker processor query from an inspector.
|
BrokerProcessorSearchOrder |
getBrokerProcessorSearchOrder()
Gets a broker processor search order.
|
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
BrokerProcessorQueryInspector |
inspectBrokerProcessorQuery()
Gets a broker processor query inspector for this distributor.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDistributorId()
Distributor
Id
associated with
this session. Distributor Id
associated with this sessionmandatory
- This method must be implemented. Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
Distributor
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartDistributors()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart distributor management is not
authorized, true
otherwisemandatory
- This method must be implemented. BrokerProcessorQuery getBrokerProcessorQuery()
mandatory
- This method must be implemented. BrokerProcessorSearchOrder getBrokerProcessorSearchOrder()
mandatory
- This method must be implemented. void applyBrokerProcessorQuery(BrokerProcessorQuery brokerProcessorQuery) throws OperationFailedException, PermissionDeniedException
brokerProcessorQuery
- the broker processor queryNullArgumentException
- brokerProcessorQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- brokerProcessorQuery
not of this servicemandatory
- This method must be implemented. BrokerProcessorQueryInspector inspectBrokerProcessorQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyBrokerProcessorSequencing(BrokerProcessorSearchOrder brokerProcessorSearchOrder) throws OperationFailedException, PermissionDeniedException
brokerProcessorSearchOrder
- the broker processor search orderNullArgumentException
-
brokerProcessorSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
brokerProcessorSearchOrder
not of this servicemandatory
- This method must be implemented. BrokerProcessorQuery getBrokerProcessorQueryFromInspector(BrokerProcessorQueryInspector brokerProcessorQueryInspector)
brokerProcessorQueryInspector
- a broker processor query
inspectorNullArgumentException
-
brokerProcessorQueryInspector
is null
UnsupportedException
-
brokerProcessorQueryInspector
is not of this servicemandatory
- This method must be implemented.