モジュール jdk.incubator.httpclient
パッケージ jdk.incubator.http

クラスHttpClient.Builder

  • 含まれているクラス:
    HttpClient
    public abstract static class HttpClient.Builder
extends Object
    不変のHttpClientのビルダー。
    インキュベーション機能。将来のリリースで削除されます。

    ビルダーは、newBuilderを呼び出すことによって作成されます。 各setterメソッドは、Builderの状態を変更し、同じインスタンスを返します。 ビルダーはスレッド・セーフではないため、外部同期なしで複数のスレッドから同時に使用すべきではありません。

    導入されたバージョン:
    9

    • フィールドの詳細

      • NO_PROXY

        public static final ProxySelector NO_PROXY
        直接接続を意味するProxy.NO_PROXYを常に返すプロキシ・セレクタ。 これは、プロキシを使用しないHttpClientのインスタンスを構築するためにproxy(ProxySelector)に渡すことができる便利なオブジェクトです。

    • コンストラクタの詳細

      • Builder

        protected Builder()
        Builderを作成します。

    • メソッドの詳細

      • cookieHandler

        public abstract HttpClient.Builder cookieHandler​(CookieHandler cookieHandler)
        Cookieハンドラを設定します。
        パラメータ:
        cookieHandler - Cookieハンドラ
        戻り値:
        このビルダー

      • sslContext

        public abstract HttpClient.Builder sslContext​(SSLContext sslContext)
        SSLContextを設定します。

        このメソッドがbuildingの前に呼び出されない場合、新しく作成されたクライアントは「デフォルト・コンテキスト」を使用します。これは通常、プロトコルを指定する必要のないクライアント・アプリケーションやクライアント認証が必要なクライアント・アプリケーションに適しています。

        パラメータ:
        sslContext - SSLContext
        戻り値:
        このビルダー

      • sslParameters

        public abstract HttpClient.Builder sslParameters​(SSLParameters sslParameters)
        SSLParametersを設定します。

        このメソッドがbuildingの前に呼び出されない場合、新しくビルドされたクライアントはデフォルトの実装固有のパラメータ・セットを使用します。

        HTTPクライアント実装(アプリケーション・プロトコル・リスト)によって内部的に使用されるいくつかのパラメータは、無視される可能性があるため、呼び出し元によって設定されるべきではありません。 指定されたオブジェクトの内容がコピーされます。

        パラメータ:
        sslParameters - SSLParameters
        戻り値:
        このビルダー

      • executor

        public abstract HttpClient.Builder executor​(Executor executor)
        非同期および依存タスクに使用されるエグゼキュータを設定します。

        このメソッドがbuildingの前に呼び出されない場合は、新しく構築された HttpClientごとにデフォルトのexecutorが作成されます。 デフォルトのエグゼキュータは「キャッシュされたスレッド・プール」を使用し、カスタム・スレッド・ファクトリを使用します。

        実装上の注意:
        セキュリティ・マネージャがインストールされている場合、スレッド・ファクトリは、アクセス権を持たないアクセス制御コンテキストで実行されるスレッドを作成します。
        パラメータ:
        executor - エグゼクティブ
        戻り値:
        このビルダー

      • followRedirects

        public abstract HttpClient.Builder followRedirects​(HttpClient.Redirect policy)
        リクエストがサーバーによって発行されたリダイレクトに自動的に従うかどうかを指定します。

        このメソッドがbuildingの前に呼び出されない場合、新しく作成されたクライアントはデフォルトのリダイレクト・ポリシーNEVERを使用します。

        パラメータ:
        policy - リダイレクト・ポリシー
        戻り値:
        このビルダー

      • version

        public abstract HttpClient.Builder version​(HttpClient.Version version)
        可能であれば、特定のHTTPプロトコル・バージョンをリクエストします。

        このメソッドがbuildingの前に呼び出されない場合、新しく作成されるクライアントはHTTP/2を優先します。

        HTTP/2に設定すると、各リクエストはHTTP/2にアップグレードしようとします。 アップグレードが成功すると、このリクエストに対するレスポンスはHTTP/2を使用し、その後のすべてのリクエストと同じ「オリジン・サーバー」へのレスポンスはHTTP/2を使用します。 アップグレードが失敗した場合、レスポンスはHTTP/1.1を使用して処理されます

        パラメータ:
        version - リクエストされたHTTPプロトコルのバージョン
        戻り値:
        このビルダー

      • priority

        public abstract HttpClient.Builder priority​(int priority)
        このクライアントから送信されたHTTP/2リクエストのデフォルトの優先度を設定します。 指定する値は、1と256 (inclusive)の間にある必要があります。
        パラメータ:
        priority - 優先度の重み付け
        戻り値:
        このビルダー
        例外:
        IllegalArgumentException - 指定された優先度が範囲外の場合

      • authenticator

        public abstract HttpClient.Builder authenticator​(Authenticator a)
        HTTP認証に使用するオーセンティケータを設定します。
        パラメータ:
        a - オーセンティケータ
        戻り値:
        このビルダー

      • build

        public abstract HttpClient build()
        このビルダーの現在の状態から構築された新しいHttpClientを返します。
        戻り値:
        このビルダー