water

Class NanoHTTPD

java.lang.Object

water.NanoHTTPD

Direct Known Subclasses:

RequestServer

public class NanoHTTPD
extends java.lang.Object

A simple, tiny, nicely embeddable HTTP 1.0 (partially 1.1) server in Java

NanoHTTPD version 1.25, Copyright © 2001,2005-2012 Jarno Elonen (elonen@iki.fi, http://iki.fi/elonen/) and Copyright © 2010 Konstantinos Togias (info@ktogias.gr, http://ktogias.gr)

Features + limitations:

• Only one Java file
• Java 1.1 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

Ways to use:

• Run as a standalone app, serves files and shows requests
• Subclass serve() and embed to your own program
• Call serveFile() from serve() with your own base directory

See the end of the source file for distribution license (Modified BSD licence)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	NanoHTTPD.Response HTTP response.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HTTP_BADREQUEST Some HTTP response status codes
static java.lang.String	HTTP_FORBIDDEN Some HTTP response status codes
static java.lang.String	HTTP_INTERNALERROR Some HTTP response status codes
static java.lang.String	HTTP_NOTFOUND Some HTTP response status codes
static java.lang.String	HTTP_NOTIMPLEMENTED Some HTTP response status codes
static java.lang.String	HTTP_NOTMODIFIED Some HTTP response status codes
static java.lang.String	HTTP_OK Some HTTP response status codes
static java.lang.String	HTTP_PARTIALCONTENT Some HTTP response status codes
static java.lang.String	HTTP_RANGE_NOT_SATISFIABLE Some HTTP response status codes
static java.lang.String	HTTP_REDIRECT Some HTTP response status codes
static java.lang.String	HTTP_TOOLONGREQUEST Some HTTP response status codes
static java.lang.String	HTTP_UNAUTHORIZED Some HTTP response status codes
static java.lang.String	MIME_DEFAULT_BINARY Common mime types for dynamic content
static java.lang.String	MIME_HTML Common mime types for dynamic content
static java.lang.String	MIME_JSON Common mime types for dynamic content
static java.lang.String	MIME_PLAINTEXT Common mime types for dynamic content
static java.lang.String	MIME_XML Common mime types for dynamic content
protected static java.io.PrintStream	myOut

Constructor Summary

Constructors

Constructor and Description
NanoHTTPD(java.net.ServerSocket socket, java.io.File wwwroot) Starts a HTTP server to given port.

Method Summary

Methods

Modifier and Type	Method and Description
static void	main(java.lang.String[] args) Starts as a standalone file server and waits for Enter.
NanoHTTPD.Response	serve(java.lang.String uri, java.lang.String method, java.util.Properties header, java.util.Properties parms) Override this to customize the server.
NanoHTTPD.Response	serveFile(java.lang.String uri, java.util.Properties header, java.io.File homeDir, boolean allowDirectoryListing) Serves file from homeDir and its' subdirectories (only).
void	stop() Stops the server.

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_OK

public static final java.lang.String HTTP_OK

Some HTTP response status codes

See Also:

Constant Field Values

HTTP_PARTIALCONTENT

public static final java.lang.String HTTP_PARTIALCONTENT

Some HTTP response status codes

See Also:

Constant Field Values

HTTP_RANGE_NOT_SATISFIABLE

public static final java.lang.String HTTP_RANGE_NOT_SATISFIABLE

Some HTTP response status codes

See Also:

Constant Field Values

HTTP_REDIRECT

public static final java.lang.String HTTP_REDIRECT

Some HTTP response status codes

See Also:

Constant Field Values

HTTP_NOTMODIFIED

public static final java.lang.String HTTP_NOTMODIFIED

Some HTTP response status codes

See Also:

Constant Field Values

HTTP_FORBIDDEN

public static final java.lang.String HTTP_FORBIDDEN

Some HTTP response status codes

See Also:

Constant Field Values

HTTP_UNAUTHORIZED

public static final java.lang.String HTTP_UNAUTHORIZED

Some HTTP response status codes

See Also:

Constant Field Values

HTTP_NOTFOUND

public static final java.lang.String HTTP_NOTFOUND

Some HTTP response status codes

See Also:

Constant Field Values

HTTP_BADREQUEST

public static final java.lang.String HTTP_BADREQUEST

Some HTTP response status codes

See Also:

Constant Field Values

HTTP_TOOLONGREQUEST

public static final java.lang.String HTTP_TOOLONGREQUEST

Some HTTP response status codes

See Also:

Constant Field Values

HTTP_INTERNALERROR

public static final java.lang.String HTTP_INTERNALERROR

Some HTTP response status codes

See Also:

Constant Field Values

HTTP_NOTIMPLEMENTED

public static final java.lang.String HTTP_NOTIMPLEMENTED

Some HTTP response status codes

See Also:

Constant Field Values

MIME_PLAINTEXT

public static final java.lang.String MIME_PLAINTEXT

Common mime types for dynamic content

See Also:

Constant Field Values

MIME_HTML

public static final java.lang.String MIME_HTML

Common mime types for dynamic content

See Also:

Constant Field Values

MIME_JSON

public static final java.lang.String MIME_JSON

Common mime types for dynamic content

See Also:

Constant Field Values

MIME_DEFAULT_BINARY

public static final java.lang.String MIME_DEFAULT_BINARY

Common mime types for dynamic content

See Also:

Constant Field Values

MIME_XML

public static final java.lang.String MIME_XML

Common mime types for dynamic content

See Also:

Constant Field Values

myOut

protected static final java.io.PrintStream myOut

Constructor Detail

NanoHTTPD

public NanoHTTPD(java.net.ServerSocket socket,
         java.io.File wwwroot)
          throws java.io.IOException

Starts a HTTP server to given port.

Throws an IOException if the socket is already in use

Throws:

java.io.IOException

Method Detail

serve

public NanoHTTPD.Response serve(java.lang.String uri,
                       java.lang.String method,
                       java.util.Properties header,
                       java.util.Properties parms)

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.

header - Header entries, percent decoded

Returns:

HTTP response, see class Response for details

stop

public void stop()

Stops the server.

main

public static void main(java.lang.String[] args)

Starts as a standalone file server and waits for Enter.

serveFile

public NanoHTTPD.Response serveFile(java.lang.String uri,
                           java.util.Properties header,
                           java.io.File homeDir,
                           boolean allowDirectoryListing)

Serves file from homeDir and its' subdirectories (only). Uses only URI, ignores all headers and HTTP parameters.