Package org.apache.juneau.rest.client.apachehttpclient50

Class ApacheHc5Transport

java.lang.Object
org.apache.juneau.rest.client.apachehttpclient50.ApacheHc5Transport
All Implemented Interfaces:
Closeable, AutoCloseable, HttpTransport
public final class ApacheHc5Transport extends Object implements HttpTransport
HttpTransport implementation backed by Apache HttpClient 5.x.

This transport is auto-discovered via ServiceLoader when org.apache.httpcomponents.client5:httpclient5 is on the classpath. You can also instantiate it explicitly:

transport = ApacheHc5Transport.builder() .httpClient(HttpClients.createDefault()) .build(); client = RestClient.builder() .transport(transport) .build();

The transport passes each ordinary request a per-request context that removes the caller's credential headers (RedirectSecurity.stripOnCrossOrigin()) from a redirect hop to another origin and from every later hop. On the client the transport creates itself, a redirect to another origin is therefore followed without those headers. With a caller-supplied client, the client's own redirect settings and RedirectStrategy decide which redirects are followed, and the context guards whatever strategy the client was built with, including LaxRedirectStrategy.

See Also:
Since:
9.2.1

  • Method Details

    • builder

      public static ApacheHc5TransportBuilder builder()
      Returns a new builder for this transport.
      Returns:
      A new builder. Never null.

    • create

      public static ApacheHc5Transport create()
      Returns a new instance backed by a default CloseableHttpClient.
      Returns:
      A new instance. Never null.

    • execute

      public TransportResponse execute(TransportRequest request) throws TransportException
      Description copied from interface: HttpTransport
      Executes the given request and returns the response.

      The caller is responsible for closing the returned TransportResponse after consuming the body.

      Specified by:
      execute in interface HttpTransport
      Parameters:
      request - The fully-resolved request. Must not be null.
      Returns:
      The response. Never null.
      Throws:
      TransportException - If a network-level error occurs.

    • supportsUrlPolicy

      public boolean supportsUrlPolicy()
      Description copied from interface: HttpTransport
      Returns true if this transport can honor the SSRF guardrail's connect-time contract for a policy-covered request (TransportRequest.isSsrfGuardActive()): pin-on-connect to a resolved address that has passed the deny-private policy, and Juneau-controlled redirect revalidation (no fallback to the transport's own auto-follow).

      The default implementation returns false (fail closed): an unknown/caller-supplied transport that has not affirmatively opted in is presumed unable to honor the contract, so RestRequest#run() rejects policy-covered requests against it rather than silently connecting without the guardrail. First-party transports that construct and fully control their own underlying HTTP client override this to return true.

      Specified by:
      supportsUrlPolicy in interface HttpTransport
      Returns:
      true if this transport supports pin-on-connect + redirect revalidation for policy-covered requests.

    • close

      public void close() throws IOException
      Description copied from interface: HttpTransport
      Releases resources held by this transport (connection pools, threads, etc.).

      The default implementation is a no-op.

      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in interface HttpTransport
      Throws:
      IOException