org.openbase.bco.registry.lib.com

Class SynchronizedRemoteRegistry<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,org.openbase.jul.extension.protobuf.IdentifiableMessage<KEY,M,MB>,Map<KEY,org.openbase.jul.extension.protobuf.IdentifiableMessage<KEY,M,MB>>,org.openbase.jul.storage.registry.ProtoBufRegistry<KEY,M,MB>,org.openbase.jul.storage.registry.plugin.RemoteRegistryPlugin<KEY,org.openbase.jul.extension.protobuf.IdentifiableMessage<KEY,M,MB>,org.openbase.jul.storage.registry.ProtoBufRegistry<KEY,M,MB>>>

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

org.openbase.bco.registry.lib.com.SynchronizedRemoteRegistry<KEY,M,MB>

Type Parameters:

KEY -

M -

MB -

All Implemented Interfaces:

org.openbase.jul.iface.Activatable, org.openbase.jul.iface.provider.NameProvider, org.openbase.jul.iface.Shutdownable, org.openbase.jul.iface.Writable, org.openbase.jul.pattern.Observable<Map<KEY,org.openbase.jul.extension.protobuf.IdentifiableMessage<KEY,M,MB>>>, org.openbase.jul.pattern.provider.DataProvider<Map<KEY,org.openbase.jul.extension.protobuf.IdentifiableMessage<KEY,M,MB>>>, org.openbase.jul.storage.registry.FileSynchronizedRegistry<KEY,org.openbase.jul.extension.protobuf.IdentifiableMessage<KEY,M,MB>>, org.openbase.jul.storage.registry.ProtoBufRegistry<KEY,M,MB>, org.openbase.jul.storage.registry.Registry<KEY,org.openbase.jul.extension.protobuf.IdentifiableMessage<KEY,M,MB>>

public class SynchronizedRemoteRegistry<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>
extends org.openbase.jul.storage.registry.RemoteRegistry<KEY,M,MB>
implements org.openbase.jul.iface.Activatable

Author:

Divine Threepwood

Nested Class Summary

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

org.openbase.jul.iface.Shutdownable.ShutdownDeamon

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOGGER

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
SynchronizedRemoteRegistry(org.openbase.jul.pattern.Observable observable, org.openbase.jul.extension.rsb.com.RSBRemoteService<M> remoteService, com.google.protobuf.Descriptors.FieldDescriptor... fieldDescriptors)
SynchronizedRemoteRegistry(org.openbase.jul.pattern.Observable observable, org.openbase.jul.extension.rsb.com.RSBRemoteService<M> remoteService, Map<KEY,org.openbase.jul.extension.protobuf.IdentifiableMessage<KEY,M,MB>> internalMap, com.google.protobuf.Descriptors.FieldDescriptor... fieldDescriptors)
SynchronizedRemoteRegistry(org.openbase.jul.pattern.Observable observable, org.openbase.jul.extension.rsb.com.RSBRemoteService remoteService, org.openbase.jul.pattern.AbstractFilter<M> filter, int... protobufFieldNumbers)
SynchronizedRemoteRegistry(org.openbase.jul.pattern.Observable observable, org.openbase.jul.extension.rsb.com.RSBRemoteService remoteService, int... protobufFieldNumbers)
SynchronizedRemoteRegistry(org.openbase.jul.extension.rsb.com.RSBRemoteService remoteService, org.openbase.jul.pattern.AbstractFilter<M> filter, int... protobufFieldNumbers)
SynchronizedRemoteRegistry(org.openbase.jul.extension.rsb.com.RSBRemoteService remoteService, int... protobufFieldNumbers)

Method Summary

Modifier and Type	Method and Description
void	activate()
void	deactivate()
com.google.protobuf.Descriptors.FieldDescriptor[]	getFieldDescriptors() Method returns the list of field descriptors which are used to identify the protobuf field that are merged into the registry.
org.openbase.jul.pattern.AbstractFilter	getFilter()
String	getName()
org.openbase.jul.extension.rsb.com.RSBRemoteService<M>	getRemoteService() Method returns the internal remote service which is used to detect external data changes.
boolean	isActive()

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

addDataObserver, contains, getBuilder, getData, getDatabaseDirectory, getDataClass, getDataFuture, getDBVersion, getId, getMessage, getMessages, getRegistryRemote, isDataAvailable, isDataAvalable, isReadOnly, loadRegistry, notifyRegistryUpdate, recursiveTryLockRegistry, register, registerConsistencyHandler, registerDependency, remove, removeDataObserver, saveRegistry, setRegistryRemote, tryLockRegistry, unlockRegistry, update, waitForData, waitForData, waitUntilReady, waitUntilReadyFuture

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

addDependencyObserver, afterConsistencyCheck, checkConsistency, checkWriteAccess, clear, contains, contains, finishTransaction, get, getEntries, getEntryMap, getEntryMapClass, 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, 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

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

Constructor Detail

SynchronizedRemoteRegistry

public SynchronizedRemoteRegistry(org.openbase.jul.extension.rsb.com.RSBRemoteService remoteService,
                                  int... protobufFieldNumbers)
                           throws org.openbase.jul.exception.InstantiationException

Parameters:

remoteService - The remote service to get informed about data updates.

protobufFieldNumbers - The field numbers to identify the descriptor fields which are used for the internal registry synchronization.

