NanoHTTPD (NanoHttpd-Core 2.3.4 API)

java.lang.Object
- org.nanohttpd.protocols.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 class NanoHTTPD.ResponseException

嵌套类
限定符和类型	类和说明
`static class`	`NanoHTTPD.ResponseException`

字段概要

字段
限定符和类型	字段和说明
`protected IAsyncRunner`	`asyncRunner` Pluggable strategy for asynchronously executing requests.
`static Pattern`	`CONTENT_DISPOSITION_ATTRIBUTE_PATTERN`
`static String`	`CONTENT_DISPOSITION_ATTRIBUTE_REGEX`
`static Pattern`	`CONTENT_DISPOSITION_PATTERN`
`static String`	`CONTENT_DISPOSITION_REGEX`
`static Pattern`	`CONTENT_TYPE_PATTERN`
`static String`	`CONTENT_TYPE_REGEX`
`String`	`hostname`
`protected List<IHandler<IHTTPSession,Response>>`	`interceptors`
`static Logger`	`LOG` logger to log to.
`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
`int`	`myPort`
`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`	`addHTTPInterceptor(IHandler<IHTTPSession,Response> interceptor)`
`void`	`closeAllConnections()` Forcibly closes all connections that are open.
`protected ClientHandler`	`createClientHandler(Socket finalAccept, InputStream inputStream)` create a instance of the client handler, subclasses can return a subclass of the ClientHandler.
`protected 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.
`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
`ServerSocket`	`getMyServerSocket()`
`IFactoryThrowing<ServerSocket,IOException>`	`getServerSocketFactory()`
`IFactory<ITempFileManager>`	`getTempFileManagerFactory()`
`Response`	`handle(IHTTPSession session)` This is the "master" method that delegates requests to handlers and makes sure there is a response to every request.
`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 void`	`safeClose(Object closeable)`
`protected Response`	`serve(IHTTPSession session)` 已过时。
`void`	`setAsyncRunner(IAsyncRunner asyncRunner)` Pluggable strategy for asynchronously executing requests.
`void`	`setHTTPHandler(IHandler<IHTTPSession,Response> handler)`
`void`	`setServerSocketFactory(IFactoryThrowing<ServerSocket,IOException> serverSocketFactory)`
`void`	`setTempFileManagerFactory(IFactory<ITempFileManager> 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.
`boolean`	`wasStarted()`

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

- 字段详细资料
  - CONTENT_DISPOSITION_REGEX
```
public static final String CONTENT_DISPOSITION_REGEX
```
    另请参阅:
    
    常量字段值
  - CONTENT_DISPOSITION_PATTERN
```
public static final Pattern CONTENT_DISPOSITION_PATTERN
```
  - CONTENT_TYPE_REGEX
```
public static final String CONTENT_TYPE_REGEX
```
    另请参阅:
    
    常量字段值
  - CONTENT_TYPE_PATTERN
```
public static final Pattern CONTENT_TYPE_PATTERN
```
  - CONTENT_DISPOSITION_ATTRIBUTE_REGEX
```
public static final String CONTENT_DISPOSITION_ATTRIBUTE_REGEX
```
    另请参阅:
    
    常量字段值
  - CONTENT_DISPOSITION_ATTRIBUTE_PATTERN
```
public static final Pattern CONTENT_DISPOSITION_ATTRIBUTE_PATTERN
```
  - 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
    
    另请参阅:
    
    常量字段值
  - LOG
```
public static final Logger LOG
```
    logger to log to.
  - MIME_TYPES
```
protected static Map<String,String> MIME_TYPES
```
    Hashtable mapping (String)FILENAME_EXTENSION -> (String)MIME_TYPE
  - hostname
```
public final String hostname
```
  - myPort
```
public final int myPort
```
  - interceptors
```
protected List<IHandler<IHTTPSession,Response>> interceptors
```
  - asyncRunner
```
protected IAsyncRunner 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
  - safeClose
```
public static final void safeClose(Object closeable)
```
  - getMyServerSocket
```
public ServerSocket getMyServerSocket()
```
  - setHTTPHandler
```
public void setHTTPHandler(IHandler<IHTTPSession,Response> handler)
```
  - addHTTPInterceptor
```
public void addHTTPInterceptor(IHandler<IHTTPSession,Response> interceptor)
```
  - closeAllConnections
```
public void closeAllConnections()
```
    Forcibly closes all connections that are open.
  - createClientHandler
```
protected ClientHandler createClientHandler(Socket finalAccept,
                                            InputStream inputStream)
```
    create a instance of the client handler, subclasses can return a subclass of the ClientHandler.
    
    参数:
    
    finalAccept - the socket the cleint is connected to
    
    inputStream - the input stream
    
    返回:
    
    the client handler
  - createServerRunnable
```
protected 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 query string pulled from the URL.
    
    返回:
    
    a map of String (parameter name) to List<String> (a list of the values supplied).
  - decodePercent
```
public 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"
  - getListeningPort
```
public final int getListeningPort()
```
  - isAlive
```
public final boolean isAlive()
```
  - getServerSocketFactory
```
public IFactoryThrowing<ServerSocket,IOException> getServerSocketFactory()
```
  - setServerSocketFactory
```
public void setServerSocketFactory(IFactoryThrowing<ServerSocket,IOException> serverSocketFactory)
```
  - getHostname
```
public String getHostname()
```
  - getTempFileManagerFactory
```
public IFactory<ITempFileManager> getTempFileManagerFactory()
```
  - makeSecure
```
public void makeSecure(SSLServerSocketFactory sslServerSocketFactory,
                       String[] sslProtocols)
```
    Call before start() to serve over HTTPS instead of HTTP
  - handle
```
public Response handle(IHTTPSession session)
```
    This is the "master" method that delegates requests to handlers and makes sure there is a response to every request. You are not supposed to call or override this method in any circumstances. But no one will stop you if you do. I'm a Javadoc, not Code Police.
    
    参数:
    
    session - the incoming session
    
    返回:
    
    a response to the incoming session
  - serve
```
@Deprecated
protected Response serve(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
  - setAsyncRunner
```
public void setAsyncRunner(IAsyncRunner asyncRunner)
```
    Pluggable strategy for asynchronously executing requests.
    
    参数:
    
    asyncRunner - new strategy for handling threads.
  - setTempFileManagerFactory
```
public void setTempFileManagerFactory(IFactory<ITempFileManager> 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

字段详细资料

CONTENT_DISPOSITION_REGEX

CONTENT_DISPOSITION_PATTERN

CONTENT_TYPE_REGEX

CONTENT_TYPE_PATTERN

CONTENT_DISPOSITION_ATTRIBUTE_REGEX

CONTENT_DISPOSITION_ATTRIBUTE_PATTERN

SOCKET_READ_TIMEOUT

MIME_PLAINTEXT

MIME_HTML

LOG

MIME_TYPES

hostname

myPort

interceptors

asyncRunner

构造器详细资料

NanoHTTPD

NanoHTTPD

方法详细资料

mimeTypes

makeSSLSocketFactory

makeSSLSocketFactory

makeSSLSocketFactory

getMimeTypeForFile

safeClose

getMyServerSocket

setHTTPHandler

addHTTPInterceptor

closeAllConnections

createClientHandler

createServerRunnable

decodeParameters

decodeParameters

decodePercent

getListeningPort

isAlive

getServerSocketFactory

setServerSocketFactory

getHostname

getTempFileManagerFactory

makeSecure

handle

serve

setAsyncRunner

setTempFileManagerFactory

start

start

start

stop

wasStarted