インターフェース HandshakeInterceptor
- すべての既知の実装クラス:
HttpSessionHandshakeInterceptor
,OriginHandshakeInterceptor
public interface HandshakeInterceptor
WebSocket ハンドシェイクリクエストのインターセプター。ハンドシェイクのリクエストとレスポンスをインスペクションしたり、属性をターゲット
WebSocketHandler
に渡したりするために使用できます。- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev
- 関連事項:
方法の概要
修飾子と型メソッド説明void
afterHandshake
(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, ExceptionSE exception) ハンドシェイクが完了した後に呼び出されます。boolean
beforeHandshake
(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, MapSE<StringSE, ObjectSE> attributes) ハンドシェイクが処理される前に呼び出されます。
メソッドの詳細
beforeHandshake
boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, MapSE<StringSE, ObjectSE> attributes) throws ExceptionSEハンドシェイクが処理される前に呼び出されます。- パラメーター:
request
- 現在のリクエストresponse
- 現在のレスポンスwsHandler
- ターゲット WebSocket ハンドラーattributes
- WebSocket セッションに関連付ける HTTP ハンドシェイクの属性。提供された属性がコピーされ、元のマップは使用されません。- 戻り値:
- ハンドシェイク(
true
)を続行するか、中止するか (false
) - 例外:
ExceptionSE
afterHandshake
void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, @Nullable ExceptionSE exception) ハンドシェイクが完了した後に呼び出されます。レスポンスステータスとヘッダーは、ハンドシェイクの結果、つまり成功したかどうかを示します。- パラメーター:
request
- 現在のリクエストresponse
- 現在のレスポンスwsHandler
- ターゲット WebSocket ハンドラーexception
- ハンドシェイク中に発生した例外、ない場合はnull