org.osid.provisioning.rules

Interface PoolProcessorNotificationSession

All Superinterfaces:

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

public interface PoolProcessorNotificationSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForPoolProcessorNotifications() Tests if this user can register for PoolProcessor notifications.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
void	registerForChangedPoolProcessor(Id poolProcessorId) Registers for notification of an updated pool processor.
void	registerForChangedPoolProcessors() Registers for notification of updated distributors.
void	registerForDeletedPoolProcessor(Id poolProcessorId) Registers for notification of a deleted pool processor.
void	registerForDeletedPoolProcessors() Registers for notification of deleted pool processors.
void	registerForNewPoolProcessors() Register for notifications of new pool processors.
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.

canRegisterForPoolProcessorNotifications

boolean canRegisterForPoolProcessorNotifications()

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

registerForNewPoolProcessors

void registerForNewPoolProcessors()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Register for notifications of new pool processors. PoolProcessorReceiver.newPoolProcessor() is invoked when a new PoolProcessor appears in this distributor.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPoolProcessors

void registerForChangedPoolProcessors()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Registers for notification of updated distributors. PoolProcessorReceiver.changedPoolProcessor() is invoked when a pool processor in this distributor is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPoolProcessor

void registerForChangedPoolProcessor(Id poolProcessorId)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Registers for notification of an updated pool processor. ProvisionableReceiver.changedPoolProcessor() is invoked when the specified pool processor in this distributor is changed.

Parameters:

poolProcessorId - the Id of the PoolProcessor to monitor

Throws:

NullArgumentException - poolProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPoolProcessors

void registerForDeletedPoolProcessors()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Registers for notification of deleted pool processors. PoolProcessorReceiver.deletedPoolProcessor() is invoked when a pool processor is deleted or removed from this distributor.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPoolProcessor

void registerForDeletedPoolProcessor(Id poolProcessorId)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Parameters:

poolProcessorId - the Id of the PoolProcessor to monitor

Throws:

NullArgumentException - poolProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.