インターフェース WebSocketGraphQlInterceptor

すべてのスーパーインターフェース:
WebGraphQlInterceptor
すべての既知の実装クラス:
AbstractAuthenticationWebSocketInterceptor、AuthenticationWebSocketInterceptor、AuthenticationWebSocketInterceptor
public interface WebSocketGraphQlInterceptor extends WebGraphQlInterceptor
WebSocket 接続の開始と終了、およびクライアント側でのサブスクリプションのキャンセルを処理するための追加メソッドを備えた WebGraphQlInterceptor の拡張です。

WebGraphQlHandler.Builder.interceptor(WebGraphQlInterceptor...) を使用してインターセプターチェーンを構成します。チェーン内の WebSocketGraphQlInterceptor 型のインターセプターは 1 つだけです。

導入:
1.0.0
作成者:
Rossen Stoyanchev

  • メソッドの詳細

    • intercept

      default reactor.core.publisher.Mono<WebGraphQlResponse> intercept(WebGraphQlRequest request, WebGraphQlInterceptor.Chain chain)
      インターフェースからコピーされた説明: WebGraphQlInterceptor
      リクエストをインターセプトし、他のインターセプターと ExecutionGraphQlService を含む残りの チェーンに委譲します。
      次で指定:
      インターフェース WebGraphQlInterceptor の intercept 
      パラメーター:
      request - WebSocket を介して GraphQL リクエストをインターセプトするときに WebSocketGraphQlRequest である可能性があるリクエスト
      chain - リクエストを実行する残りの チェーン
      戻り値:
      レスポンスのある Mono 

    • handleConnectionInitialization

      default reactor.core.publisher.Mono<ObjectSE> handleConnectionInitialization(WebSocketSessionInfo sessionInfo, MapSE<StringSE,ObjectSE> connectionInitPayload)
      GraphQL over WebSocket セッションの開始時に "connection_init" メッセージを処理し、"connection_ack" メッセージが送り返すオプションのペイロードを返します。
      パラメーター:
      sessionInfo - 基礎となる WebSocket セッションに関する情報
      connectionInitPayload - "connection_init" メッセージからのペイロード
      戻り値:
      "connection_ack" のペイロード、または空

    • handleCancelledSubscription

      default reactor.core.publisher.Mono<VoidSE> handleCancelledSubscription(WebSocketSessionInfo sessionInfo, StringSE subscriptionId)
      クライアントがサブスクリプションストリームを停止するために送信する "complete" メッセージを処理します。サブスクリプションの基礎となる Publisher は自動的にキャンセルされます。このコールバックは、サブスクリプション全体での追加の、またはより集中化された処理のためのものです。
      パラメーター:
      sessionInfo - 基礎となる WebSocket セッションに関する情報
      subscriptionId - サブスクリプションの一意の ID。サブスクリプションストリームを開始した "subscribe" メッセージの requestId に相関します
      戻り値:
      取扱い完了用 Mono 

    • handleConnectionClosed

      default void handleConnectionClosed(WebSocketSessionInfo sessionInfo, int statusCode, MapSE<StringSE,ObjectSE> connectionInitPayload)
      いずれかから、WebSocket セッションが閉じられたときに呼び出されます。
      パラメーター:
      sessionInfo - 基礎となる WebSocket セッションに関する情報
      statusCode - WebSocket「クローズ」ステータスコード
      connectionInitPayload - 接続の開始時に受信した "connect_init" メッセージからのペイロード