fi.iki.elonen

Class NanoHTTPD

java.lang.Object

fi.iki.elonen.NanoHTTPD

Direct Known Subclasses:

TimelineHTTPServer

public abstract class NanoHTTPD
extends java.lang.Object

A simple, tiny, nicely embeddable HTTP server in Java

NanoHTTPD

Copyright (c) 2012-2013 by Paul S. Hawke, 2001,2005-2013 by Jarno Elonen, 2010 by Konstantinos Togias

Features + limitations:

• Only one Java file
• Java 5 compatible
• Released as open source, Modified BSD licence
• No fixed config files, logging, authorization etc. (Implement yourself if you need them.)
• Supports parameter parsing of GET and POST methods (+ rudimentary PUT support in 1.25)
• Supports both dynamic content and file serving
• Supports file upload (since version 1.2, 2010)
• Supports partial content (streaming)
• Supports ETags
• Never caches anything
• Doesn't limit bandwidth, request time or simultaneous connections
• Default code serves files and shows all HTTP parameters and headers
• File server supports directory listing, index.html and index.htm
• File server supports partial content (streaming)
• File server supports ETags
• File server does the 301 redirection trick for directories without '/'
• File server supports simple skipping for files (continue download)
• File server serves also very long files without memory overhead
• Contains a built-in list of most common mime types
• All header names are converted lowercase so they don't vary between browsers/clients

How to use:

• Subclass and implement serve() and embed to your own program

See the separate "LICENSE.md" file for the distribution license (Modified BSD licence)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NanoHTTPD.AsyncRunner Pluggable strategy for asynchronously executing requests.
static class	NanoHTTPD.Cookie
class	NanoHTTPD.CookieHandler Provides rudimentary support for cookies.
static class	NanoHTTPD.DefaultAsyncRunner Default threading strategy for NanoHttpd.
static class	NanoHTTPD.DefaultTempFile Default strategy for creating and cleaning up temporary files.
static class	NanoHTTPD.DefaultTempFileManager Default strategy for creating and cleaning up temporary files.
protected class	NanoHTTPD.HTTPSession
static interface	NanoHTTPD.IHTTPSession Handles one session, i.e.
static class	NanoHTTPD.Method HTTP Request methods, with the ability to decode a String back to its enum value.
static class	NanoHTTPD.Response HTTP response.
static class	NanoHTTPD.ResponseException
static interface	NanoHTTPD.TempFile A temp file.
static interface	NanoHTTPD.TempFileManager Temp file manager.
static interface	NanoHTTPD.TempFileManagerFactory Factory to create temp file managers.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MIME_HTML Common mime type for dynamic content: html
static java.lang.String	MIME_PLAINTEXT Common mime type for dynamic content: plain text
static int	SOCKET_READ_TIMEOUT Maximum time to wait on Socket.getInputStream().read() (in milliseconds) This is required as the Keep-Alive HTTP connections would otherwise block the socket reading thread forever (or as long the browser is open).

Constructor Summary

Constructors

Constructor and Description
NanoHTTPD(int port) Constructs an HTTP server on given port.
NanoHTTPD(java.lang.String hostname, int port) Constructs an HTTP server on given hostname and port.

Method Summary

Modifier and Type	Method and Description
void	closeAllConnections() Forcibly closes all connections that are open.
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	decodeParameters(java.util.Map<java.lang.String,java.lang.String> parms) Decode parameters from a URL, handing the case where a single parameter name might have been supplied several times, by return lists of values.
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	decodeParameters(java.lang.String queryString) Decode parameters from a URL, handing the case where a single parameter name might have been supplied several times, by return lists of values.
protected java.lang.String	decodePercent(java.lang.String str) Decode percent encoded String values.
int	getListeningPort()
boolean	isAlive()
void	registerConnection(java.net.Socket socket) Registers that a new connection has been set up.
NanoHTTPD.Response	serve(NanoHTTPD.IHTTPSession session) Override this to customize the server.
NanoHTTPD.Response	serve(java.lang.String uri, NanoHTTPD.Method method, java.util.Map<java.lang.String,java.lang.String> headers, java.util.Map<java.lang.String,java.lang.String> parms, java.util.Map<java.lang.String,java.lang.String> files) Deprecated.
void	setAsyncRunner(NanoHTTPD.AsyncRunner asyncRunner) Pluggable strategy for asynchronously executing requests.
void	setTempFileManagerFactory(NanoHTTPD.TempFileManagerFactory tempFileManagerFactory) Pluggable strategy for creating and cleaning up temporary files.
void	start() Start the server.
void	stop() Stop the server.
void	unRegisterConnection(java.net.Socket socket) Registers that a connection has been closed
boolean	wasStarted()

