org.opendaylight.controller.config.persist.impl

Class PersisterAggregator

java.lang.Object

org.opendaylight.controller.config.persist.impl.PersisterAggregator

All Implemented Interfaces:

AutoCloseable, Persister

public final class PersisterAggregator
extends Object
implements Persister

Persister implementation that delegates persisting functionality to underlying Persister storages. Each storage has unique id, class, readonly value. Storage adapters are low level persisters that do the heavy lifting for this class. Instances of storage adapters can be injected directly via constructor or instantiated from a full name of its class provided in a properties file. Example configuration:

 netconf.config.persister.active=2,3
 # read startup configuration
 netconf.config.persister.1.storageAdapterClass=org.opendaylight.controller.config.persist.storage.directory.xml.XmlDirectoryStorageAdapter
 netconf.config.persister.1.properties.fileStorage=configuration/initial/

 netconf.config.persister.2.storageAdapterClass=org.opendaylight.controller.config.persist.storage.file.xml.XmlFileStorageAdapter
 netconf.config.persister.2.readonly=true
 netconf.config.persister.2.properties.fileStorage=configuration/current/controller.config.1.xml

 netconf.config.persister.3.storageAdapterClass=org.opendaylight.controller.config.persist.storage.file.xml.XmlFileStorageAdapter
 netconf.config.persister.3.properties.fileStorage=configuration/current/controller.config.2.xml
 netconf.config.persister.3.properties.numberOfBackups=3

 

During server startup ConfigPersisterNotificationHandler requests last snapshot from underlying storages. Each storage can respond by giving snapshot or absent response. The loadLastConfigs() will search for first non-absent response from storages ordered backwards as user specified (first '3', then '2'). When a commit notification is received, '2' will be omitted because readonly flag is set to true, so only '3' will have a chance to persist new configuration. If readonly was false or not specified, both storage adapters would be called in order specified by 'netconf.config.persister' property.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PersisterAggregator.PersisterWithConfiguration

Constructor Summary

Constructors

Constructor and Description
PersisterAggregator(List<PersisterAggregator.PersisterWithConfiguration> persisterWithConfigurations)

Method Summary

Modifier and Type	Method and Description
void	close()
static PersisterAggregator	createFromProperties(PropertiesProvider propertiesProvider)
List<ConfigSnapshotHolder>	loadLastConfigs()
void	persistConfig(ConfigSnapshotHolder holder)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PersisterAggregator

public PersisterAggregator(List<PersisterAggregator.PersisterWithConfiguration> persisterWithConfigurations)

Method Detail

createFromProperties

public static PersisterAggregator createFromProperties(PropertiesProvider propertiesProvider)

persistConfig

public void persistConfig(ConfigSnapshotHolder holder)
                   throws IOException

Specified by:

persistConfig in interface Persister

Throws:

IOException

loadLastConfigs

public List<ConfigSnapshotHolder> loadLastConfigs()

Specified by:

loadLastConfigs in interface Persister

Returns:

last non-empty result from input persisters

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Persister

toString

public String toString()

Overrides:

toString in class Object