org.osid.provisioning.rules

Interface BrokerConstrainerEnablerNotificationSession

All Superinterfaces:

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

public interface BrokerConstrainerEnablerNotificationSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForBrokerConstrainerEnablerNotifications() Tests if this user can register for BrokerConstrainerEnabler notifications.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
void	registerForChangedBrokerConstrainerEnabler(Id brokerConstrainerEnablerId) Registers for notification of an updated broker constrainer enabler.
void	registerForChangedBrokerConstrainerEnablers() Registers for notification of updated distributor enabelrs.
void	registerForDeletedBrokerConstrainerEnabler(Id brokerConstrainerEnablerId) Registers for notification of a deleted broker constrainer enabler.
void	registerForDeletedBrokerConstrainerEnablers() Registers for notification of deleted broker constrainer enablers.
void	registerForNewBrokerConstrainerEnablers() Register for notifications of new broker 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.

canRegisterForBrokerConstrainerEnablerNotifications

boolean canRegisterForBrokerConstrainerEnablerNotifications()

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

registerForNewBrokerConstrainerEnablers

void registerForNewBrokerConstrainerEnablers()
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Register for notifications of new broker constrainer enablers. BrokerConstrainerEnablerReceiver.newBrokerConstrainerEnabler() is invoked when a new BrokerConstrainerEnabler appears in this distributor.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedBrokerConstrainerEnablers

void registerForChangedBrokerConstrainerEnablers()
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Registers for notification of updated distributor enabelrs. BrokerConstrainerEnablerReceiver.changedBrokerConstrainerEnabler() is invoked when a broker constrainer enabler in this distributor is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedBrokerConstrainerEnabler

void registerForChangedBrokerConstrainerEnabler(Id brokerConstrainerEnablerId)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

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

Parameters:

brokerConstrainerEnablerId - the Id of the BrokerConstrainerEnabler to monitor

Throws:

NullArgumentException - brokerConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBrokerConstrainerEnablers

void registerForDeletedBrokerConstrainerEnablers()
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Registers for notification of deleted broker constrainer enablers. BrokerConstrainerEnablerReceiver.deletedBrokerConstrainerEnabler() is invoked when a broker 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.

registerForDeletedBrokerConstrainerEnabler

void registerForDeletedBrokerConstrainerEnabler(Id brokerConstrainerEnablerId)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Registers for notification of a deleted broker constrainer enabler. BrokerConstrainerEnablerReceiver.deletedBrokerConstrainerEnabler() is invoked when the specified broker constrainer enabler is deleted or removed from this distributor.

Parameters:

brokerConstrainerEnablerId - the Id of the BrokerConstrainerEnabler to monitor

Throws:

NullArgumentException - brokerConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.