OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.QueueNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Queue objects in this Distributor. This also includes existing queues 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 QueueLookupSession.

MethodgetDistributorId
Description

Gets the Distributor Id associated with this session.

Returnosid.id.Idthe Distributor Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetDistributor
Description

Gets the Distributor associated with this session.

Returnosid.provisioning.Distributorthe distributor
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForQueueNotifications
Description

Tests if this user can register for Queue 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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedDistributorView
Description

Federates the view for methods in this session. A federated view will include queues in distributors which are children of this distributor in the distributor hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedDistributorView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this distributor only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewQueues
Description

Register for notifications of new queues. QueueReceiver.newQueues() is invoked when a new Queue appears in this distributor.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewQueuesForBroker
Description

Register for notifications of new queues in the given broker. QueueReceiver.newQueues() is invoked when a new Queue appears in this distributor.

Parametersosid.id.IdbrokerIdthe Id of the broker to monitor
ErrorsNULL_ARGUMENT brokerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedQueues
Description

Registers for notification of updated queues. QueueReceiver.changedQueues() is invoked when a queue in this distributor is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedQueuesForBroker
Description

Registers for notification of updated queues in the given broker. QueueReceiver.changedQueues() is invoked when a queue in this distributor is changed.

Parametersosid.id.IdbrokerIdthe Id of the broker to monitor
ErrorsNULL_ARGUMENT brokerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedQueue
Description

Registers for notification of an updated queue. ProvisionableReceiver.changedQueues() is invoked when the specified queue in this distributor is changed.

Parametersosid.id.IdqueueIdthe Id of the Queue to monitor
ErrorsNULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedQueues
Description

Registers for notification of deleted queues. QueueReceiver.deletedQueues() is invoked when a queue is deleted or removed from this distributor.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedQueuesForBroker
Description

Registers for notification of deleted queues in the given broker. QueueReceiver.deletedQueues() is invoked when a queue is deleted or removed from this distributor.

Parametersosid.id.IdbrokerIdthe Id of the broker to monitor
ErrorsNULL_ARGUMENT brokerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedQueue
Description

Registers for notification of a deleted queue. QueueReceiver.deletedQueues() is invoked when the specified queue is deleted or removed from this distributor.

Parametersosid.id.IdqueueIdthe Id of the Queue to monitor
ErrorsNULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.