org.osid.provisioning

Interface RequestNotificationSession

All Superinterfaces:

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

public interface RequestNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Request objects in this Distributor. This also includes existing requests that may appear or disappear due to changes in the Dstributor 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 RequestLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForRequestNotifications() Tests if this user can register for Request notifications.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
void	registerForChangedRequest(Id requestId) Registers for notification of an updated request.
void	registerForChangedRequests() Registers for notification of updated requests.
void	registerForChangedRequestsForQueue(Id queueId) Register for notifications of updated requests for the given queue Id.
void	registerForChangedRequestsForResource(Id resourceId) Register for notifications of updated requests for the given resource Id.
void	registerForDeletedRequest(Id requestId) Registers for notification of a deleted request.
void	registerForDeletedRequests() Registers for notification of deleted requests.
void	registerForDeletedRequestsForQueue(Id queueId) Register for notifications of deleted requests for the given queue Id.
void	registerForDeletedRequestsForResource(Id resourceId) Register for notifications of deleted requests for the given resource Id.
void	registerForNewRequests() Register for notifications of new requests.
void	registerForNewRequestsForQueue(Id queueId) Register for notifications of new requests for the given queue Id.
void	registerForNewRequestsForResource(Id resourceId) Register for notifications of new requests for the given resource Id.
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.

canRegisterForRequestNotifications

boolean canRegisterForRequestNotifications()

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

registerForNewRequests

void registerForNewRequests()
                            throws OperationFailedException,
                                   PermissionDeniedException

Register for notifications of new requests. RequestReceiver.newRequests() is invoked when a new Request appears in this distributor.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewRequestsForResource

void registerForNewRequestsForResource(Id resourceId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Register for notifications of new requests for the given resource Id. RequestReceiver.newRequests() is invoked when a new Request is created.

Parameters:

resourceId - the Id of the resource to monitor

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewRequestsForQueue

void registerForNewRequestsForQueue(Id queueId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Register for notifications of new requests for the given queue Id. RequestReceiver.newRequests() is invoked when a new Request is created.

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.

registerForChangedRequests

void registerForChangedRequests()
                                throws OperationFailedException,
                                       PermissionDeniedException

Registers for notification of updated requests. RequestReceiver.changedRequests() is invoked when a request in this distributor is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedRequestsForResource

void registerForChangedRequestsForResource(Id resourceId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Register for notifications of updated requests for the given resource Id. RequestReceiver.changedRequests() is invoked when a Request in this distributor is changed.

Parameters:

resourceId - the Id of the resource to monitor

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedRequestsForQueue

void registerForChangedRequestsForQueue(Id queueId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Register for notifications of updated requests for the given queue Id. RequestReceiver.changedRequests() is invoked when a Request 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.

registerForChangedRequest

void registerForChangedRequest(Id requestId)
                               throws OperationFailedException,
                                      PermissionDeniedException

Registers for notification of an updated request. RequestReceiver.changedRequests() is invoked when the specified request in this distributor is changed.

Parameters:

requestId - the Id of the Request to monitor

Throws:

NullArgumentException - requestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedRequests

void registerForDeletedRequests()
                                throws OperationFailedException,
                                       PermissionDeniedException

Registers for notification of deleted requests. RequestReceiver.deletedRequests() is invoked when a request is deleted or removed from this distributor.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedRequestsForResource

void registerForDeletedRequestsForResource(Id resourceId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Register for notifications of deleted requests for the given resource Id. RequestReceiver.deletedRequests() is invoked when a Request is deleted or removed from this distributor.

Parameters:

resourceId - the Id of the resource to monitor

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedRequestsForQueue

void registerForDeletedRequestsForQueue(Id queueId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Register for notifications of deleted requests for the given queue Id. RequestReceiver.deletedRequests() is invoked when a Request 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.

registerForDeletedRequest

void registerForDeletedRequest(Id requestId)
                               throws OperationFailedException,
                                      PermissionDeniedException

Registers for notification of a deleted request. RequestReceiver.deletedRequests() is invoked when the specified request is deleted or removed from this distributor.

Parameters:

requestId - the Id of the Request to monitor

Throws:

NullArgumentException - requestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.