Package fi.iki.elonen

Class SimpleWebServer

java.lang.Object

fi.iki.elonen.NanoHTTPD

fi.iki.elonen.SimpleWebServer

public class SimpleWebServer
extends NanoHTTPD

Nested Class Summary

Nested classes/interfaces inherited from class fi.iki.elonen.NanoHTTPD

NanoHTTPD.AsyncRunner, NanoHTTPD.ClientHandler, NanoHTTPD.ContentType, NanoHTTPD.Cookie, NanoHTTPD.CookieHandler, NanoHTTPD.DefaultAsyncRunner, NanoHTTPD.DefaultServerSocketFactory, NanoHTTPD.DefaultTempFile, NanoHTTPD.DefaultTempFileManager, NanoHTTPD.HTTPSession, NanoHTTPD.IHTTPSession, NanoHTTPD.Method, NanoHTTPD.Response, NanoHTTPD.ResponseException, NanoHTTPD.SecureServerSocketFactory, NanoHTTPD.ServerRunnable, NanoHTTPD.ServerSocketFactory, NanoHTTPD.TempFile, NanoHTTPD.TempFileManager, NanoHTTPD.TempFileManagerFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCESS_CONTROL_ALLOW_HEADER_PROPERTY_NAME
private static final String	ALLOWED_METHODS
private final String	cors
(package private) static final String	DEFAULT_ALLOWED_HEADERS
static final List<String>	INDEX_FILE_NAMES	Default Index file names.
private static final String	LICENCE	The distribution licence
private static final int	MAX_AGE
private static Map<String,WebServerPlugin>	mimeTypeHandlers
private final boolean	quiet
protected List<File>	rootDirs

Fields inherited from class fi.iki.elonen.NanoHTTPD

asyncRunner, MIME_HTML, MIME_PLAINTEXT, MIME_TYPES, SOCKET_READ_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
SimpleWebServer(String host, int port, File wwwroot, boolean quiet)
SimpleWebServer(String host, int port, File wwwroot, boolean quiet, String cors)
SimpleWebServer(String host, int port, List<File> wwwroots, boolean quiet)
SimpleWebServer(String host, int port, List<File> wwwroots, boolean quiet, String cors)

Method Summary

Modifier and Type	Method	Description
protected NanoHTTPD.Response	addCORSHeaders(Map<String,String> queryHeaders, NanoHTTPD.Response resp, String cors)
private String	calculateAllowHeaders(Map<String,String> queryHeaders)
private boolean	canServeUri(String uri, File homeDir)
private NanoHTTPD.Response	defaultRespond(Map<String,String> headers, NanoHTTPD.IHTTPSession session, String uri)
private String	encodeUri(String uri)	URL-encodes everything between "/"-characters.
private String	findIndexFileInDirectory(File directory)
protected NanoHTTPD.Response	getForbiddenResponse(String s)
protected NanoHTTPD.Response	getInternalErrorResponse(String s)
protected NanoHTTPD.Response	getNotFoundResponse()
void	init()	Used to initialize and customize the server.
protected String	listDirectory(String uri, File f)
static void	main(String[] args)	Starts as a standalone file server and waits for Enter.
private NanoHTTPD.Response	newFixedFileResponse(File file, String mime)
static NanoHTTPD.Response	newFixedLengthResponse(NanoHTTPD.Response.IStatus status, String mimeType, String message)
protected static void	registerPluginForMimeType(String[] indexFiles, String mimeType, WebServerPlugin plugin, Map<String,String> commandLineOptions)
private NanoHTTPD.Response	respond(Map<String,String> headers, NanoHTTPD.IHTTPSession session, String uri)
NanoHTTPD.Response	serve(NanoHTTPD.IHTTPSession session)	Override this to customize the server.
(package private) NanoHTTPD.Response	serveFile(String uri, Map<String,String> header, File file, String mime)	Serves file from homeDir and its' subdirectories (only).

Methods inherited from class fi.iki.elonen.NanoHTTPD

