Class CloseableHttpClient

java.lang.Object
org.apache.hc.client5.http.impl.classic.CloseableHttpClient
All Implemented Interfaces:
Closeable, AutoCloseable, HttpClient, org.apache.hc.core5.io.ModalCloseable
Direct Known Subclasses:
InternalHttpClient, MinimalHttpClient

@Contract(threading=SAFE) public abstract class CloseableHttpClient extends Object implements HttpClient, org.apache.hc.core5.io.ModalCloseable
Base implementation of HttpClient that also implements ModalCloseable.
Since:
4.3
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private static final org.slf4j.Logger
     
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    private static org.apache.hc.core5.http.HttpHost
    determineTarget(org.apache.hc.core5.http.ClassicHttpRequest request)
     
    protected abstract CloseableHttpResponse
    doExecute(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context)
     
    execute(org.apache.hc.core5.http.ClassicHttpRequest request)
    Deprecated.
    It is strongly recommended to use execute methods with HttpClientResponseHandler such as execute(ClassicHttpRequest, HttpClientResponseHandler) in order to ensure automatic resource deallocation by the client.
    <T> T
    execute(org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler)
    Executes a request using the default context and processes the response using the given response handler.
    execute(org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context)
    Deprecated.
    It is strongly recommended to use execute methods with HttpClientResponseHandler such as execute(ClassicHttpRequest, HttpContext, HttpClientResponseHandler) in order to ensure automatic resource deallocation by the client.
    <T> T
    execute(org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context, org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler)
    Executes a request using the default context and processes the response using the given response handler.
    execute(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request)
    Deprecated.
    It is strongly recommended to use execute methods with HttpClientResponseHandler such as execute(HttpHost, ClassicHttpRequest, HttpClientResponseHandler) in order to ensure automatic resource deallocation by the client.
    <T> T
    execute(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler)
    Executes a request using the default context and processes the response using the given response handler.
    execute(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context)
    Deprecated.
    It is strongly recommended to use execute methods with HttpClientResponseHandler such as execute(HttpHost, ClassicHttpRequest, HttpContext, HttpClientResponseHandler) in order to ensure automatic resource deallocation by the client.
    <T> T
    execute(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context, org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler)
    Executes a request using the default context and processes the response using the given response handler.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface java.io.Closeable

    close

    Methods inherited from interface org.apache.hc.client5.http.classic.HttpClient

    executeOpen

    Methods inherited from interface org.apache.hc.core5.io.ModalCloseable

    close
  • Field Details

    • LOG

      private static final org.slf4j.Logger LOG
  • Constructor Details

    • CloseableHttpClient

      public CloseableHttpClient()
  • Method Details

    • doExecute

      protected abstract CloseableHttpResponse doExecute(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context) throws IOException
      Throws:
      IOException
    • determineTarget

      private static org.apache.hc.core5.http.HttpHost determineTarget(org.apache.hc.core5.http.ClassicHttpRequest request) throws ClientProtocolException
      Throws:
      ClientProtocolException
    • execute

      @Deprecated public CloseableHttpResponse execute(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context) throws IOException
      Deprecated.
      It is strongly recommended to use execute methods with HttpClientResponseHandler such as execute(HttpHost, ClassicHttpRequest, HttpContext, HttpClientResponseHandler) in order to ensure automatic resource deallocation by the client. For special cases one can still use HttpClient.executeOpen(HttpHost, ClassicHttpRequest, HttpContext) to keep the response object open after the request execution.
      Description copied from interface: HttpClient
      Executes HTTP request using the given context.
      Specified by:
      execute in interface HttpClient
      Parameters:
      target - the target host for the request. Implementations may accept null if they can still determine a route, for example to a default target or by inspecting the request.
      request - the request to execute
      context - the context to use for the execution, or null to use the default context
      Returns:
      the response to the request. This is always a final response, never an intermediate response with an 1xx status code. Whether redirects or authentication challenges will be returned or handled automatically depends on the implementation and configuration of this client.
      Throws:
      IOException - in case of a problem or the connection was aborted
      See Also:
    • execute

      @Deprecated public CloseableHttpResponse execute(org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context) throws IOException
      Deprecated.
      It is strongly recommended to use execute methods with HttpClientResponseHandler such as execute(ClassicHttpRequest, HttpContext, HttpClientResponseHandler) in order to ensure automatic resource deallocation by the client. For special cases one can still use HttpClient.executeOpen(HttpHost, ClassicHttpRequest, HttpContext) to keep the response object open after the request execution.
      Description copied from interface: HttpClient
      Executes HTTP request using the given context.
      Specified by:
      execute in interface HttpClient
      Parameters:
      request - the request to execute
      context - the context to use for the execution, or null to use the default context
      Returns:
      the response to the request. This is always a final response, never an intermediate response with an 1xx status code. Whether redirects or authentication challenges will be returned or handled automatically depends on the implementation and configuration of this client.
      Throws:
      IOException - in case of a problem or the connection was aborted
      See Also:
    • execute

      @Deprecated public CloseableHttpResponse execute(org.apache.hc.core5.http.ClassicHttpRequest request) throws IOException
      Deprecated.
      It is strongly recommended to use execute methods with HttpClientResponseHandler such as execute(ClassicHttpRequest, HttpClientResponseHandler) in order to ensure automatic resource deallocation by the client. For special cases one can still use HttpClient.executeOpen(HttpHost, ClassicHttpRequest, HttpContext) to keep the response object open after the request execution.
      Description copied from interface: HttpClient
      Executes HTTP request using the default context.
      Specified by:
      execute in interface HttpClient
      Parameters:
      request - the request to execute
      Returns:
      the response to the request. This is always a final response, never an intermediate response with an 1xx status code. Whether redirects or authentication challenges will be returned or handled automatically depends on the implementation and configuration of this client.
      Throws:
      IOException - in case of a problem or the connection was aborted
      See Also:
    • execute

      @Deprecated public CloseableHttpResponse execute(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request) throws IOException
      Deprecated.
      It is strongly recommended to use execute methods with HttpClientResponseHandler such as execute(HttpHost, ClassicHttpRequest, HttpClientResponseHandler) in order to ensure automatic resource deallocation by the client. For special cases one can still use HttpClient.executeOpen(HttpHost, ClassicHttpRequest, HttpContext) to keep the response object open after the request execution.
      Description copied from interface: HttpClient
      Executes HTTP request using the default context.
      Specified by:
      execute in interface HttpClient
      Parameters:
      target - the target host for the request. Implementations may accept null if they can still determine a route, for example to a default target or by inspecting the request.
      request - the request to execute
      Returns:
      the response to the request. This is always a final response, never an intermediate response with an 1xx status code. Whether redirects or authentication challenges will be returned or handled automatically depends on the implementation and configuration of this client.
      Throws:
      IOException - in case of a problem or the connection was aborted
      See Also:
    • execute

      public <T> T execute(org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler) throws IOException
      Executes a request using the default context and processes the response using the given response handler. The content entity associated with the response is fully consumed and the underlying connection is released back to the connection manager automatically in all cases relieving individual HttpClientResponseHandlers from having to manage resource deallocation internally.
      Specified by:
      execute in interface HttpClient
      Parameters:
      request - the request to execute
      responseHandler - the response handler
      Returns:
      the response object as generated by the response handler.
      Throws:
      IOException - in case of a problem or the connection was aborted
      ClientProtocolException - in case of an http protocol error
    • execute

      public <T> T execute(org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context, org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler) throws IOException
      Executes a request using the default context and processes the response using the given response handler. The content entity associated with the response is fully consumed and the underlying connection is released back to the connection manager automatically in all cases relieving individual HttpClientResponseHandlers from having to manage resource deallocation internally.
      Specified by:
      execute in interface HttpClient
      Parameters:
      request - the request to execute
      context - the context to use for the execution, or null to use the default context
      responseHandler - the response handler
      Returns:
      the response object as generated by the response handler.
      Throws:
      IOException - in case of a problem or the connection was aborted
      ClientProtocolException - in case of an http protocol error
    • execute

      public <T> T execute(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler) throws IOException
      Executes a request using the default context and processes the response using the given response handler. The content entity associated with the response is fully consumed and the underlying connection is released back to the connection manager automatically in all cases relieving individual HttpClientResponseHandlers from having to manage resource deallocation internally.
      Specified by:
      execute in interface HttpClient
      Parameters:
      target - the target host for the request. Implementations may accept null if they can still determine a route, for example to a default target or by inspecting the request.
      request - the request to execute
      responseHandler - the response handler
      Returns:
      the response object as generated by the response handler.
      Throws:
      IOException - in case of a problem or the connection was aborted
      ClientProtocolException - in case of an http protocol error
    • execute

      public <T> T execute(org.apache.hc.core5.http.HttpHost target, org.apache.hc.core5.http.ClassicHttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context, org.apache.hc.core5.http.io.HttpClientResponseHandler<? extends T> responseHandler) throws IOException
      Executes a request using the default context and processes the response using the given response handler. The content entity associated with the response is fully consumed and the underlying connection is released back to the connection manager automatically in all cases relieving individual HttpClientResponseHandlers from having to manage resource deallocation internally.
      Specified by:
      execute in interface HttpClient
      Parameters:
      target - the target host for the request. Implementations may accept null if they can still determine a route, for example to a default target or by inspecting the request.
      request - the request to execute
      context - the context to use for the execution, or null to use the default context
      responseHandler - the response handler
      Returns:
      the response object as generated by the response handler.
      Throws:
      IOException - in case of a problem or the connection was aborted
      ClientProtocolException - in case of an http protocol error