public interface ParameterProcessorNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to ParameterProcessor
objects in this Configuration.
This also includes existing ParameterProcessors
that may appear or disappear due to changes in the Configuration
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
ParameterProcessorLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeParameterProcessorNotification(Id notificationId)
Acknowledge a parameter processor notification.
|
boolean |
canRegisterForParameterProcessorNotifications()
Tests if this user can register for
ParameterProcessor
notifications. |
Configuration |
getConfiguration()
Gets the
Configuration associated with this session. |
Id |
getConfigurationId()
Gets the
Configuration Id associated
with this session. |
void |
registerForChangedParameterProcessor(Id parameterProcessorId)
Registers for notification of an updated parameter processor.
|
void |
registerForChangedParameterProcessors()
Registers for notification of updated parameter processors.
|
void |
registerForDeletedParameterProcessor(Id parameterProcessorId)
Registers for notification of a deleted parameter processor.
|
void |
registerForDeletedParameterProcessors()
Registers for notification of deleted parameter processors.
|
void |
registerForNewParameterProcessors()
Register for notifications of new parameter processors.
|
void |
reliableParameterProcessorNotifications()
Reliable notifications are desired.
|
void |
unreliableParameterProcessorNotifications()
Unreliable notifications are desired.
|
void |
useFederatedConfigurationView()
Federates the view for methods in this session.
|
void |
useIsolatedConfigurationView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getConfigurationId()
Configuration
Id
associated
with this session. Configuration Id
associated with this
sessionmandatory
- This method must be implemented. Configuration getConfiguration() throws OperationFailedException, PermissionDeniedException
Configuration
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForParameterProcessorNotifications()
ParameterProcessor
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedConfigurationView()
mandatory
- This method is must be implemented. void useIsolatedConfigurationView()
mandatory
- This method is must be implemented. void reliableParameterProcessorNotifications()
acknowledgeParameterProcessorNotification()
.mandatory
- This method is must be implemented. void unreliableParameterProcessorNotifications()
mandatory
- This method is must be implemented. void acknowledgeParameterProcessorNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewParameterProcessors() throws OperationFailedException, PermissionDeniedException
ParameterProcessorReceiver.newParameterProcessors()
is invoked
when a new ParameterProcessor
appears in this
configuration.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedParameterProcessors() throws OperationFailedException, PermissionDeniedException
ParameterProcessorReceiver.changedParameterProcessors()
is
invoked when a parameter processor in this configuration is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedParameterProcessor(Id parameterProcessorId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedParameterProcessors()
is invoked
when the specified parameter processor in this configuration is
changed.parameterProcessorId
- the Id
of the
ParameterProcessor
to monitorNullArgumentException
- parameterProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedParameterProcessors() throws OperationFailedException, PermissionDeniedException
ParameterProcessorReceiver.deletedParameterProcessors()
is
invoked when a parameter processor is deleted or removed from this
configuration.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedParameterProcessor(Id parameterProcessorId) throws OperationFailedException, PermissionDeniedException
ParameterProcessorReceiver.deletedParameterProcessors()
is
invoked when the specified parameter processor is deleted or removed
from this configuration.parameterProcessorId
- the Id
of the
ParameterProcessor
to monitorNullArgumentException
- parameterProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.