org.openbase.jul.storage.registry

Class ProtoBufFileSynchronizedRegistry<KEY extends Comparable<KEY>,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>,SIB extends com.google.protobuf.GeneratedMessage.Builder<SIB>>

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,IdentifiableMessage<KEY,M,MB>,ProtoBufMessageMap<KEY,M,MB>,ProtoBufRegistry<KEY,M,MB>>

org.openbase.jul.storage.registry.ProtoBufFileSynchronizedRegistry<KEY,M,MB,SIB>

Type Parameters:

KEY -

M - Message

MB - Message Builder

SIB - Synchronized internal builder

All Implemented Interfaces:

NameProvider, Shutdownable, Writable, org.openbase.jul.pattern.Observable<Map<KEY,IdentifiableMessage<KEY,M,MB>>>, FileSynchronizedRegistry<KEY,IdentifiableMessage<KEY,M,MB>>, ProtoBufRegistry<KEY,M,MB>, Registry<KEY,IdentifiableMessage<KEY,M,MB>>

public class ProtoBufFileSynchronizedRegistry<KEY extends Comparable<KEY>,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>,SIB extends com.google.protobuf.GeneratedMessage.Builder<SIB>>
extends FileSynchronizedRegistryImpl<KEY,IdentifiableMessage<KEY,M,MB>,ProtoBufMessageMap<KEY,M,MB>,ProtoBufRegistry<KEY,M,MB>>
implements ProtoBufRegistry<KEY,M,MB>

Author:

Divine Threepwood

Nested Class Summary

Nested classes/interfaces inherited from class org.openbase.jul.storage.registry.FileSynchronizedRegistryImpl

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
ProtoBufFileSynchronizedRegistry(Class<M> messageClass, BuilderSyncSetup<SIB> builderSetup, com.google.protobuf.Descriptors.FieldDescriptor fieldDescriptor, IdGenerator<KEY,M> idGenerator, File databaseDirectory, FileProvider<Identifiable<KEY>> fileProvider)
ProtoBufFileSynchronizedRegistry(Class<M> messageClass, ProtoBufMessageMapImpl<KEY,M,MB,SIB> internalMap, IdGenerator<KEY,M> idGenerator, File databaseDirectory, FileProvider<Identifiable<KEY>> fileProvider)

Method Summary

Modifier and Type	Method and Description
void	activateVersionControl(Package converterPackage) This method activate the version control unit of the underlying registry db.
boolean	contains(M message)
MB	getBuilder(KEY key)
IdGenerator<KEY,M>	getIdGenerator()
M	getMessage(KEY id)
Class<M>	getMessageClass()
M	register(M message)
M	remove(M message)
void	shutdown()
M	update(M message)

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

activateVersionControl, afterConsistencyCheck, checkWriteAccess, clear, getDatabaseDirectory, getDatabaseName, getDatabaseState, getDBVersion, isConsistent, isOutdated, loadRegistry, register, remove, saveRegistry, update

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.ProtoBufRegistry

getMessages

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

getDatabaseDirectory, getDBVersion, loadRegistry, saveRegistry

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

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

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

checkWriteAccess, 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

ProtoBufFileSynchronizedRegistry

public ProtoBufFileSynchronizedRegistry(Class<M> messageClass,
                                        BuilderSyncSetup<SIB> builderSetup,
                                        com.google.protobuf.Descriptors.FieldDescriptor fieldDescriptor,
                                        IdGenerator<KEY,M> idGenerator,
                                        File databaseDirectory,
                                        FileProvider<Identifiable<KEY>> fileProvider)
                                 throws InstantiationException,
                                        InterruptedException

Throws:

InstantiationException

InterruptedException

ProtoBufFileSynchronizedRegistry

public ProtoBufFileSynchronizedRegistry(Class<M> messageClass,
                                        ProtoBufMessageMapImpl<KEY,M,MB,SIB> internalMap,
                                        IdGenerator<KEY,M> idGenerator,
                                        File databaseDirectory,
                                        FileProvider<Identifiable<KEY>> fileProvider)
                                 throws InstantiationException,
                                        InterruptedException

Throws:

InstantiationException

InterruptedException

Method Detail

shutdown

public void shutdown()

Description copied from class: AbstractRegistry

Specified by:

shutdown in interface Shutdownable

Overrides:

shutdown in class FileSynchronizedRegistryImpl<KEY extends Comparable<KEY>,IdentifiableMessage<KEY extends Comparable<KEY>,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,ProtoBufMessageMap<KEY extends Comparable<KEY>,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,ProtoBufRegistry<KEY extends Comparable<KEY>,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>

activateVersionControl

public void activateVersionControl(Package converterPackage)
                            throws CouldNotPerformException

This method activate the version control unit of the underlying registry db. The version check and db upgrade is automatically performed during the registry db loading phase. 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:

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.

getMessageClass

public Class<M> getMessageClass()

register

public M register(M message)
           throws CouldNotPerformException

Specified by:

register in interface ProtoBufRegistry<KEY extends Comparable<KEY>,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Throws:

CouldNotPerformException

contains

public boolean contains(M message)
                 throws CouldNotPerformException

Specified by:

contains in interface ProtoBufRegistry<KEY extends Comparable<KEY>,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Throws:

CouldNotPerformException

update

public M update(M message)
         throws CouldNotPerformException

Specified by:

update in interface ProtoBufRegistry<KEY extends Comparable<KEY>,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Throws:

CouldNotPerformException

remove

public M remove(M message)
         throws CouldNotPerformException

Specified by:

remove in interface ProtoBufRegistry<KEY extends Comparable<KEY>,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Throws:

CouldNotPerformException

getMessage

public M getMessage(KEY id)
             throws CouldNotPerformException

Specified by:

getMessage in interface ProtoBufRegistry<KEY extends Comparable<KEY>,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Throws:

CouldNotPerformException

getBuilder

public MB getBuilder(KEY key)
              throws CouldNotPerformException

Specified by:

getBuilder in interface ProtoBufRegistry<KEY extends Comparable<KEY>,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Throws:

CouldNotPerformException

getIdGenerator

public IdGenerator<KEY,M> getIdGenerator()