org.openbase.bco.registry.lib.com

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

java.lang.Object

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

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

Type Parameters:

M -

MB -

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.Readyable, 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

Direct Known Subclasses:

AbstractVirtualRegistryController

public abstract class AbstractRegistryController<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>
extends org.openbase.jul.extension.rsb.com.RSBCommunicationService<M,MB>
implements org.openbase.jul.storage.registry.RegistryController<M>, org.openbase.jul.iface.Launchable<rst.rsb.ScopeType.Scope>

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

Modifier and Type	Field and Description
protected org.openbase.jul.storage.file.ProtoBufJSonFileProvider	protoBufJSonFileProvider
static boolean	SPARSELY_REGISTRY_DATA_FILTERED
static boolean	SPARSELY_REGISTRY_DATA_NOTIFIED

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

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

Constructor Summary

Constructors

Constructor and Description
AbstractRegistryController(Class<? extends org.openbase.jul.extension.rsb.scope.jp.JPScope> jpScopeProperty, MB builder) Constructor creates a new RegistryController based on the given scope and publishing registry data of the given builder.
AbstractRegistryController(Class<? extends org.openbase.jul.extension.rsb.scope.jp.JPScope> jpScopeProperty, 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
void	activate()
protected void	activateRemoteRegistries()
void	deactivate()
protected void	deactivateRemoteRegistries()
rst.rsb.ScopeType.Scope	getDefaultConfig()
protected List<org.openbase.jul.storage.registry.ProtoBufFileSynchronizedRegistry>	getRegistries()
List<org.openbase.jul.storage.registry.RemoteRegistry>	getRemoteRegistries()
Boolean	isConsistent() Test if at least one local registry is inconsistent.
Boolean	isReady()
void	notifyChange()
protected void	postInit()
protected abstract void	registerConsistencyHandler()
protected void	registerConsistencyHandler(org.openbase.jul.storage.registry.ConsistencyHandler consistencyHandler, Class messageClass)
protected abstract void	registerDependencies()
protected void	registerDependency(org.openbase.jul.storage.registry.Registry dependency, Class messageClass)
void	registerMethods(org.openbase.jul.extension.rsb.iface.RSBLocalServer server)
protected abstract void	registerPlugins()
protected abstract void	registerRegistries()
protected void	registerRegistry(org.openbase.jul.storage.registry.ProtoBufFileSynchronizedRegistry registry)
protected abstract void	registerRemoteRegistries()
protected void	registerRemoteRegistry(org.openbase.jul.storage.registry.RemoteRegistry registry)
void	shutdown()
protected abstract void	syncRegistryFlags()
void	waitUntilReady()
Future<Void>	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, updateDataToPublish, validateActivation, validateInitialization, validateMiddleware, waitForAvailabilityState, waitForData, waitForData, waitForMiddleware

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

Field Detail

SPARSELY_REGISTRY_DATA_FILTERED

public static final boolean SPARSELY_REGISTRY_DATA_FILTERED

See Also:

Constant Field Values

SPARSELY_REGISTRY_DATA_NOTIFIED

public static final boolean SPARSELY_REGISTRY_DATA_NOTIFIED

See Also:

Constant Field Values

protoBufJSonFileProvider

protected org.openbase.jul.storage.file.ProtoBufJSonFileProvider protoBufJSonFileProvider

Constructor Detail

AbstractRegistryController

public AbstractRegistryController(Class<? extends org.openbase.jul.extension.rsb.scope.jp.JPScope> jpScopeProperty,
                                  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:

jpScopeProperty - 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

AbstractRegistryController

public AbstractRegistryController(Class<? extends org.openbase.jul.extension.rsb.scope.jp.JPScope> jpScopeProperty,
                                  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:

jpScopeProperty - 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

getDefaultConfig

public rst.rsb.ScopeType.Scope getDefaultConfig()
                                         throws org.openbase.jul.exception.NotAvailableException

Specified by:

getDefaultConfig in interface org.openbase.jul.iface.provider.DefaultConfigProvider<rst.rsb.ScopeType.Scope>

Throws:

org.openbase.jul.exception.NotAvailableException

postInit

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

Overrides:

postInit in class org.openbase.jul.extension.rsb.com.RSBCommunicationService<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Throws:

org.openbase.jul.exception.InitializationException

InterruptedException

activate

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

Specified by:

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

Overrides:

activate in class org.openbase.jul.extension.rsb.com.RSBCommunicationService<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Throws:

InterruptedException

org.openbase.jul.exception.CouldNotPerformException

deactivate

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

Specified by:

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

Overrides:

deactivate in class org.openbase.jul.extension.rsb.com.RSBCommunicationService<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Throws:

InterruptedException

org.openbase.jul.exception.CouldNotPerformException

shutdown

public void shutdown()

Specified by:

shutdown in interface org.openbase.jul.iface.Manageable<rst.rsb.ScopeType.Scope>

Specified by:

shutdown in interface org.openbase.jul.iface.Shutdownable

Overrides:

shutdown in class org.openbase.jul.extension.rsb.com.RSBCommunicationService<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

registerMethods

public void registerMethods(org.openbase.jul.extension.rsb.iface.RSBLocalServer server)
                     throws org.openbase.jul.exception.CouldNotPerformException

Specified by:

registerMethods in class org.openbase.jul.extension.rsb.com.RSBCommunicationService<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Throws:

org.openbase.jul.exception.CouldNotPerformException

notifyChange

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

Specified by:

notifyChange in interface org.openbase.jul.iface.Changeable

Specified by:

notifyChange in interface org.openbase.jul.pattern.Controller<M extends com.google.protobuf.GeneratedMessage>

Overrides:

notifyChange in class org.openbase.jul.extension.rsb.com.RSBCommunicationService<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

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

deactivateRemoteRegistries

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

registerDependency

protected void registerDependency(org.openbase.jul.storage.registry.Registry dependency,
                                  Class messageClass)
                           throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

registerRegistry

protected void registerRegistry(org.openbase.jul.storage.registry.ProtoBufFileSynchronizedRegistry registry)

registerRemoteRegistry

protected void registerRemoteRegistry(org.openbase.jul.storage.registry.RemoteRegistry registry)

registerConsistencyHandler

protected void registerConsistencyHandler(org.openbase.jul.storage.registry.ConsistencyHandler consistencyHandler,
                                          Class messageClass)
                                   throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getRemoteRegistries

public List<org.openbase.jul.storage.registry.RemoteRegistry> getRemoteRegistries()

getRegistries

protected List<org.openbase.jul.storage.registry.ProtoBufFileSynchronizedRegistry> getRegistries()

waitUntilReady

public void waitUntilReady()
                    throws InterruptedException

Specified by:

waitUntilReady in interface org.openbase.jul.storage.registry.RegistryService

Throws:

InterruptedException

waitUntilReadyFuture

public Future<Void> waitUntilReadyFuture()

Specified by:

waitUntilReadyFuture in interface org.openbase.jul.storage.registry.RegistryService

isReady

public Boolean isReady()

Specified by:

isReady in interface org.openbase.jul.iface.Readyable

Specified by:

isReady in interface org.openbase.jul.storage.registry.RegistryService

Overrides:

isReady in class org.openbase.jul.extension.rsb.com.RSBCommunicationService<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Returns:

isConsistent

public Boolean isConsistent()

Test if at least one local registry is inconsistent.

Specified by:

isConsistent in interface org.openbase.jul.storage.registry.RegistryService

Returns:

true if all managed registries are consistent and else false

registerConsistencyHandler

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

registerPlugins

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

registerRegistries

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

registerDependencies

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

syncRegistryFlags

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

registerRemoteRegistries

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

Throws:

org.openbase.jul.exception.CouldNotPerformException