closeAllConnections, createClientHandler, createServerRunnable, decodeParameters, decodeParameters, decodePercent, getHostname, getListeningPort, getMimeTypeForFile, getServerSocketFactory, getTempFileManagerFactory, isAlive, makeSecure, makeSSLSocketFactory, makeSSLSocketFactory, makeSSLSocketFactory, mimeTypes, newChunkedResponse, newFixedLengthResponse, newFixedLengthResponse, serve, setAsyncRunner, setServerSocketFactory, setTempFileManagerFactory, start, start, start, stop, useGzipWhenAccepted, wasStarted

Methods inherited from class java.lang.Object

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

Field Details

INDEX_FILE_NAMES

public static final List<String> INDEX_FILE_NAMES

Default Index file names.

LICENCE

private static final String LICENCE

The distribution licence

mimeTypeHandlers

private static Map<String,WebServerPlugin> mimeTypeHandlers

quiet

private final boolean quiet

cors

private final String cors

rootDirs

protected List<File> rootDirs

ALLOWED_METHODS

private static final String ALLOWED_METHODS

See Also:

• Constant Field Values

MAX_AGE

private static final int MAX_AGE

See Also:

• Constant Field Values

DEFAULT_ALLOWED_HEADERS

static final String DEFAULT_ALLOWED_HEADERS

See Also:

• Constant Field Values

ACCESS_CONTROL_ALLOW_HEADER_PROPERTY_NAME

public static final String ACCESS_CONTROL_ALLOW_HEADER_PROPERTY_NAME

See Also:

• Constant Field Values

Constructor Details

SimpleWebServer

public SimpleWebServer(String host,
 int port,
 File wwwroot,
 boolean quiet,
 String cors)

SimpleWebServer

public SimpleWebServer(String host,
 int port,
 File wwwroot,
 boolean quiet)

SimpleWebServer

public SimpleWebServer(String host,
 int port,
 List<File> wwwroots,
 boolean quiet)

SimpleWebServer

public SimpleWebServer(String host,
 int port,
 List<File> wwwroots,
 boolean quiet,
 String cors)

Method Details

main

public static void main(String[] args)

Starts as a standalone file server and waits for Enter.

registerPluginForMimeType

protected static void registerPluginForMimeType(String[] indexFiles,
 String mimeType,
 WebServerPlugin plugin,
 Map<String,String> commandLineOptions)

canServeUri

private boolean canServeUri(String uri,
 File homeDir)

encodeUri

private String encodeUri(String uri)

URL-encodes everything between "/"-characters. Encodes spaces as '%20' instead of '+'.

findIndexFileInDirectory

private String findIndexFileInDirectory(File directory)

getForbiddenResponse

protected NanoHTTPD.Response getForbiddenResponse(String s)

getInternalErrorResponse

protected NanoHTTPD.Response getInternalErrorResponse(String s)

getNotFoundResponse

protected NanoHTTPD.Response getNotFoundResponse()

init

public void init()

Used to initialize and customize the server.

listDirectory

protected String listDirectory(String uri,
 File f)

newFixedLengthResponse

public static NanoHTTPD.Response newFixedLengthResponse(NanoHTTPD.Response.IStatus status,
 String mimeType,
 String message)

respond

private NanoHTTPD.Response respond(Map<String,String> headers,
 NanoHTTPD.IHTTPSession session,
 String uri)

defaultRespond

private NanoHTTPD.Response defaultRespond(Map<String,String> headers,
 NanoHTTPD.IHTTPSession session,
 String uri)

serve

public NanoHTTPD.Response serve(NanoHTTPD.IHTTPSession session)

Description copied from class: NanoHTTPD

Override this to customize the server.

(By default, this returns a 404 "Not Found" plain text error response.)

Overrides:

serve in class NanoHTTPD

Parameters:

session - The HTTP session

Returns:

HTTP response, see class Response for details

serveFile

NanoHTTPD.Response serveFile(String uri,
 Map<String,String> header,
 File file,
 String mime)

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

newFixedFileResponse

private NanoHTTPD.Response newFixedFileResponse(File file,
 String mime)
                                         throws FileNotFoundException

Throws:

FileNotFoundException

addCORSHeaders

protected NanoHTTPD.Response addCORSHeaders(Map<String,String> queryHeaders,
 NanoHTTPD.Response resp,
 String cors)

calculateAllowHeaders

private String calculateAllowHeaders(Map<String,String> queryHeaders)