org.openbase.jul.storage.registry

Class RemoteRegistry<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

java.lang.Object

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

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

org.openbase.jul.storage.registry.AbstractRegistry<KEY,IdentifiableMessage<KEY,M,MB>,Map<KEY,IdentifiableMessage<KEY,M,MB>>,ProtoBufRegistry<KEY,M,MB>,RemoteRegistryPlugin<KEY,IdentifiableMessage<KEY,M,MB>,ProtoBufRegistry<KEY,M,MB>>>

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

Type Parameters:

KEY -

M -

MB -

All Implemented Interfaces:

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

public class RemoteRegistry<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>
extends AbstractRegistry<KEY,IdentifiableMessage<KEY,M,MB>,Map<KEY,IdentifiableMessage<KEY,M,MB>>,ProtoBufRegistry<KEY,M,MB>,RemoteRegistryPlugin<KEY,IdentifiableMessage<KEY,M,MB>,ProtoBufRegistry<KEY,M,MB>>>
implements ProtoBufRegistry<KEY,M,MB>, org.openbase.jul.pattern.provider.DataProvider<Map<KEY,IdentifiableMessage<KEY,M,MB>>>

Author:

Divine Threepwood

Nested Class Summary

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
RemoteRegistry()
RemoteRegistry(Map<KEY,IdentifiableMessage<KEY,M,MB>> internalMap)

Method Summary

Modifier and Type	Method and Description
void	addDataObserver(org.openbase.jul.pattern.Observer<Map<KEY,IdentifiableMessage<KEY,M,MB>>> observer)
boolean	contains(M entry)
MB	getBuilder(KEY key)
Map<KEY,IdentifiableMessage<KEY,M,MB>>	getData()
File	getDatabaseDirectory()
Class<Map<KEY,IdentifiableMessage<KEY,M,MB>>>	getDataClass()
CompletableFuture<Map<KEY,IdentifiableMessage<KEY,M,MB>>>	getDataFuture()
Integer	getDBVersion()
KEY	getId(M entry)
M	getMessage(KEY key)
List<M>	getMessages()
protected RegistryRemote<?>	getRegistryRemote() Method returns the registry remote where this instance is bound to.
boolean	isDataAvailable() Check if the remote registry provides already valid data.
boolean	isDataAvalable() Deprecated. please use isDataAvailable() instead
boolean	isReadOnly()
void	loadRegistry()
void	notifyRegistryUpdate(Collection<M> values)
boolean	recursiveTryLockRegistry(Set<Registry> lockedRegistries) Try to acquire the write lock for this registry and the registries it depends on recursively.
M	register(M entry)
void	registerConsistencyHandler(ConsistencyHandler<KEY,IdentifiableMessage<KEY,M,MB>,Map<KEY,IdentifiableMessage<KEY,M,MB>>,ProtoBufRegistry<KEY,M,MB>> consistencyHandler)
void	registerDependency(Registry registry) If this registry depends on other registries, this method can be used to tell this registry all depending registries.
M	remove(M entry)
void	removeDataObserver(org.openbase.jul.pattern.Observer<Map<KEY,IdentifiableMessage<KEY,M,MB>>> observer)
void	saveRegistry()
void	setRegistryRemote(RegistryRemote<?> remote)
boolean	tryLockRegistry() Try to acquire the write lock for this registry.
void	unlockRegistry() Unlock the write lock of the registry.
M	update(M entry)
void	waitForData() Method blocks until the remote registry is synchronized.
void	waitForData(long timeout, TimeUnit timeUnit)
void	waitUntilReady() Method blocks until the referred registry is not handling any tasks and is currently consistent.
Future<Void>	waitUntilReadyFuture() Method blocks until the registry is not handling any tasks and is currently consistent.

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

addDependencyObserver, afterConsistencyCheck, checkConsistency, checkWriteAccess, clear, contains, contains, finishTransaction, get, getEntries, getEntryMap, getEntryMapClass, getName, info, isBusy, isBusyByCurrentThread, isConsistent, isDependingOnConsistentRegistries, isEmpty, isReady, isSandbox, isWriteLockedByCurrentThread, load, lock, log, log, log, notifyObservers, register, registerPlugin, remove, remove, removeAllDependencies, removeConsistencyHandler, removeDependency, removeDependencyObserver, replaceInternalMap, replaceInternalMap, setName, setupSandbox, shutdown, size, superRemove, toString, unlock, update, 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, clear, contains, contains, get, get, getEntries, getEntryMap, getName, isConsistent, isEmpty, isEmtpy, isReady, isSandbox, register, remove, remove, removeDependencyObserver, size, 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, shutdown

Constructor Detail

RemoteRegistry

