org.openbase.jul.storage.registry.version

Class DBVersionControl

java.lang.Object

org.openbase.jul.storage.registry.version.DBVersionControl

public class DBVersionControl
extends Object

Author:

Divine Threepwood

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLIED_VERSION_CONSISTENCY_HANDLER_FIELD
static String	DB_CONVERTER_PACKAGE_NAME
protected org.slf4j.Logger	logger
static String	VERSION_FIELD
static String	VERSION_FILE_NAME
static String	VERSION_FILE_WARNING

Constructor Summary

Constructors

Constructor and Description
DBVersionControl(String entryType, FileProvider entryFileProvider, Package converterPackage, File databaseDirectory)
DBVersionControl(String entryType, FileProvider entryFileProvider, Package converterPackage, File databaseDirectory, Writable databaseWriteAccess)

Method Summary

Modifier and Type	Method and Description
int	detectAndUpgradeCurrentDBVersion() Method detects the current db version and returns the version number as integer.
int	detectCurrentDBVersion(File databaseDirectory) Method detects the current db version of the given database.
Set<String>	detectExecutedVersionConsistencyHandler() Method detects the already executed version consistency handler which are registered within the db version file.
String	formatEntryToHumanReadableString(com.google.gson.JsonObject jsonEntry)
Package	getConverterPackage()
List<DBVersionConverter>	getConverterPipeline()
File	getDatabaseDirectory()
List<DBVersionConverter>	getDBConverterPipeline(int currentVersion, int targetVersion) Method returns a db entry converter pipeline which supports the db entry version conversion from the current to the target version.
FileProvider	getEntryFileProvider()
int	getLatestDBVersion()
List<ConsistencyHandler>	loadDBVersionConsistencyHandlers(FileSynchronizedRegistry registry) Loads a consistency handler list which is used for consistency reconstruction after a db upgrade.
void	registerConsistencyHandlerExecution(ConsistencyHandler versionConsistencyHandler) Method upgrades the applied db version consistency handler list of the version file.
void	storeEntry(String entryAsString, File entryFile)
void	upgradeCurrentDBVersion() Method upgrades the current db version to the latest db version.
void	upgradeDB(int currentVersion, int targetVersion)
com.google.gson.JsonObject	upgradeDBEntry(com.google.gson.JsonObject entry, DBVersionConverter converter, Map<File,com.google.gson.JsonObject> dbSnapshot, Map<String,Map<File,DatabaseEntryDescriptor>> globalDbSnapshots)
void	validateAndUpgradeDBVersion()

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_FILE_NAME

public static final String VERSION_FILE_NAME

See Also:

Constant Field Values

VERSION_FIELD

public static final String VERSION_FIELD

See Also:

Constant Field Values

DB_CONVERTER_PACKAGE_NAME

public static final String DB_CONVERTER_PACKAGE_NAME

See Also:

Constant Field Values

APPLIED_VERSION_CONSISTENCY_HANDLER_FIELD

public static final String APPLIED_VERSION_CONSISTENCY_HANDLER_FIELD

See Also:

Constant Field Values

VERSION_FILE_WARNING

public static final String VERSION_FILE_WARNING

See Also:

Constant Field Values

logger

protected final org.slf4j.Logger logger

Constructor Detail

DBVersionControl

public DBVersionControl(String entryType,
                        FileProvider entryFileProvider,
                        Package converterPackage,
                        File databaseDirectory,
                        Writable databaseWriteAccess)
                 throws InstantiationException

Throws:

InstantiationException

DBVersionControl

public DBVersionControl(String entryType,
                        FileProvider entryFileProvider,
                        Package converterPackage,
                        File databaseDirectory)
                 throws InstantiationException

Throws:

InstantiationException

Method Detail

validateAndUpgradeDBVersion

public void validateAndUpgradeDBVersion()
                                 throws CouldNotPerformException

Throws:

CouldNotPerformException

upgradeDB

public void upgradeDB(int currentVersion,
                      int targetVersion)
               throws CouldNotPerformException

Throws:

CouldNotPerformException

upgradeDBEntry

public com.google.gson.JsonObject upgradeDBEntry(com.google.gson.JsonObject entry,
                                                 DBVersionConverter converter,
                                                 Map<File,com.google.gson.JsonObject> dbSnapshot,
                                                 Map<String,Map<File,DatabaseEntryDescriptor>> globalDbSnapshots)
                                          throws CouldNotPerformException

Throws:

CouldNotPerformException

formatEntryToHumanReadableString

public String formatEntryToHumanReadableString(com.google.gson.JsonObject jsonEntry)
                                        throws CouldNotPerformException

Parameters:

jsonEntry -

Returns:

Throws:

CouldNotPerformException

storeEntry

public void storeEntry(String entryAsString,
                       File entryFile)
                throws CouldNotPerformException

Throws:

CouldNotPerformException

getLatestDBVersion

public int getLatestDBVersion()

detectCurrentDBVersion

public int detectCurrentDBVersion(File databaseDirectory)
                           throws CouldNotPerformException

Method detects the current db version of the given database.

Parameters:

databaseDirectory -

Returns:

the current db version as integer.

Throws:

CouldNotPerformException

detectAndUpgradeCurrentDBVersion

public int detectAndUpgradeCurrentDBVersion()
                                     throws CouldNotPerformException

Method detects the current db version and returns the version number as integer.

Returns:

Throws:

CouldNotPerformException

upgradeCurrentDBVersion

public void upgradeCurrentDBVersion()
                             throws CouldNotPerformException

Method upgrades the current db version to the latest db version.

Throws:

CouldNotPerformException

getDBConverterPipeline

public List<DBVersionConverter> getDBConverterPipeline(int currentVersion,
                                                       int targetVersion)
                                                throws CouldNotPerformException

Method returns a db entry converter pipeline which supports the db entry version conversion from the current to the target version.

Parameters:

currentVersion -

targetVersion -

Returns:

Throws:

CouldNotPerformException

loadDBVersionConsistencyHandlers

public List<ConsistencyHandler> loadDBVersionConsistencyHandlers(FileSynchronizedRegistry registry)
                                                          throws CouldNotPerformException

Loads a consistency handler list which is used for consistency reconstruction after a db upgrade.

Parameters:

registry -

Returns:

the consistency handler list.

Throws:

CouldNotPerformException

registerConsistencyHandlerExecution

public void registerConsistencyHandlerExecution(ConsistencyHandler versionConsistencyHandler)
                                         throws CouldNotPerformException

Method upgrades the applied db version consistency handler list of the version file.

Parameters:

versionConsistencyHandler -

Throws:

CouldNotPerformException

detectExecutedVersionConsistencyHandler

public Set<String> detectExecutedVersionConsistencyHandler()
                                                    throws CouldNotPerformException

Method detects the already executed version consistency handler which are registered within the db version file.

Returns:

Throws:

CouldNotPerformException

getConverterPackage

public Package getConverterPackage()

getConverterPipeline

public List<DBVersionConverter> getConverterPipeline()

getEntryFileProvider

public FileProvider getEntryFileProvider()

getDatabaseDirectory

public File getDatabaseDirectory()