org.sensorhub.impl.service.sps

Class SPSService

java.lang.Object

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

org.sensorhub.impl.service.sps.SPSService

All Implemented Interfaces:

IEventListener, IEventProducer, IModule<SPSServiceConfig>, IServiceModule<SPSServiceConfig>

public class SPSService
extends AbstractModule<SPSServiceConfig>
implements IServiceModule<SPSServiceConfig>, IEventListener

Implementation of SensorHub generic SPS service. The service can manage any of the sensors installed on the SensorHub instance and is configured automatically from the information generated by the sensors interfaces.

Since:

Jan 15, 2015

Author:

Alex Robin

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
SPSService()

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 void	deploy()
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(SPSServiceConfig 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.
protected void	undeploy()

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

Methods inherited from interface org.sensorhub.api.module.IModule

getConfiguration, getCurrentError, getCurrentState, getLocalID, getName, getStatusMessage, init, init, isInitialized, isStarted, loadState, registerListener, requestInit, requestStop, saveState, unregisterListener, updateConfig, waitForState

Constructor Detail

SPSService

public SPSService()

Method Detail

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

Overrides:

requestStart in class AbstractModule<SPSServiceConfig>

Throws:

SensorHubException - if startup could not be initiated

setConfiguration

public void setConfiguration(SPSServiceConfig config)

Description copied from interface: IModule

Sets the module configuration

Specified by:

setConfiguration in interface IModule<SPSServiceConfig>

Overrides:

setConfiguration in class AbstractModule<SPSServiceConfig>

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

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

deploy

protected void deploy()
               throws SensorHubException

Throws:

SensorHubException

undeploy

protected void undeploy()

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

Throws:

SensorHubException

handleEvent

public void handleEvent(Event<?> e)

Specified by:

handleEvent in interface IEventListener