クラス AbstractStandardUpgradeStrategy
java.lang.ObjectSE
org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy
- 実装されたすべてのインターフェース:
RequestUpgradeStrategy
public abstract class AbstractStandardUpgradeStrategy
extends ObjectSE
implements RequestUpgradeStrategy
標準の WebSocket API for Java（JSR-356）に基づいて構築された
RequestUpgradeStrategy 実装の基本クラス。- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev
フィールドサマリー
フィールドコンストラクターのサマリー
コンストラクターメソッドのサマリー
修飾子と型メソッド説明protected ServerContainerEEgetContainer(HttpServletRequestEE request) protected final HttpServletRequestEEgetHttpServletRequest(ServerHttpRequest request) protected final HttpServletResponseEEgetHttpServletResponse(ServerHttpResponse response) protected ListSE<WebSocketExtension>getInstalledExtensions(WebSocketContainerEE container) getSupportedExtensions(ServerHttpRequest request) 基礎となる WebSocket サーバーによってサポートされる WebSocket プロトコル拡張機能を返します。voidupgrade(ServerHttpRequest request, ServerHttpResponse response, StringSE selectedProtocol, ListSE<WebSocketExtension> selectedExtensions, PrincipalSE user, WebSocketHandler wsHandler, MapSE<StringSE, ObjectSE> attrs) ランタイム固有の手順を実行して、アップグレードを完了します。protected abstract voidupgradeInternal(ServerHttpRequest request, ServerHttpResponse response, StringSE selectedProtocol, ListSE<ExtensionEE> selectedExtensions, EndpointEE endpoint) クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSEインターフェース org.springframework.web.socket.server.RequestUpgradeStrategy から継承されたメソッド
getSupportedVersions
フィールドの詳細
logger
コンストラクターの詳細
AbstractStandardUpgradeStrategy
public AbstractStandardUpgradeStrategy()
メソッドの詳細
getContainer
getHttpServletRequest
getHttpServletResponse
getSupportedExtensions
インターフェースからコピーされた説明:RequestUpgradeStrategy基礎となる WebSocket サーバーによってサポートされる WebSocket プロトコル拡張機能を返します。- 次で指定:
- インターフェース
RequestUpgradeStrategyのgetSupportedExtensions
getInstalledExtensions
upgrade
public void upgrade(ServerHttpRequest request, ServerHttpResponse response, @Nullable StringSE selectedProtocol, ListSE<WebSocketExtension> selectedExtensions, @Nullable PrincipalSE user, WebSocketHandler wsHandler, MapSE<StringSE, ObjectSE> attrs) throws HandshakeFailureExceptionインターフェースからコピーされた説明:RequestUpgradeStrategyランタイム固有の手順を実行して、アップグレードを完了します。ハンドシェイクリクエストのネゴシエーションが成功した後に呼び出されます。- 次で指定:
- インターフェース
RequestUpgradeStrategyのupgrade - パラメーター:
request- 現在のリクエストresponse- 現在のレスポンスselectedProtocol- 選択されたサブプロトコル（存在する場合）selectedExtensions- 選択された WebSocket プロトコル拡張user- WebSocket セッションに関連付けるユーザーwsHandler- WebSocket メッセージのハンドラーattrs- ハンドシェイクは、HandshakeInterceptorを介して WebSocket セッションで設定され、WebSocketHandlerで利用可能になる特定の属性をリクエストします。- 例外:
HandshakeFailureException- ハンドシェイクリクエストの要件のネゴシエーションに失敗したのではなく、内部の回復不可能なエラー、つまりサーバーエラーが原因でハンドシェイク処理が完了しなかった場合にスローされます。
upgradeInternal
protected abstract void upgradeInternal(ServerHttpRequest request, ServerHttpResponse response, @Nullable StringSE selectedProtocol, ListSE<ExtensionEE> selectedExtensions, EndpointEE endpoint) throws HandshakeFailureException