serguei.http

Class HttpServer

java.lang.Object

serguei.http.HttpServer

public class HttpServer
extends Object

This is HTTP Server. When started it will listen on one (usually HTTP port) or two (plus HTTPS port - this will do SSL handshake on the connection) This class provides all necessary scaffolding including listening on a port and creating threads for processing requests. The actual job of processing request is done in HttpServerRequestHandler object passed in a constructor

Author:

Serguei Poliakov

Constructor Summary

Constructors

Constructor and Description
HttpServer(HttpServerRequestHandler requestHandler, InetAddress inetAddress, int port) Creating an instance of HttpServer listening to one ports (this does not actually start the server - call start() for that).
HttpServer(HttpServerRequestHandler requestHandler, InetAddress inetAddress, int port, int sslPort, KeyStore keyStore, String certificatePassword) Creating an instance of HttpServer listening to two ports (this does not actually start the server - call start() for that).
HttpServer(HttpServerRequestHandler requestHandler, InetAddress inetAddress, int port, int sslPort, KeyStore keyStore, String certificatePassword, TrustManager clientAuthTrustManager) Creating an instance of HttpServer listening to two ports (this does not actually start the server - call start() for that).
HttpServer(HttpServerRequestHandler requestHandler, InetAddress inetAddress, int port, int sslPort, String keyStorePath, String keyStorePassword, String certificatePassword) Creating an instance of HttpServer listening to two ports (this does not actually start the server - call start() for that).
HttpServer(HttpServerRequestHandler requestHandler, InetAddress inetAddress, int port, int sslPort, String keyStorePath, String keyStorePassword, String certificatePassword, TrustManager clientAuthTrustManager) Creating an instance of HttpServer listening to two ports (this does not actually start the server - call start() for that).
HttpServer(HttpServerRequestHandler requestHandler, int port) Creating an instance of HttpServer listening to one ports (this does not actually start the server - call start() for that).
HttpServer(HttpServerRequestHandler requestHandler, int port, int sslPort, KeyStore keyStore, String certificatePassword) Creating an instance of HttpServer listening to two ports (this does not actually start the server - call start() for that).
HttpServer(HttpServerRequestHandler requestHandler, int port, int sslPort, KeyStore keyStore, String certificatePassword, TrustManager clientAuthTrustManager) Creating an instance of HttpServer listening to two ports (this does not actually start the server - call start() for that).
HttpServer(HttpServerRequestHandler requestHandler, int port, int sslPort, String keyStorePath, String keyStorePassword, String certificatePassword) Creating an instance of HttpServer listening to two ports (this does not actually start the server - call start() for that).
HttpServer(HttpServerRequestHandler requestHandler, int port, int sslPort, String keyStorePath, String keyStorePassword, String certificatePassword, TrustManager clientAuthTrustManager) Creating an instance of HttpServer listening to two ports (this does not actually start the server - call start() for that).

Method Summary

Modifier and Type	Method and Description
void	addHostSpecificKeystore(String serverName, KeyStore keyStore, String certificatePassword) Add additional keyStore with keys for a specific host name Choice will be made based on SNI, if nothing matches, the default specified in the constructor will be used
void	addHostSpecificKeystore(String serverName, String keyStorePath, String keyStorePassword, String certificatePassword) Add additional keyStore with keys for a specific host name Choice will be made based on SNI, if nothing matches, the default specified in the constructor will be used
void	closeAllConnection() Closes all connections immediately without waiting for the processing to finish The server will continue to accept new connections
int	getConnectionNo()
long	getConnectionsCreated()
protected HttpServerRequestHandler	getRequestHandler()
boolean	isRunning()
boolean	isStopped()
void	setCipherSuites(String... enabledCipherSuites)
void	setNeedClientAuthentication(boolean needClientAuthentication) This requests a client to provide authentication certificate (TLS only)
void	setOnConnectHandler(HttpServerOnConnectProcess onConnectHandler) Sets a handler that will be called immediately after the connection to the server is made, in case of TLS connection, also after the handshake took place
void	setOnRequestHeadersHandler(HttpServerOnRequestHeadersProcess onRequestHeadersHandler) Sets a handler that will be called immediately after the request headers are read but before reading the request body (if any)
void	setTcpNoDelay(boolean tcpNoDelay) Switch TCP_NODELAY When it is TCP_NODELAY is on, Nagle's algorithm is switched off This will affect new connections only
void	setThrottlingDelay(int throttlingDelayMils) If set to a value of more then zero, this introduces a delay between every 100 bytes read from input stream.
void	setTimeoutMils(int timeoutMils) Set timeout on client connection.
void	setTlsProtocol(TlsVersion... enabledTlsProtocols)
void	shouldFailWhenNoSni(boolean shouldFail)
void	shouldWarnWhenSniNotMatching(boolean warnWhenSniNotMatching)
void	start() Starts the server.
void	start(int attempts, int timeoutMillis) Starts the server making several attempts.
void	start(int attempts, int timeoutMillis, int backlog) Starts the server making several attempts.
void	stop() Stops the server.
void	stopNow() Stops the server.
void	useJdkDefaultCipherSuites()
void	useJdkDefaultTlsProtocols()

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpServer

