org.osid.provisioning

Interface BrokerNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface BrokerNotificationSession
extends OsidSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForBrokerNotifications() Tests if this user can register for Broker notifications.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
void	registerForChangedBroker(Id brokerId) Registers for notification of an updated broker.
void	registerForChangedBrokers() Registers for notification of updated brokers.
void	registerForDeletedBroker(Id brokerId) Registers for notification of a deleted broker.
void	registerForDeletedBrokers() Registers for notification of deleted brokers.
void	registerForNewBrokers() Register for notifications of new brokers.
void	useFederatedDistributorView() Federates the view for methods in this session.
void	useIsolatedDistributorView() Isolates the view for methods in this session.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getDistributorId

Id getDistributorId()

Gets the Distributor Id associated with this session.

Returns:

the Distributor Id associated with this session

Compliance:

mandatory - This method must be implemented.

getDistributor

Distributor getDistributor()
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets the Distributor associated with this session.

Returns:

the distributor

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForBrokerNotifications

boolean canRegisterForBrokerNotifications()

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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedDistributorView

void useFederatedDistributorView()

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.

Compliance:

mandatory - This method is must be implemented.

useIsolatedDistributorView

void useIsolatedDistributorView()

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

Compliance:

mandatory - This method is must be implemented.

registerForNewBrokers

void registerForNewBrokers()
                           throws OperationFailedException,
                                  PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedBrokers

void registerForChangedBrokers()
                               throws OperationFailedException,
                                      PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedBroker

void registerForChangedBroker(Id brokerId)
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of an updated broker. BrokerReceiver.changedBroker() is invoked when the specified broker in this distributor is changed.

Parameters:

brokerId - the Id of the Broker to monitor

Throws:

NullArgumentException - brokerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBrokers

void registerForDeletedBrokers()
                               throws OperationFailedException,
                                      PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBroker

void registerForDeletedBroker(Id brokerId)
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of a deleted broker. BrokerReceiver.deletedBroker() is invoked when the specified broker is deleted or removed from this distributor.

Parameters:

brokerId - the Id of the Broker to monitor

Throws:

NullArgumentException - brokerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.