org.openbase.bco.registry.lib.com

Class AbstractVirtualRegistryController<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>,RM>

java.lang.Object

org.openbase.jul.extension.rsb.com.RSBCommunicationService<M,MB>

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

org.openbase.bco.registry.lib.com.AbstractVirtualRegistryController<M,MB,RM>

Type Parameters:

M - The virtual registry message type.

MB - The virtual registry message builder.

RM - The message type of the real registry which is mirrored by this virtual registry.

All Implemented Interfaces:

org.openbase.jul.extension.protobuf.iface.DataBuilderProvider<M,MB>, org.openbase.jul.extension.protobuf.MessageController<M,MB>, org.openbase.jul.extension.rst.iface.ScopeProvider, org.openbase.jul.iface.Activatable, org.openbase.jul.iface.Changeable, org.openbase.jul.iface.DefaultInitializable, org.openbase.jul.iface.DefaultInitializableImpl<rst.rsb.ScopeType.Scope>, org.openbase.jul.iface.Initializable<rst.rsb.ScopeType.Scope>, org.openbase.jul.iface.Launchable<rst.rsb.ScopeType.Scope>, org.openbase.jul.iface.Manageable<rst.rsb.ScopeType.Scope>, org.openbase.jul.iface.Pingable, org.openbase.jul.iface.provider.DefaultConfigProvider<rst.rsb.ScopeType.Scope>, org.openbase.jul.iface.Requestable<M>, org.openbase.jul.iface.Shutdownable, org.openbase.jul.pattern.Controller<M>, org.openbase.jul.pattern.provider.DataProvider<M>, org.openbase.jul.storage.registry.RegistryController<M>, org.openbase.jul.storage.registry.RegistryService

public abstract class AbstractVirtualRegistryController<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>,RM>
extends AbstractRegistryController<M,MB>

Author:

Divine Threepwood

Nested Class Summary

Nested classes/interfaces inherited from interface org.openbase.jul.pattern.Controller

org.openbase.jul.pattern.Controller.ControllerAvailabilityState

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

org.openbase.jul.iface.Shutdownable.ShutdownDeamon

Field Summary

Fields inherited from class org.openbase.bco.registry.lib.com.AbstractRegistryController

protoBufJSonFileProvider, SPARSELY_REGISTRY_DATA_FILTERED, SPARSELY_REGISTRY_DATA_NOTIFIED

Fields inherited from class org.openbase.jul.extension.rsb.com.RSBCommunicationService

informer, informerWatchDog, logger, managableLock, RPC_REQUEST_STATUS, scope, SCOPE_SUFFIX_CONTROL, SCOPE_SUFFIX_STATUS, server, serverWatchDog

Constructor Summary

Constructors

Constructor and Description
AbstractVirtualRegistryController(Class<? extends org.openbase.jul.extension.rsb.scope.jp.JPScope> jpScopePropery, MB builder) Constructor creates a new RegistryController based on the given scope and publishing registry data of the given builder.
AbstractVirtualRegistryController(Class<? extends org.openbase.jul.extension.rsb.scope.jp.JPScope> jpScopePropery, MB builder, boolean filterSparselyRegistryData) Constructor creates a new RegistryController based on the given scope and publishing registry data of the given builder.

Method Summary

Modifier and Type	Method and Description
protected void	activateRemoteRegistries()
protected void	deactivateRemoteRegistries()
protected List<org.openbase.jul.storage.registry.RegistryRemote>	getRegistryRemotes()
protected void	postInit()
protected void	registerConsistencyHandler()
protected void	registerDependencies()
protected void	registerPlugins()
protected void	registerRegistries()
protected void	registerRegistryRemote(org.openbase.jul.storage.registry.RegistryRemote registry)
protected abstract void	registerRegistryRemotes()
protected void	syncRegistryFlags()
protected abstract void	syncVirtualRegistryFields(MB virtualDataBuilder, RM realData)

Methods inherited from class org.openbase.bco.registry.lib.com.AbstractRegistryController

activate, deactivate, getDefaultConfig, getRegistries, getRemoteRegistries, isReady, notifyChange, registerConsistencyHandler, registerDependency, registerMethods, registerRegistry, registerRemoteRegistries, registerRemoteRegistry, shutdown, waitUntilReady, waitUntilReadyFuture

Methods inherited from class org.openbase.jul.extension.rsb.com.RSBCommunicationService

