org.lsst.ccs

Interface ConfigurationListener

All Known Implementing Classes:

ConfigurationDAOWrapper

public interface ConfigurationListener

A Configuration listener interface. Register it with the ConfigurationService and be notified when there are configuration changes within the agent.

Author:

The LSST CCS Team

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ConfigurationListener.ConfigurationOperation The type of configuration operation that lead to the ConfigurationListener notification.

Method Summary

Modifier and Type	Method and Description
default void	configurationChanged(ConfigurationInfo newConfigurationInfo, ConfigurationInfo oldConfigurationInfo, ConfigurationListener.ConfigurationOperation configurationOperation) Call back method when there have been configuration changes performed on this agent.
default void	configurationChanged(ConfigurationInfo configurationInfo, ConfigurationListener.ConfigurationOperation configurationOperation) Deprecated.
default void	failedConfigurationOperation(ConfigurationInfo configurationInfo, ConfigurationListener.ConfigurationOperation configurationOperation, Exception ex)

Method Detail

configurationChanged

default void configurationChanged(ConfigurationInfo newConfigurationInfo,
                                  ConfigurationInfo oldConfigurationInfo,
                                  ConfigurationListener.ConfigurationOperation configurationOperation)

Call back method when there have been configuration changes performed on this agent. This callback is executed on the ACTION thread on which user commands are executed. For this reason no time consuming operations should be performed in this method. Any thrown exception will be caught and logged but it will not affect the outcome of the configuration command. To get the difference between the old and the new configuration use ConfigurationInfo#diff on the new ConfigurationInfo object with the old ConfigurationInfo as its argument.

Parameters:

newConfigurationInfo - The current ConfigurationInfo object. It reflects the latest configuration information.

oldConfigurationInfo - The previous ConfigurationInfo object. It reflects the overall configuration before the changes.

configurationOperation - The type of configuration operation that was performed.

configurationChanged

@Deprecated
default void configurationChanged(ConfigurationInfo configurationInfo,
                                              ConfigurationListener.ConfigurationOperation configurationOperation)

Deprecated.

failedConfigurationOperation

default void failedConfigurationOperation(ConfigurationInfo configurationInfo,
                                          ConfigurationListener.ConfigurationOperation configurationOperation,
                                          Exception ex)