org.jupnp.transport.impl.osgi

Class HttpServiceServletContainerAdapter

java.lang.Object

org.jupnp.transport.impl.osgi.HttpServiceServletContainerAdapter

All Implemented Interfaces:

ServletContainerAdapter

public class HttpServiceServletContainerAdapter
extends Object
implements ServletContainerAdapter

This is a servlet container adapter for an OSGi http service. It is a singleton as there will be only a single OSGi http service available to register servlets on

Author:

Kai Kreuzer, Ivan Iliev - No longer a singleton

Field Summary

Fields

Modifier and Type	Field and Description
protected org.osgi.service.http.HttpService	httpService

Method Summary

Modifier and Type	Method and Description
int	addConnector(String host, int port) Might be called several times to set up the connectors.
static HttpServiceServletContainerAdapter	getInstance(org.osgi.service.http.HttpService httpService, org.osgi.framework.BundleContext context)
void	registerServlet(String contextPath, javax.servlet.Servlet servlet) Might be called several times to register (the same) handler for UPnP requests, should only register it once.
void	setExecutorService(ExecutorService executorService) Might be called several times to integrate the servlet container with jUPnP's executor configuration.
void	startIfNotRunning() Start your servlet container if it isn't already running, might be called multiple times.
void	stopIfRunning() Stop your servlet container if it's still running, might be called multiple times.

Methods inherited from class java.lang.Object

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

Field Detail

httpService

protected org.osgi.service.http.HttpService httpService

Method Detail

getInstance

public static HttpServiceServletContainerAdapter getInstance(org.osgi.service.http.HttpService httpService,
                                                             org.osgi.framework.BundleContext context)

setExecutorService

public void setExecutorService(ExecutorService executorService)

Description copied from interface: ServletContainerAdapter

Might be called several times to integrate the servlet container with jUPnP's executor configuration. You can ignore this call if you want to configure the container's thread pooling independently from jUPnP. If you use the given jUPnP ExecutorService, make sure the Jetty container won't shut it down when ServletContainerAdapter.stopIfRunning() is called!

Specified by:

setExecutorService in interface ServletContainerAdapter

Parameters:

executorService - The service to use when spawning new servlet execution threads.

addConnector

public int addConnector(String host,
                        int port)
                 throws IOException

Description copied from interface: ServletContainerAdapter

Might be called several times to set up the connectors. This is the host/address and the port jUPnP expects to receive HTTP requests on. If you set up your HTTP server connectors elsewhere and ignore when jUPnP calls this method, make sure you configure jUPnP with the correct host/port of your servlet container.

Specified by:

addConnector in interface ServletContainerAdapter

Parameters:

host - The host address for the socket.

port - The port, might be -1 to bind to an ephemeral port.

Returns:

The actual registered local port.

Throws:

IOException - If the connector couldn't be opened to retrieve the registered local port.

registerServlet

public void registerServlet(String contextPath,
                            javax.servlet.Servlet servlet)

Description copied from interface: ServletContainerAdapter

Might be called several times to register (the same) handler for UPnP requests, should only register it once.

Specified by:

registerServlet in interface ServletContainerAdapter

Parameters:

contextPath - The context path prefix for all UPnP requests.

servlet - The servlet handling all UPnP requests.

startIfNotRunning

public void startIfNotRunning()

Description copied from interface: ServletContainerAdapter

Start your servlet container if it isn't already running, might be called multiple times.

Specified by:

startIfNotRunning in interface ServletContainerAdapter

stopIfRunning

public void stopIfRunning()

Description copied from interface: ServletContainerAdapter

Stop your servlet container if it's still running, might be called multiple times.

Specified by:

stopIfRunning in interface ServletContainerAdapter