パッケージ jakarta.websocket.server
クラス ServerEndpointConfig.Builder
java.lang.ObjectSE
jakarta.websocket.server.ServerEndpointConfig.Builder
- 含まれているインターフェース:
- ServerEndpointConfig
ServerEndpointConfig.Builder は、サーバーエンドポイントをデプロイする目的で
ServerEndpointConfig.Builder オブジェクトを作成するために使用されるクラスです。ここではいくつかの例を示します。
パスのみのエンドポイントのプレーン構成を構築します。
ServerEndpointConfig config = ServerEndpointConfig.Builder.create(ProgrammaticEndpoint.class, "/foo").build();
サブプロトコルとカスタムコンフィギュレーターなしで構成を構築します。
ServerEndpointConfig config = ServerEndpointConfig.Builder.create(ProgrammaticEndpoint.class, "/bar")
.subprotocols(subprotocols)
.configurator(new MyServerConfigurator())
.build();
- 作成者:
- dannycoward
方法の概要
修飾子と型メソッド説明build()このビルダーオブジェクトに設定されている現在の属性を使用して、構成オブジェクトを構築します。configurator(ServerEndpointConfig.Configurator serverEndpointConfigurator) このビルダーによってビルドされた構成オブジェクトで使用するカスタムコンフィギュレーターを設定します。static ServerEndpointConfig.Builderエンドポイントクラスの必須情報(プログラムまたはアノテーション付き)、使用する相対 URI または URI テンプレートを使用し、サブプロトコル、拡張機能、エンコーダー、デコーダー、カスタムコンフィギュレーターを使用せずにビルダーを作成します。構成で使用するデコーダー実装クラスを設定します。このビルダーのエンコーダ実装クラスのリストを設定します。extensions(ListSE<Extension> extensions) 構成で使用する拡張機能を設定します。subprotocols(ListSE<StringSE> subprotocols) 構成で使用するサブプロトコルを設定します。
方法の詳細
create
エンドポイントクラスの必須情報(プログラムまたはアノテーション付き)、使用する相対 URI または URI テンプレートを使用し、サブプロトコル、拡張機能、エンコーダー、デコーダー、カスタムコンフィギュレーターを使用せずにビルダーを作成します。- パラメーター:
endpointClass- 構成するエンドポイントのクラスpath- エンドポイントがデプロイされる URI または URI テンプレート。末尾の "/" は無視され、パスは / で始まる必要があります。- 戻り値:
- ServerEndpointConfig.Builder の新しいインスタンス
build
このビルダーオブジェクトに設定されている現在の属性を使用して、構成オブジェクトを構築します。- 戻り値:
- 新しい ServerEndpointConfig オブジェクト。
encoders
このビルダーのエンコーダ実装クラスのリストを設定します。- パラメーター:
encoders- エンコーダ- 戻り値:
- このビルダーインスタンス
decoders
構成で使用するデコーダー実装クラスを設定します。- パラメーター:
decoders- デコーダ- 戻り値:
- このビルダーインスタンス。
subprotocols
構成で使用するサブプロトコルを設定します。- パラメーター:
subprotocols- サブプロトコル。- 戻り値:
- このビルダーインスタンス
extensions
構成で使用する拡張機能を設定します。- パラメーター:
extensions- 使用する拡張機能。- 戻り値:
- このビルダーインスタンス。
configurator
public ServerEndpointConfig.Builder configurator(ServerEndpointConfig.Configurator serverEndpointConfigurator) このビルダーによってビルドされた構成オブジェクトで使用するカスタムコンフィギュレーターを設定します。- パラメーター:
serverEndpointConfigurator- コンフィギュレーター- 戻り値:
- このビルダーインスタンス