org.osid.provisioning

Interface PoolNotificationSession

All Superinterfaces:

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

public interface PoolNotificationSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForPoolNotifications() Tests if this user can register for Pool notifications.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
void	registerForChangedPool(Id poolId) Registers for notification of an updated pool.
void	registerForChangedPools() Registers for notification of updated pools.
void	registerForChangedPoolsForBroker(Id brokerId) Register for notifications of updated pools for the given broker Id.
void	registerForDeletedPool(Id poolId) Registers for notification of a deleted pool.
void	registerForDeletedPools() Registers for notification of deleted pools.
void	registerForDeletedPoolsForBroker(Id brokerId) Register for notifications of deleted pools for the given broker Id.
void	registerForNewPools() Register for notifications of new pools.
void	registerForNewPoolsForBroker(Id brokerId) Register for notifications of new pools for the given broker Id.
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.

canRegisterForPoolNotifications

boolean canRegisterForPoolNotifications()

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

registerForNewPools

void registerForNewPools()
                         throws OperationFailedException,
                                PermissionDeniedException

Register for notifications of new pools. PoolReceiver.newPools() is invoked when a new Pool appears in this distributor.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewPoolsForBroker

void registerForNewPoolsForBroker(Id brokerId)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Register for notifications of new pools for the given broker Id. PoolReceiver.newPools() is invoked when a new Pool is created.

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.

registerForChangedPools

void registerForChangedPools()
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of updated pools. PoolReceiver.changedPools() is invoked when a pool in this distributor is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPoolsForBroker

void registerForChangedPoolsForBroker(Id brokerId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Register for notifications of updated pools for the given broker Id. PoolReceiver.changedPools() is invoked when a pool 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.

registerForChangedPool

void registerForChangedPool(Id poolId)
                            throws OperationFailedException,
                                   PermissionDeniedException

Registers for notification of an updated pool. PoolReceiver.changedPools() is invoked when the specified pool in this distributor is changed.

Parameters:

poolId - the Id of the Pool to monitor

Throws:

NullArgumentException - poolId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPools

void registerForDeletedPools()
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of deleted pools. PoolReceiver.deletedPools() is invoked when a pool is deleted or removed from this distributor.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPoolsForBroker

void registerForDeletedPoolsForBroker(Id brokerId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Register for notifications of deleted pools for the given broker Id. PoolReceiver.deletedPools() is invoked when a pool in this distributor is removed or deleted.

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.

registerForDeletedPool

void registerForDeletedPool(Id poolId)
                            throws OperationFailedException,
                                   PermissionDeniedException

Registers for notification of a deleted pool. PoolReceiver.deletedPools() is invoked when the specified pool is deleted or removed from this distributor.

Parameters:

poolId - the Id of the Pool to monitor

Throws:

NullArgumentException - poolId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.