org.osid.provisioning

Interface QueueNotificationSession

All Superinterfaces:

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

public interface QueueNotificationSession
extends OsidSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForQueueNotifications() Tests if this user can register for Queue notifications.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
void	registerForChangedQueue(Id queueId) Registers for notification of an updated queue.
void	registerForChangedQueues() Registers for notification of updated queues.
void	registerForChangedQueuesForBroker(Id brokerId) Registers for notification of updated queues in the given broker.
void	registerForDeletedQueue(Id queueId) Registers for notification of a deleted queue.
void	registerForDeletedQueues() Registers for notification of deleted queues.
void	registerForDeletedQueuesForBroker(Id brokerId) Registers for notification of deleted queues in the given broker.
void	registerForNewQueues() Register for notifications of new queues.
void	registerForNewQueuesForBroker(Id brokerId) Register for notifications of new queues in the given broker.
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.

canRegisterForQueueNotifications

boolean canRegisterForQueueNotifications()

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.

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 queues 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.

registerForNewQueues

void registerForNewQueues()
                          throws OperationFailedException,
                                 PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewQueuesForBroker

void registerForNewQueuesForBroker(Id brokerId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Register for notifications of new queues in the given broker. QueueReceiver.newQueues() is invoked when a new Queue appears in 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.

registerForChangedQueues

void registerForChangedQueues()
                              throws OperationFailedException,
                                     PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedQueuesForBroker

void registerForChangedQueuesForBroker(Id brokerId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Registers for notification of updated queues in the given broker. QueueReceiver.changedQueues() is invoked when a queue 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.

registerForChangedQueue

void registerForChangedQueue(Id queueId)
                             throws OperationFailedException,
                                    PermissionDeniedException

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

Parameters:

queueId - the Id of the Queue to monitor

Throws:

NullArgumentException - queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedQueues

void registerForDeletedQueues()
                              throws OperationFailedException,
                                     PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedQueuesForBroker

void registerForDeletedQueuesForBroker(Id brokerId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Registers for notification of deleted queues in the given broker. QueueReceiver.deletedQueues() is invoked when a queue 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.

registerForDeletedQueue

void registerForDeletedQueue(Id queueId)
                             throws OperationFailedException,
                                    PermissionDeniedException

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

Parameters:

queueId - the Id of the Queue to monitor

Throws:

NullArgumentException - queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.