public interface ServerContainer extends WebSocketContainer
WebSocket 対応の Web コンテナーの場合、開発者は、ServerContainer インスタンスを ServletContext 上の jakarta.websocket.server.ServerContainer
という名前の属性として取得することにより、ServerContainer インスタンスへの参照を取得できます。このようにして、このインターフェースに保持されている登録メソッドを呼び出して、エンドポイントを含む WAR ファイルのデプロイの間に ServletContextListener からサーバーエンドポイントを登録できます。
Web コンテナーの外部で実行される WebSocket 実装には、アプリケーションデプロイ時に開発者に ServerContainer インスタンスを提供する他の手段があります。
アプリケーションデプロイフェーズが完了し、websocket アプリケーションが受信接続の受け入れを開始すると、登録メソッドは呼び出されなくなります。
修飾子と型 | メソッドと説明 |
---|---|
void | addEndpoint(ClassSE<?> endpointClass) アプリケーションのデプロイの初期化フェーズ中に、指定されたアノテーション付きエンドポイントをこの ServerContainer にデプロイします。 |
void | addEndpoint(ServerEndpointConfig serverConfig) |
connectToServer, connectToServer, connectToServer, connectToServer, getDefaultAsyncSendTimeout, getDefaultMaxBinaryMessageBufferSize, getDefaultMaxSessionIdleTimeout, getDefaultMaxTextMessageBufferSize, getInstalledExtensions, setAsyncSendTimeout, setDefaultMaxBinaryMessageBufferSize, setDefaultMaxSessionIdleTimeout, setDefaultMaxTextMessageBufferSize
void addEndpoint(ClassSE<?> endpointClass) throws DeploymentException
endpointClass
- アノテーション付きエンドポイントのクラス DeploymentException
- アノテーション付きエンドポイントの形式が正しくない場合。IllegalStateExceptionSE
- 含まれている websocket アプリケーションがすでにデプロイされている場合。void addEndpoint(ServerEndpointConfig serverConfig) throws DeploymentException
serverConfig
- 登録される論理エンドポイントを表す構成インスタンス。DeploymentException
- エンドポイントの形式が不適切だった場合。IllegalStateExceptionSE
- 含まれている websocket アプリケーションがすでにデプロイされている場合。Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.