クラス JettyRequestUpgradeStrategy
java.lang.ObjectSE
org.springframework.web.socket.server.jetty.JettyRequestUpgradeStrategy
- 実装されたすべてのインターフェース:
Aware
、ServletContextAware
、RequestUpgradeStrategy
public class JettyRequestUpgradeStrategy
extends ObjectSE
implements RequestUpgradeStrategy, ServletContextAware
Jetty 12 EE10 用の
RequestUpgradeStrategy
。- 導入:
- 5.3.4
- 作成者:
- Rossen Stoyanchev
コンストラクターの概要
コンストラクターメソッドのサマリー
修飾子と型メソッド説明void
addWebSocketConfigurer
(ConsumerSE<org.eclipse.jetty.websocket.api.Configurable> webSocketConfigurer) JettyWebSocketServerContainer
で WebSocket サーバーパラメーターを構成するためのコールバックを追加します。getSupportedExtensions
(ServerHttpRequest request) 基礎となる WebSocket サーバーによってサポートされる WebSocket プロトコル拡張機能を返します。StringSE[]
サポートされている WebSocket プロトコルバージョンを返します。void
setServletContext
(ServletContextEE servletContext) このオブジェクトが実行されるServletContext
EE を設定します。void
upgrade
(ServerHttpRequest request, ServerHttpResponse response, StringSE selectedProtocol, ListSE<WebSocketExtension> selectedExtensions, PrincipalSE user, WebSocketHandler handler, MapSE<StringSE, ObjectSE> attributes) ランタイム固有の手順を実行して、アップグレードを完了します。
コンストラクターの詳細
JettyRequestUpgradeStrategy
public JettyRequestUpgradeStrategy()
メソッドの詳細
getSupportedVersions
インターフェースからコピーされた説明:RequestUpgradeStrategy
サポートされている WebSocket プロトコルバージョンを返します。- 次で指定:
- インターフェース
RequestUpgradeStrategy
のgetSupportedVersions
getSupportedExtensions
インターフェースからコピーされた説明:RequestUpgradeStrategy
基礎となる WebSocket サーバーによってサポートされる WebSocket プロトコル拡張機能を返します。- 次で指定:
- インターフェース
RequestUpgradeStrategy
のgetSupportedExtensions
addWebSocketConfigurer
public void addWebSocketConfigurer(ConsumerSE<org.eclipse.jetty.websocket.api.Configurable> webSocketConfigurer) JettyWebSocketServerContainer
で WebSocket サーバーパラメーターを構成するためのコールバックを追加します。- 導入:
- 6.1
setServletContext
インターフェースからコピーされた説明:ServletContextAware
このオブジェクトが実行されるServletContext
EE を設定します。通常の Bean プロパティの設定後、InitializingBean の
afterPropertiesSet
またはカスタム init メソッドのような初期コールバックの前に呼び出されます。ApplicationContextAware のsetApplicationContext
の後に呼び出されます。- 次で指定:
- インターフェース
ServletContextAware
のsetServletContext
- パラメーター:
servletContext
- このオブジェクトによって使用される ServletContext オブジェクト- 関連事項:
upgrade
public void upgrade(ServerHttpRequest request, ServerHttpResponse response, @Nullable StringSE selectedProtocol, ListSE<WebSocketExtension> selectedExtensions, @Nullable PrincipalSE user, WebSocketHandler handler, MapSE<StringSE, ObjectSE> attributes) throws HandshakeFailureExceptionインターフェースからコピーされた説明:RequestUpgradeStrategy
ランタイム固有の手順を実行して、アップグレードを完了します。ハンドシェイクリクエストのネゴシエーションが成功した後に呼び出されます。- 次で指定:
- インターフェース
RequestUpgradeStrategy
のupgrade
- パラメーター:
request
- 現在のリクエストresponse
- 現在のレスポンスselectedProtocol
- 選択されたサブプロトコル(存在する場合)selectedExtensions
- 選択された WebSocket プロトコル拡張user
- WebSocket セッションに関連付けるユーザーhandler
- WebSocket メッセージのハンドラーattributes
- ハンドシェイクは、HandshakeInterceptor
を介して WebSocket セッションで設定され、WebSocketHandler
で利用可能になる特定の属性をリクエストします。- 例外:
HandshakeFailureException
- ハンドシェイクリクエストの要件のネゴシエーションに失敗したのではなく、内部の回復不可能なエラー、つまりサーバーエラーが原因でハンドシェイク処理が完了しなかった場合にスローされます。