public HttpServer(HttpServerRequestHandler requestHandler,
                  int port)

Creating an instance of HttpServer listening to one ports (this does not actually start the server - call start() for that). This listens to connection to all IP addresses (bind to 0.0.0.0).

Parameters:

requestHandler - - an implementation of HttpServerRequestHandler that will processes all requests

port - - port for HTTP requests

HttpServer

public HttpServer(HttpServerRequestHandler requestHandler,
                  InetAddress inetAddress,
                  int port)

Creating an instance of HttpServer listening to one ports (this does not actually start the server - call start() for that).

Parameters:

requestHandler - - an implementation of HttpServerRequestHandler that will processes all requests

inetAddress - - an IP address to which the server is bound. You can use this constructor if you wish to limit your server to a particular local interface, if it is null, then we binding on 0.0.0.0

port - - port for HTTP requests

HttpServer

public HttpServer(HttpServerRequestHandler requestHandler,
                  int port,
                  int sslPort,
                  String keyStorePath,
                  String keyStorePassword,
                  String certificatePassword)

Creating an instance of HttpServer listening to two ports (this does not actually start the server - call start() for that). This listens to connection to all IP addresses (bind to 0.0.0.0).

Parameters:

requestHandler - - an implementation of HttpServerRequestHandler that will processes all requests

port - - port for HTTP requests

sslPort - - port for HTTPS requests (on connection to this port the server will expect the client to start SSL handshake)

keyStorePath - - path to Java keystore file (JKS file)

keyStorePassword - - password for Java keystore file

certificatePassword - - password for certificates in Java keystore

HttpServer

public HttpServer(HttpServerRequestHandler requestHandler,
                  int port,
                  int sslPort,
                  String keyStorePath,
                  String keyStorePassword,
                  String certificatePassword,
                  TrustManager clientAuthTrustManager)

Creating an instance of HttpServer listening to two ports (this does not actually start the server - call start() for that). This listens to connection to all IP addresses (bind to 0.0.0.0).

Parameters:

requestHandler - - an implementation of HttpServerRequestHandler that will processes all requests

port - - port for HTTP requests

sslPort - - port for HTTPS requests (on connection to this port the server will expect the client to start SSL handshake)

keyStorePath - - path to Java keystore file (JKS file)

keyStorePassword - - password for Java keystore file

certificatePassword - - password for certificates in Java keystore

clientAuthTrustManager - - trust manager for client authentication (when requested)

HttpServer

public HttpServer(HttpServerRequestHandler requestHandler,
                  int port,
                  int sslPort,
                  KeyStore keyStore,
                  String certificatePassword,
                  TrustManager clientAuthTrustManager)

Creating an instance of HttpServer listening to two ports (this does not actually start the server - call start() for that). This listens to connection to all IP addresses (bind to 0.0.0.0).

Parameters:

requestHandler - - an implementation of HttpServerRequestHandler that will processes all requests

port - - port for HTTP requests

sslPort - - port for HTTPS requests (on connection to this port the server will expect the client to start SSL handshake)

keyStore - - Java keystore

certificatePassword - - password for certificates in Java keystore

HttpServer

public HttpServer(HttpServerRequestHandler requestHandler,
                  int port,
                  int sslPort,
                  KeyStore keyStore,
                  String certificatePassword)

Creating an instance of HttpServer listening to two ports (this does not actually start the server - call start() for that). This listens to connection to all IP addresses (bind to 0.0.0.0).

Parameters:

requestHandler - - an implementation of HttpServerRequestHandler that will processes all requests

port - - port for HTTP requests

sslPort - - port for HTTPS requests (on connection to this port the server will expect the client to start SSL handshake)

keyStore - - Java keystore

certificatePassword - - password for certificates in Java keystore

HttpServer

public HttpServer(HttpServerRequestHandler requestHandler,
                  InetAddress inetAddress,
                  int port,
                  int sslPort,
                  String keyStorePath,
                  String keyStorePassword,
                  String certificatePassword)

