Package org.apache.hc.core5.http.impl.bootstrap

Class ServerBootstrap

java.lang.Object

org.apache.hc.core5.http.impl.bootstrap.ServerBootstrap

public class ServerBootstrap
extends Object

HttpServer bootstrap.

Since:

4.4

Field Summary

Fields

Modifier and Type	Field	Description
private String	canonicalHostName
private CharCodingConfig	charCodingConfig
private HttpConnectionFactory<? extends DefaultBHttpServerConnection>	connectionFactory
private ConnectionReuseStrategy	connStrategy
private ExceptionListener	exceptionListener
private final List<FilterEntry<HttpFilterHandler>>	filters
private final List<HandlerEntry<HttpRequestHandler>>	handlerList
private Http1Config	http1Config
private HttpProcessor	httpProcessor
private int	listenerPort
private InetAddress	localAddress
private LookupRegistry<HttpRequestHandler>	lookupRegistry
private HttpResponseFactory<ClassicHttpResponse>	responseFactory
private ServerSocketFactory	serverSocketFactory
private SocketConfig	socketConfig
private SSLContext	sslContext
private Callback<SSLParameters>	sslSetupHandler
private Http1StreamListener	streamListener

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ServerBootstrap()

Method Summary

Modifier and Type	Method	Description
final ServerBootstrap	addFilterAfter(String existing, String name, HttpFilterHandler filterHandler)	Adds the filter after the filter with the given name.
final ServerBootstrap	addFilterBefore(String existing, String name, HttpFilterHandler filterHandler)	Adds the filter before the filter with the given name.
final ServerBootstrap	addFilterFirst(String name, HttpFilterHandler filterHandler)	Add an filter to the head of the processing list.
final ServerBootstrap	addFilterLast(String name, HttpFilterHandler filterHandler)	Add an filter to the tail of the processing list.
static ServerBootstrap	bootstrap()
HttpServer	create()
final ServerBootstrap	register(String uriPattern, HttpRequestHandler requestHandler)	Registers the given HttpRequestHandler as a default handler for URIs matching the given pattern.
final ServerBootstrap	registerVirtual(String hostname, String uriPattern, HttpRequestHandler requestHandler)	Registers the given HttpRequestHandler as a handler for URIs matching the given host and the pattern.
final ServerBootstrap	replaceFilter(String existing, HttpFilterHandler filterHandler)	Replace an existing filter with the given name with new filter.
final ServerBootstrap	setCanonicalHostName(String canonicalHostName)	Sets canonical name (fully qualified domain name) of the server.
final ServerBootstrap	setCharCodingConfig(CharCodingConfig charCodingConfig)	Sets connection configuration.
final ServerBootstrap	setConnectionFactory(HttpConnectionFactory<? extends DefaultBHttpServerConnection> connectionFactory)	Assigns HttpConnectionFactory instance.
final ServerBootstrap	setConnectionReuseStrategy(ConnectionReuseStrategy connStrategy)	Assigns ConnectionReuseStrategy instance.
final ServerBootstrap	setExceptionListener(ExceptionListener exceptionListener)	Assigns ExceptionListener instance.
final ServerBootstrap	setHttp1Config(Http1Config http1Config)	Sets connection configuration.
final ServerBootstrap	setHttpProcessor(HttpProcessor httpProcessor)	Assigns HttpProcessor instance.
final ServerBootstrap	setListenerPort(int listenerPort)	Sets listener port number.
final ServerBootstrap	setLocalAddress(InetAddress localAddress)	Assigns local interface for the listener.
final ServerBootstrap	setLookupRegistry(LookupRegistry<HttpRequestHandler> lookupRegistry)	Assigns LookupRegistry instance.
final ServerBootstrap	setResponseFactory(HttpResponseFactory<ClassicHttpResponse> responseFactory)	Assigns HttpResponseFactory instance.
final ServerBootstrap	setServerSocketFactory(ServerSocketFactory serverSocketFactory)	Assigns ServerSocketFactory instance.
final ServerBootstrap	setSocketConfig(SocketConfig socketConfig)	Sets socket configuration.
final ServerBootstrap	setSslContext(SSLContext sslContext)	Assigns SSLContext instance.
final ServerBootstrap	setSslSetupHandler(Callback<SSLParameters> sslSetupHandler)	Assigns Callback for SSLParameters.
final ServerBootstrap	setStreamListener(Http1StreamListener streamListener)	Assigns ExceptionListener instance.

Methods inherited from class java.lang.Object

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

Field Details

handlerList

private final List<HandlerEntry<HttpRequestHandler>> handlerList

filters

private final List<FilterEntry<HttpFilterHandler>> filters

canonicalHostName

private String canonicalHostName

lookupRegistry

private LookupRegistry<HttpRequestHandler> lookupRegistry

listenerPort

private int listenerPort

localAddress

private InetAddress localAddress

