Class ServletWebServer

java.lang.Object
org.apache.xmlrpc.webserver.WebServer
org.apache.xmlrpc.webserver.ServletWebServer
All Implemented Interfaces:
Runnable

public class ServletWebServer extends WebServer

This is a subclass of the WebServer, which offers a minimal servlet API. It is recommended to use this class, rather than the WebServer, because it offers you a smooth migration path to a full blown servlet engine.

Use of the ServletWebServer goes like this: First of all, create a servlet. It may be an instance of XmlRpcServlet or a subclass thereof. Note, that servlets are stateless: One servlet may be used by multiple threads (aka requests) concurrently. In other words, the servlet must not have any instance variables, other than those which are read only after the servlets initialization.

The XmlRpcServlet is by default using a property file named org/apache/xmlrpc/server/webserver/XmlRpcServlet.properties. See the PropertyHandlerMapping for details on the property file.

   final int port = 8088;

   XmlRpcServlet servlet = new XmlRpcServlet();
   ServletWebServer webServer = new ServletWebServer(servlet, port);
   webServer.start();
 
  • Field Details

    • servlet

      private final javax.servlet.http.HttpServlet servlet
  • Constructor Details

    • ServletWebServer

      public ServletWebServer(javax.servlet.http.HttpServlet pServlet, int pPort) throws javax.servlet.ServletException
      Creates a new instance, which is listening on all local IP addresses and the given port.
      Parameters:
      pServlet - The servlet, which is handling requests.
      pPort - The servers port number; 0 for a random port being choosen.
      Throws:
      javax.servlet.ServletException - Initializing the servlet failed.
    • ServletWebServer

      public ServletWebServer(javax.servlet.http.HttpServlet pServlet, int pPort, InetAddress pAddr) throws javax.servlet.ServletException
      Creates a new instance, which is listening on the given IP address and the given port.
      Parameters:
      pServlet - The servlet, which is handling requests.
      pPort - The servers port number; 0 for a random port being choosen.
      pAddr - The servers IP address.
      Throws:
      javax.servlet.ServletException - Initializing the servlet failed.
  • Method Details