HttpService is a server side HTTP protocol handler based on the classic (blocking) I/O model.

HttpService relies on HttpProcessor to generate mandatory protocol headers for all outgoing messages and apply common, cross-cutting message transformations to all incoming and outgoing messages, whereas individual HttpRequestHandlers are expected to implement application specific content generation and processing.

HttpService uses HttpRequestMapper to map matching request handler for a particular request URI of an incoming HTTP request.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	HttpService.Builder Builder for `HttpService`.

Modifier and Type	Field and Description
private final ConnectionReuseStrategy	connReuseStrategy
private final HttpProcessor	processor
private final HttpServerRequestHandler	requestHandler
private final Http1StreamListener	streamListener

Constructor Summary

Access	Constructor and Description
public	HttpService(final HttpProcessor the processor to use on requests and responses processor, final HttpRequestMapper<HttpRequestHandler> the handler mapper handlerMapper, final ConnectionReuseStrategy the connection reuse strategy. If `null` `DefaultConnectionReuseStrategy#INSTANCE` will be used. connReuseStrategy, final HttpResponseFactory<ClassicHttpResponse> the response factory. If `null` `DefaultClassicHttpResponseFactory#INSTANCE` will be used. responseFactory, final Http1StreamListener message stream listener. streamListener) Create a new HTTP service.
public	HttpService(final HttpProcessor the processor to use on requests and responses processor, final HttpRequestMapper<HttpRequestHandler> the handler mapper handlerMapper, final ConnectionReuseStrategy the connection reuse strategy. If `null` `DefaultConnectionReuseStrategy#INSTANCE` will be used. connReuseStrategy, final HttpResponseFactory<ClassicHttpResponse> the response factory. If `null` `DefaultClassicHttpResponseFactory#INSTANCE` will be used. responseFactory) Create a new HTTP service.
public	HttpService(final HttpProcessor the processor to use on requests and responses processor, final HttpServerRequestHandler the request handler. requestHandler, final ConnectionReuseStrategy the connection reuse strategy. If `null` `DefaultConnectionReuseStrategy#INSTANCE` will be used. connReuseStrategy, final Http1StreamListener message stream listener. streamListener) Create a new HTTP service.
public	HttpService(final HttpProcessor the processor to use on requests and responses processor, final HttpServerRequestHandler the request handler. requestHandler) Create a new HTTP service.

Method Summary

Modifier and Type	Method and Description
public static HttpService.Builder	builder() Create a new `Builder`.
protected void	handleException(final HttpException the exception. ex, final ClassicHttpResponse the HTTP response. response) Handles the given exception and generates an HTTP response to be sent back to the client to inform about the exceptional condition encountered in the course of the request processing.
public void	handleRequest(final HttpServerConnection the active connection to the client conn, final HttpContext the actual execution context. context) Handles receives one HTTP request over the given connection within the given execution context and sends a response back to the client.
protected int	toStatusCode(final Exception ex)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

connReuseStrategy	back to summary
private final ConnectionReuseStrategy connReuseStrategy

processor	back to summary
private final HttpProcessor processor

requestHandler	back to summary
private final HttpServerRequestHandler requestHandler

streamListener	back to summary
private final Http1StreamListener streamListener

Constructor Detail

HttpService back to summary

HttpService	back to summary
public HttpService(final HttpProcessor processor, final HttpRequestMapper<HttpRequestHandler> handlerMapper, final ConnectionReuseStrategy connReuseStrategy, final HttpResponseFactory<ClassicHttpResponse> responseFactory, final Http1StreamListener streamListener) Create a new HTTP service. Parameters processor:HttpProcessor the processor to use on requests and responses handlerMapper:HttpRequestMapper<HttpRequestHandler> the handler mapper connReuseStrategy:ConnectionReuseStrategy the connection reuse strategy. If `null` `DefaultConnectionReuseStrategy#INSTANCE` will be used. responseFactory:HttpResponseFactory<ClassicHttpResponse> the response factory. If `null` `DefaultClassicHttpResponseFactory#INSTANCE` will be used. streamListener:Http1StreamListener message stream listener.

public HttpService(final HttpProcessor processor, final HttpRequestMapper<HttpRequestHandler> handlerMapper, final ConnectionReuseStrategy connReuseStrategy, final HttpResponseFactory<ClassicHttpResponse> responseFactory, final Http1StreamListener streamListener)

Create a new HTTP service.

Parameters

processor:HttpProcessor: the processor to use on requests and responses
handlerMapper:HttpRequestMapper<HttpRequestHandler>: the handler mapper
connReuseStrategy:ConnectionReuseStrategy: the connection reuse strategy. If null DefaultConnectionReuseStrategy#INSTANCE will be used.
responseFactory:HttpResponseFactory<ClassicHttpResponse>: the response factory. If null DefaultClassicHttpResponseFactory#INSTANCE will be used.
streamListener:Http1StreamListener: message stream listener.

HttpService back to summary

HttpService	back to summary
public HttpService(final HttpProcessor processor, final HttpRequestMapper<HttpRequestHandler> handlerMapper, final ConnectionReuseStrategy connReuseStrategy, final HttpResponseFactory<ClassicHttpResponse> responseFactory) Create a new HTTP service. Parameters processor:HttpProcessor the processor to use on requests and responses handlerMapper:HttpRequestMapper<HttpRequestHandler> the handler mapper connReuseStrategy:ConnectionReuseStrategy the connection reuse strategy. If `null` `DefaultConnectionReuseStrategy#INSTANCE` will be used. responseFactory:HttpResponseFactory<ClassicHttpResponse> the response factory. If `null` `DefaultClassicHttpResponseFactory#INSTANCE` will be used.

Create a new HTTP service.

Parameters

processor:HttpProcessor: the processor to use on requests and responses
handlerMapper:HttpRequestMapper<HttpRequestHandler>: the handler mapper
connReuseStrategy:ConnectionReuseStrategy: the connection reuse strategy. If null DefaultConnectionReuseStrategy#INSTANCE will be used.
responseFactory:HttpResponseFactory<ClassicHttpResponse>: the response factory. If null DefaultClassicHttpResponseFactory#INSTANCE will be used.

HttpService back to summary

HttpService	back to summary
public HttpService(final HttpProcessor processor, final HttpServerRequestHandler requestHandler, final ConnectionReuseStrategy connReuseStrategy, final Http1StreamListener streamListener) Create a new HTTP service. Parameters processor:HttpProcessor the processor to use on requests and responses requestHandler:HttpServerRequestHandler the request handler. connReuseStrategy:ConnectionReuseStrategy the connection reuse strategy. If `null` `DefaultConnectionReuseStrategy#INSTANCE` will be used. streamListener:Http1StreamListener message stream listener.

public HttpService(final HttpProcessor processor, final HttpServerRequestHandler requestHandler, final ConnectionReuseStrategy connReuseStrategy, final Http1StreamListener streamListener)

Create a new HTTP service.

Parameters

processor:HttpProcessor: the processor to use on requests and responses
requestHandler:HttpServerRequestHandler: the request handler.
connReuseStrategy:ConnectionReuseStrategy: the connection reuse strategy. If null DefaultConnectionReuseStrategy#INSTANCE will be used.
streamListener:Http1StreamListener: message stream listener.

HttpService	back to summary
public HttpService(final HttpProcessor processor, final HttpServerRequestHandler requestHandler) Create a new HTTP service. Parameters processor:HttpProcessor the processor to use on requests and responses requestHandler:HttpServerRequestHandler the request handler.

HttpService

back to summary

public HttpService(final HttpProcessor processor, final HttpServerRequestHandler requestHandler)

Create a new HTTP service.

Parameters

processor:HttpProcessor: the processor to use on requests and responses
requestHandler:HttpServerRequestHandler: the request handler.

