public interface PoolProcessorEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to PoolProcessorEnabler
objects in this Distributor.
This also includes existing PoolProcessorEnablers
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
PoolProcessorEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForPoolProcessorEnablerNotifications()
Tests if this user can register for
PoolProcessorEnabler
notifications. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
registerForChangedPoolProcessorEnabler(Id poolProcessorEnablerId)
Registers for notification of an updated pool processor enabler.
|
void |
registerForChangedPoolProcessorEnablers()
Registers for notification of updated distributor enabelrs.
|
void |
registerForDeletedPoolProcessorEnabler(Id poolProcessorEnablerId)
Registers for notification of a deleted pool processor enabler.
|
void |
registerForDeletedPoolProcessorEnablers()
Registers for notification of deleted pool processor enablers.
|
void |
registerForNewPoolProcessorEnablers()
Register for notifications of new pool 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 canRegisterForPoolProcessorEnablerNotifications()
PoolProcessorEnabler
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 registerForNewPoolProcessorEnablers() throws OperationFailedException, PermissionDeniedException
PoolProcessorEnablerReceiver.newPoolProcessorEnablers()
is
invoked when a new PoolProcessorEnabler
appears in this
distributor.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedPoolProcessorEnablers() throws OperationFailedException, PermissionDeniedException
PoolProcessorEnablerReceiver.changedPoolProcessorEnablers()
is
invoked when a pool processor enabler in this distributor is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedPoolProcessorEnabler(Id poolProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedPoolProcessorEnablers()
is
invoked when the specified pool processor enabler in this distributor
is changed.poolProcessorEnablerId
- the Id
of the
PoolProcessorEnabler
to monitorNullArgumentException
- poolProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedPoolProcessorEnablers() throws OperationFailedException, PermissionDeniedException
PoolProcessorEnablerReceiver.deletedPoolProcessorEnablers()
is
invoked when a pool processor enabler is deleted or removed from this
distributor.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedPoolProcessorEnabler(Id poolProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
PoolProcessorEnablerReceiver.deletedPoolProcessorEnablers()
is
invoked when the specified pool processor enabler is deleted or
removed from this distributor.poolProcessorEnablerId
- the Id
of the
PoolProcessorEnabler
to monitorNullArgumentException
- poolProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.