NanoHTTPD (wsonrpc-server 2.2.0 API)

java.lang.Object
- net.apexes.wsonrpc.server.support.http.NanoHTTPD

```
public abstract class NanoHTTPD
extends 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 to lower case 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)

嵌套类概要

嵌套类
限定符和类型	类和说明
`static interface`	`NanoHTTPD.AsyncRunner` Pluggable strategy for asynchronously executing requests.
`class`	`NanoHTTPD.ClientHandler` The runnable that will be used for every new client connection.
`protected static class`	`NanoHTTPD.ContentType`
`static class`	`NanoHTTPD.Cookie`
`class`	`NanoHTTPD.CookieHandler` Provides rudimentary support for cookies.
`static class`	`NanoHTTPD.DefaultAsyncRunner` Default threading strategy for NanoHTTPD.
`static class`	`NanoHTTPD.DefaultServerSocketFactory` Creates a normal ServerSocket for TCP connections
`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. parses the HTTP request and returns the response.
`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 class`	`NanoHTTPD.SecureServerSocketFactory` Creates a new SSLServerSocket
`class`	`NanoHTTPD.ServerRunnable` The runnable that will be used for the main listening thread.
`static interface`	`NanoHTTPD.ServerSocketFactory` Factory to create ServerSocketFactories.
`static interface`	`NanoHTTPD.TempFile` A temp file.
`static interface`	`NanoHTTPD.TempFileManager` Temp file manager.
`static interface`	`NanoHTTPD.TempFileManagerFactory` Factory to create temp file managers.

字段概要