Creating an instance of HttpServer listening to two ports (this does not actually start the server - call start() for that).

Parameters:

requestHandler - - an implementation of HttpServerRequestHandler that will processes all requests

inetAddress - - an IP address to which the server is bound. You can use this constructor if you wish to limit your server to a particular local interface, if it is null, then we binding on 0.0.0.0

port - - port for HTTP requests

sslPort - - port for HTTPS requests (on connection to this port the server will expect the client to start SSL handshake)

keyStorePath - - path to Java keystore file (JKS file)

keyStorePassword - - password for Java keystore file

certificatePassword - - password for certificates in Java keystore

HttpServer

public HttpServer(HttpServerRequestHandler requestHandler,
                  InetAddress inetAddress,
                  int port,
                  int sslPort,
                  KeyStore keyStore,
                  String certificatePassword)

Creating an instance of HttpServer listening to two ports (this does not actually start the server - call start() for that).

Parameters:

requestHandler - - an implementation of HttpServerRequestHandler that will processes all requests

inetAddress - - an IP address to which the server is bound. You can use this constructor if you wish to limit your server to a particular local interface, if it is null, then we binding on 0.0.0.0

port - - port for HTTP requests

sslPort - - port for HTTPS requests (on connection to this port the server will expect the client to start SSL handshake)

keyStore - - Java keystore

certificatePassword - - password for certificates in Java keystore

HttpServer

public HttpServer(HttpServerRequestHandler requestHandler,
                  InetAddress inetAddress,
                  int port,
                  int sslPort,
                  String keyStorePath,
                  String keyStorePassword,
                  String certificatePassword,
                  TrustManager clientAuthTrustManager)

Creating an instance of HttpServer listening to two ports (this does not actually start the server - call start() for that).

Parameters:

requestHandler - - an implementation of HttpServerRequestHandler that will processes all requests

inetAddress - - an IP address to which the server is bound. You can use this constructor if you wish to limit your server to a particular local interface, if it is null, then we binding on 0.0.0.0

port - - port for HTTP requests

sslPort - - port for HTTPS requests (on connection to this port the server will expect the client to start SSL handshake)

keyStorePath - - path to Java keystore file (JKS file)

keyStorePassword - - password for Java keystore file

certificatePassword - - password for certificates in Java keystore

clientAuthTrustManager - - trust manager for client authentication (when requested)

HttpServer

public HttpServer(HttpServerRequestHandler requestHandler,
                  InetAddress inetAddress,
                  int port,
                  int sslPort,
                  KeyStore keyStore,
                  String certificatePassword,
                  TrustManager clientAuthTrustManager)

Creating an instance of HttpServer listening to two ports (this does not actually start the server - call start() for that).

Parameters:

requestHandler - - an implementation of HttpServerRequestHandler that will processes all requests

inetAddress - - an IP address to which the server is bound. You can use this constructor if you wish to limit your server to a particular local interface, if it is null, then we binding on 0.0.0.0

port - - port for HTTP requests

sslPort - - port for HTTPS requests (on connection to this port the server will expect the client to start SSL handshake)

keyStore - - Java keystore

certificatePassword - - password for certificates in Java keystore

clientAuthTrustManager - - trust manager for client authentication (when requested)

Method Detail

start

public void start()
           throws IOException

Starts the server. This operation will return after server sockets are bound to ports but before the server actually starts listening on sockets

Throws:

IOException - - often indicate that we can't bind to a port (e.g. because it is used by a different application or we don't have authority to find to it).

start

public void start(int attempts,
                  int timeoutMillis)
           throws IOException

Starts the server making several attempts. This operation will return after server sockets are bound to ports but before the server actually starts listening on sockets This method of starting a server can be useful when this server is used in testing as on some OSs a socket closed by previous test might linger for a bit resulting in the next test to fail

Parameters:

attempts - - number of attempts

timeoutMillis - - pause between two attempts in milliseconds

Throws:

IOException - - often indicate that we can't bind to a port (e.g. because it is used by a different application or we don't have authority to find to it).

start

public void start(int attempts,
                  int timeoutMillis,
                  int backlog)
           throws IOException

Starts the server making several attempts. This operation will return after server sockets are bound to ports but before the server actually starts listening on sockets This method of starting a server can be useful when this server is used in testing as on some OSs a socket closed by previous test might linger for a bit resulting in the next test to fail

Parameters:

attempts - - number of attempts

timeoutMillis - - pause between two attempts in milliseconds

backlog - - requested maximum length of the queue of incoming connections

