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

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 hostname, String uriPattern, HttpRequestHandler requestHandler)	Registers the given HttpRequestHandler as a handler for URIs matching the given host and the pattern.
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)	Deprecated. Use register(String, String, HttpRequestHandler).
final ServerBootstrap	replaceFilter(String existing, HttpFilterHandler filterHandler)	Replace an existing filter with the given name with new filter.
final ServerBootstrap	setAuthorityResolver(BiFunction<String,URIAuthority,URIAuthority> authorityResolver)	Sets authority resolver to be used when creating the RequestRouter.
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)	Sets HttpConnectionFactory instance.
final ServerBootstrap	setConnectionReuseStrategy(ConnectionReuseStrategy connStrategy)	Sets ConnectionReuseStrategy instance.
final ServerBootstrap	setExceptionListener(ExceptionListener exceptionListener)	Sets ExceptionListener instance.
final ServerBootstrap	setHttp1Config(Http1Config http1Config)	Sets HTTP/1 protocol configuration.
final ServerBootstrap	setHttpProcessor(HttpProcessor httpProcessor)	Sets HttpProcessor instance.
final ServerBootstrap	setListenerPort(int listenerPort)	Sets listener port number.
final ServerBootstrap	setLocalAddress(InetAddress localAddress)	Sets local interface for the listener.
final ServerBootstrap	setLookupRegistry(LookupRegistry<HttpRequestHandler> lookupRegistry)	Deprecated. Use RequestRouter.
final ServerBootstrap	setRequestRouter(HttpRequestMapper<HttpRequestHandler> requestRouter)	Sets HttpRequestMapper instance.
final ServerBootstrap	setResponseFactory(HttpResponseFactory<ClassicHttpResponse> responseFactory)	Sets HttpResponseFactory instance.
final ServerBootstrap	setServerSocketFactory(ServerSocketFactory serverSocketFactory)	Sets ServerSocketFactory instance.
final ServerBootstrap	setSocketConfig(SocketConfig socketConfig)	Sets socket configuration.
final ServerBootstrap	setSslContext(SSLContext sslContext)	Sets SSLContext instance.
final ServerBootstrap	setSslSetupHandler(Callback<SSLParameters> sslSetupHandler)	Sets Callback for SSLParameters.
final ServerBootstrap	setStreamListener(Http1StreamListener streamListener)	Sets ExceptionListener instance.

Methods inherited from class java.lang.Object

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

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)

Sets local interface for the listener.

setSocketConfig

public final ServerBootstrap setSocketConfig(SocketConfig socketConfig)

Sets socket configuration.

setHttp1Config

public final ServerBootstrap setHttp1Config(Http1Config http1Config)

Sets HTTP/1 protocol configuration.

setCharCodingConfig

public final ServerBootstrap setCharCodingConfig(CharCodingConfig charCodingConfig)

Sets connection configuration.

setHttpProcessor

public final ServerBootstrap setHttpProcessor(HttpProcessor httpProcessor)

Sets HttpProcessor instance.

setConnectionReuseStrategy

public final ServerBootstrap setConnectionReuseStrategy(ConnectionReuseStrategy connStrategy)

Sets ConnectionReuseStrategy instance.

setResponseFactory

public final ServerBootstrap setResponseFactory(HttpResponseFactory<ClassicHttpResponse> responseFactory)

Sets HttpResponseFactory instance.

setLookupRegistry

@Deprecated
public final ServerBootstrap setLookupRegistry(LookupRegistry<HttpRequestHandler> lookupRegistry)

Deprecated.

Use RequestRouter.

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.

register

public final ServerBootstrap register(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.

Since:

5.3

registerVirtual

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

Deprecated.

Use register(String, String, HttpRequestHandler).

setRequestRouter

public final ServerBootstrap setRequestRouter(HttpRequestMapper<HttpRequestHandler> requestRouter)

Sets HttpRequestMapper instance.

Since:

5.3

See Also:

• RequestRouter

setConnectionFactory

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

Sets HttpConnectionFactory instance.

setServerSocketFactory

public final ServerBootstrap setServerSocketFactory(ServerSocketFactory serverSocketFactory)

Sets ServerSocketFactory instance.

setSslContext

public final ServerBootstrap setSslContext(SSLContext sslContext)

Sets SSLContext instance.

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

setSslSetupHandler

public final ServerBootstrap setSslSetupHandler(Callback<SSLParameters> sslSetupHandler)

Sets Callback for SSLParameters.

setExceptionListener

public final ServerBootstrap setExceptionListener(ExceptionListener exceptionListener)

Sets ExceptionListener instance.

setStreamListener

public final ServerBootstrap setStreamListener(Http1StreamListener streamListener)

Sets ExceptionListener instance.

setAuthorityResolver

public final ServerBootstrap setAuthorityResolver(BiFunction<String,URIAuthority,URIAuthority> authorityResolver)

Sets authority resolver to be used when creating the RequestRouter.

Returns:

this instance.

Since:

5.4

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()