org.dstadler.commons.http

Class NanoHTTPD

java.lang.Object

org.dstadler.commons.http.NanoHTTPD

public class NanoHTTPD
extends java.lang.Object

A simple, tiny, nicely embeddable HTTP 1.0 server in Java

NanoHTTPD version 1.14, Copyright © 2001,2005-2010 Jarno Elonen (elonen@iki.fi, http://iki.fi/elonen/)

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
• Supports both dynamic content and file serving
• 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 does the 301 redirection trick for directories without '/'
• File server supports simple skipping for files (continue download)
• File server uses current directory as a web root
• 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 from current directory 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
static 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_OK Some HTTP response status codes
static java.lang.String	HTTP_REDIRECT 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

Constructor Summary

Constructors

Constructor and Description
NanoHTTPD(int port) Starts a HTTP server to given port and binds on all host-names.
NanoHTTPD(int port, java.net.InetAddress bindHost) Starts a HTTP server to given port and only binds on the given name if specifed non-null.
NanoHTTPD(int port, java.net.InetAddress bindHost, int sessionTimeout) Starts a HTTP server to given port and only binds on the given name if specifed non-null.

Method Summary

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 uriIn, java.util.Properties header, java.io.File homeDir, boolean allowDirectoryListing) Serves file from homeDir and its' subdirectories (only).
static void	setEncoding(java.lang.String encoding)
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_REDIRECT

public static final java.lang.String HTTP_REDIRECT

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_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_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

Constructor Detail

NanoHTTPD

public NanoHTTPD(int port)
          throws java.io.IOException

Starts a HTTP server to given port and binds on all host-names.

Parameters:

port - The port to listen for HTTP connections

Throws:

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

NanoHTTPD

public NanoHTTPD(int port,
                 java.net.InetAddress bindHost)
          throws java.io.IOException

Starts a HTTP server to given port and only binds on the given name if specifed non-null.

Parameters:

port - The port to listen for HTTP connections

bindHost - If non-null, the hostanme/address to bind to.

Throws:

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

NanoHTTPD

public NanoHTTPD(int port,
                 java.net.InetAddress bindHost,
                 int sessionTimeout)
          throws java.io.IOException

Starts a HTTP server to given port and only binds on the given name if specifed non-null.

Parameters:

port - The port to listen for HTTP connections

bindHost - If non-null, the hostanme/address to bind to.

sessionTimeout - Timeout in milliseconds after which reading from the HTTP client side is terminated with a timeout-error.

Throws:

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

Method Detail

setEncoding

public static void setEncoding(java.lang.String encoding)

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)
                 throws java.io.IOException

Starts as a standalone file server and waits for Enter.

Throws:

java.io.IOException

serveFile

public NanoHTTPD.Response serveFile(java.lang.String uriIn,
                                    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.