パッケージ jakarta.websocket.server
インターフェース ServerEndpointConfig
- すべてのスーパーインターフェース:
EndpointConfig
public interface ServerEndpointConfig extends EndpointConfig
ServerEndpointConfig は、サーバーエンドポイントにのみ固有の Web ソケット構成情報を含む特別な種類のエンドポイント構成オブジェクトです。プログラムエンドポイントをデプロイする開発者は、ServerEndpointConfig.Builder
を使用して ServerEndpointConfig オブジェクトを作成できます。特定の構成操作は、ServerEndpointConfig.Configurator
を提供することによってカスタマイズできます- 作成者:
- dannycoward
ネストされたクラスのサマリー
ネストされたクラス 修飾子と型 インターフェース 説明 static class
ServerEndpointConfig.Builder
ServerEndpointConfig.Builder は、サーバーエンドポイントをデプロイする目的でServerEndpointConfig.Builder
オブジェクトを作成するために使用されるクラスです。static class
ServerEndpointConfig.Configurator
ServerEndpointConfig.Configurator クラスは、オープニングハンドシェイクのインターセプトなどのカスタム構成アルゴリズムを提供したり、このコンフィギュレーターで構成された各エンドポイントインスタンスからアクセスできる任意のメソッドとアルゴリズムを提供したい開発者によって拡張できます。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 ServerEndpointConfig.Configurator
getConfigurator()
この構成が使用しているServerEndpointConfig.Configurator
を返します。ClassSE<?>
getEndpointClass()
この構成が構成しているエンドポイントのクラスを返します。ListSE<Extension>
getExtensions()
構成された WebSocket 拡張機能を返します。StringSE
getPath()
このエンドポイント構成のパスを返します。ListSE<StringSE>
getSubprotocols()
構成された WebSocket サブプロトコルを返します。インターフェース jakarta.websocket.EndpointConfig から継承されたメソッド
getDecoders, getEncoders, getUserProperties
メソッドの詳細
getEndpointClass
ClassSE<?> getEndpointClass()
この構成が構成しているエンドポイントのクラスを返します。エンドポイントがアノテーション付きのエンドポイントである場合、値は @ServerEndpoint でアノテーションが付けられた Java クラスのクラスです。エンドポイントがプログラムの場合、値はエンドポイントのサブクラスのクラスです。- 戻り値:
- アノテーション付きまたはプログラムによるエンドポイントのクラス。
getPath
StringSE getPath()
このエンドポイント構成のパスを返します。パスは、この構成を使用するエンドポイントがマップされるサーバーの WebSocket ルートからの相対 URI または URI テンプレート(レベル 1)です。パスは常に非 null であり、常に先頭の "/" で始まります。- 戻り値:
- この構成の相対パス。
getSubprotocols
ListSE<StringSE> getSubprotocols()
構成された WebSocket サブプロトコルを返します。- 戻り値:
- サブプロトコルのリスト、ない場合は空のリスト
getConfigurator
ServerEndpointConfig.Configurator getConfigurator()
この構成が使用しているServerEndpointConfig.Configurator
を返します。ServerEndpointConfig.Builder.configurator(jakarta.websocket.server.ServerEndpointConfig.Configurator)
を呼び出して何も設定されていない場合、このメソッドはプラットフォームのデフォルトコンフィギュレーターを返します。- 戻り値:
- 使用中のコンフィギュレータ。