addDataObserver, cloneDataBuilder, getBuilderSetup, getControllerAvailabilityState, getData, getDataBuilder, getDataBuilder, getDataClass, getDataField, getDataFieldDescriptor, getDataFuture, getScope, hasDataField, init, init, init, init, init, init, isActive, isDataAvailable, notifyDataUpdate, ping, removeDataObserver, requestStatus, setDataField, setDataField, supportsDataField, toString, validateInitialization, waitForAvailabilityState, waitForData, waitForData

Methods inherited from class java.lang.Object

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

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

getControllerAvailabilityState, getData, getDataClass, waitForAvailabilityState

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

ping

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

requestStatus

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

launch

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

registerShutdownHook, registerShutdownHook

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

isActive

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

init

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

init

Constructor Detail

AbstractVirtualRegistryController

public AbstractVirtualRegistryController(Class<? extends org.openbase.jul.extension.rsb.scope.jp.JPScope> jpScopePropery,
                                         MB builder)
                                  throws org.openbase.jul.exception.InstantiationException

Constructor creates a new RegistryController based on the given scope and publishing registry data of the given builder. Node: By default this constructor filters sparsely registry data. If you want to publish data of internal registries even if other internal registries are not ready yet, use can use the other constructor of this class and set the filterSparselyRegistryData flag to false.

Parameters:

jpScopePropery - the scope which is used for registry communication and data publishing.

builder - the builder to build the registry data message.

Throws:

org.openbase.jul.exception.InstantiationException

AbstractVirtualRegistryController

public AbstractVirtualRegistryController(Class<? extends org.openbase.jul.extension.rsb.scope.jp.JPScope> jpScopePropery,
                                         MB builder,
                                         boolean filterSparselyRegistryData)
                                  throws org.openbase.jul.exception.InstantiationException

Constructor creates a new RegistryController based on the given scope and publishing registry data of the given builder.

Parameters:

jpScopePropery - the scope which is used for registry communication and data publishing.

builder - the builder to build the registry data message.

filterSparselyRegistryData - if this flag is true the registry data is only published if non of the internal registries is busy.

Throws:

org.openbase.jul.exception.InstantiationException

Method Detail

postInit

protected void postInit()
                 throws org.openbase.jul.exception.InitializationException,
                        InterruptedException

Overrides:

postInit in class AbstractRegistryController<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Throws:

org.openbase.jul.exception.InitializationException

InterruptedException

registerConsistencyHandler

protected void registerConsistencyHandler()
                                   throws org.openbase.jul.exception.CouldNotPerformException

Specified by:

registerConsistencyHandler in class AbstractRegistryController<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Throws:

org.openbase.jul.exception.CouldNotPerformException

registerDependencies

protected void registerDependencies()
                             throws org.openbase.jul.exception.CouldNotPerformException

Specified by:

registerDependencies in class AbstractRegistryController<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Throws:

org.openbase.jul.exception.CouldNotPerformException

syncRegistryFlags

protected void syncRegistryFlags()
                          throws org.openbase.jul.exception.CouldNotPerformException,
                                 InterruptedException

Specified by:

syncRegistryFlags in class AbstractRegistryController<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

registerRegistries

protected void registerRegistries()
                           throws org.openbase.jul.exception.CouldNotPerformException

Specified by:

registerRegistries in class AbstractRegistryController<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Throws:

org.openbase.jul.exception.CouldNotPerformException

registerPlugins

protected void registerPlugins()
                        throws org.openbase.jul.exception.CouldNotPerformException,
                               InterruptedException

Specified by:

registerPlugins in class AbstractRegistryController<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

activateRemoteRegistries

protected void activateRemoteRegistries()
                                 throws org.openbase.jul.exception.CouldNotPerformException,
                                        InterruptedException

Overrides:

activateRemoteRegistries in class AbstractRegistryController<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

deactivateRemoteRegistries

protected void deactivateRemoteRegistries()
                                   throws org.openbase.jul.exception.CouldNotPerformException,
                                          InterruptedException

Overrides:

deactivateRemoteRegistries in class AbstractRegistryController<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

registerRegistryRemote

protected void registerRegistryRemote(org.openbase.jul.storage.registry.RegistryRemote registry)

getRegistryRemotes

protected List<org.openbase.jul.storage.registry.RegistryRemote> getRegistryRemotes()

registerRegistryRemotes

protected abstract void registerRegistryRemotes()
                                         throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

syncVirtualRegistryFields

protected abstract void syncVirtualRegistryFields(MB virtualDataBuilder,
                                                  RM realData)
                                           throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException