org.sensorhub.impl.module

Class ModuleRegistry

java.lang.Object

org.sensorhub.impl.module.ModuleRegistry

All Implemented Interfaces:

IEventListener, IEventProducer, IModuleManager<IModule<?>>

public class ModuleRegistry
extends Object
implements IModuleManager<IModule<?>>, IEventProducer, IEventListener

This class is in charge of loading all configured modules on startup as well as dynamically loading/unloading modules on demand. It also keeps lists of all loaded and available modules.

TODO implement global event manager for all modules ? TODO return weak references to modules ?

Since:

Sep 2, 2013

Author:

Alex Robin

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID
static long	SHUTDOWN_TIMEOUT_MS

Constructor Summary

Constructors

Constructor and Description
ModuleRegistry(IModuleConfigRepository configRepos, EventBus eventBus)

Method Summary

Methods

Modifier and Type	Method and Description
ModuleConfig	createModuleConfig(IModuleProvider provider) Creates a new module config class using information from a module provider
void	destroyModule(String moduleID) Removes the module with the given id
Collection<ModuleConfig>	getAvailableModules() Gets the list of all modules handled by this manager that are configured but not yet loaded (i.e.
Collection<IModuleProvider>	getInstalledModuleTypes() Retrieves list of all installed module types
Collection<IModuleProvider>	getInstalledModuleTypes(Class<?> moduleClass) Retrieves list of all installed module types that are sub-types of the specified class
Collection<IModule<?>>	getLoadedModules() Gets the list of all modules handled by this manager that are already loaded (i.e.
IModule<?>	getModuleById(String moduleID) Retrieves a module instance by its local ID
File	getModuleDataFolder(String moduleID) Retrieves the folder where the module data should be stored
WeakReference<? extends IModule<?>>	getModuleRef(String moduleID)
IModuleStateManager	getStateManager(String moduleID) Returns the default state manager for the given module
void	handleEvent(Event<?> e)
IModule<?>	initModule(String moduleID) Initializes the module with the given local ID This method is synchronous so it will block forever until the module is actually initialized or an exception is thrown
IModule<?>	initModule(String moduleID, boolean force, long timeOut) Initializes the module with the given local ID This method is synchronous so it will block until the module is actually initialized, the timeout occurs or an exception is thrown
void	initModuleAsync(IModule<?> module, boolean force) Inits the module asynchronously in a separate thread
IModule<?>	initModuleAsync(String moduleID, boolean force, IEventListener listener) Initializes the module with the given local ID This method is asynchronous so it returns immediately and the listener will be notified when the module is actually initialized
boolean	isModuleLoaded(String moduleID)
void	loadAllModules() Loads all enabled modules from configuration entries provided by the specified IModuleConfigRepository
Object	loadClass(String className) Loads any class by reflection
IModule<?>	loadModule(ModuleConfig config) Instantiates and loads a module using the given configuration This method is synchronous so it will block forever until the module is actually loaded, and it will also wait for it to be started if 'autostart' was requested.
IModule<?>	loadModule(ModuleConfig config, long timeOut) Instantiates and loads a module using the given configuration This method is synchronous so it will block until the module is actually loaded, (and started if 'autostart' was true), the timeout occurs or an exception is thrown
IModule<?>	loadModuleAsync(ModuleConfig config, IEventListener listener) Instantiates and loads a module using the given configuration This method is asynchronous so, when it returns without error, the module is guaranteed to be loaded but not necessarilly initialized or started.
protected void	postInit(IModule<?> module)
void	registerListener(IEventListener listener) Registers a listener with this event producer.
void	restartModuleAsync(IModule<?> module) Restarts the module asynchronously in a separate thread This will actually called requestStop() and then requestStart()
void	restartModuleAsync(String moduleID, IEventListener listener) Restarts the module with the given local ID This method is asynchronous so it returns immediately and the listener will be notified when the module is actually restarted
void	saveConfiguration(ModuleConfig... configList) Saves the given module configurations in the repository
void	saveModulesConfiguration() Save all modules current configuration to the repository
void	shutdown(boolean saveConfig, boolean saveState) Shuts down all modules and the config repository
IModule<?>	startModule(String moduleID) Starts the module with the given local ID This method is synchronous so it will block forever until the module is actually started or an exception is thrown
IModule<?>	startModule(String moduleID, long timeOut) Starts the module with the given local ID This method is synchronous so it will block until the module is actually started, the timeout occurs or an exception is thrown
void	startModuleAsync(IModule<?> module) Starts the module asynchronously in a separate thread
IModule<?>	startModuleAsync(String moduleID, IEventListener listener) Starts the module with the given local ID This method is asynchronous so it returns immediately and the listener will be notified when the module is actually started
IModule<?>	stopModule(String moduleID) Stops the module with the given local ID This method is synchronous so it will block forever until the module is actually stopped or an exception is thrown
IModule<?>	stopModule(String moduleID, long timeOut) Stops the module with the given local ID This method is synchronous so it will block until the module is actually stopped, the timeout occurs or an exception is thrown
void	stopModuleAsync(IModule<?> module) Stops the module asynchronously in a separate thread
IModule<?>	stopModuleAsync(String moduleID, IEventListener listener) Stops the module with the given local ID This method is asynchronous so it returns immediately and the listener will be notified when the module is actually stopped
void	unloadModule(String moduleID) Unloads a module instance. This causes the module to be removed from registry but its last saved configuration is kept as-is.
void	unregisterListener(IEventListener listener) Unregisters a listener from this event producer.
void	updateModuleConfigAsync(IModule module, ModuleConfig config) Updates the module configuration asynchronously in a separate thread
void	updateModuleConfigAsync(ModuleConfig config) Updates the configuration of the module with the given local ID
void	waitForAllModulesLoaded()

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

SHUTDOWN_TIMEOUT_MS

public static final long SHUTDOWN_TIMEOUT_MS

See Also:

Constant Field Values

Constructor Detail

ModuleRegistry

public ModuleRegistry(IModuleConfigRepository configRepos,
              EventBus eventBus)

Method Detail

loadAllModules

public void loadAllModules()

Loads all enabled modules from configuration entries provided by the specified IModuleConfigRepository

waitForAllModulesLoaded

public void waitForAllModulesLoaded()

loadModule

public IModule<?> loadModule(ModuleConfig config)
                      throws SensorHubException

Instantiates and loads a module using the given configuration
This method is synchronous so it will block forever until the module is actually loaded, and it will also wait for it to be started if 'autostart' was requested.

Parameters:

config - Configuration class to use to instantiate the module

Returns:

loaded module instance

Throws:

SensorHubException

loadModule

public IModule<?> loadModule(ModuleConfig config,
                    long timeOut)
                      throws SensorHubException

Instantiates and loads a module using the given configuration
This method is synchronous so it will block until the module is actually loaded, (and started if 'autostart' was true), the timeout occurs or an exception is thrown

Parameters:

config - Configuration class to use to instantiate the module

timeOut - Maximum time to wait for load and startup to complete (or <= 0 to wait forever)

Returns:

loaded module instance

Throws:

SensorHubException

loadModuleAsync

public IModule<?> loadModuleAsync(ModuleConfig config,
                         IEventListener listener)
                           throws SensorHubException

Instantiates and loads a module using the given configuration
This method is asynchronous so, when it returns without error, the module is guaranteed to be loaded but not necessarilly initialized or started. The listener will be notified when the module's state changes further.

Parameters:

config - Configuration class to use to instantiate the module

listener - Listener to register for receiving the module's events

Returns:

loaded module instance (may not yet be started when this method returns)

Throws:

SensorHubException - if no module with given ID can be found

loadClass

public Object loadClass(String className)
                 throws SensorHubException

Loads any class by reflection

Parameters:

className -

Returns:

new object instantiated

Throws:

SensorHubException

createModuleConfig

public ModuleConfig createModuleConfig(IModuleProvider provider)
                                throws SensorHubException

Creates a new module config class using information from a module provider

Parameters:

provider -

Returns:

the new configuration class

Throws:

SensorHubException

isModuleLoaded

public boolean isModuleLoaded(String moduleID)

Specified by:

isModuleLoaded in interface IModuleManager<IModule<?>>

Parameters:

moduleID - local ID of module

Returns:

true if module is loaded, false otherwise

unloadModule

public void unloadModule(String moduleID)
                  throws SensorHubException

Unloads a module instance.
This causes the module to be removed from registry but its last saved configuration is kept as-is. Call saveConfiguration(ModuleConfig...) first if you want to keep the current config.

Parameters:

moduleID -

Throws:

SensorHubException

initModule

public IModule<?> initModule(String moduleID)
                      throws SensorHubException

Initializes the module with the given local ID
This method is synchronous so it will block forever until the module is actually initialized or an exception is thrown

Parameters:

moduleID - Local ID of module to initialize

Returns:

module instance corresponding to moduleID

Throws:

SensorHubException - if an error occurs during init

initModule

public IModule<?> initModule(String moduleID,
                    boolean force,
                    long timeOut)
                      throws SensorHubException

Initializes the module with the given local ID
This method is synchronous so it will block until the module is actually initialized, the timeout occurs or an exception is thrown

Parameters:

moduleID - Local ID of module to initialize

force - set to true to force a reinit, even if module was already initialized

timeOut - Maximum time to wait for init to complete (or <= 0 to wait forever)

Returns:

module Loaded module with the given moduleID

Throws:

SensorHubException - if an error occurs during init

initModuleAsync

public IModule<?> initModuleAsync(String moduleID,
                         boolean force,
                         IEventListener listener)
                           throws SensorHubException

Initializes the module with the given local ID
This method is asynchronous so it returns immediately and the listener will be notified when the module is actually initialized

Parameters:

moduleID - Local ID of module to initialize

force - set to true to force a reinit, even if module was already initialized

listener - Listener to register for receiving the module's events

Returns:

the module instance (may not yet be initialized when this method returns)

Throws:

SensorHubException - if no module with given ID can be found

initModuleAsync

public void initModuleAsync(IModule<?> module,
                   boolean force)
                     throws SensorHubException

Inits the module asynchronously in a separate thread

Parameters:

module - module instance to initialize

force - set to true to force a reinit, even if module was already initialized

Throws:

SensorHubException

startModule

public IModule<?> startModule(String moduleID)
                       throws SensorHubException

Starts the module with the given local ID
This method is synchronous so it will block forever until the module is actually started or an exception is thrown

Parameters:

moduleID - Local ID of module to start

Returns:

module instance corresponding to moduleID

Throws:

SensorHubException - if an error occurs during startup

startModule

public IModule<?> startModule(String moduleID,
                     long timeOut)
                       throws SensorHubException

Starts the module with the given local ID
This method is synchronous so it will block until the module is actually started, the timeout occurs or an exception is thrown

Parameters:

moduleID - Local ID of module to start

timeOut - Maximum time to wait for startup to complete (or <= 0 to wait forever)

Returns:

module Loaded module with the given moduleID

Throws:

SensorHubException - if an error occurs during startup

startModuleAsync

public IModule<?> startModuleAsync(String moduleID,
                          IEventListener listener)
                            throws SensorHubException

Starts the module with the given local ID
This method is asynchronous so it returns immediately and the listener will be notified when the module is actually started

Parameters:

moduleID - Local ID of module to start

listener - Listener to register for receiving the module's events

Returns:

the module instance (may not yet be started when this method returns)

Throws:

SensorHubException - if no module with given ID can be found

startModuleAsync

public void startModuleAsync(IModule<?> module)
                      throws SensorHubException

Starts the module asynchronously in a separate thread

Parameters:

module - module instance to start

Throws:

SensorHubException

stopModule

public IModule<?> stopModule(String moduleID)
                      throws SensorHubException

Stops the module with the given local ID
This method is synchronous so it will block forever until the module is actually stopped or an exception is thrown

Parameters:

moduleID - Local ID of module to disable

Returns:

module instance corresponding to moduleID

Throws:

SensorHubException - if an error occurs during shutdown

stopModule

public IModule<?> stopModule(String moduleID,
                    long timeOut)
                      throws SensorHubException

Stops the module with the given local ID
This method is synchronous so it will block until the module is actually stopped, the timeout occurs or an exception is thrown

Parameters:

moduleID - Local ID of module to enable

timeOut - Maximum time to wait for shutdown to complete (or <= 0 to wait forever)

Returns:

module Loaded module with the given moduleID

Throws:

SensorHubException - if an error occurs during shutdown

stopModuleAsync

public IModule<?> stopModuleAsync(String moduleID,
                         IEventListener listener)
                           throws SensorHubException

Stops the module with the given local ID
This method is asynchronous so it returns immediately and the listener will be notified when the module is actually stopped

Parameters:

moduleID - Local ID of module to stop

listener - Listener to register for receiving the module's events

Returns:

the module instance (may not yet be stopped when this method returns)

Throws:

SensorHubException - if no module with given ID can be found

stopModuleAsync

public void stopModuleAsync(IModule<?> module)
                     throws SensorHubException

Stops the module asynchronously in a separate thread

Parameters:

module - module instance to stop

Throws:

SensorHubException

restartModuleAsync

public void restartModuleAsync(String moduleID,
                      IEventListener listener)
                        throws SensorHubException

Restarts the module with the given local ID
This method is asynchronous so it returns immediately and the listener will be notified when the module is actually restarted

Parameters:

moduleID - Local ID of module to restart

listener - Listener to register for receiving the module's events

Throws:

SensorHubException - if no module with given ID can be found

restartModuleAsync

public void restartModuleAsync(IModule<?> module)
                        throws SensorHubException

Restarts the module asynchronously in a separate thread
This will actually called requestStop() and then requestStart()

Parameters:

module - module instance to restart

Throws:

SensorHubException

updateModuleConfigAsync

public void updateModuleConfigAsync(ModuleConfig config)
                             throws SensorHubException

Updates the configuration of the module with the given local ID

Parameters:

config - new configuration (must contain the valid local ID of the module to update)

Throws:

SensorHubException - if no module with given ID can be found

updateModuleConfigAsync

public void updateModuleConfigAsync(IModule module,
                           ModuleConfig config)
                             throws SensorHubException

Updates the module configuration asynchronously in a separate thread

Parameters:

module - module instance to update

config - new module configuration

Throws:

SensorHubException

destroyModule

public void destroyModule(String moduleID)
                   throws SensorHubException

Removes the module with the given id

Parameters:

moduleID - Local ID of module to delete

Throws:

SensorHubException

saveModulesConfiguration

public void saveModulesConfiguration()

Save all modules current configuration to the repository

saveConfiguration

public void saveConfiguration(ModuleConfig... configList)

Saves the given module configurations in the repository

Parameters:

configList -

getLoadedModules

public Collection<IModule<?>> getLoadedModules()

Description copied from interface: IModuleManager

Gets the list of all modules handled by this manager that are already loaded (i.e. enabled)

Specified by:

getLoadedModules in interface IModuleManager<IModule<?>>

Returns:

list of module instances

getModuleById

public IModule<?> getModuleById(String moduleID)
                         throws SensorHubException

Description copied from interface: IModuleManager

Retrieves a module instance by its local ID

Specified by:

getModuleById in interface IModuleManager<IModule<?>>

Parameters:

moduleID - Id of module to retrieve

Returns:

direct reference to the module instance

Throws:

SensorHubException - if no module with given ID can be found

getModuleRef

public WeakReference<? extends IModule<?>> getModuleRef(String moduleID)
                                                 throws SensorHubException

Throws:

SensorHubException

getAvailableModules

public Collection<ModuleConfig> getAvailableModules()

Description copied from interface: IModuleManager

Gets the list of all modules handled by this manager that are configured but not yet loaded (i.e. disabled)

Specified by:

getAvailableModules in interface IModuleManager<IModule<?>>

Returns:

list of module configuration classes

getInstalledModuleTypes

public Collection<IModuleProvider> getInstalledModuleTypes()

Retrieves list of all installed module types

Returns:

list of module providers (not the module themselves)

getInstalledModuleTypes

public Collection<IModuleProvider> getInstalledModuleTypes(Class<?> moduleClass)

Retrieves list of all installed module types that are sub-types of the specified class

Parameters:

moduleClass - Parent class of modules to search for

Returns:

list of module providers (not the module themselves)

shutdown

public void shutdown(boolean saveConfig,
            boolean saveState)
              throws SensorHubException

Shuts down all modules and the config repository

Parameters:

saveConfig - If true, save current modules config

saveState - If true, save current module state

Throws:

SensorHubException

getStateManager

public IModuleStateManager getStateManager(String moduleID)

Returns the default state manager for the given module

Parameters:

moduleID -

Returns:

the state manager or null if no module data folder is specified in config

getModuleDataFolder

public File getModuleDataFolder(String moduleID)

Retrieves the folder where the module data should be stored

Parameters:

moduleID - Local ID of module

Returns:

File object representing the folder or null if none was specified

registerListener

public void registerListener(IEventListener listener)

Description copied from interface: IEventProducer

Registers a listener with this event producer. The listener is reponsible for filtering received events.

Specified by:

registerListener in interface IEventProducer

unregisterListener

public void unregisterListener(IEventListener listener)

Description copied from interface: IEventProducer

Unregisters a listener from this event producer. No more event will be sent to the listener from this producer.

Specified by:

unregisterListener in interface IEventProducer

handleEvent

public void handleEvent(Event<?> e)

Specified by:

handleEvent in interface IEventListener

postInit

protected void postInit(IModule<?> module)