org.apache.hc.core5.http.impl.io

类 HttpRequestExecutor

java.lang.Object

org.apache.hc.core5.http.impl.io.HttpRequestExecutor

@Contract(threading=IMMUTABLE)
public class HttpRequestExecutor
extends Object

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

HttpRequestExecutor 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. Application specific processing can be implemented outside HttpRequestExecutor once the request has been executed and a response has been received.

从以下版本开始:

4.0

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	HttpRequestExecutor.Builder Builder for HttpRequestExecutor.

字段概要

字段

限定符和类型	字段和说明
static Timeout	DEFAULT_WAIT_FOR_CONTINUE

构造器概要

构造器

构造器和说明
HttpRequestExecutor()
HttpRequestExecutor(ConnectionReuseStrategy connReuseStrategy)
HttpRequestExecutor(Timeout waitForContinue, ConnectionReuseStrategy connReuseStrategy, Http1StreamListener streamListener) Creates new instance of HttpRequestExecutor.

方法概要

限定符和类型	方法和说明
static HttpRequestExecutor.Builder	builder() Create a new HttpRequestExecutor.Builder.
ClassicHttpResponse	execute(ClassicHttpRequest request, HttpClientConnection conn, HttpContext context) Sends the request and obtain a response.
ClassicHttpResponse	execute(ClassicHttpRequest request, HttpClientConnection conn, HttpResponseInformationCallback informationCallback, HttpContext context) Sends the request and obtain a response.
boolean	keepAlive(ClassicHttpRequest request, ClassicHttpResponse response, HttpClientConnection connection, HttpContext context) Determines whether the connection can be kept alive and is safe to be re-used for subsequent message exchanges.
void	postProcess(ClassicHttpResponse response, HttpProcessor processor, HttpContext context) Post-processes the given response using the given protocol processor and completes the process of request execution.
void	preProcess(ClassicHttpRequest request, HttpProcessor processor, HttpContext context) Pre-process the given request using the given protocol processor and initiates the process of request execution.

从类继承的方法 java.lang.Object

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

字段详细资料

DEFAULT_WAIT_FOR_CONTINUE

public static final Timeout DEFAULT_WAIT_FOR_CONTINUE

构造器详细资料

HttpRequestExecutor

public HttpRequestExecutor(Timeout waitForContinue,
                           ConnectionReuseStrategy connReuseStrategy,
                           Http1StreamListener streamListener)

Creates new instance of HttpRequestExecutor.

从以下版本开始:

4.3

HttpRequestExecutor

public HttpRequestExecutor(ConnectionReuseStrategy connReuseStrategy)

HttpRequestExecutor

public HttpRequestExecutor()

方法详细资料

execute

public ClassicHttpResponse execute(ClassicHttpRequest request,
                                   HttpClientConnection conn,
                                   HttpResponseInformationCallback informationCallback,
                                   HttpContext context)
                            throws IOException,
                                   HttpException

Sends the request and obtain a response.

参数:

request - the request to execute.

conn - the connection over which to execute the request.

informationCallback - callback to execute upon receipt of information status (1xx). May be null.

context - the context

返回:

the response to the request.

抛出:

IOException - in case of an I/O error.

HttpException - in case of HTTP protocol violation or a processing problem.

execute

public ClassicHttpResponse execute(ClassicHttpRequest request,
                                   HttpClientConnection conn,
                                   HttpContext context)
                            throws IOException,
                                   HttpException

Sends the request and obtain a response.

参数:

request - the request to execute.

conn - the connection over which to execute the request.

context - the context

返回:

the response to the request.

抛出:

IOException - in case of an I/O error.

HttpException - in case of HTTP protocol violation or a processing problem.

preProcess

public void preProcess(ClassicHttpRequest request,
                       HttpProcessor processor,
                       HttpContext context)
                throws HttpException,
                       IOException

Pre-process the given request using the given protocol processor and initiates the process of request execution.

参数:

request - the request to prepare

processor - the processor to use

context - the context for sending the request

抛出:

IOException - in case of an I/O error.

HttpException - in case of HTTP protocol violation or a processing problem.

postProcess

public void postProcess(ClassicHttpResponse response,
                        HttpProcessor processor,
                        HttpContext context)
                 throws HttpException,
                        IOException

Post-processes the given response using the given protocol processor and completes the process of request execution.

This method does not read the response entity, if any. The connection over which content of the response entity is being streamed from cannot be reused until the response entity has been fully consumed.

参数:

response - the response object to post-process

processor - the processor to use

context - the context for post-processing the response

抛出:

IOException - in case of an I/O error.

HttpException - in case of HTTP protocol violation or a processing problem.

keepAlive

public boolean keepAlive(ClassicHttpRequest request,
                         ClassicHttpResponse response,
                         HttpClientConnection connection,
                         HttpContext context)
                  throws IOException

Determines whether the connection can be kept alive and is safe to be re-used for subsequent message exchanges.

参数:

request - current request object.

response - current response object.

connection - actual connection.

context - current context.

返回:

true is the connection can be kept-alive and re-used.

抛出:

IOException - in case of an I/O error.

builder

public static HttpRequestExecutor.Builder builder()

Create a new HttpRequestExecutor.Builder.

从以下版本开始:

5.2