Method Detail

builder back to summary

builder	back to summary
public static HttpService.Builder builder() Create a new `Builder`. Since 5.2

public static HttpService.Builder builder()

Create a new Builder.

Since: 5.2

handleException	back to summary
protected void handleException(final HttpException ex, final ClassicHttpResponse response) Handles the given exception and generates an HTTP response to be sent back to the client to inform about the exceptional condition encountered in the course of the request processing. Parameters ex:HttpException the exception. response:ClassicHttpResponse the HTTP response.

handleException

back to summary

protected void handleException(final HttpException ex, final ClassicHttpResponse response)

Handles the given exception and generates an HTTP response to be sent back to the client to inform about the exceptional condition encountered in the course of the request processing.

Parameters

ex:HttpException: the exception.
response:ClassicHttpResponse: the HTTP response.

handleRequest	back to summary
public void handleRequest(final HttpServerConnection conn, final HttpContext context) throws IOException, HttpException Handles receives one HTTP request over the given connection within the given execution context and sends a response back to the client. Parameters conn:HttpServerConnection the active connection to the client context:HttpContext the actual execution context. Exceptions IOException: in case of an I/O error. HttpException: in case of HTTP protocol violation or a processing problem.

handleRequest

back to summary

public void handleRequest(final HttpServerConnection conn, final HttpContext context) throws IOException, HttpException

Handles receives one HTTP request over the given connection within the given execution context and sends a response back to the client.

Parameters

conn:HttpServerConnection: the active connection to the client
context:HttpContext: the actual execution context.

Exceptions

IOException:: in case of an I/O error.
HttpException:: in case of HTTP protocol violation or a processing problem.

toStatusCode	back to summary
protected int toStatusCode(final Exception ex)

org.apache.hc.core5.http.impl.io back to summary

public final Class HttpService.Builder

Class Inheritance

extends Object

java.lang.Object
org.apache.hc.core5.http.impl.io.HttpService.Builder

Builder for HttpService.

Since: 5.2

Field Summary

Modifier and Type	Field and Description
private ConnectionReuseStrategy	connReuseStrategy
private HttpProcessor	processor
private HttpServerRequestHandler	requestHandler
private Http1StreamListener	streamListener

Constructor Summary

Access	Constructor and Description
private	Builder()

Method Summary

Modifier and Type	Method and Description
public HttpService	build() Create a new HTTP service.
public HttpService.Builder	withConnectionReuseStrategy(final ConnectionReuseStrategy connReuseStrategy)
public HttpService.Builder	withHttp1StreamListener(final Http1StreamListener streamListener)
public HttpService.Builder	withHttpProcessor(final HttpProcessor processor)
public HttpService.Builder	withHttpServerRequestHandler(final HttpServerRequestHandler requestHandler)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

connReuseStrategy	back to summary
private ConnectionReuseStrategy connReuseStrategy

processor	back to summary
private HttpProcessor processor

requestHandler	back to summary
private HttpServerRequestHandler requestHandler

streamListener	back to summary
private Http1StreamListener streamListener

Constructor Detail

Builder	back to summary
private Builder()

Method Detail

build	back to summary
public HttpService build() Create a new HTTP service. Since 5.2

build

back to summary

public HttpService build()

Create a new HTTP service.

Since: 5.2

withConnectionReuseStrategy	back to summary
public HttpService.Builder withConnectionReuseStrategy(final ConnectionReuseStrategy connReuseStrategy)

withHttp1StreamListener	back to summary
public HttpService.Builder withHttp1StreamListener(final Http1StreamListener streamListener)

withHttpProcessor	back to summary
public HttpService.Builder withHttpProcessor(final HttpProcessor processor)

withHttpServerRequestHandler	back to summary
public HttpService.Builder withHttpServerRequestHandler(final HttpServerRequestHandler requestHandler)

public Class HttpService

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class HttpService.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail