org.lsst.ccs

Class ConfigurationDAOWrapper

java.lang.Object

org.lsst.ccs.ConfigurationDAOWrapper

All Implemented Interfaces:

ConfigurationListener, HasLifecycle

public class ConfigurationDAOWrapper
extends Object
implements HasLifecycle, ConfigurationListener

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.ConfigurationListener

ConfigurationListener.ConfigurationOperation

Method Summary

Modifier and Type	Method and Description
void	build() First lifecycle hook.
void	configurationChanged(ConfigurationInfo newConfigurationInfo, ConfigurationInfo oldConfigurationInfo, ConfigurationListener.ConfigurationOperation configurationOperation) Call back method when there have been configuration changes performed on this agent.
Set<String>	findAvailableConfigurationsForCategory(String category)
Properties	getConfigurationProperties(String tag, String category)
void	init() Called from the enclosing Subsystem at initialization phase.
boolean	isAvailable()
ConfigurationView	loadConfiguration(ConfigurationDescription configDescription)
ConfigurationView	loadGlobalConfiguration(String name, int version)
String	locateConfigurations(ConfigurationInfo configInfo)
ConfigurationDescription	registerConfiguration(ConfigurationInfo configInfo)
ConfigurationDescription	saveChangesForCategoriesAs(ConfigurationDescription configDesc, ConfigurationInfo configInfo, boolean fullConfiguration)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle

postBuild, postInit, postShutdown, postStart, shutdown, start

Methods inherited from interface org.lsst.ccs.ConfigurationListener

configurationChanged

Method Detail

build

public void build()

Description copied from interface: HasLifecycle

First lifecycle hook. Modification of the component tree is allowed at this stage. After this stage the tree of component cannot be modified anymore. This is where agent periodic tasks should be scheduled.

Specified by:

build in interface HasLifecycle

init

public void init()

Description copied from interface: HasLifecycle

Called from the enclosing Subsystem at initialization phase.

This method is called before the children components of this object have their init method called.

At the time it is called, connection to the messaging layer is not yet done, so there should be no attempt to send messages in the body of this method. Configuration for message listening can nevertheless be done here, such as adding MessageListener objects.

It is unnecessary to call super.init()

Specified by:

init in interface HasLifecycle

getConfigurationProperties

public Properties getConfigurationProperties(String tag,
                                             String category)
                                      throws ConfigurationServiceException

Throws:

ConfigurationServiceException

loadConfiguration

public ConfigurationView loadConfiguration(ConfigurationDescription configDescription)
                                    throws ConfigurationServiceException

Throws:

ConfigurationServiceException

loadGlobalConfiguration

public ConfigurationView loadGlobalConfiguration(String name,
                                                 int version)

saveChangesForCategoriesAs

public ConfigurationDescription saveChangesForCategoriesAs(ConfigurationDescription configDesc,
                                                           ConfigurationInfo configInfo,
                                                           boolean fullConfiguration)
                                                    throws ConfigurationServiceException

Throws:

ConfigurationServiceException

registerConfiguration

public ConfigurationDescription registerConfiguration(ConfigurationInfo configInfo)
                                               throws ConfigurationServiceException

Throws:

ConfigurationServiceException

isAvailable

public boolean isAvailable()

findAvailableConfigurationsForCategory

public Set<String> findAvailableConfigurationsForCategory(String category)

locateConfigurations

public String locateConfigurations(ConfigurationInfo configInfo)

configurationChanged

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

Description copied from interface: ConfigurationListener

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.

Specified by:

configurationChanged in interface ConfigurationListener

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.