public interface ConfigurationNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Configurations.
Notrifications related to adding or
removing of parameters are handled through the
ValueNotificationSession.
This session is intended for adapters
and providers needing to synchronize their state with this service without
the use of polling. Notifications are cancelled when this session is
closed.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForConfigurationNotifications()
Tests if this user can register for
Configuration
notifications. |
void |
registerForChangedConfiguration(Id configurationId)
Registers for notifications of an update to a configuration.
|
void |
registerForChangedConfigurations()
Registers for notification of updated configurations.
|
void |
registerForDeletedConfiguration(Id configurationId)
Registers for notifications of a deleted configuration.
|
void |
registerForDeletedConfigurationAncestors(Id configurationId)
Registers for notification if an ancestor is removed from the
specified configuration in the configuration hierarchy.
|
void |
registerForDeletedConfigurationDescendants(Id configurationId)
Registers for notification if a descendant is removed from fthe
specified configuration in the configuration hierarchy.
|
void |
registerForDeletedConfigurations()
Registers for notification of deleted configurations.
|
void |
registerForNewConfigurationAncestors(Id configurationId)
Registers for notification if an ancestor is added to the specified
configuration in the configuration hierarchy.
|
void |
registerForNewConfigurationDescendants(Id configurationId)
Registers for notification if a descendant is added to the specified
configuration in the configuration hierarchy.
|
void |
registerForNewConfigurations()
Registers for notifications of new configurations.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForConfigurationNotifications()
Configuration
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 registerForNewConfigurations() throws OperationFailedException, PermissionDeniedException
ConfigurationReceiver.newConfiguration()
is invoked when a new
Configuration
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewConfigurationAncestors(Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ConfigurationReceiver.newConfigurationAncestor()
is invoked
when the specified configuration experiences an addition in ancestry.configurationId
- the Id
of the configuration to
monitorNotFoundException
- a configuration was not found
identified by the given Id
NullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewConfigurationDescendants(Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ConfigurationReceiver.newConfigurationDescendant()
is invoked
when the specified configuration experiences an addition in
descendants.configurationId
- the Id
of the configuration to
monitorNotFoundException
- a configuration was not found
identified by the given Id
NullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedConfigurations() throws OperationFailedException, PermissionDeniedException
ConfigurationReceiver.changedConfiguration()
is invoked when a
configuration is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedConfiguration(Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ConfigurationReceiver.changedConfiguration()
is invoked when
the specified Configuration
is changed.configurationId
- the Id
of the
Configuration
to monitorNotFoundException
- a Configuration
was
not found identified by the given Id
NullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedConfigurations() throws OperationFailedException, PermissionDeniedException
ConfigurationReceiver.deletedConfiguration()
is invoked when a
Configuration
is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedConfiguration(Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ConfiguratinReceiver.deletedConfiguration()
is invoked when
the specified configuration is deleted.configurationId
- the Id
of the
Configuration
to monitorNotFoundException
- a Configuration
was
not found identified by the given Id
NullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedConfigurationAncestors(Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ConfigurationReceiver.deletedConfigurationAncestor()
is
invoked when the specified configuration experiences a removal of an
ancestor.configurationId
- the Id
of the configuration to
monitorNotFoundException
- a configuration was not found
identified by the given Id
NullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedConfigurationDescendants(Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ConfigurationReceiver.deletedConfigurationDescendant()
is
invoked when the specified configuration experiences a removal of one
of its descdendents.configurationId
- the Id
of the configuration to
monitorNotFoundException
- a configuration was not found
identified by the given Id
NullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.