org.osid.provisioning.rules

Interface QueueConstrainerEnablerNotificationSession

All Superinterfaces:

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

public interface QueueConstrainerEnablerNotificationSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForQueueConstrainerEnablerNotifications() Tests if this user can register for QueueConstrainerEnabler notifications.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
void	registerForChangedQueueConstrainerEnabler(Id queueConstrainerEnablerId) Registers for notification of an updated queue constrainer enabler.
void	registerForChangedQueueConstrainerEnablers() Registers for notification of updated distributor enabelrs.
void	registerForDeletedQueueConstrainerEnabler(Id queueConstrainerEnablerId) Registers for notification of a deleted queue constrainer enabler.
void	registerForDeletedQueueConstrainerEnablers() Registers for notification of deleted queue constrainer enablers.
void	registerForNewQueueConstrainerEnablers() Register for notifications of new queue constrainer enablers.
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.

canRegisterForQueueConstrainerEnablerNotifications

boolean canRegisterForQueueConstrainerEnablerNotifications()

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

registerForNewQueueConstrainerEnablers

void registerForNewQueueConstrainerEnablers()
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Register for notifications of new queue constrainer enablers. QueueConstrainerEnablerReceiver.newQueueConstrainerEnablers() is invoked when a new QueueConstrainerEnabler appears in this distributor.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedQueueConstrainerEnablers

void registerForChangedQueueConstrainerEnablers()
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Registers for notification of updated distributor enabelrs. QueueConstrainerEnablerReceiver.changedQueueConstrainerEnablers() is invoked when a queue constrainer enabler in this distributor is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedQueueConstrainerEnabler

void registerForChangedQueueConstrainerEnabler(Id queueConstrainerEnablerId)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

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

Parameters:

queueConstrainerEnablerId - the Id of the QueueConstrainerEnabler to monitor

Throws:

NullArgumentException - queueConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedQueueConstrainerEnablers

void registerForDeletedQueueConstrainerEnablers()
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Registers for notification of deleted queue constrainer enablers. QueueConstrainerEnablerReceiver.deletedQueueConstrainerEnablers() is invoked when a queue constrainer enabler is deleted or removed from this distributor.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedQueueConstrainerEnabler

void registerForDeletedQueueConstrainerEnabler(Id queueConstrainerEnablerId)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Registers for notification of a deleted queue constrainer enabler. QueueConstrainerEnablerReceiver.deletedQueueConstrainerEnablers() is invoked when the specified queue constrainer enabler is deleted or removed from this distributor.

Parameters:

queueConstrainerEnablerId - the Id of the QueueConstrainerEnabler to monitor

Throws:

NullArgumentException - queueConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.