com.sun.net.httpserver
abstract public class: HttpServer [javadoc |
source]
java.lang.Object
com.sun.net.httpserver.HttpServer
Direct Known Subclasses:
HttpsServerImpl, HttpServerImpl, HttpsServer
This class implements a simple HTTP server. A HttpServer is bound to an IP address
and port number and listens for incoming TCP connections from clients on this address.
The sub-class
HttpsServer implements a server which handles HTTPS requests.
One or more HttpHandler objects must be associated with a server
in order to process requests. Each such HttpHandler is registered
with a root URI path which represents the
location of the application or service on this server. The mapping of a handler
to a HttpServer is encapsulated by a HttpContext object. HttpContexts
are created by calling #createContext(String,HttpHandler) .
Any request for which no handler can be found is rejected with a 404 response.
Management of threads can be done external to this object by providing a
java.util.concurrent.Executor object. If none is provided a default
implementation is used.
Mapping request URIs to HttpContext paths
When a HTTP request is received,
the appropriate HttpContext (and handler) is located by finding the context
whose path is the longest matching prefix of the request URI's path.
Paths are matched literally, which means that the strings are compared
case sensitively, and with no conversion to or from any encoded forms.
For example. Given a HttpServer with the following HttpContexts configured.
| Context | Context path |
| ctx1 | "/" |
| ctx2 | "/apps/" |
| ctx3 | "/apps/foo/" |
the following table shows some request URIs and which, if any context they would
match with.
| Request URI | Matches context |
| "http://foo.com/apps/foo/bar" | ctx3 |
| "http://foo.com/apps/Foo/bar" | no match, wrong case |
| "http://foo.com/apps/app1" | ctx2 |
| "http://foo.com/foo" | ctx1 |
Note about socket backlogs
When binding to an address and port number, the application can also specify an integer
backlog parameter. This represents the maximum number of incoming TCP connections
which the system will queue internally. Connections are queued while they are waiting to
be accepted by the HttpServer. When the limit is reached, further connections may be
rejected (or possibly ignored) by the underlying TCP implementation. Setting the right
backlog value is a compromise between efficient resource usage in the TCP layer (not setting
it too high) and allowing adequate throughput of incoming requests (not setting it too low).
| Method from com.sun.net.httpserver.HttpServer Summary: |
|---|
|
bind, create, create, createContext, createContext, getAddress, getExecutor, removeContext, removeContext, setExecutor, start, stop |
| Method from com.sun.net.httpserver.HttpServer Detail: |
|---|
 abstract public void bind(InetSocketAddress addr,
int backlog) throws IOException
Binds a currently unbound HttpServer to the given address and port number.
A maximum backlog can also be specified. This is the maximum number of
queued incoming connections to allow on the listening socket.
Queued TCP connections exceeding this limit may be rejected by the TCP implementation. |
 public static HttpServer create() throws IOException {
return create (null, 0);
}
creates a HttpServer instance which is initially not bound to any local address/port.
The HttpServer is acquired from the currently installed HttpServerProvider
The server must be bound using #bind(InetSocketAddress,int) before it can be used. |
public static HttpServer create(InetSocketAddress addr,
int backlog) throws IOException {
HttpServerProvider provider = HttpServerProvider.provider();
return provider.createHttpServer (addr, backlog);
} Create a HttpServer instance which will bind to the
specified java.net.InetSocketAddress (IP address and port number)
A maximum backlog can also be specified. This is the maximum number of
queued incoming connections to allow on the listening socket.
Queued TCP connections exceeding this limit may be rejected by the TCP implementation.
The HttpServer is acquired from the currently installed HttpServerProvider |
abstract public HttpContext createContext(String path) Creates a HttpContext without initially specifying a handler. The handler must later be specified using
HttpContext#setHandler(HttpHandler) . A HttpContext represents a mapping from a
URI path to an exchange handler on this HttpServer. Once created, and when
the handler has been set, all requests
received by the server for the path will be handled by calling
the handler object. The context is identified by the path, and
can later be removed from the server using this with the #removeContext(String) method.
The path specifies the root URI path for this context. The first character of path must be
'/'.
The class overview describes how incoming request URIs are mapped
to HttpContext instances. |
abstract public HttpContext createContext(String path,
HttpHandler handler) Creates a HttpContext. A HttpContext represents a mapping from a
URI path to a exchange handler on this HttpServer. Once created, all requests
received by the server for the path will be handled by calling
the given handler object. The context is identified by the path, and
can later be removed from the server using this with the #removeContext(String) method.
The path specifies the root URI path for this context. The first character of path must be
'/'.
The class overview describes how incoming request URIs are mapped
to HttpContext instances. |
abstract public InetSocketAddress getAddress() returns the address this server is listening on |
abstract public Executor getExecutor() returns this server's Executor object if one was specified with
#setExecutor(Executor) , or null if none was
specified. |
abstract public void removeContext(String path) throws IllegalArgumentException Removes the context identified by the given path from the server.
Removing a context does not affect exchanges currently being processed
but prevents new ones from being accepted. |
abstract public void removeContext(HttpContext context) Removes the given context from the server.
Removing a context does not affect exchanges currently being processed
but prevents new ones from being accepted. |
abstract public void setExecutor(Executor executor) sets this server's java.util.concurrent.Executor object. An
Executor must be established before #start() is called.
All HTTP requests are handled in tasks given to the executor.
If this method is not called (before start()) or if it is
called with a null Executor, then
a default implementation is used, which uses the thread
which was created by the #start() method. |
abstract public void start() Starts this server in a new background thread. The background thread
inherits the priority, thread group and context class loader
of the caller. |
abstract public void stop(int delay) stops this server by closing the listening socket and disallowing
any new exchanges from being processed. The method will then block
until all current exchange handlers have completed or else when
approximately delay seconds have elapsed (whichever happens
sooner). Then, all open TCP connections are closed, the background
thread created by start() exits, and the method returns.
Once stopped, a HttpServer cannot be re-used. |
Save This Page