Class H2AsyncClientBuilder

java.lang.Object
org.apache.hc.client5.http.impl.async.H2AsyncClientBuilder
Direct Known Subclasses:
CachingH2AsyncClientBuilder
public class H2AsyncClientBuilder extends Object
Builder for HTTP/2 only CloseableHttpAsyncClient instances.

Concurrent message exchanges with the same connection route executed with these CloseableHttpAsyncClient instances will get automatically multiplexed over a single physical HTTP/2 connection.

When a particular component is not explicitly set this class will use its default implementation.

Since:
5.0

  • Field Details

    • ioReactorConfig

      private org.apache.hc.core5.reactor.IOReactorConfig ioReactorConfig

    • ioSessionListener

      private org.apache.hc.core5.reactor.IOSessionListener ioSessionListener

    • h2Config

      private org.apache.hc.core5.http2.config.H2Config h2Config

    • charCodingConfig

      private org.apache.hc.core5.http.config.CharCodingConfig charCodingConfig

    • schemePortResolver

      private SchemePortResolver schemePortResolver

    • targetAuthStrategy

      private AuthenticationStrategy targetAuthStrategy

    • proxyAuthStrategy

      private AuthenticationStrategy proxyAuthStrategy

    • requestInterceptors

      private LinkedList<H2AsyncClientBuilder.RequestInterceptorEntry> requestInterceptors

    • responseInterceptors

      private LinkedList<H2AsyncClientBuilder.ResponseInterceptorEntry> responseInterceptors

    • execInterceptors

      private LinkedList<H2AsyncClientBuilder.ExecInterceptorEntry> execInterceptors

    • routePlanner

      private HttpRoutePlanner routePlanner

    • redirectStrategy

      private RedirectStrategy redirectStrategy

    • retryStrategy

      private HttpRequestRetryStrategy retryStrategy

    • authSchemeRegistry

      private org.apache.hc.core5.http.config.Lookup<AuthSchemeFactory> authSchemeRegistry

    • cookieSpecRegistry

      private org.apache.hc.core5.http.config.Lookup<CookieSpecFactory> cookieSpecRegistry

    • cookieStore

      private CookieStore cookieStore

    • credentialsProvider

      private CredentialsProvider credentialsProvider

    • userAgent

      private String userAgent

    • defaultHeaders

      private Collection<? extends org.apache.hc.core5.http.Header> defaultHeaders

    • defaultRequestConfig

      private RequestConfig defaultRequestConfig

    • connectionConfigResolver

      private org.apache.hc.core5.function.Resolver<org.apache.hc.core5.http.HttpHost, ConnectionConfig> connectionConfigResolver

    • evictIdleConnections

      private boolean evictIdleConnections

    • maxIdleTime

      private org.apache.hc.core5.util.TimeValue maxIdleTime

    • systemProperties

      private boolean systemProperties

    • automaticRetriesDisabled

      private boolean automaticRetriesDisabled

    • redirectHandlingDisabled

      private boolean redirectHandlingDisabled

    • cookieManagementDisabled

      private boolean cookieManagementDisabled

    • authCachingDisabled

      private boolean authCachingDisabled

    • dnsResolver

      private DnsResolver dnsResolver

    • tlsStrategy

      private org.apache.hc.core5.http.nio.ssl.TlsStrategy tlsStrategy

    • threadFactory

      private ThreadFactory threadFactory

    • closeables

      private List<Closeable> closeables

    • ioReactorExceptionCallback

      private org.apache.hc.core5.function.Callback<Exception> ioReactorExceptionCallback

    • ioSessionDecorator

      private org.apache.hc.core5.function.Decorator<org.apache.hc.core5.reactor.IOSession> ioSessionDecorator

    • priorityHeaderDisabled

      private boolean priorityHeaderDisabled

  • Constructor Details

    • H2AsyncClientBuilder

      protected H2AsyncClientBuilder()

  • Method Details

    • create

      public static H2AsyncClientBuilder create()

    • setH2Config

      public final H2AsyncClientBuilder setH2Config(org.apache.hc.core5.http2.config.H2Config h2Config)
      Sets H2Config configuration.
      Returns:
      this instance.

    • setIOReactorConfig

      public final H2AsyncClientBuilder setIOReactorConfig(org.apache.hc.core5.reactor.IOReactorConfig ioReactorConfig)
      Sets IOReactorConfig configuration.
      Returns:
      this instance.

    • setIOSessionListener

      public final H2AsyncClientBuilder setIOSessionListener(org.apache.hc.core5.reactor.IOSessionListener ioSessionListener)
      Sets IOSessionListener listener.
      Returns:
      this instance.
      Since:
      5.2

    • setCharCodingConfig

      public final H2AsyncClientBuilder setCharCodingConfig(org.apache.hc.core5.http.config.CharCodingConfig charCodingConfig)
      Sets CharCodingConfig configuration.
      Returns:
      this instance.

    • setTargetAuthenticationStrategy

      public final H2AsyncClientBuilder setTargetAuthenticationStrategy(AuthenticationStrategy targetAuthStrategy)
      Sets AuthenticationStrategy instance for target host authentication.
      Returns:
      this instance.

    • setProxyAuthenticationStrategy

      public final H2AsyncClientBuilder setProxyAuthenticationStrategy(AuthenticationStrategy proxyAuthStrategy)
      Sets AuthenticationStrategy instance for proxy authentication.
      Returns:
      this instance.

    • setIoReactorExceptionCallback

      public final H2AsyncClientBuilder setIoReactorExceptionCallback(org.apache.hc.core5.function.Callback<Exception> ioReactorExceptionCallback)
      Sets the callback that will be invoked when the client's IOReactor encounters an uncaught exception.
      Returns:
      this instance.
      Since:
      5.2

    • setIoSessionDecorator

      public final H2AsyncClientBuilder setIoSessionDecorator(org.apache.hc.core5.function.Decorator<org.apache.hc.core5.reactor.IOSession> ioSessionDecorator)
      Sets the IOSession Decorator that will be use with the client's IOReactor.
      Returns:
      this instance.
      Since:
      5.2

    • disableRequestPriority

      @Experimental public final H2AsyncClientBuilder disableRequestPriority()
      Disable installing the HTTP/2 Priority header interceptor by default.
      Since:
      5.6

    • addResponseInterceptorFirst

      public final H2AsyncClientBuilder addResponseInterceptorFirst(org.apache.hc.core5.http.HttpResponseInterceptor interceptor)
      Adds this protocol interceptor to the head of the protocol processing list.
      Returns:
      this instance.

    • addResponseInterceptorLast

      public final H2AsyncClientBuilder addResponseInterceptorLast(org.apache.hc.core5.http.HttpResponseInterceptor interceptor)
      Adds this protocol interceptor to the tail of the protocol processing list.
      Returns:
      this instance.

    • addExecInterceptorBefore

      public final H2AsyncClientBuilder addExecInterceptorBefore(String existing, String name, AsyncExecChainHandler interceptor)
      Adds this execution interceptor before an existing interceptor.
      Returns:
      this instance.

    • addExecInterceptorAfter

      public final H2AsyncClientBuilder addExecInterceptorAfter(String existing, String name, AsyncExecChainHandler interceptor)
      Adds this execution interceptor after interceptor with the given name.
      Returns:
      this instance.

    • replaceExecInterceptor

      public final H2AsyncClientBuilder replaceExecInterceptor(String existing, AsyncExecChainHandler interceptor)
      Replace an existing interceptor with the given name with new interceptor.
      Returns:
      this instance.

    • addExecInterceptorFirst

      public final H2AsyncClientBuilder addExecInterceptorFirst(String name, AsyncExecChainHandler interceptor)
      Add an interceptor to the head of the processing list.
      Returns:
      this instance.

    • addExecInterceptorLast

      public final H2AsyncClientBuilder addExecInterceptorLast(String name, AsyncExecChainHandler interceptor)
      Add an interceptor to the tail of the processing list.
      Returns:
      this instance.

    • addRequestInterceptorFirst

      public final H2AsyncClientBuilder addRequestInterceptorFirst(org.apache.hc.core5.http.HttpRequestInterceptor interceptor)
      Adds this protocol interceptor to the head of the protocol processing list.
      Returns:
      this instance.

    • addRequestInterceptorLast

      public final H2AsyncClientBuilder addRequestInterceptorLast(org.apache.hc.core5.http.HttpRequestInterceptor interceptor)
      Adds this protocol interceptor to the tail of the protocol processing list.
      Returns:
      this instance.

    • setRetryStrategy

      public final H2AsyncClientBuilder setRetryStrategy(HttpRequestRetryStrategy retryStrategy)
      Sets HttpRequestRetryStrategy instance.

      Please note this value can be overridden by the disableAutomaticRetries() method.

      Returns:
      this instance.

    • setRedirectStrategy

      public H2AsyncClientBuilder setRedirectStrategy(RedirectStrategy redirectStrategy)
      Sets RedirectStrategy instance.

      Please note this value can be overridden by the disableRedirectHandling() method.

      Returns:
      this instance.

    • setSchemePortResolver

      public final H2AsyncClientBuilder setSchemePortResolver(SchemePortResolver schemePortResolver)
      Sets SchemePortResolver instance.
      Returns:
      this instance.

    • setDnsResolver

      public final H2AsyncClientBuilder setDnsResolver(DnsResolver dnsResolver)
      Sets DnsResolver instance.
      Returns:
      this instance.

    • setTlsStrategy

      public final H2AsyncClientBuilder setTlsStrategy(org.apache.hc.core5.http.nio.ssl.TlsStrategy tlsStrategy)
      Sets TlsStrategy instance.
      Returns:
      this instance.

    • setThreadFactory

      public final H2AsyncClientBuilder setThreadFactory(ThreadFactory threadFactory)
      Sets ThreadFactory instance.
      Returns:
      this instance.

    • setUserAgent

      public final H2AsyncClientBuilder setUserAgent(String userAgent)
      Sets User-Agent value.
      Returns:
      this instance.

    • setDefaultHeaders

      public final H2AsyncClientBuilder setDefaultHeaders(Collection<? extends org.apache.hc.core5.http.Header> defaultHeaders)
      Sets default request header values.
      Returns:
      this instance.

    • setRoutePlanner

      public final H2AsyncClientBuilder setRoutePlanner(HttpRoutePlanner routePlanner)
      Sets HttpRoutePlanner instance.
      Returns:
      this instance.

    • setDefaultCredentialsProvider

      public final H2AsyncClientBuilder setDefaultCredentialsProvider(CredentialsProvider credentialsProvider)
      Sets default CredentialsProvider instance which will be used for request execution if not explicitly set in the client execution context.
      Returns:
      this instance.

    • setDefaultAuthSchemeRegistry

      public final H2AsyncClientBuilder setDefaultAuthSchemeRegistry(org.apache.hc.core5.http.config.Lookup<AuthSchemeFactory> authSchemeRegistry)
      Sets default AuthScheme registry which will be used for request execution if not explicitly set in the client execution context.
      Returns:
      this instance.

    • setDefaultCookieSpecRegistry

      public final H2AsyncClientBuilder setDefaultCookieSpecRegistry(org.apache.hc.core5.http.config.Lookup<CookieSpecFactory> cookieSpecRegistry)
      Sets default CookieSpec registry which will be used for request execution if not explicitly set in the client execution context.
      Returns:
      this instance.

    • setDefaultCookieStore

      public final H2AsyncClientBuilder setDefaultCookieStore(CookieStore cookieStore)
      Sets default CookieStore instance which will be used for request execution if not explicitly set in the client execution context.
      Returns:
      this instance.

    • setDefaultRequestConfig

      public final H2AsyncClientBuilder setDefaultRequestConfig(RequestConfig config)
      Sets default RequestConfig instance which will be used for request execution if not explicitly set in the client execution context.
      Returns:
      this instance.

    • setConnectionConfigResolver

      public final H2AsyncClientBuilder setConnectionConfigResolver(org.apache.hc.core5.function.Resolver<org.apache.hc.core5.http.HttpHost, ConnectionConfig> connectionConfigResolver)
      Sets Resolver for ConnectionConfig on a per host basis.
      Returns:
      this instance.
      Since:
      5.2

    • setDefaultConnectionConfig

      public final H2AsyncClientBuilder setDefaultConnectionConfig(ConnectionConfig connectionConfig)
      Sets the same ConnectionConfig for all hosts.
      Returns:
      this instance.
      Since:
      5.2

    • useSystemProperties

      public final H2AsyncClientBuilder useSystemProperties()
      Use system properties when creating and configuring default implementations.
      Returns:
      this instance.

    • disableRedirectHandling

      public final H2AsyncClientBuilder disableRedirectHandling()
      Disables automatic redirect handling.
      Returns:
      this instance.

    • disableAutomaticRetries

      public final H2AsyncClientBuilder disableAutomaticRetries()
      Disables automatic request recovery and re-execution.
      Returns:
      this instance.

    • disableCookieManagement

      public final H2AsyncClientBuilder disableCookieManagement()
      Disables state (cookie) management.
      Returns:
      this instance.

    • disableAuthCaching

      public final H2AsyncClientBuilder disableAuthCaching()
      Disables authentication scheme caching.
      Returns:
      this instance.

    • evictIdleConnections

      public final H2AsyncClientBuilder evictIdleConnections(org.apache.hc.core5.util.TimeValue maxIdleTime)
      Makes this instance of HttpClient proactively evict idle connections from the connection pool using a background thread.

      One MUST explicitly close HttpClient with Closeable.close() in order to stop and release the background thread.

      Please note this method has no effect if the instance of HttpClient is configured to use a shared connection manager.

      Parameters:
      maxIdleTime - maximum time persistent connections can stay idle while kept alive in the connection pool. Connections whose inactivity period exceeds this value will get closed and evicted from the pool.
      Returns:
      this instance.

    • customizeExecChain

      @Internal protected void customizeExecChain(org.apache.hc.core5.http.config.NamedElementChain<AsyncExecChainHandler> execChainDefinition)
      Request exec chain customization and extension.

      For internal use.

    • addCloseable

      @Internal protected void addCloseable(Closeable closeable)
      Adds to the list of Closeable resources to be managed by the client.

      For internal use.

    • build

      public CloseableHttpAsyncClient build()

    • getProperty

      private static String getProperty(String key, String defaultValue)