org.sensorhub.ui

Class AdminUIModule

java.lang.Object

org.sensorhub.impl.module.AbstractModule<AdminUIConfig>

org.sensorhub.ui.AdminUIModule

All Implemented Interfaces:

IEventListener, IEventProducer, IModule<AdminUIConfig>

public class AdminUIModule
extends AbstractModule<AdminUIConfig>
implements IEventListener

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	log
protected static String	SERVLET_PARAM_MODULE_ID
protected static String	SERVLET_PARAM_UI_CLASS
protected static String	WIDGETSET

Fields inherited from class org.sensorhub.impl.module.AbstractModule

config, eventHandler, lastError, logger, startRequested, state, stateLock, statusMsg

Constructor Summary

Constructors

Constructor and Description
AdminUIModule()

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
protected IModuleConfigForm	generateForm(Class<?> clazz)
protected IModuleAdminPanel<IModule<?>>	generatePanel(Class<?> clazz)
static AdminUIModule	getInstance()
void	handleEvent(Event<?> e)
void	requestStart() Requests the module to start. Implementations of this method may block until the module is started or return immediately while they wait for the proper start conditions. When this method returns without error the module state is guaranteed to be ModuleEvent.ModuleState.STARTING
void	setConfiguration(AdminUIConfig config) Sets the module configuration
void	start() Starts the module synchronously with the current configuration. Implementations of this method must block until the module is successfully started or send an exception. Module lifecycle events may not be generated when calling this method directly. 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.) Implementations of this method must block until the module is successfully stopped or send an exception. Module lifecycle events may not be generated when calling this method directly. stop() can be called right after init() even if start() hasn't been called.

Methods inherited from class org.sensorhub.impl.module.AbstractModule

canInit, canStart, canStop, clearError, clearStatus, getConfiguration, getCurrentError, getCurrentState, getLocalID, getLogger, getName, getStatusMessage, init, init, isInitialized, isStarted, loadState, notifyConnectionStatus, registerListener, reportError, reportError, reportStatus, requestInit, requestStop, saveState, setState, toString, unregisterListener, updateConfig, waitForState

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

SERVLET_PARAM_UI_CLASS

protected static final String SERVLET_PARAM_UI_CLASS

See Also:

Constant Field Values

SERVLET_PARAM_MODULE_ID

protected static final String SERVLET_PARAM_MODULE_ID

See Also:

Constant Field Values

WIDGETSET

protected static final String WIDGETSET

See Also:

Constant Field Values

Constructor Detail

AdminUIModule

public AdminUIModule()

Method Detail

getInstance

public static AdminUIModule getInstance()

requestStart

public void requestStart()
                  throws SensorHubException

Description copied from interface: IModule

Requests the module to start.
Implementations of this method may block until the module is started or return immediately while they wait for the proper start conditions.
When this method returns without error the module state is guaranteed to be ModuleEvent.ModuleState.STARTING

Specified by:

requestStart in interface IModule<AdminUIConfig>

Overrides:

requestStart in class AbstractModule<AdminUIConfig>

Throws:

SensorHubException - if startup could not be initiated

setConfiguration

public void setConfiguration(AdminUIConfig config)

Description copied from interface: IModule

Sets the module configuration

Specified by:

setConfiguration in interface IModule<AdminUIConfig>

Overrides:

setConfiguration in class AbstractModule<AdminUIConfig>

start

public void start()
           throws SensorHubException

Description copied from interface: IModule

Starts the module synchronously with the current configuration.
Implementations of this method must block until the module is successfully started or send an exception.
Module lifecycle events may not be generated when calling this method directly.
init() should always be called before start().

Specified by:

start in interface IModule<AdminUIConfig>

Throws:

SensorHubException

stop

public void stop()

Description copied from interface: IModule

Stops the module.
All temporary resources created by the module should be cleaned when this is called (ex: memory, files, connections, etc.)
Implementations of this method must block until the module is successfully stopped or send an exception.
Module lifecycle events may not be generated when calling this method directly.
stop() can be called right after init() even if start() hasn't been called.

Specified by:

stop in interface IModule<AdminUIConfig>

generatePanel

protected IModuleAdminPanel<IModule<?>> generatePanel(Class<?> clazz)

generateForm

protected IModuleConfigForm generateForm(Class<?> clazz)

cleanup

public void cleanup()
             throws SensorHubException

Description copied from interface: IModule

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

Specified by:

cleanup in interface IModule<AdminUIConfig>

Throws:

SensorHubException

handleEvent

public void handleEvent(Event<?> e)

Specified by:

handleEvent in interface IEventListener