Methods inherited from class java.lang.Object

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

Field Detail

SOCKET_READ_TIMEOUT

public static final int SOCKET_READ_TIMEOUT

Maximum time to wait on Socket.getInputStream().read() (in milliseconds) This is required as the Keep-Alive HTTP connections would otherwise block the socket reading thread forever (or as long the browser is open).

See Also:

Constant Field Values

MIME_PLAINTEXT

public static final java.lang.String MIME_PLAINTEXT

Common mime type for dynamic content: plain text

See Also:

Constant Field Values

MIME_HTML

public static final java.lang.String MIME_HTML

Common mime type for dynamic content: html

See Also:

Constant Field Values

Constructor Detail

NanoHTTPD

public NanoHTTPD(int port)

Constructs an HTTP server on given port.

Parameters:

port -

NanoHTTPD

public NanoHTTPD(java.lang.String hostname,
                 int port)

Constructs an HTTP server on given hostname and port.

Parameters:

hostname -

port -

Method Detail

start

public void start()
           throws java.io.IOException

Start the server.

Throws:

java.io.IOException - if the socket is in use.

stop

public void stop()

Stop the server.

registerConnection

public void registerConnection(java.net.Socket socket)

Registers that a new connection has been set up.

Parameters:

socket - the Socket for the connection.

unRegisterConnection

public void unRegisterConnection(java.net.Socket socket)

Registers that a connection has been closed

Parameters:

socket - the Socket for the connection.

closeAllConnections

public void closeAllConnections()

Forcibly closes all connections that are open.

getListeningPort

public final int getListeningPort()

wasStarted

public final boolean wasStarted()

isAlive

public final boolean isAlive()

serve

@Deprecated
public NanoHTTPD.Response serve(java.lang.String uri,
                                            NanoHTTPD.Method method,
                                            java.util.Map<java.lang.String,java.lang.String> headers,
                                            java.util.Map<java.lang.String,java.lang.String> parms,
                                            java.util.Map<java.lang.String,java.lang.String> files)

Deprecated.

Override this to customize the server.

(By default, this delegates to serveFile() and allows directory listing.)

Parameters:

uri - Percent-decoded URI without parameters, for example "/index.cgi"

method - "GET", "POST" etc.

parms - Parsed, percent decoded parameters from URI and, in case of POST, data.

headers - Header entries, percent decoded

files -

Returns:

HTTP response, see class Response for details

serve

public NanoHTTPD.Response serve(NanoHTTPD.IHTTPSession session)

Override this to customize the server.

(By default, this delegates to serveFile() and allows directory listing.)

Parameters:

session - The HTTP session

Returns:

HTTP response, see class Response for details

decodePercent

protected java.lang.String decodePercent(java.lang.String str)

Decode percent encoded String values.

Parameters:

str - the percent encoded String

Returns:

expanded form of the input, for example "foo%20bar" becomes "foo bar"

decodeParameters

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> decodeParameters(java.util.Map<java.lang.String,java.lang.String> parms)

Decode parameters from a URL, handing the case where a single parameter name might have been supplied several times, by return lists of values. In general these lists will contain a single element.

Parameters:

parms - original NanoHttpd parameters values, as passed to the serve() method.

Returns:

a map of String (parameter name) to List<String> (a list of the values supplied).

decodeParameters

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> decodeParameters(java.lang.String queryString)

Decode parameters from a URL, handing the case where a single parameter name might have been supplied several times, by return lists of values. In general these lists will contain a single element.

Parameters:

queryString - a query string pulled from the URL.

Returns:

a map of String (parameter name) to List<String> (a list of the values supplied).

setAsyncRunner

public void setAsyncRunner(NanoHTTPD.AsyncRunner asyncRunner)

Pluggable strategy for asynchronously executing requests.

Parameters:

asyncRunner - new strategy for handling threads.

setTempFileManagerFactory

public void setTempFileManagerFactory(NanoHTTPD.TempFileManagerFactory tempFileManagerFactory)

Pluggable strategy for creating and cleaning up temporary files.

Parameters:

tempFileManagerFactory - new strategy for handling temp files.