Throws:

IOException - - often indicate that we can't bind to a port (e.g. because it is used by a different application or we don't have authority to find to it).

stop

public void stop()

Stops the server. This will stop listening to ports and attempt to wait until all current requests finish execution (subject to a timeout).

stopNow

public void stopNow()

Stops the server. This will stop listening to ports and close all sockets immediately.

getConnectionNo

public int getConnectionNo()

Returns:

Current number of client connections to the server

getConnectionsCreated

public long getConnectionsCreated()

Returns:

Total number of created client connections

isRunning

public boolean isRunning()

Returns:

true if the server started successfully and accepting incoming connections

isStopped

public boolean isStopped()

Returns:

true if the server stopped (after waiting for active requests to finish or timeout)

setTlsProtocol

public void setTlsProtocol(TlsVersion... enabledTlsProtocols)

Parameters:

enabledTlsProtocols - - list of allowed TLS protocols

useJdkDefaultTlsProtocols

public void useJdkDefaultTlsProtocols()

setCipherSuites

public void setCipherSuites(String... enabledCipherSuites)

Parameters:

enabledCipherSuites - - list of allowed Cipher Suites

useJdkDefaultCipherSuites

public void useJdkDefaultCipherSuites()

setNeedClientAuthentication

public void setNeedClientAuthentication(boolean needClientAuthentication)

This requests a client to provide authentication certificate (TLS only)

Parameters:

needClientAuthentication - - true if authentication required, false if not

addHostSpecificKeystore

public void addHostSpecificKeystore(String serverName,
                                    String keyStorePath,
                                    String keyStorePassword,
                                    String certificatePassword)

Add additional keyStore with keys for a specific host name Choice will be made based on SNI, if nothing matches, the default specified in the constructor will be used

Parameters:

serverName - - server name received in SNI during TLS handshake

keyStorePath - - path to Java keystore file (JKS file)

keyStorePassword - - password for Java keystore file

certificatePassword - - password for certificates in Java keystore

addHostSpecificKeystore

public void addHostSpecificKeystore(String serverName,
                                    KeyStore keyStore,
                                    String certificatePassword)

Add additional keyStore with keys for a specific host name Choice will be made based on SNI, if nothing matches, the default specified in the constructor will be used

Parameters:

serverName - - server name received in SNI during TLS handshake

keyStore - - Java keystore

certificatePassword - - password for certificates in Java keystore

closeAllConnection

public void closeAllConnection()

Closes all connections immediately without waiting for the processing to finish The server will continue to accept new connections

shouldFailWhenNoSni

public void shouldFailWhenNoSni(boolean shouldFail)

Parameters:

shouldFail - - when set to TRUE, server will fail handshake if ClientHello does not include Server Name Indication extension.

shouldWarnWhenSniNotMatching

public void shouldWarnWhenSniNotMatching(boolean warnWhenSniNotMatching)

Parameters:

warnWhenSniNotMatching - - when set to TRUE, server will send unrecognized_name alert if ClientHello includes Server Name Indication extension, but it does not match any host-specific keystores.

setTimeoutMils

public void setTimeoutMils(int timeoutMils)

Set timeout on client connection. This will change the timeout only for new connections.

Parameters:

timeoutMils - - timeout in milliseconds

setThrottlingDelay

public void setThrottlingDelay(int throttlingDelayMils)

If set to a value of more then zero, this introduces a delay between every 100 bytes read from input stream. This is when this library is used in testing. This will affect only new client connections.

Parameters:

throttlingDelayMils - - delay in milliseconds, when zero - no delay.

setTcpNoDelay

public void setTcpNoDelay(boolean tcpNoDelay)

Switch TCP_NODELAY When it is TCP_NODELAY is on, Nagle's algorithm is switched off This will affect new connections only

Parameters:

tcpNoDelay - - when true then Nagle's algorithm is off (default)

setOnRequestHeadersHandler

public void setOnRequestHeadersHandler(HttpServerOnRequestHeadersProcess onRequestHeadersHandler)

Sets a handler that will be called immediately after the request headers are read but before reading the request body (if any)

Parameters:

onRequestHeadersHandler - - the handler, if null (default) - no processing will take place

setOnConnectHandler

public void setOnConnectHandler(HttpServerOnConnectProcess onConnectHandler)

Sets a handler that will be called immediately after the connection to the server is made, in case of TLS connection, also after the handshake took place

Parameters:

onConnectHandler - - the handler, if null (default) - no processing will take place

getRequestHandler

protected HttpServerRequestHandler getRequestHandler()