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

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

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.
MethodcanRegisterForBrokerNotifications
Description

Tests if this user can register for Broker 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 brokers 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.
MethodregisterForNewBrokers
Description

Register for notifications of new brokers. BrokerReceiver.newBrokers() is invoked when a new Broker appears in this distributor.

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

Registers for notification of updated brokers. BrokerReceiver.changedBrokers() is invoked when a broker in this distributor is changed.

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

Registers for notification of an updated broker. BrokerReceiver.changedBrokers() is invoked when the specified broker 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.
MethodregisterForDeletedBrokers
Description

Registers for notification of deleted brokers. BrokerReceiver.deletedBrokers() is invoked when a broker is deleted or removed from this distributor.

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

Registers for notification of a deleted broker. BrokerReceiver.deletedBrokers() is invoked when the specified broker 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.