org.eclipse.emf.emfstore.server

Interface ESXmlRpcWebServerProvider

All Known Implementing Classes:

XmlRpcBuiltinWebServer

public interface ESXmlRpcWebServerProvider

Extension point interface to use client specific web server/server configuration/logging etc to implement EMFStore Server, e.g. embedded Jetty. Only one extension is allowed in a OSGi system, otherwise EMFStore startup will terminate with an error. If none is specified, the default EMFStore built-in server is used.

Since:

1.3

Author:

Marco van Meegen

Method Summary

Modifier and Type	Method and Description
void	addHandler(String handlerName, Class<?> clazz) Adds a handler to the web server.
int	getPort() Returns the port the server is listening to.
void	initServer() Starts the server.
boolean	removeHandler(String handlerName) Removes a handler from the web server.
void	setPort(int port) Set the port for the server, must be called before any other method can be called.
void	stopServer() Stops the server.

Method Detail

stopServer

void stopServer()

Stops the server.

removeHandler

boolean removeHandler(String handlerName)

Removes a handler from the web server.

Parameters:

handlerName - the handler's name

Returns:

true, if other handler still available

addHandler

void addHandler(String handlerName,
                Class<?> clazz)
         throws ESServerInitException

Adds a handler to the web server.

Parameters:

handlerName - handler name

clazz - class of server interface

Throws:

ESServerInitException - in case of failure

initServer

void initServer()
         throws ESServerInitException

Starts the server.

Throws:

ESServerInitException - in case of failure

setPort

void setPort(int port)

Set the port for the server, must be called before any other method can be called.

Parameters:

port - http(s) port where server will answer

getPort

int getPort()

Returns the port the server is listening to.

Returns:

port server listens to