パッケージ jakarta.websocket

クラス ClientEndpointConfig.Builder

java.lang.ObjectSE
jakarta.websocket.ClientEndpointConfig.Builder
含まれているインターフェース:
ClientEndpointConfig
public static final class ClientEndpointConfig.Builder extends ObjectSE
ClientEndpointConfig.Builder は、クライアントエンドポイントをデプロイする目的で ClientEndpointConfig オブジェクトを作成するために使用されるクラスです。次に例を示します。エンコーダー、デコーダー、サブプロトコル、拡張機能を使用せずにプレーンな構成を構築します。 ClientEndpointConfig cec = ClientEndpointConfig.Builder.create().build();  サブプロトコルとカスタムコンフィギュレーターのない構成の構築。
 
 ClientEndpointConfig customCec = ClientEndpointConfig.Builder.create()
         .preferredSubprotocols(mySubprotocols)
         .configurator(new MyClientConfigurator())
         .build();
作成者:
dannycoward

  • メソッドの詳細

    • create

      public static ClientEndpointConfig.Builder create()
      サブプロトコル、拡張機能、エンコーダー、デコーダー、null コンフィギュレーターを含まない新しいビルダーオブジェクトを作成します。
      戻り値:
      新しいビルダーオブジェクト。

    • build

      public ClientEndpointConfig build()
      このビルダーで設定された属性を使用して構成オブジェクトを構築します。
      戻り値:
      新しい構成オブジェクト。

    • configurator

      public ClientEndpointConfig.Builder configurator(ClientEndpointConfig.Configurator clientEndpointConfigurator)
      このビルダーが構築する構成のコンフィギュレーターオブジェクトを設定します。
      パラメーター:
      clientEndpointConfigurator - コンフィギュレーター
      戻り値:
      ビルダーインスタンス

    • preferredSubprotocols

      public ClientEndpointConfig.Builder preferredSubprotocols(ListSE<StringSE> preferredSubprotocols)
      このビルダーが構築する構成の優先サブプロトコルを設定します。リストは、このクライアントがそのセッションに使用することを希望する優先順で処理されます。
      パラメーター:
      preferredSubprotocols - 推奨されるサブプロトコル名。
      戻り値:
      ビルダーインスタンス

    • extensions

      public ClientEndpointConfig.Builder extensions(ListSE<Extension> extensions)
      このビルダーが構築する構成の拡張を設定します。リストは、クライアントがそのセッションに使用することを希望する優先順で処理されます。
      パラメーター:
      extensions - 拡張機能
      戻り値:
      ビルダーインスタンス

    • encoders

      public ClientEndpointConfig.Builder encoders(ListSE<ClassSE<? extends Encoder>> encoders)
      クライアントが使用するエンコーダ実装クラスのリストを割り当てます。
      パラメーター:
      encoders - エンコーダ実装クラス
      戻り値:
      ビルダーインスタンス

    • decoders

      public ClientEndpointConfig.Builder decoders(ListSE<ClassSE<? extends Decoder>> decoders)
      クライアントが使用するデコーダー実装クラスのリストを割り当てます。
      パラメーター:
      decoders - デコーダ実装クラス
      戻り値:
      このビルダーインスタンス

    • sslContext

      public ClientEndpointConfig.Builder sslContext(SSLContextSE sslContext)
      WebSocket サーバーへの接続時に使用する SSLContext を割り当てます。同じ SSLContext を使用するサーバーへの既存の接続があり、その接続が WebSocket 接続の多重化をサポートしている場合、コンテナーは新しい接続を作成するのではなく、その接続を再利用することを選択できます。コンテナーは、この動作を制御するためにコンテナー固有の構成を提供する場合があります。
      パラメーター:
      sslContext - 安全な WebSocket (wss) 接続または非安全な WebSocket (ws) 接続の null のために初期化する必要がある SSLContext。
      戻り値:
      このビルダーインスタンス