org.codice.ddf.admin.configuration

Class ConfigurationUpdater

java.lang.Object

org.codice.ddf.admin.configuration.ConfigurationUpdater

All Implemented Interfaces:

ConfigurationPersistencePlugin

public class ConfigurationUpdater
extends Object
implements ConfigurationPersistencePlugin

Addresses shortcomings of the Felix ConfigInstaller with our own implementation that properly updates the etc directory.

This configuration installer handles writeback like the Felix one did and does a few other things:

• Removes files from etc when they are deleted from ConfigurationAdmin
• Protects against tampering with the felix.fileinstall.filename by third parties, which could disrupt the dropping of config files
• Ensures password fields in config files are encrypted

Handling writeback means running this class handles the updating of dropped-in config files in the etc directory. To keep Felix itself from disrupting this process, enableConfigSave in custom.properties should be set to false.

Constructor Summary

Constructors

Constructor and Description
ConfigurationUpdater(ConfigurationAdmin ddfConfigAdmin, List strategies, EncryptionService encryptionService)

Method Summary

Modifier and Type	Method and Description
void	handleDelete(String pid) Given the pid of a configuration about to be deleted, perform processing before the configuration is deleted.
void	handleStore(ConfigurationContext context) Given the ConfigurationContext of a configuration about to be written, perform processing before the results get stored.
void	initialize(Set<ConfigurationContext> state) Provide an initialization hook for synchronous resource allocation after a plugin is available to be called, unlike an OSGi life-cycle init() method, which is called prior to the service becoming available.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationUpdater

public ConfigurationUpdater(ConfigurationAdmin ddfConfigAdmin,
                            List strategies,
                            EncryptionService encryptionService)

Method Detail

initialize

public void initialize(Set<ConfigurationContext> state)

Description copied from interface: ConfigurationPersistencePlugin

Provide an initialization hook for synchronous resource allocation after a plugin is available to be called, unlike an OSGi life-cycle init() method, which is called prior to the service becoming available.

Specified by:

initialize in interface ConfigurationPersistencePlugin

Parameters:

state - the current configuration state of the system.

See Also:

ConfigurationPersistencePlugin

handleStore

public void handleStore(ConfigurationContext context)
                 throws IOException

Description copied from interface: ConfigurationPersistencePlugin

Given the ConfigurationContext of a configuration about to be written, perform processing before the results get stored.

Specified by:

handleStore in interface ConfigurationPersistencePlugin

Parameters:

context - an object of relevant info that is safe to access during a config operation.

Throws:

IOException - to abort the configuration update operation and indicate to the user that it failed.

handleDelete

public void handleDelete(String pid)
                  throws IOException

Given the pid of a configuration about to be deleted, perform processing before the configuration is deleted.

Remove config files from etc when a delete occurs but only if felix is tracking the file.

Specified by:

handleDelete in interface ConfigurationPersistencePlugin

Parameters:

pid - the pid pointing to the configuration to delete.

Throws:

IOException - to abort the configuration delete operation and indicate to the user that it failed.