public interface BrokerProcessorEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to BrokerProcessorEnabler
objects in this
Distributor.
This also includes existing
BrokerProcessorEnablers
that may appear or disappear due to
changes in the Distributor
hierarchy, This session is
intended for consumers needing to synchronize their state with this
service without the use of polling. Notifications are cancelled when this
session is closed.
The two views defined in this session correspond to the views in the
BrokerProcessorEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForBrokerProcessorEnablerNotifications()
Tests if this user can register for
BrokerProcessorEnabler
notifications. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
registerForChangedBrokerProcessorEnabler(Id brokerProcessorEnablerId)
Registers for notification of an updated broker processor enabler.
|
void |
registerForChangedBrokerProcessorEnablers()
Registers for notification of updated distributor enabelrs.
|
void |
registerForDeletedBrokerProcessorEnabler(Id brokerProcessorEnablerId)
Registers for notification of a deleted broker processor enabler.
|
void |
registerForDeletedBrokerProcessorEnablers()
Registers for notification of deleted broker processor enablers.
|
void |
registerForNewBrokerProcessorEnablers()
Register for notifications of new broker processor enablers.
|
void |
useFederatedDistributorView()
Federates the view for methods in this session.
|
void |
useIsolatedDistributorView()
Isolates the view for methods in this session.
|
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 canRegisterForBrokerProcessorEnablerNotifications()
BrokerProcessorEnabler
notifications. A return of true does not guarantee successful
authorization. A return of false indicates that it is known all
methods in this session will result in a PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer notification operations. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedDistributorView()
mandatory
- This method is must be implemented. void useIsolatedDistributorView()
mandatory
- This method is must be implemented. void registerForNewBrokerProcessorEnablers() throws OperationFailedException, PermissionDeniedException
BrokerProcessorEnablerReceiver.newBrokerProcessorEnablers()
is
invoked when a new BrokerProcessorEnabler
appears in
this distributor.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedBrokerProcessorEnablers() throws OperationFailedException, PermissionDeniedException
BrokerProcessorEnablerReceiver.changedBrokerProcessorEnablers()
is invoked when a broker processor enabler in this distributor
is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedBrokerProcessorEnabler(Id brokerProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedBrokerProcessorEnablers()
is invoked when the specified broker processor enabler in this
distributor is changed.brokerProcessorEnablerId
- the Id
of the
BrokerProcessorEnabler
to monitorNullArgumentException
- brokerProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedBrokerProcessorEnablers() throws OperationFailedException, PermissionDeniedException
BrokerProcessorEnablerReceiver.deletedBrokerProcessorEnablers()
is invoked when a broker processor enabler is deleted or
removed from this distributor.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedBrokerProcessorEnabler(Id brokerProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
BrokerProcessorEnablerReceiver.deletedBrokerProcessorEnablers()
is invoked when the specified broker processor enabler is
deleted or removed from this distributor.brokerProcessorEnablerId
- the Id
of the
BrokerProcessorEnabler
to monitorNullArgumentException
- brokerProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.