socketConfig

private SocketConfig socketConfig

http1Config

private Http1Config http1Config

charCodingConfig

private CharCodingConfig charCodingConfig

httpProcessor

private HttpProcessor httpProcessor

connStrategy

private ConnectionReuseStrategy connStrategy

responseFactory

private HttpResponseFactory<ClassicHttpResponse> responseFactory

serverSocketFactory

private ServerSocketFactory serverSocketFactory

sslContext

private SSLContext sslContext

sslSetupHandler

private Callback<SSLParameters> sslSetupHandler

connectionFactory

private HttpConnectionFactory<? extends DefaultBHttpServerConnection> connectionFactory

exceptionListener

private ExceptionListener exceptionListener

streamListener

private Http1StreamListener streamListener

Constructor Details

ServerBootstrap

private ServerBootstrap()

Method Details

bootstrap

public static ServerBootstrap bootstrap()

setCanonicalHostName

public final ServerBootstrap setCanonicalHostName(String canonicalHostName)

Sets canonical name (fully qualified domain name) of the server.

Since:

5.0

setListenerPort

public final ServerBootstrap setListenerPort(int listenerPort)

Sets listener port number.

setLocalAddress

public final ServerBootstrap setLocalAddress(InetAddress localAddress)

Assigns local interface for the listener.

setSocketConfig

public final ServerBootstrap setSocketConfig(SocketConfig socketConfig)

Sets socket configuration.

setHttp1Config

public final ServerBootstrap setHttp1Config(Http1Config http1Config)

Sets connection configuration.

setCharCodingConfig

public final ServerBootstrap setCharCodingConfig(CharCodingConfig charCodingConfig)

Sets connection configuration.

setHttpProcessor

public final ServerBootstrap setHttpProcessor(HttpProcessor httpProcessor)

Assigns HttpProcessor instance.

setConnectionReuseStrategy

public final ServerBootstrap setConnectionReuseStrategy(ConnectionReuseStrategy connStrategy)

Assigns ConnectionReuseStrategy instance.

setResponseFactory

public final ServerBootstrap setResponseFactory(HttpResponseFactory<ClassicHttpResponse> responseFactory)

Assigns HttpResponseFactory instance.

setLookupRegistry

public final ServerBootstrap setLookupRegistry(LookupRegistry<HttpRequestHandler> lookupRegistry)

Assigns LookupRegistry instance.

register

public final ServerBootstrap register(String uriPattern,
 HttpRequestHandler requestHandler)

Registers the given HttpRequestHandler as a default handler for URIs matching the given pattern.

Parameters:

uriPattern - the pattern to register the handler for.

requestHandler - the handler.

registerVirtual

public final ServerBootstrap registerVirtual(String hostname,
 String uriPattern,
 HttpRequestHandler requestHandler)

Registers the given HttpRequestHandler as a handler for URIs matching the given host and the pattern.

Parameters:

hostname -

uriPattern - the pattern to register the handler for.

requestHandler - the handler.

setConnectionFactory

public final ServerBootstrap setConnectionFactory(HttpConnectionFactory<? extends DefaultBHttpServerConnection> connectionFactory)

Assigns HttpConnectionFactory instance.

setServerSocketFactory

public final ServerBootstrap setServerSocketFactory(ServerSocketFactory serverSocketFactory)

Assigns ServerSocketFactory instance.

setSslContext

public final ServerBootstrap setSslContext(SSLContext sslContext)

Assigns SSLContext instance.

Please note this value can be overridden by the setServerSocketFactory(javax.net.ServerSocketFactory) method.

setSslSetupHandler

public final ServerBootstrap setSslSetupHandler(Callback<SSLParameters> sslSetupHandler)

Assigns Callback for SSLParameters.

setExceptionListener

public final ServerBootstrap setExceptionListener(ExceptionListener exceptionListener)

Assigns ExceptionListener instance.

setStreamListener

public final ServerBootstrap setStreamListener(Http1StreamListener streamListener)

Assigns ExceptionListener instance.

addFilterBefore

public final ServerBootstrap addFilterBefore(String existing,
 String name,
 HttpFilterHandler filterHandler)

Adds the filter before the filter with the given name.

addFilterAfter

public final ServerBootstrap addFilterAfter(String existing,
 String name,
 HttpFilterHandler filterHandler)

Adds the filter after the filter with the given name.

replaceFilter

public final ServerBootstrap replaceFilter(String existing,
 HttpFilterHandler filterHandler)

Replace an existing filter with the given name with new filter.

addFilterFirst

public final ServerBootstrap addFilterFirst(String name,
 HttpFilterHandler filterHandler)

Add an filter to the head of the processing list.

addFilterLast

public final ServerBootstrap addFilterLast(String name,
 HttpFilterHandler filterHandler)

Add an filter to the tail of the processing list.

create

public HttpServer create()