org.openbase.jul.storage.registry

Class FileSynchronizedRegistryImpl<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,REGISTRY extends FileSynchronizedRegistry<KEY,ENTRY>>

java.lang.Object

org.openbase.jul.pattern.AbstractObservable<T>

org.openbase.jul.pattern.ObservableImpl<Map<KEY,ENTRY>>

org.openbase.jul.storage.registry.AbstractRegistry<KEY,ENTRY,MAP,REGISTRY,FileRegistryPlugin<KEY,ENTRY,REGISTRY>>

org.openbase.jul.storage.registry.FileSynchronizedRegistryImpl<KEY,ENTRY,MAP,REGISTRY>

Type Parameters:

KEY -

ENTRY -

MAP -

REGISTRY -

All Implemented Interfaces:

NameProvider, Shutdownable, Writable, org.openbase.jul.pattern.Observable<Map<KEY,ENTRY>>, FileSynchronizedRegistry<KEY,ENTRY>, Registry<KEY,ENTRY>

Direct Known Subclasses:

ProtoBufFileSynchronizedRegistry

public class FileSynchronizedRegistryImpl<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,REGISTRY extends FileSynchronizedRegistry<KEY,ENTRY>>
extends AbstractRegistry<KEY,ENTRY,MAP,REGISTRY,FileRegistryPlugin<KEY,ENTRY,REGISTRY>>
implements FileSynchronizedRegistry<KEY,ENTRY>

Author:

Divine Threepwood

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileSynchronizedRegistryImpl.DatabaseState

Nested classes/interfaces inherited from interface org.openbase.jul.iface.Shutdownable

Shutdownable.ShutdownDeamon

Field Summary

Fields inherited from class org.openbase.jul.storage.registry.AbstractRegistry

consistent, logger, pluginPool, sandbox

Fields inherited from class org.openbase.jul.pattern.ObservableImpl

VALUE_LOCK

Fields inherited from class org.openbase.jul.pattern.AbstractObservable

latestValueHash, observers, unchangedValueFilter

Fields inherited from interface org.openbase.jul.iface.provider.NameProvider

TYPE_FIELD_NAME

Constructor Summary

Constructors

Constructor and Description
FileSynchronizedRegistryImpl(MAP entryMap, File databaseDirectory, FileProcessor<ENTRY> fileProcessor, FileProvider<Identifiable<KEY>> fileProvider)
FileSynchronizedRegistryImpl(MAP entryMap, File databaseDirectory, FileProcessor<ENTRY> fileProcessor, FileProvider<Identifiable<KEY>> fileProvider, FileRegistryPluginPool<KEY,ENTRY,FileRegistryPlugin<KEY,ENTRY,REGISTRY>,REGISTRY> filePluginPool)

Method Summary

Modifier and Type	Method and Description
void	activateVersionControl(String entryType, Package converterPackage) This method activates the version control unit of the underlying registry db.
protected void	afterConsistencyCheck() Can be overwritten for further registry actions scheduled after consistency checks.
void	checkWriteAccess()
void	clear()
File	getDatabaseDirectory()
String	getDatabaseName()
FileSynchronizedRegistryImpl.DatabaseState	getDatabaseState()
Integer	getDBVersion()
boolean	isConsistent()
boolean	isOutdated()
void	loadRegistry()
ENTRY	register(ENTRY entry) Method registers the given entry.
ENTRY	remove(ENTRY entry)
void	saveRegistry()
void	shutdown()
ENTRY	update(ENTRY entry)

Methods inherited from class org.openbase.jul.storage.registry.AbstractRegistry

addDependencyObserver, checkConsistency, contains, contains, finishTransaction, get, getEntries, getEntryMap, getEntryMapClass, getName, info, isBusy, isBusyByCurrentThread, isDependingOnConsistentRegistries, isEmpty, isReadOnly, isReady, isSandbox, isWriteLockedByCurrentThread, load, lock, log, log, log, notifyObservers, recursiveTryLockRegistry, registerConsistencyHandler, registerDependency, registerPlugin, remove, removeAllDependencies, removeConsistencyHandler, removeDependency, removeDependencyObserver, replaceInternalMap, replaceInternalMap, setName, setupSandbox, size, superRemove, toString, tryLockRegistry, unlock, unlockRegistry, verifyID, verifyID

Methods inherited from class org.openbase.jul.pattern.ObservableImpl

applyValueUpdate, getValue, getValueFuture, isValueAvailable, waitForValue

