Interface ApacheHttpClient.Builder

    • Method Detail

      • socketTimeout

        ApacheHttpClient.Builder socketTimeout​(Duration socketTimeout)
        The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. A duration of 0 means infinity, and is not recommended.
      • connectionTimeout

        ApacheHttpClient.Builder connectionTimeout​(Duration connectionTimeout)
        The amount of time to wait when initially establishing a connection before giving up and timing out. A duration of 0 means infinity, and is not recommended.
      • connectionAcquisitionTimeout

        ApacheHttpClient.Builder connectionAcquisitionTimeout​(Duration connectionAcquisitionTimeout)
        The amount of time to wait when acquiring a connection from the pool before giving up and timing out.
        Parameters:
        connectionAcquisitionTimeout - the timeout duration
        Returns:
        this builder for method chaining.
      • maxConnections

        ApacheHttpClient.Builder maxConnections​(Integer maxConnections)
        The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool.
      • expectContinueEnabled

        ApacheHttpClient.Builder expectContinueEnabled​(Boolean expectContinueEnabled)
        Configure whether the client should send an HTTP expect-continue handshake before each request.
      • connectionTimeToLive

        ApacheHttpClient.Builder connectionTimeToLive​(Duration connectionTimeToLive)
        The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency.
      • connectionMaxIdleTime

        ApacheHttpClient.Builder connectionMaxIdleTime​(Duration maxIdleConnectionTimeout)
        Configure the maximum amount of time that a connection should be allowed to remain open while idle.
      • useIdleConnectionReaper

        ApacheHttpClient.Builder useIdleConnectionReaper​(Boolean useConnectionReaper)
        Configure whether the idle connections in the connection pool should be closed asynchronously.

        When enabled, connections left idling for longer than connectionMaxIdleTime(Duration) will be closed. This will not close connections currently in use. By default, this is enabled.

      • dnsResolver

        ApacheHttpClient.Builder dnsResolver​(org.apache.http.conn.DnsResolver dnsResolver)
        Configuration that defines a DNS resolver. If no matches are found, the default resolver is used.
      • socketFactory

        ApacheHttpClient.Builder socketFactory​(org.apache.http.conn.socket.ConnectionSocketFactory socketFactory)
        Configuration that defines a custom Socket factory. If set to a null value, a default factory is used.

        When set to a non-null value, the use of a custom factory implies the configuration options TRUST_ALL_CERTIFICATES, TLS_TRUST_MANAGERS_PROVIDER, and TLS_KEY_MANAGERS_PROVIDER are ignored.

      • tcpKeepAlive

        ApacheHttpClient.Builder tcpKeepAlive​(Boolean keepConnectionAlive)
        Configure whether to enable or disable TCP KeepAlive. The configuration will be passed to the socket option SocketOptions.SO_KEEPALIVE.

        By default, this is disabled.

        When enabled, the actual KeepAlive mechanism is dependent on the Operating System and therefore additional TCP KeepAlive values (like timeout, number of packets, etc) must be configured via the Operating System (sysctl on Linux/Mac, and Registry values on Windows).