org.sensorhub.impl.service

Class HttpServer

java.lang.Object

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

org.sensorhub.impl.service.HttpServer

All Implemented Interfaces:

IEventProducer, IModule<HttpServerConfig>

public class HttpServer
extends AbstractModule<HttpServerConfig>

Wrapper module for the HTTP server engine (Jetty for now)

Since:

Sep 6, 2013

Author:

Alex Robin

Field Summary

Fields

Modifier and Type	Field and Description
static String	TEST_MSG

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

config, eventHandler

Constructor Summary

Constructors

Constructor and Description
HttpServer()

Method Summary

Methods

Modifier and Type	Method and Description
void	addServletSecurity(String pathSpec, String... roles)
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
void	deployServlet(javax.servlet.http.HttpServlet servlet, Map<String,String> initParams, String... paths)
void	deployServlet(javax.servlet.http.HttpServlet servlet, String path)
static HttpServer	getInstance()
org.eclipse.jetty.server.Server	getJettyServer()
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	undeployServlet(javax.servlet.http.HttpServlet servlet)
void	updateConfig(HttpServerConfig config) Updates the module's configuration dynamically. The module must honor this new configuration unless an error is detected.

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

getConfiguration, getLocalID, getName, init, isEnabled, loadState, registerListener, saveState, unregisterListener

Methods inherited from class java.lang.Object

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

Field Detail

TEST_MSG

public static String TEST_MSG

Constructor Detail

HttpServer

public HttpServer()

Method Detail

getInstance

public static HttpServer getInstance()

updateConfig

public void updateConfig(HttpServerConfig config)
                  throws SensorHubException

Description copied from interface: IModule

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.

Specified by:

updateConfig in interface IModule<HttpServerConfig>

Overrides:

updateConfig in class AbstractModule<HttpServerConfig>

Throws:

SensorHubException

start

public void start()
           throws SensorHubException

Description copied from interface: IModule

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

Throws:

SensorHubException

stop

public void stop()
          throws SensorHubException

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.)
stop() can be called right after init() even if start() hasn't been called.

Throws:

SensorHubException

deployServlet

public void deployServlet(javax.servlet.http.HttpServlet servlet,
                 String path)

deployServlet

public void deployServlet(javax.servlet.http.HttpServlet servlet,
                 Map<String,String> initParams,
                 String... paths)

undeployServlet

public void undeployServlet(javax.servlet.http.HttpServlet servlet)

addServletSecurity

public void addServletSecurity(String pathSpec,
                      String... roles)

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

Throws:

SensorHubException

getJettyServer

public org.eclipse.jetty.server.Server getJettyServer()