Methods inherited from class org.openbase.jul.pattern.AbstractObservable

addObserver, isNotificationInProgess, notifyObservers, notifyObservers, removeObserver, setExecutorService, setHashGenerator, waitUntilNotificationIsFinished

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openbase.jul.storage.registry.Registry

addDependencyObserver, contains, contains, get, get, getEntries, getEntryMap, getName, isEmpty, isEmtpy, isReadOnly, isReady, isSandbox, recursiveTryLockRegistry, remove, removeDependencyObserver, size, tryLockRegistry, unlockRegistry

Methods inherited from interface org.openbase.jul.iface.Writable

isWritable

Methods inherited from interface org.openbase.jul.pattern.Observable

addObserver, getLatestValue, getValue, getValueFuture, isValueAvailable, removeObserver, waitForValue, waitForValue

Methods inherited from interface org.openbase.jul.iface.Shutdownable

registerShutdownHook, registerShutdownHook

Constructor Detail

FileSynchronizedRegistryImpl

public FileSynchronizedRegistryImpl(MAP entryMap,
                                    File databaseDirectory,
                                    FileProcessor<ENTRY> fileProcessor,
                                    FileProvider<Identifiable<KEY>> fileProvider)
                             throws InstantiationException,
                                    InterruptedException

Throws:

InstantiationException

InterruptedException

FileSynchronizedRegistryImpl

public FileSynchronizedRegistryImpl(MAP entryMap,
                                    File databaseDirectory,
                                    FileProcessor<ENTRY> fileProcessor,
                                    FileProvider<Identifiable<KEY>> fileProvider,
                                    FileRegistryPluginPool<KEY,ENTRY,FileRegistryPlugin<KEY,ENTRY,REGISTRY>,REGISTRY> filePluginPool)
                             throws InstantiationException,
                                    InterruptedException

Throws:

InstantiationException

InterruptedException

Method Detail

getDatabaseName

public String getDatabaseName()

activateVersionControl

public void activateVersionControl(String entryType,
                                   Package converterPackage)
                            throws CouldNotPerformException

This method activates the version control unit of the underlying registry db. The version check and db upgrade is automatically performed during the registry db loading phrase. The db will be upgraded to the latest db format provided by the given converter package. The converter package should contain only classes implementing the DBVersionConverter interface. To fully support outdated db upgrade make sure that the converter pipeline covers the whole version range!

Activate version control before loading the registry. Please provide within the converter package only converter with the naming structure [$(EntryType)_$(VersionN)_To_$(VersionN+1)_DBConverter].

Example:

converter package myproject.db.converter containing the converter pipeline

myproject.db.converter.DeviceConfig_0_To_1_DBConverter.class myproject.db.converter.DeviceConfig_1_To_2_DBConverter.class myproject.db.converter.DeviceConfig_2_To_3_DBConverter.class

Would support the db upgrade from version 0 till the latest db version 3.

Parameters:

entryType -

converterPackage - the package containing all converter which provides db entry updates from the first to the latest db version.

Throws:

CouldNotPerformException - in case of an invalid converter pipeline or initialization issues.

register

public ENTRY register(ENTRY entry)
               throws CouldNotPerformException

Description copied from class: AbstractRegistry

Method registers the given entry.

Specified by:

register in interface Registry<KEY,ENTRY extends Identifiable<KEY>>

Overrides:

register in class AbstractRegistry<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,REGISTRY extends FileSynchronizedRegistry<KEY,ENTRY>,FileRegistryPlugin<KEY,ENTRY extends Identifiable<KEY>,REGISTRY extends FileSynchronizedRegistry<KEY,ENTRY>>>

Parameters:

entry - the new entry to register which is not yet included in the registry

Returns:

the registered entry updated by all consistency checks this registry provides.

Throws:

CouldNotPerformException - is thrown if the given entry is not valid, already registered or something else went wrong during the registration.

update

public ENTRY update(ENTRY entry)
             throws CouldNotPerformException

Description copied from class: AbstractRegistry

Specified by:

update in interface Registry<KEY,ENTRY extends Identifiable<KEY>>

Overrides:

update in class AbstractRegistry<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,REGISTRY extends FileSynchronizedRegistry<KEY,ENTRY>,FileRegistryPlugin<KEY,ENTRY extends Identifiable<KEY>,REGISTRY extends FileSynchronizedRegistry<KEY,ENTRY>>>

Parameters:

