| java.lang.Object | |
| ↳ | org.apache.http.protocol.HttpService |
Class Overview
HttpService is a server side HTTP protocol handler based in the blocking
I/O model that implements the essential requirements of the HTTP protocol
for the server side message processing as described by RFC 2616.
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 take care of application specific
content generation and processing.
HttpService relies on HttpRequestHandler to resolve matching request
handler for a particular request URI of an incoming HTTP request.
HttpService can use optional HttpExpectationVerifier to ensure that
incoming requests meet server's expectations.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Create a new HTTP service.
| |||||||||||
Create a new HTTP service.
| |||||||||||
This constructor is deprecated.
use
HttpService(HttpProcessor, ConnectionReuseStrategy, HttpResponseFactory, HttpRequestHandlerResolver, HttpParams)
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Handles receives one HTTP request over the given connection within the
given execution context and sends a response back to the client.
| |||||||||||
This method is deprecated.
set
ConnectionReuseStrategy using constructor
| |||||||||||
This method is deprecated.
set
HttpExpectationVerifier using constructor
| |||||||||||
This method is deprecated.
set
HttpRequestHandlerResolver using constructor
| |||||||||||
This method is deprecated.
set
HttpProcessor using constructor
| |||||||||||
This method is deprecated.
set
HttpResponseFactory using constructor
| |||||||||||
This method is deprecated.
set
HttpResponseFactory using constructor
| |||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
The default implementation of this method attempts to resolve an
HttpRequestHandler for the request URI of the given request
and, if found, executes its
handle(HttpRequest, HttpResponse, HttpContext)
method. | |||||||||||
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.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
public HttpService (HttpProcessor processor, ConnectionReuseStrategy connStrategy, HttpResponseFactory responseFactory, HttpRequestHandlerResolver handlerResolver, HttpExpectationVerifier expectationVerifier, HttpParams params)
Create a new HTTP service.
Parameters
| processor | the processor to use on requests and responses |
|---|---|
| connStrategy | the connection reuse strategy |
| responseFactory | the response factory |
| handlerResolver | the handler resolver. May be null. |
| expectationVerifier | the expectation verifier. May be null. |
| params | the HTTP parameters |
public HttpService (HttpProcessor processor, ConnectionReuseStrategy connStrategy, HttpResponseFactory responseFactory, HttpRequestHandlerResolver handlerResolver, HttpParams params)
Create a new HTTP service.
Parameters
| processor | the processor to use on requests and responses |
|---|---|
| connStrategy | the connection reuse strategy |
| responseFactory | the response factory |
| handlerResolver | the handler resolver. May be null. |
| params | the HTTP parameters |
public HttpService (HttpProcessor proc, ConnectionReuseStrategy connStrategy, HttpResponseFactory responseFactory)
This constructor is deprecated.
use HttpService(HttpProcessor, ConnectionReuseStrategy, HttpResponseFactory, HttpRequestHandlerResolver, HttpParams)
Create a new HTTP service.
Parameters
| proc | the processor to use on requests and responses |
|---|---|
| connStrategy | the connection reuse strategy |
| responseFactory | the response factory |
Public Methods
public void handleRequest (HttpServerConnection conn, HttpContext context)
Handles receives one HTTP request over the given connection within the given execution context and sends a response back to the client.
Parameters
| conn | the active connection to the client |
|---|---|
| context | the actual execution context. |
Throws
| IOException | in case of an I/O error. |
|---|---|
| HttpException | in case of HTTP protocol violation or a processing problem. |
public void setConnReuseStrategy (ConnectionReuseStrategy connStrategy)
public void setExpectationVerifier (HttpExpectationVerifier expectationVerifier)
public void setHandlerResolver (HttpRequestHandlerResolver handlerResolver)
public void setHttpProcessor (HttpProcessor processor)
public void setParams (HttpParams params)
public void setResponseFactory (HttpResponseFactory responseFactory)
Protected Methods
protected void doService (HttpRequest request, HttpResponse response, HttpContext context)
The default implementation of this method attempts to resolve an
HttpRequestHandler for the request URI of the given request
and, if found, executes its
handle(HttpRequest, HttpResponse, HttpContext)
method.
Super-classes can override this method in order to provide a custom implementation of the request processing logic.
Parameters
| request | the HTTP request. |
|---|---|
| response | the HTTP response. |
| context | the execution context. |
Throws
| IOException | in case of an I/O error. |
|---|---|
| HttpException | in case of HTTP protocol violation or a processing problem. |
protected void handleException (HttpException ex, HttpResponse 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 | the exception. |
|---|---|
| response | the HTTP response. |