Package java.net.http

Interface HttpClient.Builder

  • Enclosing class:
    HttpClient

    public static interface HttpClient.Builder
    A builder of HTTP Clients.

    Builders are created by invoking newBuilder. Each of the setter methods modifies the state of the builder and returns the same instance. Builders are not thread-safe and should not be used concurrently from multiple threads without external synchronization.

    Since:
    11
    • Method Detail

      • cookieHandler

        HttpClient.Builder cookieHandler​(CookieHandler cookieHandler)
        Sets a cookie handler.
        Parameters:
        cookieHandler - the cookie handler
        Returns:
        this builder
      • connectTimeout

        HttpClient.Builder connectTimeout​(Duration duration)
        Sets the connect timeout duration for this client.

        In the case where a new connection needs to be established, if the connection cannot be established within the given duration, then HttpClient::send throws an HttpConnectTimeoutException, or HttpClient::sendAsync completes exceptionally with an HttpConnectTimeoutException. If a new connection does not need to be established, for example if a connection can be reused from a previous request, then this timeout duration has no effect.

        Parameters:
        duration - the duration to allow the underlying connection to be established
        Returns:
        this builder
        Throws:
        IllegalArgumentException - if the duration is non-positive
      • sslContext

        HttpClient.Builder sslContext​(SSLContext sslContext)
        Sets an SSLContext.

        If this method is not invoked prior to building, then newly built clients will use the default context, which is normally adequate for client applications that do not need to specify protocols, or require client authentication.

        Parameters:
        sslContext - the SSLContext
        Returns:
        this builder
      • sslParameters

        HttpClient.Builder sslParameters​(SSLParameters sslParameters)
        Sets an SSLParameters.

        If this method is not invoked prior to building, then newly built clients will use a default, implementation specific, set of parameters.

        Some parameters which are used internally by the HTTP Client implementation (such as the application protocol list) should not be set by callers, as they may be ignored. The contents of the given object are copied.

        Parameters:
        sslParameters - the SSLParameters
        Returns:
        this builder
      • executor

        HttpClient.Builder executor​(Executor executor)
        Sets the executor to be used for asynchronous and dependent tasks.

        If this method is not invoked prior to building, a default executor is created for each newly built HttpClient.

        Implementation Note:
        The default executor uses a thread pool, with a custom thread factory. If a security manager has been installed, the thread factory creates threads that run with an access control context that has no permissions.
        Parameters:
        executor - the Executor
        Returns:
        this builder
      • followRedirects

        HttpClient.Builder followRedirects​(HttpClient.Redirect policy)
        Specifies whether requests will automatically follow redirects issued by the server.

        If this method is not invoked prior to building, then newly built clients will use a default redirection policy of NEVER.

        Parameters:
        policy - the redirection policy
        Returns:
        this builder
      • version

        HttpClient.Builder version​(HttpClient.Version version)
        Requests a specific HTTP protocol version where possible.

        If this method is not invoked prior to building, then newly built clients will prefer HTTP/2.

        If set to HTTP/2, then each request will attempt to upgrade to HTTP/2. If the upgrade succeeds, then the response to this request will use HTTP/2 and all subsequent requests and responses to the same origin server will use HTTP/2. If the upgrade fails, then the response will be handled using HTTP/1.1

        Implementation Note:
        Constraints may also affect the selection of protocol version. For example, if HTTP/2 is requested through a proxy, and if the implementation does not support this mode, then HTTP/1.1 may be used
        Parameters:
        version - the requested HTTP protocol version
        Returns:
        this builder
      • priority

        HttpClient.Builder priority​(int priority)
        Sets the default priority for any HTTP/2 requests sent from this client. The value provided must be between 1 and 256 (inclusive).
        Parameters:
        priority - the priority weighting
        Returns:
        this builder
        Throws:
        IllegalArgumentException - if the given priority is out of range
      • authenticator

        HttpClient.Builder authenticator​(Authenticator authenticator)
        Sets an authenticator to use for HTTP authentication.
        Parameters:
        authenticator - the Authenticator
        Returns:
        this builder
      • build

        HttpClient build()
        Returns a new HttpClient built from the current state of this builder.
        Returns:
        a new HttpClient