org.osid.provisioning.rules

Interface BrokerProcessorEnablerNotificationSession

All Superinterfaces:

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

public interface BrokerProcessorEnablerNotificationSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForBrokerProcessorEnablerNotifications() Tests if this user can register for BrokerProcessorEnabler notifications.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
void	registerForChangedBrokerProcessorEnabler(Id brokerProcessorEnablerId) Registers for notification of an updated broker processor enabler.
void	registerForChangedBrokerProcessorEnablers() Registers for notification of updated distributor enabelrs.
void	registerForDeletedBrokerProcessorEnabler(Id brokerProcessorEnablerId) Registers for notification of a deleted broker processor enabler.
void	registerForDeletedBrokerProcessorEnablers() Registers for notification of deleted broker processor enablers.
void	registerForNewBrokerProcessorEnablers() Register for notifications of new broker processor 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.

canRegisterForBrokerProcessorEnablerNotifications

boolean canRegisterForBrokerProcessorEnablerNotifications()

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

registerForNewBrokerProcessorEnablers

void registerForNewBrokerProcessorEnablers()
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Register for notifications of new broker processor enablers. BrokerProcessorEnablerReceiver.newBrokerProcessorEnablers() is invoked when a new BrokerProcessorEnabler appears in this distributor.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedBrokerProcessorEnablers

void registerForChangedBrokerProcessorEnablers()
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Registers for notification of updated distributor enabelrs. BrokerProcessorEnablerReceiver.changedBrokerProcessorEnablers() is invoked when a broker processor enabler in this distributor is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedBrokerProcessorEnabler

void registerForChangedBrokerProcessorEnabler(Id brokerProcessorEnablerId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

brokerProcessorEnablerId - the Id of the BrokerProcessorEnabler to monitor

Throws:

NullArgumentException - brokerProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBrokerProcessorEnablers

void registerForDeletedBrokerProcessorEnablers()
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Registers for notification of deleted broker processor enablers. BrokerProcessorEnablerReceiver.deletedBrokerProcessorEnablers() is invoked when a broker processor enabler is deleted or removed from this distributor.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBrokerProcessorEnabler

void registerForDeletedBrokerProcessorEnabler(Id brokerProcessorEnablerId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Registers for notification of a deleted broker processor enabler. BrokerProcessorEnablerReceiver.deletedBrokerProcessorEnablers() is invoked when the specified broker processor enabler is deleted or removed from this distributor.

Parameters:

brokerProcessorEnablerId - the Id of the BrokerProcessorEnabler to monitor

Throws:

NullArgumentException - brokerProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.