Throws:

org.openbase.jul.exception.InstantiationException - is thrown in case the instantiation fails.

SynchronizedRemoteRegistry

public SynchronizedRemoteRegistry(org.openbase.jul.extension.rsb.com.RSBRemoteService remoteService,
                                  org.openbase.jul.pattern.AbstractFilter<M> filter,
                                  int... protobufFieldNumbers)
                           throws org.openbase.jul.exception.InstantiationException

Parameters:

remoteService - The remote service to get informed about data updates.

filter - the filter which is used to synchronize the messages

protobufFieldNumbers - The field numbers to identify the descriptor fields which are used for the internal registry synchronization.

Throws:

org.openbase.jul.exception.InstantiationException - is thrown in case the instantiation fails.

SynchronizedRemoteRegistry

public SynchronizedRemoteRegistry(org.openbase.jul.pattern.Observable observable,
                                  org.openbase.jul.extension.rsb.com.RSBRemoteService remoteService,
                                  int... protobufFieldNumbers)
                           throws org.openbase.jul.exception.InstantiationException

Parameters:

observable - The observable to get informed about data updates.

remoteService - The remote service to get informed about data updates.

protobufFieldNumbers - The field numbers to identify the descriptor fields which are used for the internal registry synchronization..

Throws:

org.openbase.jul.exception.InstantiationException - is thrown in case the instantiation fails.

SynchronizedRemoteRegistry

public SynchronizedRemoteRegistry(org.openbase.jul.pattern.Observable observable,
                                  org.openbase.jul.extension.rsb.com.RSBRemoteService remoteService,
                                  org.openbase.jul.pattern.AbstractFilter<M> filter,
                                  int... protobufFieldNumbers)
                           throws org.openbase.jul.exception.InstantiationException

Parameters:

observable - The observable to get informed about data updates.

remoteService - The remote service to get informed about data updates.

filter - the filter which is used to synchronize the messages

protobufFieldNumbers - The field numbers to identify the descriptor fields which are used for the internal registry synchronization.

Throws:

org.openbase.jul.exception.InstantiationException - is thrown in case the instantiation fails.

SynchronizedRemoteRegistry

public SynchronizedRemoteRegistry(org.openbase.jul.pattern.Observable observable,
                                  org.openbase.jul.extension.rsb.com.RSBRemoteService<M> remoteService,
                                  com.google.protobuf.Descriptors.FieldDescriptor... fieldDescriptors)
                           throws org.openbase.jul.exception.InstantiationException

Parameters:

observable - The observable to get informed about data updates.

remoteService - The remote service to get informed about data updates.

fieldDescriptors - The field descriptors which are used for the internal registry synchronization.

Throws:

org.openbase.jul.exception.InstantiationException - is thrown in case the instantiation fails.

SynchronizedRemoteRegistry

public SynchronizedRemoteRegistry(org.openbase.jul.pattern.Observable observable,
                                  org.openbase.jul.extension.rsb.com.RSBRemoteService<M> remoteService,
                                  Map<KEY,org.openbase.jul.extension.protobuf.IdentifiableMessage<KEY,M,MB>> internalMap,
                                  com.google.protobuf.Descriptors.FieldDescriptor... fieldDescriptors)
                           throws org.openbase.jul.exception.InstantiationException

Parameters:

observable - The observable to get informed about data updates.

remoteService - The remote service to get informed about data updates.

internalMap - the internal map instance of this registry.

fieldDescriptors - The field descriptors which are used for the internal registry synchronization.

Throws:

org.openbase.jul.exception.InstantiationException - is thrown in case the instantiation fails.

Method Detail

getFieldDescriptors

public com.google.protobuf.Descriptors.FieldDescriptor[] getFieldDescriptors()

Method returns the list of field descriptors which are used to identify the protobuf field that are merged into the registry.

Returns:

getRemoteService

public org.openbase.jul.extension.rsb.com.RSBRemoteService<M> getRemoteService()

Method returns the internal remote service which is used to detect external data changes.

Returns:

activate

public void activate()
              throws org.openbase.jul.exception.CouldNotPerformException,
                     InterruptedException

Specified by:

activate in interface org.openbase.jul.iface.Activatable

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

deactivate

public void deactivate()
                throws org.openbase.jul.exception.CouldNotPerformException,
                       InterruptedException

Specified by:

deactivate in interface org.openbase.jul.iface.Activatable

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

isActive

public boolean isActive()

Specified by:

isActive in interface org.openbase.jul.iface.Activatable

getName

public String getName()

Specified by:

getName in interface org.openbase.jul.iface.provider.NameProvider

Specified by:

getName in interface org.openbase.jul.storage.registry.Registry<KEY,org.openbase.jul.extension.protobuf.IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>

Overrides:

getName in class org.openbase.jul.storage.registry.AbstractRegistry<KEY,org.openbase.jul.extension.protobuf.IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,Map<KEY,org.openbase.jul.extension.protobuf.IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>,org.openbase.jul.storage.registry.ProtoBufRegistry<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,org.openbase.jul.storage.registry.plugin.RemoteRegistryPlugin<KEY,org.openbase.jul.extension.protobuf.IdentifiableMessage<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>,org.openbase.jul.storage.registry.ProtoBufRegistry<KEY,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>>>

getFilter

public org.openbase.jul.pattern.AbstractFilter getFilter()