字段
限定符和类型	字段和说明
`protected NanoHTTPD.AsyncRunner`	`asyncRunner` Pluggable strategy for asynchronously executing requests.
`static String`	`MIME_HTML` Common MIME type for dynamic content: html
`static String`	`MIME_PLAINTEXT` Common MIME type for dynamic content: plain text
`protected static Map<String,String>`	`MIME_TYPES` Hashtable mapping (String)FILENAME_EXTENSION -> (String)MIME_TYPE
`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).

构造器概要

构造器
构造器和说明
`NanoHTTPD(int port)` Constructs an HTTP server on given port.
`NanoHTTPD(String hostname, int port)` Constructs an HTTP server on given hostname and port.

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`closeAllConnections()` Forcibly closes all connections that are open.
`protected NanoHTTPD.ClientHandler`	`createClientHandler(Socket finalAccept, InputStream inputStream)` create a instance of the client support, subclasses can return a subclass of the ClientHandler.
`protected NanoHTTPD.ServerRunnable`	`createServerRunnable(int timeout)` Instantiate the server runnable, can be overwritten by subclasses to provide a subclass of the ServerRunnable.
`protected static Map<String,List<String>>`	`decodeParameters(Map<String,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 static Map<String,List<String>>`	`decodeParameters(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 static String`	`decodePercent(String str)` Decode percent encoded `String` values.
`String`	`getHostname()`
`int`	`getListeningPort()`
`static String`	`getMimeTypeForFile(String uri)` Get MIME type from file name extension, if possible
`NanoHTTPD.ServerSocketFactory`	`getServerSocketFactory()`
`NanoHTTPD.TempFileManagerFactory`	`getTempFileManagerFactory()`
`boolean`	`isAlive()`
`void`	`makeSecure(SSLServerSocketFactory sslServerSocketFactory, String[] sslProtocols)` Call before start() to serve over HTTPS instead of HTTP
`static SSLServerSocketFactory`	`makeSSLSocketFactory(KeyStore loadedKeyStore, KeyManager[] keyManagers)` Creates an SSLSocketFactory for HTTPS.
`static SSLServerSocketFactory`	`makeSSLSocketFactory(KeyStore loadedKeyStore, KeyManagerFactory loadedKeyFactory)` Creates an SSLSocketFactory for HTTPS.
`static SSLServerSocketFactory`	`makeSSLSocketFactory(String keyAndTrustStoreClasspathPath, char[] passphrase)` Creates an SSLSocketFactory for HTTPS.
`static Map<String,String>`	`mimeTypes()`
`static NanoHTTPD.Response`	`newChunkedResponse(NanoHTTPD.Response.IStatus status, String mimeType, InputStream data)` Create a response with unknown length (using HTTP 1.1 chunking).
`static NanoHTTPD.Response`	`newFixedLengthResponse(NanoHTTPD.Response.IStatus status, String mimeType, InputStream data, long totalBytes)` Create a response with known length.
`static NanoHTTPD.Response`	`newFixedLengthResponse(NanoHTTPD.Response.IStatus status, String mimeType, String txt)` Create a text response with known length.
`static NanoHTTPD.Response`	`newFixedLengthResponse(String msg)` Create a text response with known length.
`NanoHTTPD.Response`	`serve(NanoHTTPD.IHTTPSession session)` Override this to customize the server.
`NanoHTTPD.Response`	`serve(String uri, NanoHTTPD.Method method, Map<String,String> headers, Map<String,String> parms, Map<String,String> files)` 已过时。
`void`	`setAsyncRunner(NanoHTTPD.AsyncRunner asyncRunner)` Pluggable strategy for asynchronously executing requests.
`void`	`setServerSocketFactory(NanoHTTPD.ServerSocketFactory serverSocketFactory)`
`void`	`setTempFileManagerFactory(NanoHTTPD.TempFileManagerFactory tempFileManagerFactory)` Pluggable strategy for creating and cleaning up temporary files.
`void`	`start()` Start the server.
`void`	`start(int timeout)` Starts the server (in setDaemon(true) mode).
`void`	`start(int timeout, boolean daemon)` Start the server.
`void`	`stop()` Stop the server.
`protected boolean`	`useGzipWhenAccepted(NanoHTTPD.Response r)`
`boolean`	`wasStarted()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - 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).
    
    另请参阅:
    
    常量字段值
  - MIME_PLAINTEXT
```
public static final String MIME_PLAINTEXT
```
    Common MIME type for dynamic content: plain text
    
    另请参阅:
    
    常量字段值
  - MIME_HTML
```
public static final String MIME_HTML
```
    Common MIME type for dynamic content: html
    
    另请参阅:
    
    常量字段值
  - MIME_TYPES
```
protected static Map<String,String> MIME_TYPES
```
    Hashtable mapping (String)FILENAME_EXTENSION -> (String)MIME_TYPE
  - asyncRunner
```
protected NanoHTTPD.AsyncRunner asyncRunner
```
    Pluggable strategy for asynchronously executing requests.
- 构造器详细资料
  - NanoHTTPD
```
public NanoHTTPD(int port)
```
    Constructs an HTTP server on given port.
  - NanoHTTPD
```
public NanoHTTPD(String hostname,
                 int port)
```
    Constructs an HTTP server on given hostname and port.
- 方法详细资料
  - mimeTypes
```
public static Map<String,String> mimeTypes()
```
  - makeSSLSocketFactory
```
public static SSLServerSocketFactory makeSSLSocketFactory(KeyStore loadedKeyStore,
                                                          KeyManager[] keyManagers)
                                                   throws IOException
```
    Creates an SSLSocketFactory for HTTPS. Pass a loaded KeyStore and an array of loaded KeyManagers. These objects must properly loaded/initialized by the caller.
    
    抛出:
    
    IOException
  - makeSSLSocketFactory
```
public static SSLServerSocketFactory makeSSLSocketFactory(KeyStore loadedKeyStore,
                                                          KeyManagerFactory loadedKeyFactory)
                                                   throws IOException
```
    Creates an SSLSocketFactory for HTTPS. Pass a loaded KeyStore and a loaded KeyManagerFactory. These objects must properly loaded/initialized by the caller.
    
    抛出:
    
    IOException
  - makeSSLSocketFactory
```
public static SSLServerSocketFactory makeSSLSocketFactory(String keyAndTrustStoreClasspathPath,
                                                          char[] passphrase)
                                                   throws IOException
```
    Creates an SSLSocketFactory for HTTPS. Pass a KeyStore resource with your certificate and passphrase
    
    抛出:
    
    IOException
  - getMimeTypeForFile
```
public static String getMimeTypeForFile(String uri)
```
    Get MIME type from file name extension, if possible
    
    参数:
    
    uri - the string representing a file
    
    返回:
    
    the connected mime/type
  - closeAllConnections
```
public void closeAllConnections()
```
    Forcibly closes all connections that are open.
  - createClientHandler
```
protected NanoHTTPD.ClientHandler createClientHandler(Socket finalAccept,
                                                      InputStream inputStream)
```
    create a instance of the client support, subclasses can return a subclass of the ClientHandler.
    
    参数:
    
    finalAccept - the socket the cleint is connected to
    
    inputStream - the input stream
    
    返回:
    
    the client support
  - createServerRunnable
```
protected NanoHTTPD.ServerRunnable createServerRunnable(int timeout)
```
    Instantiate the server runnable, can be overwritten by subclasses to provide a subclass of the ServerRunnable.
    
    参数:
    
    timeout - the socet timeout to use.
    
    返回:
    
    the server runnable.
  - decodeParameters
```
protected static Map<String,List<String>> decodeParameters(Map<String,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.
    
    参数:
    
    parms - original NanoHTTPD parameters values, as passed to the serve() method.
    
    返回:
    
    a map of String (parameter name) to List<String> (a list of the values supplied).
  - decodeParameters
```
protected static Map<String,List<String>> decodeParameters(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.
    
    参数:
    
    queryString - a dsl string pulled from the URL.
    
    返回:
    
    a map of String (parameter name) to List<String> (a list of the values supplied).
  - decodePercent
```
protected static String decodePercent(String str)
```
    Decode percent encoded String values.
    
    参数:
    
    str - the percent encoded String
    
    返回:
    
    expanded form of the input, for example "foo%20bar" becomes "foo bar"
  - useGzipWhenAccepted
```
protected boolean useGzipWhenAccepted(NanoHTTPD.Response r)
```
    返回:
    
    true if the gzip compression should be used if the client accespts it. Default this option is on for text content and off for everything. Override this for custom semantics.
  - getListeningPort
```
public final int getListeningPort()
```
  - isAlive
```
public final boolean isAlive()
```
  - getServerSocketFactory
```
public NanoHTTPD.ServerSocketFactory getServerSocketFactory()
```
  - setServerSocketFactory
```
public void setServerSocketFactory(NanoHTTPD.ServerSocketFactory serverSocketFactory)
```
  - getHostname
```
public String getHostname()
```
  - getTempFileManagerFactory
```
public NanoHTTPD.TempFileManagerFactory getTempFileManagerFactory()
```
  - makeSecure
```
public void makeSecure(SSLServerSocketFactory sslServerSocketFactory,
                       String[] sslProtocols)
```
    Call before start() to serve over HTTPS instead of HTTP
  - newChunkedResponse
```
public static NanoHTTPD.Response newChunkedResponse(NanoHTTPD.Response.IStatus status,
                                                    String mimeType,
                                                    InputStream data)
```
    Create a response with unknown length (using HTTP 1.1 chunking).
  - newFixedLengthResponse
```
public static NanoHTTPD.Response newFixedLengthResponse(NanoHTTPD.Response.IStatus status,
                                                        String mimeType,
                                                        InputStream data,
                                                        long totalBytes)
```
    Create a response with known length.
  - newFixedLengthResponse
```
public static NanoHTTPD.Response newFixedLengthResponse(NanoHTTPD.Response.IStatus status,
                                                        String mimeType,
                                                        String txt)
```
    Create a text response with known length.
  - newFixedLengthResponse
```
public static NanoHTTPD.Response newFixedLengthResponse(String msg)
```
    Create a text response with known length.
  - serve
```
public NanoHTTPD.Response serve(NanoHTTPD.IHTTPSession session)
```
    Override this to customize the server.
    
    (By default, this returns a 404 "Not Found" plain text error response.)
    
    参数:
    
    session - The HTTP session
    
    返回:
    
    HTTP response, see class Response for details
  - serve
```
@Deprecated
public NanoHTTPD.Response serve(String uri,
                                             NanoHTTPD.Method method,
                                             Map<String,String> headers,
                                             Map<String,String> parms,
                                             Map<String,String> files)
```
    已过时。
    
    Override this to customize the server.
    
    (By default, this returns a 404 "Not Found" plain text error response.)
    
    参数:
    
    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
    
    返回:
    
    HTTP response, see class Response for details
  - setAsyncRunner
```
public void setAsyncRunner(NanoHTTPD.AsyncRunner asyncRunner)
```
    Pluggable strategy for asynchronously executing requests.
    
    参数:
    
    asyncRunner - new strategy for handling threads.
  - setTempFileManagerFactory
```
public void setTempFileManagerFactory(NanoHTTPD.TempFileManagerFactory tempFileManagerFactory)
```
    Pluggable strategy for creating and cleaning up temporary files.
    
    参数:
    
    tempFileManagerFactory - new strategy for handling temp files.
  - start
```
public void start()
           throws IOException
```
    Start the server.
    
    抛出:
    
    IOException - if the socket is in use.
  - start
```
public void start(int timeout)
           throws IOException
```
    Starts the server (in setDaemon(true) mode).
    
    抛出:
    
    IOException
  - start
```
public void start(int timeout,
                  boolean daemon)
           throws IOException
```
    Start the server.
    
    参数:
    
    timeout - timeout to use for socket connections.
    
    daemon - start the thread daemon or not.
    
    抛出:
    
    IOException - if the socket is in use.
  - stop
```
public void stop()
```
    Stop the server.
  - wasStarted
```
public final boolean wasStarted()
```

类 NanoHTTPD

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

SOCKET_READ_TIMEOUT

MIME_PLAINTEXT

MIME_HTML

MIME_TYPES

asyncRunner

构造器详细资料

NanoHTTPD

NanoHTTPD

方法详细资料

mimeTypes

makeSSLSocketFactory

makeSSLSocketFactory

makeSSLSocketFactory

getMimeTypeForFile

closeAllConnections

createClientHandler

createServerRunnable

decodeParameters

decodeParameters

decodePercent

useGzipWhenAccepted

getListeningPort

isAlive

getServerSocketFactory

setServerSocketFactory

getHostname

getTempFileManagerFactory

makeSecure

newChunkedResponse

newFixedLengthResponse

newFixedLengthResponse

newFixedLengthResponse

serve

serve

setAsyncRunner

setTempFileManagerFactory

start

start

start

stop

wasStarted