パッケージ jakarta.websocket

インターフェース ClientEndpointConfig

  • すべてのスーパーインターフェース:
    EndpointConfig
    public interface ClientEndpointConfig
extends EndpointConfig
    ClientEndpointConfig は、クライアントエンドポイントにのみ固有の Web ソケット構成情報を含む特別な種類のエンドポイント構成オブジェクトです。プログラマティッククライアントエンドポイントをデプロイする開発者は、ClientEndpointConfig.Builder を使用してこの構成のインスタンスを作成できます。開発者は、ClientEndpointConfig.Configurator の実装を提供することにより、構成操作の一部をオーバーライドできます。
    作成者:
    dannycoward

    • ネストされたクラスのサマリー

      ネストされたクラス  
      修飾子と型 インターフェース 説明
      static class ClientEndpointConfig.Builder
      ClientEndpointConfig.Builder は、クライアントエンドポイントをデプロイする目的で ClientEndpointConfig オブジェクトを作成するために使用されるクラスです。
      static class ClientEndpointConfig.Configurator
      Configurator クラスは、オープニングハンドシェイクのインターセプト、またはこのコンフィギュレーターで構成された各エンドポイントインスタンスからアクセスできる任意のメソッドとアルゴリズムを提供するなど、カスタム構成アルゴリズムを提供する開発者によって拡張できます。

    • メソッドの詳細

      • getPreferredSubprotocols

        ListSE<StringSE> getPreferredSubprotocols()
        クライアントエンドポイントが使用したいサブプロトコルの順序付きリストを、優先順に、このクライアントがセッションに使用したい最初のお気に入りを返します。このリストは、この構成を使用するクライアントの開始ハンドシェイクで Sec-WebSocket-Protocol ヘッダーを生成するために使用されます。最初のプロトコル名が最も優先されます。クライアントオープニングハンドシェイクを参照してください。
        戻り値:
        優先サブプロトコルのリスト、ない場合は空のリスト

      • getExtensions

        ListSE<Extension> getExtensions()
        このクライアントがセッションに使用する拡張機能を、優先順に、お気に入りから順に返します。これらは、この構成を使用するクライアントの開始ハンドシェイクで Sec-WebSocket-Extensions ヘッダーにデータを入力するために使用される拡張機能です。リストの最初の拡張子が最も優先される拡張子です。拡張機能のネゴシエーションを参照してください。
        戻り値:
        拡張機能のリスト、存在しない場合は空のリスト。

      • getSSLContext

        SSLContextSE getSSLContext()
        サーバーへの WebSocket (wss) 接続を確立するために使用される SSLContext を返します。SSLContext が初期化されます。安全でない WebSocket (ws) 接続の場合、これは null になります。同じ SSLContext を使用するサーバーへの既存の接続があり、その接続が WebSocket 接続の多重化をサポートしている場合、コンテナーは新しい接続を作成するのではなく、その接続を再利用することを選択できます。コンテナーは、この動作を制御するためにコンテナー固有の構成を提供する場合があります。
        戻り値:
        サーバーまたは null への安全な接続を確立するために使用する SSLContext (安全でない接続を確立する必要がある場合)

      • getConfigurator

        ClientEndpointConfig.Configurator getConfigurator()
        この構成のカスタムコンフィギュレーターを返します。開発者が提供しなかった場合は、プラットフォームのデフォルトコンフィギュレータが返されます。
        戻り値:
        この構成で使用されているコンフィギュレーター。