org.sensorhub.api.module

Interface IModule<ConfigType extends ModuleConfig>

Type Parameters:

ConfigType -

All Superinterfaces:

IEventProducer

All Known Subinterfaces:

ICommProvider<ConfigType>, IDataProducerModule<ConfigType>, IObsStorageModule<ConfigType>, IOnDemandProcessModule<ConfigType>, IProcessModule<ConfigType>, IRecordStorageModule<ConfigType>, ISensorModule<ConfigType>, IServiceModule<ConfigType>, IStorageModule<ConfigType>, IStreamProcessModule<ConfigType>

All Known Implementing Classes:

AbstractModule, AbstractSensorModule, AbstractStreamProcess, GenericStreamStorage, HttpServer, InMemoryBasicStorage, SMLStreamProcess, TCPCommProvider

public interface IModule<ConfigType extends ModuleConfig>
extends IEventProducer

Generic interface for all modules in the system.

Since:

Nov 12, 2010

Author:

Alex Robin

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanup() Cleans up all ressources used by the module when deleted All persistent resources created by the module should be cleaned when this is called
ConfigType	getConfiguration() Retrieves a copy of the module configuration (i.e.
String	getLocalID() Helper method to get the module's local ID
String	getName() Helper method to get the module's name
void	init(ConfigType config) Initializes the module with the specified configuration
boolean	isEnabled() Checks if module is enabled
void	loadState(IModuleStateManager loader) Restores the state of this module from info provided by the input stream
void	registerListener(IEventListener listener) Registers a listener to receive events generated by this module
void	saveState(IModuleStateManager saver) Saves the state of this module to the provided output stream
void	start() Starts the module with the current configuration. init() should always be called before start().
void	stop() Stops the module. All temporary resources created by the module should be cleaned when this is called (ex: memory, files, connections, etc.) stop() can be called right after init() even if start() hasn't been called.
void	unregisterListener(IEventListener listener) Unregisters a listener and thus stop receiving events generayed by this module
void	updateConfig(ConfigType config) Updates the module's configuration dynamically. The module must honor this new configuration unless an error is detected.

Method Detail

getConfiguration

ConfigType getConfiguration()

Retrieves a copy of the module configuration (i.e. for reading only since changes won't have any effect until updateConfig is called)

Returns:

a copy of the configuration object associated to this module

getName

String getName()

Helper method to get the module's name

Returns:

name string

getLocalID

String getLocalID()

Helper method to get the module's local ID

Returns:

id string

isEnabled

boolean isEnabled()

Checks if module is enabled

Returns:

true if module is enabled, false otherwise

init

void init(ConfigType config)
          throws SensorHubException

Initializes the module with the specified configuration

Parameters:

config -

Throws:

SensorHubException

updateConfig

void updateConfig(ConfigType config)
                  throws SensorHubException

Updates the module's configuration dynamically.
The module must honor this new configuration unless an error is detected. It is the responsability of the module to initiate a restart if the new configuration requires it.

Parameters:

config -

Throws:

SensorHubException

start

void start()
           throws SensorHubException

Starts the module with the current configuration.
init() should always be called before start().

Throws:

SensorHubException

stop

void stop()
          throws SensorHubException

Stops the module.
All temporary resources created by the module should be cleaned when this is called (ex: memory, files, connections, etc.)
stop() can be called right after init() even if start() hasn't been called.

Throws:

SensorHubException

saveState

void saveState(IModuleStateManager saver)
               throws SensorHubException

Saves the state of this module to the provided output stream

Parameters:

saver -

Throws:

SensorHubException

loadState

void loadState(IModuleStateManager loader)
               throws SensorHubException

Restores the state of this module from info provided by the input stream

Parameters:

loader -

Throws:

SensorHubException

cleanup

void cleanup()
             throws SensorHubException

Cleans up all ressources used by the module when deleted All persistent resources created by the module should be cleaned when this is called

Throws:

SensorHubException

registerListener

void registerListener(IEventListener listener)

Registers a listener to receive events generated by this module

Specified by:

registerListener in interface IEventProducer

Parameters:

listener -

unregisterListener

void unregisterListener(IEventListener listener)

Unregisters a listener and thus stop receiving events generayed by this module

Specified by:

unregisterListener in interface IEventProducer

Parameters:

listener -