org.cauli.server

接口 WebServer

所有超级接口:

Endpoint<WebServer>

所有已知实现类:

NettyWebServer

public interface WebServer
extends Endpoint<WebServer>

Configures an event based webserver.

To create an instance, use WebServers.createWebServer(int).

As with many of the interfaces in cauli, setter style methods return a reference to this, to allow for simple initialization using method chaining.

Hello World Example

 class HelloWorldHandler implements HttpHandler {
   void handleHttpRequest(HttpRequest request, HttpResponse response, HttpControl control) {
     response.header("Content-Type", "text/html")
             .content("Hello World")
             .end();
   }
 }
 WebServer webServer = WebServers.createWebServer(8080)
                                 .add(new HelloWorldHandler());
 webServer.start();
 print("Point your browser to " + webServer.getUri());
 

Serving Static Files

 WebServer webServer = WebServers.createWebServer(8080)
                                 .add(new StaticFileHandler("./wwwdata"));
 webServer.start();
 

作者:

Joe Walnes

另请参阅:

WebServers, HttpHandler, WebSocketConnection, EventSourceConnection

方法概要

方法

限定符和类型	方法和说明
WebServer	add(HttpHandler handler) Add an HttpHandler.
WebServer	add(String path, EventSourceHandler handler) Add a WebSocketHandler for dealing with WebSockets.
WebServer	add(String path, HttpHandler handler) Add an HttpHandler that will only respond to a certain path (e.g "/some/page").
WebServer	add(String path, WebSocketHandler handler) Add a WebSocketHandler for dealing with WebSockets.
int	getPort() Get base port that webserver is serving on.
WebServer	setupSsl(InputStream keyStore, String storePass, String keyPass) Setup SSL/TLS handler
WebServer	staleConnectionTimeout(long millis) Number of milliseconds before a stale HTTP keep-alive connection is closed by the server.

从接口继承的方法 org.cauli.server.Endpoint

connectionExceptionHandler, getExecutor, getUri, setupSsl, start, stop, uncaughtExceptionHandler

方法详细资料

add

WebServer add(HttpHandler handler)

Add an HttpHandler. When a request comes in the first HttpHandler will be invoked. The HttpHandler should either handle the request, or pass the request onto the next HttpHandler (using HttpControl.nextHandler()). This is repeated until a HttpHandler returns a response. If there are no remaining handlers, the webserver shall return 404 NOT FOUND to the browser.

HttpHandlers are attempted in the order in which they are added to the WebServer.

另请参阅:

HttpHandler

add

WebServer add(String path,
            HttpHandler handler)

Add an HttpHandler that will only respond to a certain path (e.g "/some/page").

This is shortcut for add(newPathMatchHandler(path, handler)).

另请参阅:

HttpHandler, add(HttpHandler), PathMatchHandler

add

WebServer add(String path,
            WebSocketHandler handler)

Add a WebSocketHandler for dealing with WebSockets.

This is shortcut for add(new PathMatchHandler(path, newHttpToWebSocketHandler(handler))).

另请参阅:

WebSocketHandler, HttpHandler, add(HttpHandler), HttpToWebSocketHandler, PathMatchHandler

add

WebServer add(String path,
            EventSourceHandler handler)

Add a WebSocketHandler for dealing with WebSockets.

This is shortcut for add(new PathMatchHandler(path, newHttpToEventSourceHandler(handler))).

另请参阅:

HttpHandler, add(HttpHandler), HttpToEventSourceHandler, PathMatchHandler

getPort

int getPort()

Get base port that webserver is serving on.

staleConnectionTimeout

WebServer staleConnectionTimeout(long millis)

Number of milliseconds before a stale HTTP keep-alive connection is closed by the server. A HTTP connection is considered stale if it remains open without sending more data within the timeout window.

setupSsl

WebServer setupSsl(InputStream keyStore,
                 String storePass,
                 String keyPass)
                   throws WebbitException

Setup SSL/TLS handler

参数:

keyStore - Keystore InputStream

storePass - Store password

keyPass - Key password

返回:

current WebServer instance

抛出:

WebbitException - A problem loading the keystore