public interface MyProvisionNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Provision
objects in this Distributor
for
resources related to the authenticated agent.This also includes existing
provisions 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.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForProvisionNotifications()
Tests if this user can register for
Provision
notifications. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
registerForChangedProvisions()
Registers for notification of updated provisions for resources related
to the authenticated agent.
|
void |
registerForChangedProvisionsForBroker(Id brokerId)
Register for notifications of updated provisions for the given broker
Id for resources related to the authenticated agent. |
void |
registerForChangedProvisionsForPool(Id poolId)
Register for notifications of updated provisions for the given pool
Id for resources related to the authenticated agent. |
void |
registerForChangedProvisionsForQueue(Id queueId)
Register for notifications of updated provisions for the given queue
Id for resources related to the authenticated agent. |
void |
registerForDeletedProvisions()
Registers for notification of deleted provisions for resources related
to the authenticated agent.
|
void |
registerForDeletedProvisionsForBroker(Id brokerId)
Register for notifications of deleted provisions for the given broker
Id for resources related to the authenticated agent. |
void |
registerForDeletedProvisionsForPool(Id poolId)
Register for notifications of deleted provisions for the given pool
Id for resources related to the authenticated agent. |
void |
registerForDeletedProvisionsForQueue(Id queueId)
Register for notifications of deleted provisions for the given queue
Id for resources related to the authenticated agent. |
void |
registerForNewProvisions()
Register for notifications of new provisions for resources related to
the authenticated agent.
|
void |
registerForNewProvisionsForBroker(Id brokerId)
Register for notifications of new provisions for the given broker
Id for resources related to the authenticated agent. |
void |
registerForNewProvisionsForPool(Id poolId)
Register for notifications of new provisions for the given pool
Id for resources related to the authenticated agent. |
void |
registerForNewProvisionsForQueue(Id queueId)
Register for notifications of new provisions for the given queue
Id for resources related to the authenticated agent. |
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 canRegisterForProvisionNotifications()
Provision
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 registerForNewProvisions() throws OperationFailedException, PermissionDeniedException
ProvisionReceiver.newProvision()
is invoked when a new Provision
appears in this
distributor.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewProvisionsForPool(Id poolId) throws OperationFailedException, PermissionDeniedException
Id
for resources related to the authenticated agent.
ProvisionReceiver.newProvision()
is invoked when a new
Provision
is created.poolId
- the Id
of the pool to monitorNullArgumentException
- poolId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewProvisionsForQueue(Id queueId) throws OperationFailedException, PermissionDeniedException
Id
for resources related to the authenticated agent.
ProvisionReceiver.newProvision()
is invoked when a new
Provision
is created.queueId
- the Id
of the queue to monitorNullArgumentException
- queueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewProvisionsForBroker(Id brokerId) throws OperationFailedException, PermissionDeniedException
Id
for resources related to the authenticated agent.
ProvisionReceiver.newProvision()
is invoked when a new
Provision
is created.brokerId
- the Id
of the broker to monitorNullArgumentException
- brokerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProvisions() throws OperationFailedException, PermissionDeniedException
ProvisionReceiver.changedProvision()
is invoked when a
provision in this distributor is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProvisionsForPool(Id poolId) throws OperationFailedException, PermissionDeniedException
Id
for resources related to the authenticated agent.
ProvisionReceiver.changedProvision()
is invoked when a
provision in this distributor is changed.poolId
- the Id
of the pool to monitorNullArgumentException
- poolId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProvisionsForQueue(Id queueId) throws OperationFailedException, PermissionDeniedException
Id
for resources related to the authenticated agent.
ProvisionReceiver.changedProvision()
is invoked when a
provision in this distributor is changed.queueId
- the Id
of the queue to monitorNullArgumentException
- queueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProvisionsForBroker(Id brokerId) throws OperationFailedException, PermissionDeniedException
Id
for resources related to the authenticated agent.
ProvisionReceiver.changedProvision()
is invoked when a
provision in this distributor is changed.brokerId
- the Id
of the broker to monitorNullArgumentException
- brokerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedProvisions() throws OperationFailedException, PermissionDeniedException
ProvisionReceiver.deletedProvision()
is invoked when a
provision is deleted or removed from this distributor.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedProvisionsForPool(Id poolId) throws OperationFailedException, PermissionDeniedException
Id
for resources related to the authenticated agent.
ProvisionReceiver.deletedProvision()
is invoked when a
provision in this distributor is removed or deleted.poolId
- the Id
of the pool to monitorNullArgumentException
- poolId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedProvisionsForQueue(Id queueId) throws OperationFailedException, PermissionDeniedException
Id
for resources related to the authenticated agent.
ProvisionReceiver.deletedProvision()
is invoked when a
provision in this distributor is removed or deleted.queueId
- the Id
of the queue to monitorNullArgumentException
- queueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedProvisionsForBroker(Id brokerId) throws OperationFailedException, PermissionDeniedException
Id
for resources related to the authenticated agent.
ProvisionReceiver.deletedProvision()
is invoked when a
provision in this distributor is removed or deleted.brokerId
- the Id
of the vroker to monitorNullArgumentException
- queueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.