entry -

Returns:

Throws:

CouldNotPerformException

remove

public ENTRY remove(ENTRY entry)
             throws CouldNotPerformException

Description copied from class: AbstractRegistry

Specified by:

remove in interface Registry<KEY,ENTRY extends Identifiable<KEY>>

Overrides:

remove in class AbstractRegistry<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,REGISTRY extends FileSynchronizedRegistry<KEY,ENTRY>,FileRegistryPlugin<KEY,ENTRY extends Identifiable<KEY>,REGISTRY extends FileSynchronizedRegistry<KEY,ENTRY>>>

Parameters:

entry -

Returns:

Throws:

CouldNotPerformException

clear

public void clear()
           throws CouldNotPerformException

Description copied from class: AbstractRegistry

Specified by:

clear in interface Registry<KEY,ENTRY extends Identifiable<KEY>>

Overrides:

clear in class AbstractRegistry<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,REGISTRY extends FileSynchronizedRegistry<KEY,ENTRY>,FileRegistryPlugin<KEY,ENTRY extends Identifiable<KEY>,REGISTRY extends FileSynchronizedRegistry<KEY,ENTRY>>>

Throws:

CouldNotPerformException

afterConsistencyCheck

protected void afterConsistencyCheck()
                              throws CouldNotPerformException

Description copied from class: AbstractRegistry

Can be overwritten for further registry actions scheduled after consistency checks.

Don't forgett to pass-througt the call to the super class. (super.afterConsistencyCheck())

Overrides:

afterConsistencyCheck in class AbstractRegistry<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,REGISTRY extends FileSynchronizedRegistry<KEY,ENTRY>,FileRegistryPlugin<KEY,ENTRY extends Identifiable<KEY>,REGISTRY extends FileSynchronizedRegistry<KEY,ENTRY>>>

Throws:

CouldNotPerformException - is thrown if any plugin afterConsistencyCheck fails.

loadRegistry

public void loadRegistry()
                  throws CouldNotPerformException

Specified by:

loadRegistry in interface FileSynchronizedRegistry<KEY,ENTRY extends Identifiable<KEY>>

Throws:

CouldNotPerformException

saveRegistry

public void saveRegistry()
                  throws MultiException

Specified by:

saveRegistry in interface FileSynchronizedRegistry<KEY,ENTRY extends Identifiable<KEY>>

Throws:

MultiException

checkWriteAccess

public void checkWriteAccess()
                      throws RejectedException

Description copied from class: AbstractRegistry

Specified by:

checkWriteAccess in interface Writable

Overrides:

checkWriteAccess in class AbstractRegistry<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,REGISTRY extends FileSynchronizedRegistry<KEY,ENTRY>,FileRegistryPlugin<KEY,ENTRY extends Identifiable<KEY>,REGISTRY extends FileSynchronizedRegistry<KEY,ENTRY>>>

Throws:

RejectedException

shutdown

public void shutdown()

Description copied from class: AbstractRegistry

Specified by:

shutdown in interface Shutdownable

Overrides:

shutdown in class AbstractRegistry<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,REGISTRY extends FileSynchronizedRegistry<KEY,ENTRY>,FileRegistryPlugin<KEY,ENTRY extends Identifiable<KEY>,REGISTRY extends FileSynchronizedRegistry<KEY,ENTRY>>>

getDatabaseDirectory

public File getDatabaseDirectory()

Specified by:

getDatabaseDirectory in interface FileSynchronizedRegistry<KEY,ENTRY extends Identifiable<KEY>>

getDBVersion

public Integer getDBVersion()

Specified by:

getDBVersion in interface FileSynchronizedRegistry<KEY,ENTRY extends Identifiable<KEY>>

isConsistent

public boolean isConsistent()

Description copied from class: AbstractRegistry

Specified by:

isConsistent in interface Registry<KEY,ENTRY extends Identifiable<KEY>>

Overrides:

isConsistent in class AbstractRegistry<KEY,ENTRY extends Identifiable<KEY>,MAP extends Map<KEY,ENTRY>,REGISTRY extends FileSynchronizedRegistry<KEY,ENTRY>,FileRegistryPlugin<KEY,ENTRY extends Identifiable<KEY>,REGISTRY extends FileSynchronizedRegistry<KEY,ENTRY>>>

Returns:

isOutdated

public boolean isOutdated()

getDatabaseState

public FileSynchronizedRegistryImpl.DatabaseState getDatabaseState()