public interface QueueConstrainerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to QueueConstrainer
objects in this Distributor.
This also includes existing QueueConstrainers
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
QueueConstrainerLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForQueueConstrainerNotifications()
Tests if this user can register for
QueueConstrainer
notifications. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
registerForChangedQueueConstrainer(Id queueConstrainerId)
Registers for notification of an updated queue constrainer.
|
void |
registerForChangedQueueConstrainers()
Registers for notification of updated distributors.
|
void |
registerForDeletedQueueConstrainer(Id queueConstrainerId)
Registers for notification of a deleted queue constrainer.
|
void |
registerForDeletedQueueConstrainers()
Registers for notification of deleted queue constrainers.
|
void |
registerForNewQueueConstrainers()
Register for notifications of new queue constrainers.
|
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 canRegisterForQueueConstrainerNotifications()
QueueConstrainer
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 registerForNewQueueConstrainers() throws OperationFailedException, PermissionDeniedException
QueueConstrainerReceiver.newQueueConstrainers()
is invoked
when a new QueueConstrainer
appears in this
distributor.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedQueueConstrainers() throws OperationFailedException, PermissionDeniedException
QueueConstrainerReceiver.changedQueueConstrainers()
is invoked
when a queue constrainer in this distributor is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedQueueConstrainer(Id queueConstrainerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedQueueConstrainers()
is invoked
when the specified queue constrainer in this distributor is changed.queueConstrainerId
- the Id
of the
QueueConstrainer
to monitorNullArgumentException
- queueConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedQueueConstrainers() throws OperationFailedException, PermissionDeniedException
QueueConstrainerReceiver.deletedQueueConstrainers()
is invoked
when a queue constrainer is deleted or removed from this distributor.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedQueueConstrainer(Id queueConstrainerId) throws OperationFailedException, PermissionDeniedException
QueueConstrainerReceiver.deletedQueueConstrainers()
is invoked
when the specified queue constrainer is deleted or removed from this
distributor.queueConstrainerId
- the Id
of the
QueueConstrainer
to monitorNullArgumentException
- queueConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.