Package ej.hoka.http

Class HttpServer.HttpServerBuilder

java.lang.Object

ej.hoka.http.HttpServer.HttpServerBuilder

Enclosing class:

HttpServer

public static class HttpServer.HttpServerBuilder
extends java.lang.Object

HttpServer.HttpServerBuilder builder.

Method Summary

Modifier and Type	Method	Description
HttpServer.HttpServerBuilder	apiBase(java.lang.String apiBase)	Add a path common base that will be appended to all routes mapped without starting with a forward slash '/'.
HttpServer	build()	Builds and returns an instance of HttpServer with the configured parameters.
HttpServer.HttpServerBuilder	connectionTimeout(int connectionTimeout)	By default, server is configured to keep connection open during one minute if possible.
HttpServer.HttpServerBuilder	developmentMode()	Activate development mode.
HttpServer.HttpServerBuilder	encodingRegistry(EncodingRegistry encodingRegistry)	If this method is not called an instance of EncodingRegistry is used by the server.
HttpServer.HttpServerBuilder	port(int port)	Set the server port number.
HttpServer.HttpServerBuilder	secure(javax.net.ServerSocketFactory ssf)	Set Server Socket Factory.
HttpServer.HttpServerBuilder	simultaneousConnections(int simultaneousConnections)	Set the max simultaneous connections.
HttpServer.HttpServerBuilder	staticFilesHandler(StaticFilesHandler handler)	Set the static files handler to serve static files.
HttpServer.HttpServerBuilder	withStrictAcceptContentEncoding()	RFC2616 14.3 Activate strict content encoding acceptance.
HttpServer.HttpServerBuilder	withTrailingSlashSupport()	Activate trailing slash matching support in URI.
HttpServer.HttpServerBuilder	workerCount(int workerCount)	Set threads count that handles incoming request.

Methods inherited from class java.lang.Object

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

Method Detail

port

public HttpServer.HttpServerBuilder port(int port)

Set the server port number.

Parameters:

port - server port. use 0 set setup a random available port.

Returns:

HttpServer.HttpServerBuilder to continue setting up the server parameters

Throws:

java.lang.IllegalArgumentException - if port is < 0

simultaneousConnections

public HttpServer.HttpServerBuilder simultaneousConnections(int simultaneousConnections)

Set the max simultaneous connections.

Parameters:

simultaneousConnections - max simultaneous connections that can be handled by the server.

Returns:

HttpServer.HttpServerBuilder to continue setting up the server parameters

Throws:

java.lang.IllegalArgumentException - - if simultaneousConnections is <= 0;

workerCount

public HttpServer.HttpServerBuilder workerCount(int workerCount)

Set threads count that handles incoming request.

Parameters:

workerCount - number of threads to handle incoming requests

Returns:

HttpServer.HttpServerBuilder to continue setting up the server parameters

Throws:

java.lang.IllegalArgumentException - - if workerCount is <= 0;

apiBase

public HttpServer.HttpServerBuilder apiBase(@Nullable
                                            java.lang.String apiBase)

Add a path common base that will be appended to all routes mapped without starting with a forward slash '/'. This is useful when dealing with rest API to set the rest api URI base once. The base should start with a '/' and also ends with a '/'.

Parameters:

apiBase - the api base path

Returns:

HttpServer.HttpServerBuilder to continue setting up the server parameters

Throws:

java.lang.IllegalArgumentException - if apiBase is null or empty

secure

public HttpServer.HttpServerBuilder secure(@Nullable
                                           javax.net.ServerSocketFactory ssf)

Set Server Socket Factory. this used to set ssl

Parameters:

ssf - Server socket factory to setup HTTPS

Returns:

HttpServer.HttpServerBuilder to continue setting up the server parameters

Throws:

java.lang.IllegalArgumentException - if ServerSocketFactory parameter is null

connectionTimeout

public HttpServer.HttpServerBuilder connectionTimeout(int connectionTimeout)

By default, server is configured to keep connection open during one minute if possible. A timeout of zero is interpreted as an infinite timeout.

Parameters:

connectionTimeout - the timeout duration.

Returns:

HttpServer.HttpServerBuilder to continue setting up the server parameters

Throws:

java.lang.IllegalArgumentException - if connectionTimeout < 0

encodingRegistry

public HttpServer.HttpServerBuilder encodingRegistry(@Nullable
                                                     EncodingRegistry encodingRegistry)

If this method is not called an instance of EncodingRegistry is used by the server.

Parameters:

encodingRegistry - the registry of available encoding handlers.

Returns:

HttpServer.HttpServerBuilder to continue setting up the server parameters

Throws:

java.lang.IllegalArgumentException - if encodingRegistry is null

withStrictAcceptContentEncoding

public HttpServer.HttpServerBuilder withStrictAcceptContentEncoding()

RFC2616 14.3 Activate strict content encoding acceptance. The server will returns a 406 (Not Acceptable) for every request with a header Accept-Encoding with no encoding supported by the server. Register custom content encoding using EncodingRegistry.registerContentEncoding(ContentEncoding)

Returns:

HttpServer.HttpServerBuilder to continue setting up the server parameters

withTrailingSlashSupport

public HttpServer.HttpServerBuilder withTrailingSlashSupport()

Activate trailing slash matching support in URI. When used URI '/hello' and '/hello/' will point to different request handler otherwise URI '/hello' and '/hello/' are the same

Returns:

HttpServer.HttpServerBuilder to continue setting up the server parameters

staticFilesHandler

public HttpServer.HttpServerBuilder staticFilesHandler(@Nullable
                                                       StaticFilesHandler handler)

Set the static files handler to serve static files. Use this only for public resources.

Parameters:

handler - the StaticFilesHandler instance

Returns:

HttpServer.HttpServerBuilder to continue setting up the server parameters

Throws:

java.lang.IllegalArgumentException - if the handler is null

developmentMode

public HttpServer.HttpServerBuilder developmentMode()

Activate development mode. The server will send stack trace of thrown exceptions to the clients.

Returns:

HttpServer.HttpServerBuilder to continue setting up the server parameters

build

public HttpServer build()

Builds and returns an instance of HttpServer with the configured parameters.

Returns:

an instance of HttpServer with the configured parameters.