public class WebServer extends Object implements Runnable
The WebServer
is a minimal HTTP server, that might be used
as an embedded web server.
Use of the WebServer
has grown very popular amongst users
of Apache XML-RPC. Why this is the case, can hardly be explained,
because the WebServer
is at best a workaround, compared to
full blown servlet engines like Tomcat or Jetty. For example, under
heavy load it will almost definitely be slower than a real servlet
engine, because it does neither support proper keepalive (multiple
requests per physical connection) nor chunked mode (in other words,
it cannot stream requests).
If you still insist in using the WebServer
, it is
recommended to use its subclass, the ServletWebServer
instead,
which offers a minimal subset of the servlet API. In other words,
you keep yourself the option to migrate to a real servlet engine
later.
Use of the WebServer
goes roughly like this: First of all,
create a property file (for example "MyHandlers.properties") and
add it to your jar file. The property keys are handler names and
the property values are the handler classes. Once that is done,
create an instance of WebServer:
final int port = 8088; final String propertyFile = "MyHandler.properties"; PropertyHandlerMapping mapping = new PropertyHandlerMapping(); ClassLoader cl = Thread.currentThread().getContextClassLoader(); mapping.load(cl, propertyFile); WebServer webServer = new WebServer(port); XmlRpcServerConfigImpl config = new XmlRpcServerConfigImpl(); XmlRpcServer server = webServer.getXmlRpcServer(); server.setConfig(config); server.setHandlerMapping(mapping); webServer.start();
Modifier and Type | Field and Description |
---|---|
protected List |
accept |
protected List |
deny |
protected XmlRpcStreamServer |
server |
protected ServerSocket |
serverSocket |
Constructor and Description |
---|
WebServer(int pPort)
Creates a web server at the specified port number.
|
WebServer(int pPort,
InetAddress pAddr)
Creates a web server at the specified port number and IP address.
|
Modifier and Type | Method and Description |
---|---|
void |
acceptClient(String pAddress)
Add an IP address to the list of accepted clients.
|
protected boolean |
allowConnection(Socket s)
Checks incoming connections to see if they should be allowed.
|
protected ServerSocket |
createServerSocket(int pPort,
int backlog,
InetAddress addr)
Factory method to manufacture the server socket.
|
void |
denyClient(String pAddress)
Add an IP address to the list of denied clients.
|
int |
getPort()
Returns the port, on which the web server is running.
|
XmlRpcStreamServer |
getXmlRpcServer()
Returns the
XmlRpcServer . |
protected boolean |
isParanoid()
Returns the client filtering state.
|
void |
log(String pMessage)
Logs a message.
|
void |
log(Throwable pError)
Logs an error.
|
protected ThreadPool.Task |
newTask(WebServer pServer,
XmlRpcStreamServer pXmlRpcServer,
Socket pSocket) |
protected ThreadPool |
newThreadPool() |
protected XmlRpcStreamServer |
newXmlRpcStreamServer() |
void |
run()
Listens for client requests until stopped.
|
void |
setParanoid(boolean pParanoid)
Switch client filtering on/off.
|
void |
shutdown()
Stop listening on the server port.
|
void |
start()
Spawns a new thread which binds this server to the port it's
configured to accept connections on.
|
protected ServerSocket serverSocket
protected final List accept
protected final List deny
protected final XmlRpcStreamServer server
public WebServer(int pPort)
pPort
- Port number; 0 for a random port, choosen by the
operating system.public WebServer(int pPort, InetAddress pAddr)
pPort
- Port number; 0 for a random port, choosen by the
operating system.pAddr
- Local IP address; null for all available IP addresses.protected XmlRpcStreamServer newXmlRpcStreamServer()
protected ServerSocket createServerSocket(int pPort, int backlog, InetAddress addr) throws IOException
SSLServerSocket
).pPort
- Port number; 0 for a random port, choosen by the operating
system.backlog
- addr
- If null
, binds to
INADDR_ANY
, meaning that all network interfaces on
a multi-homed host will be listening.IOException
- Error creating listener socket.public void start() throws IOException
IOException
- Binding the server socket failed.run()
public void setParanoid(boolean pParanoid)
pParanoid
- True to enable filtering, false otherwise.acceptClient(java.lang.String)
,
denyClient(java.lang.String)
protected boolean isParanoid()
acceptClient(java.lang.String)
,
denyClient(java.lang.String)
public void acceptClient(String pAddress)
pAddress
- The IP address being enabled.IllegalArgumentException
- Parsing the address failed.denyClient(java.lang.String)
,
setParanoid(boolean)
public void denyClient(String pAddress)
pAddress
- The IP address being disabled.IllegalArgumentException
- Parsing the address failed.acceptClient(java.lang.String)
,
setParanoid(boolean)
protected boolean allowConnection(Socket s)
s
- The socket to inspect.protected ThreadPool.Task newTask(WebServer pServer, XmlRpcStreamServer pXmlRpcServer, Socket pSocket) throws IOException
IOException
public void run()
start()
to invoke this method, and shutdown()
to
break out of it.run
in interface Runnable
RuntimeException
- Generally caused by either an
UnknownHostException
or BindException
with the vanilla web server.start()
,
shutdown()
protected ThreadPool newThreadPool()
public void shutdown()
listener
effectively breaks it out of its run()
loop.run()
public int getPort()
start()
only.public void log(Throwable pError)
pError
- The error being logged.public void log(String pMessage)
pMessage
- The being logged.public XmlRpcStreamServer getXmlRpcServer()
XmlRpcServer
.Copyright © 2001–2023 The Apache Software Foundation. All rights reserved.