Modifier and Type | Class and Description |
---|---|
class |
ClientException
Exceptions generated by the client API
|
Modifier and Type | Method and Description |
---|---|
void |
IModule.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
|
ModuleType |
IModuleManager.getModuleById(String moduleID)
Retrieves a module instance by its local ID
|
void |
IModule.init()
Initializes the module synchronously with the current configuration.
Implementations of this method must block until the module is successfully initialized or send an exception. Module lifecycle events may not be generated when calling this method directly. |
void |
IModule.init(ConfigType config)
Initializes the module synchronously with the specified configuration.
Implementations of this method must block until the module is successfully initialized or send an exception. This is equivalent to calling IModule.setConfiguration(ModuleConfig)
and then IModule.init() with no arguments.Module lifecycle events may not be generated when calling this method directly. |
void |
IModule.loadState(IModuleStateManager loader)
Restores the state of this module
Implementations of this method must block until the module state is successfully loaded or send an exception. |
void |
IModule.requestInit(boolean force)
Requests to initialize the module with the current configuration.
Implementations of this method block until the module is initialized or return immediately while they wait for the proper init conditions. When this method returns without error the module state is guaranteed to be ModuleEvent.ModuleState.INITIALIZING |
void |
IModule.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 |
IModule.requestStop()
Requests the module to stop.
Implementations of this method may block until the module is stopped or return immediately while they wait for the proper stop conditions. When this method returns without error the module state is guaranteed to be ModuleEvent.ModuleState.STOPPING |
void |
IModule.saveState(IModuleStateManager saver)
Saves the state of this module.
Implementations of this method must block until the module state is successfully saved or send an exception. |
void |
IModule.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 |
IModule.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. |
void |
IModule.updateConfig(ConfigType config)
Updates the module's configuration dynamically.
The module must honor this new configuration unless an error is detected. |
Modifier and Type | Class and Description |
---|---|
class |
StorageException
Exception type generated by persistence API
|
Modifier and Type | Method and Description |
---|---|
Collection<? extends IRecordStorageModule<?>> |
IPersistenceManager.findStorageForSensor(String sensorID)
Finds storage modules where the specified sensor data is archived
|
StorageConfig |
IPersistenceManager.getDefaultStorageConfig(Class<?> storageClass)
Gets the default config for the specified storage type
|
Modifier and Type | Class and Description |
---|---|
class |
ProcessException
Exceptions generated by process implementations
|
Modifier and Type | Method and Description |
---|---|
Map<String,? extends IStreamingDataInterface> |
IOnDemandProcessInstance.getOutputs()
Retrieves the list of data outputs
|
Modifier and Type | Class and Description |
---|---|
class |
SensorException
Exceptions generated by the sensor API
|
Modifier and Type | Class and Description |
---|---|
class |
ServiceException
Exceptions generated by the service API
|
Modifier and Type | Method and Description |
---|---|
protected void |
SOSClient.connectWithPersistentHttp(DataStreamParser parser,
SOSClient.SOSRecordListener listener) |
protected void |
SOSClient.connectWithWebsockets(DataStreamParser parser,
SOSClient.SOSRecordListener listener) |
AbstractProcess |
SOSClient.getSensorDescription(String sensorUID) |
void |
SOSClient.retrieveStreamDescription() |
void |
SOSClient.startStream(SOSClient.SOSRecordListener listener) |
Modifier and Type | Method and Description |
---|---|
void |
SOSTClient.cleanup() |
void |
SOSTClient.init() |
void |
SOSTClient.requestStart() |
void |
SOSTClient.start() |
void |
SOSTClient.stop() |
Modifier and Type | Method and Description |
---|---|
void |
SPSClient.retrieveCommandDescription() |
SubmitResponse |
SPSClient.sendTaskMessage(DataBlock data) |
Modifier and Type | Method and Description |
---|---|
void |
UDPCommProvider.cleanup() |
void |
TCPCommProvider.cleanup() |
ICommNetwork<?> |
NetworkManagerImpl.getModuleById(String moduleID) |
void |
UDPCommProvider.start() |
void |
TCPCommProvider.start() |
void |
UDPCommProvider.stop() |
void |
TCPCommProvider.stop() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
AbstractModule.canInit(boolean force) |
protected boolean |
AbstractModule.canStart() |
protected boolean |
AbstractModule.canStop() |
ModuleConfig |
ModuleRegistry.createModuleConfig(IModuleProvider provider)
Creates a new module config class using information from a module provider
|
void |
ModuleRegistry.destroyModule(String moduleID)
Removes the module with the given id
|
IModule<?> |
ModuleRegistry.getModuleById(String moduleID) |
WeakReference<? extends IModule<?>> |
ModuleRegistry.getModuleRef(String moduleID) |
void |
AbstractModule.init() |
void |
AbstractModule.init(ConfigType config) |
IModule<?> |
ModuleRegistry.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<?> |
ModuleRegistry.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 |
ModuleRegistry.initModuleAsync(IModule<?> module,
boolean force)
Inits the module asynchronously in a separate thread
|
IModule<?> |
ModuleRegistry.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 |
Object |
ModuleRegistry.loadClass(String className)
Loads any class by reflection
|
IModule<?> |
ModuleRegistry.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<?> |
ModuleRegistry.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<?> |
ModuleRegistry.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. |
void |
AbstractModule.loadState(IModuleStateManager loader) |
void |
AbstractModule.requestInit(boolean force) |
void |
AbstractModule.requestStart() |
void |
AbstractModule.requestStop() |
void |
ModuleRegistry.restartModuleAsync(IModule<?> module)
Restarts the module asynchronously in a separate thread
This will actually called requestStop() and then requestStart() |
void |
ModuleRegistry.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 |
AbstractModule.saveState(IModuleStateManager saver) |
void |
ModuleRegistry.shutdown(boolean saveConfig,
boolean saveState)
Shuts down all modules and the config repository
|
IModule<?> |
ModuleRegistry.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<?> |
ModuleRegistry.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 |
ModuleRegistry.startModuleAsync(IModule<?> module)
Starts the module asynchronously in a separate thread
|
IModule<?> |
ModuleRegistry.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<?> |
ModuleRegistry.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<?> |
ModuleRegistry.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 |
ModuleRegistry.stopModuleAsync(IModule<?> module)
Stops the module asynchronously in a separate thread
|
IModule<?> |
ModuleRegistry.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 |
ModuleRegistry.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 |
AbstractModule.updateConfig(ConfigType config) |
void |
ModuleRegistry.updateModuleConfigAsync(IModule module,
ModuleConfig config)
Updates the module configuration asynchronously in a separate thread
|
void |
ModuleRegistry.updateModuleConfigAsync(ModuleConfig config)
Updates the configuration of the module with the given local ID
|
void |
RobustConnection.waitForConnection()
Waits until the client is connected
If connection is detected by another thread, this method can also be notified by calling stateLock.notify() |
Modifier and Type | Method and Description |
---|---|
void |
GenericStreamStorage.cleanup() |
Collection<IRecordStorageModule<?>> |
PersistenceManagerImpl.findStorageForSensor(String sensorLocalID) |
StorageConfig |
PersistenceManagerImpl.getDefaultStorageConfig(Class<?> storageClass) |
IStorageModule<?> |
PersistenceManagerImpl.getModuleById(String moduleID) |
void |
InMemoryBasicStorage.start() |
void |
GenericStreamStorage.start() |
void |
InMemoryBasicStorage.stop() |
void |
GenericStreamStorage.stop() |
Modifier and Type | Method and Description |
---|---|
void |
BasicStorageImpl.cleanup() |
void |
BasicStorageImpl.stop() |
Modifier and Type | Method and Description |
---|---|
IProcessModule<?> |
ProcessingManagerImpl.getModuleById(String moduleID) |
void |
SMLStreamProcess.init(SMLStreamProcessConfig config) |
void |
AbstractStreamProcess.start() |
void |
SMLStreamProcess.start() |
void |
SMLStreamProcess.updateConfig(SMLStreamProcessConfig config) |
Modifier and Type | Method and Description |
---|---|
void |
BasicSecurityRealm.cleanup() |
void |
BasicSecurityRealm.init() |
void |
BasicSecurityRealm.start() |
void |
BasicSecurityRealm.stop() |
Modifier and Type | Method and Description |
---|---|
void |
SensorSystem.cleanup() |
ISensorModule<?> |
SensorManagerImpl.getModuleById(String moduleID) |
void |
SensorSystem.init() |
void |
AbstractSensorModule.init() |
void |
AbstractSensorModule.init(ConfigType config) |
void |
SensorSystem.loadState(IModuleStateManager loader) |
void |
AbstractSensorModule.loadState(IModuleStateManager loader) |
void |
SensorSystem.saveState(IModuleStateManager saver) |
void |
AbstractSensorModule.saveState(IModuleStateManager saver) |
void |
SensorSystem.start() |
void |
SensorSystem.stop() |
void |
AbstractSensorModule.updateConfig(ConfigType config) |
Modifier and Type | Method and Description |
---|---|
void |
SOSVirtualSensor.cleanup() |
void |
SOSVirtualSensor.loadState(IModuleStateManager loader) |
void |
SOSVirtualSensor.saveState(IModuleStateManager saver) |
void |
SOSVirtualSensor.start() |
void |
SOSVirtualSensor.stop() |
Modifier and Type | Method and Description |
---|---|
protected void |
SWEVirtualSensor.checkConfig() |
void |
SWEVirtualSensor.cleanup() |
void |
SWEVirtualSensor.start() |
void |
SWEVirtualSensor.stop() |
Modifier and Type | Method and Description |
---|---|
void |
HttpServer.cleanup() |
void |
HttpServer.start() |
void |
HttpServer.stop() |
void |
HttpServer.updateConfig(HttpServerConfig config) |
Modifier and Type | Method and Description |
---|---|
void |
SOSService.cleanup() |
protected void |
SOSService.deploy() |
protected void |
SOSServlet.generateCapabilities()
Generates the SOSServiceCapabilities object with info from data source
|
protected ISOSDataConsumer |
SensorConsumerConfig.getConsumerInstance() |
protected abstract ISOSDataConsumer |
SOSConsumerConfig.getConsumerInstance() |
protected abstract ISOSDataProviderFactory |
SOSProviderConfig.getFactory(SOSServlet service)
Retrieves the factory associated with this type of data provider
|
protected ISOSDataProviderFactory |
SensorDataProviderConfig.getFactory(SOSServlet service) |
protected ISOSDataProviderFactory |
StorageDataProviderConfig.getFactory(SOSServlet service) |
protected ISOSDataProviderFactory |
StreamProcessProviderConfig.getFactory(SOSServlet service) |
protected double |
StreamDataProviderFactory.getLowestSamplingPeriodFromProducer() |
IObservation |
StreamDataProvider.getNextObservation() |
protected Set<String> |
StreamDataProviderFactory.getObservablePropertiesFromProducer() |
protected Set<String> |
StreamDataProviderFactory.getObservationTypesFromProducer() |
void |
SOSService.requestStart() |
protected void |
SOSServlet.start() |
void |
SOSService.start() |
Constructor and Description |
---|
SensorDataConsumer(SensorConsumerConfig config) |
SensorDataProviderFactory(SOSServlet service,
SensorDataProviderConfig config) |
SensorWithStorageConsumer(SensorConsumerConfig config) |
SensorWithStorageProviderFactory(SOSServlet service,
SensorDataProviderConfig config) |
StorageDataProviderFactory(SOSServlet service,
StorageDataProviderConfig config) |
StreamDataProviderFactory(SOSServlet service,
StreamDataProviderConfig config,
ProducerType producer,
String producerType) |
StreamDataProviderFactory(StreamDataProviderConfig config,
ProducerType producer,
String producerType) |
StreamProcessProviderFactory(SOSServlet service,
StreamProcessProviderConfig config) |
StreamProcessWithStorageProviderFactory(SOSServlet service,
StreamProcessProviderConfig config) |
StreamWithStorageProviderFactory(SOSServlet service,
StreamDataProviderConfig config,
ProducerType producer) |
Modifier and Type | Method and Description |
---|---|
void |
SPSService.cleanup() |
protected void |
SPSService.deploy() |
protected ISPSConnector |
SensorConnectorConfig.getConnector(SPSServlet service) |
protected abstract ISPSConnector |
SPSConnectorConfig.getConnector(SPSServlet service)
Retrieves the connector instance describe by this configuration
|
void |
SPSService.requestStart() |
void |
SPSService.start() |
protected void |
SPSServlet.start() |
Constructor and Description |
---|
DirectSensorConnector(SPSServlet service,
SensorConnectorConfig config) |
SharedSensorConnector(SPSServlet service,
SensorConnectorConfig config) |
Modifier and Type | Method and Description |
---|---|
void |
AdminUIModule.cleanup() |
void |
AdminUIModule.requestStart() |
void |
AdminUIModule.start() |
Copyright © 2016 Sensia Software LLC. All rights reserved.