public class

HttpServerImpl

extends HttpServer
java.lang.Object
   ↳ com.sun.net.httpserver.HttpServer
     ↳ sun.net.httpserver.HttpServerImpl

Summary

Public Methods
void bind(InetSocketAddress addr, int backlog)
Binds a currently unbound HttpServer to the given address and port number.
HttpContextImpl createContext(String path, HttpHandler handler)
Creates a HttpContext.
HttpContextImpl createContext(String path)
Creates a HttpContext without initially specifying a handler.
InetSocketAddress getAddress()
returns the address this server is listening on
Executor getExecutor()
returns this server's Executor object if one was specified with setExecutor(Executor), or null if none was specified.
void removeContext(HttpContext context)
Removes the given context from the server.
void removeContext(String path)
Removes the context identified by the given path from the server.
void setExecutor(Executor executor)
sets this server's Executor object.
void start()
Starts this server in a new background thread.
void stop(int delay)
stops this server by closing the listening socket and disallowing any new exchanges from being processed.
[Expand]
Inherited Methods
From class com.sun.net.httpserver.HttpServer
From class java.lang.Object

Public Methods

public void bind (InetSocketAddress addr, int backlog)

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.

Parameters
addr the address to listen on
backlog the socket backlog. If this value is less than or equal to zero, then a system default value is used.
Throws
IOException

public HttpContextImpl 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.

Parameters
path the root URI path to associate the context with
handler the handler to invoke for incoming requests.

public HttpContextImpl createContext (String path)

Creates a HttpContext without initially specifying a handler. The handler must later be specified using 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.

Parameters
path the root URI path to associate the context with

public InetSocketAddress getAddress ()

returns the address this server is listening on

Returns
  • the address/port number the server is listening on

public Executor getExecutor ()

returns this server's Executor object if one was specified with setExecutor(Executor), or null if none was specified.

Returns
  • the Executor established for this server or null if not set.

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.

Parameters
context the context to remove
Throws
IllegalArgumentException

public void removeContext (String path)

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.

Parameters
path the path of the handler to remove
Throws
IllegalArgumentException

public void setExecutor (Executor executor)

sets this server's 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.

Parameters
executor the Executor to set, or null for default implementation

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.

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.

Parameters
delay the maximum time in seconds to wait until exchanges have finished.