public RemoteRegistry()
               throws InstantiationException

Throws:

InstantiationException

RemoteRegistry

public RemoteRegistry(Map<KEY,IdentifiableMessage<KEY,M,MB>> internalMap)
               throws InstantiationException

Throws:

InstantiationException

Method Detail

notifyRegistryUpdate

public void notifyRegistryUpdate(Collection<M> values)
                          throws CouldNotPerformException

Throws:

CouldNotPerformException

getId

public KEY getId(M entry)
          throws CouldNotPerformException

Throws:

CouldNotPerformException

getMessage

public M getMessage(KEY key)
             throws CouldNotPerformException

Specified by:

getMessage in interface ProtoBufRegistry<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,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Throws:

CouldNotPerformException

register

public M register(M entry)
           throws CouldNotPerformException

Specified by:

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

Throws:

CouldNotPerformException

update

public M update(M entry)
         throws CouldNotPerformException

Specified by:

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

Throws:

CouldNotPerformException

remove

public M remove(M entry)
         throws CouldNotPerformException

Specified by:

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

Throws:

CouldNotPerformException

contains

public boolean contains(M entry)
                 throws CouldNotPerformException

Specified by:

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

Throws:

CouldNotPerformException

loadRegistry

public void loadRegistry()
                  throws CouldNotPerformException

Specified by:

loadRegistry in interface FileSynchronizedRegistry<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>

Throws:

CouldNotPerformException

saveRegistry

public void saveRegistry()
                  throws CouldNotPerformException

Specified by:

saveRegistry in interface FileSynchronizedRegistry<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>

Throws:

CouldNotPerformException

getMessages

public List<M> getMessages()
                    throws CouldNotPerformException

Specified by:

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

Throws:

CouldNotPerformException

getDBVersion

public Integer getDBVersion()
                     throws NotAvailableException

Specified by:

getDBVersion in interface FileSynchronizedRegistry<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>

Throws:

NotAvailableException

getDatabaseDirectory

public File getDatabaseDirectory()
                          throws NotAvailableException

Specified by:

getDatabaseDirectory in interface FileSynchronizedRegistry<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>

Throws:

NotAvailableException

registerConsistencyHandler

public void registerConsistencyHandler(ConsistencyHandler<KEY,IdentifiableMessage<KEY,M,MB>,Map<KEY,IdentifiableMessage<KEY,M,MB>>,ProtoBufRegistry<KEY,M,MB>> consistencyHandler)
                                throws CouldNotPerformException

Overrides:

registerConsistencyHandler in class AbstractRegistry<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,Map<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>,ProtoBufRegistry<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,RemoteRegistryPlugin<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,ProtoBufRegistry<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>>

Throws:

CouldNotPerformException

registerDependency

public void registerDependency(Registry registry)
                        throws CouldNotPerformException

Description copied from class: AbstractRegistry

If this registry depends on other registries, this method can be used to tell this registry all depending registries. For instance this is used to switch to read only mode in case one depending registry is not consistent. Consistency checks are skipped as well if at least one depending registry is not consistent.

Overrides:

registerDependency in class AbstractRegistry<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,Map<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>,ProtoBufRegistry<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,RemoteRegistryPlugin<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,ProtoBufRegistry<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>>

Parameters:

registry - the dependency of these registry.

Throws:

CouldNotPerformException

tryLockRegistry

public boolean tryLockRegistry()
                        throws RejectedException

Description copied from class: AbstractRegistry

Try to acquire the write lock for this registry. If this method returns true then this thread now holds the write lock for this registry. If it returns false then the lock could not currently be acquired.

Specified by:

tryLockRegistry in interface Registry<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>

Overrides:

tryLockRegistry in class AbstractRegistry<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,Map<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>,ProtoBufRegistry<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,RemoteRegistryPlugin<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,ProtoBufRegistry<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>>

Returns:

If the lock could be acquired.

Throws:

RejectedException - If the registry does not support to be locked externally which is for example the case for remote registries.

recursiveTryLockRegistry

public boolean recursiveTryLockRegistry(Set<Registry> lockedRegistries)
                                 throws RejectedException

Description copied from class: AbstractRegistry

Try to acquire the write lock for this registry and the registries it depends on recursively. This method returns true if all locks could be acquired and false if at least one lock could not be acquired. In any case the set lockedRegistries contains any locked registry afterwards. So if the method returns false any registry inside this set should be unlocked before trying it again to prevent dead locks. Additionally this method should only be performed while already holding the write lock for the registry. Else it can happen that a thread that tries to recursively lock the same registry by using the same set as another thread thinks that he acquired it even though the other thread is currently in the process of acquiring it.

Specified by:

recursiveTryLockRegistry in interface Registry<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>

Overrides:

recursiveTryLockRegistry in class AbstractRegistry<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,Map<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>,ProtoBufRegistry<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,RemoteRegistryPlugin<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,ProtoBufRegistry<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>>

Parameters:

lockedRegistries - Set of already locked registries. Should be given empty to this method and will contain all locked registries afterwards.

Returns:

If all registries could be locked.

Throws:

RejectedException - If the registry does not support to be locked externally which is for example the case for remote registries.

unlockRegistry

public void unlockRegistry()

Description copied from class: AbstractRegistry

Unlock the write lock of the registry.

Specified by:

unlockRegistry in interface Registry<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>

Overrides:

unlockRegistry in class AbstractRegistry<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,Map<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>,ProtoBufRegistry<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,RemoteRegistryPlugin<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,ProtoBufRegistry<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>>

isReadOnly

public boolean isReadOnly()

Description copied from class: AbstractRegistry

Specified by:

isReadOnly in interface Registry<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>

Overrides:

isReadOnly in class AbstractRegistry<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,Map<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>,ProtoBufRegistry<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,RemoteRegistryPlugin<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,ProtoBufRegistry<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>>

Returns:

waitUntilReady

public void waitUntilReady()
                    throws InterruptedException,
                           CouldNotPerformException

Method blocks until the referred registry is not handling any tasks and is currently consistent. Note: If you have just modified the registry this method can maybe return immediately if the task is not yet received by the registry controller. So you should prefer the futures of the modification methods for synchronization tasks.

Throws:

InterruptedException - is thrown in case the thread was externally interrupted.

CouldNotPerformException - is thrown if the wait could not be performed.

waitUntilReadyFuture

public Future<Void> waitUntilReadyFuture()

Method blocks until the registry is not handling any tasks and is currently consistent. Note: If you have just modified the registry this method can maybe return immediately if the task is not yet received by the registry controller. So you should prefer the futures of the modification methods for synchronization tasks.

Returns:

a future which is finished if the registry is ready.

getDataClass

public Class<Map<KEY,IdentifiableMessage<KEY,M,MB>>> getDataClass()

Specified by:

getDataClass in interface org.openbase.jul.pattern.provider.DataProvider<Map<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>>

getData

public Map<KEY,IdentifiableMessage<KEY,M,MB>> getData()
                                               throws NotAvailableException

Specified by:

getData in interface org.openbase.jul.pattern.provider.DataProvider<Map<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>>

Throws:

NotAvailableException

getDataFuture

public CompletableFuture<Map<KEY,IdentifiableMessage<KEY,M,MB>>> getDataFuture()

Specified by:

getDataFuture in interface org.openbase.jul.pattern.provider.DataProvider<Map<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>>

addDataObserver

public void addDataObserver(org.openbase.jul.pattern.Observer<Map<KEY,IdentifiableMessage<KEY,M,MB>>> observer)

Specified by:

addDataObserver in interface org.openbase.jul.pattern.provider.DataProvider<Map<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>>

removeDataObserver

public void removeDataObserver(org.openbase.jul.pattern.Observer<Map<KEY,IdentifiableMessage<KEY,M,MB>>> observer)

Specified by:

removeDataObserver in interface org.openbase.jul.pattern.provider.DataProvider<Map<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>>

waitForData

public void waitForData()
                 throws InterruptedException

Method blocks until the remote registry is synchronized.

Specified by:

waitForData in interface org.openbase.jul.pattern.provider.DataProvider<Map<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>>

Throws:

InterruptedException - is thrown in case the thread is externally interrupted.

waitForData

public void waitForData(long timeout,
                        TimeUnit timeUnit)
                 throws CouldNotPerformException,
                        InterruptedException

Specified by:

waitForData in interface org.openbase.jul.pattern.provider.DataProvider<Map<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>>

Throws:

CouldNotPerformException

InterruptedException

setRegistryRemote

public void setRegistryRemote(RegistryRemote<?> remote)

getRegistryRemote

protected RegistryRemote<?> getRegistryRemote()
                                       throws NotAvailableException

Method returns the registry remote where this instance is bound to.

Returns:

the registry remote if available.

Throws:

NotAvailableException - Because this bound is optionally this method may throws an NotAvailableException in case the remote registry is independent of any registry remote.

isDataAvailable

public boolean isDataAvailable()

Check if the remote registry provides already valid data.

Specified by:

isDataAvailable in interface org.openbase.jul.pattern.provider.DataProvider<Map<KEY,IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>>

Returns:

if data is available

isDataAvalable

@Deprecated
public boolean isDataAvalable()

Deprecated. please use isDataAvailable() instead

Returns: