Package org.springframework.graphql.client

Interface WebSocketGraphQlClientInterceptor

All Superinterfaces:

GraphQlClientInterceptor

public interface WebSocketGraphQlClientInterceptor
extends GraphQlClientInterceptor

An extension of GraphQlClientInterceptor with additional methods to for WebSocket interception points. Only a single interceptor of type WebSocketGraphQlClientInterceptor may be configured.

Use GraphQlClient.Builder.interceptor(GraphQlClientInterceptor...) to configure the interceptor chain. Only one interceptor in the chain may be of type WebSocketGraphQlClientInterceptor.

Since:

1.0.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.graphql.client.GraphQlClientInterceptor

GraphQlClientInterceptor.Chain, GraphQlClientInterceptor.SubscriptionChain

Method Summary

Modifier and Type	Method	Description
default reactor.core.publisher.Mono<Object>	connectionInitPayload()	Provide a Mono that returns the payload for the "connection_init" message.
default reactor.core.publisher.Mono<Void>	handleConnectionAck(Map<String,Object> ackPayload)	Handler the "connection_ack" message received from the server at the start of the WebSocket connection.

Methods inherited from interface org.springframework.graphql.client.GraphQlClientInterceptor

andThen, intercept, interceptSubscription

Method Details

connectionInitPayload

default reactor.core.publisher.Mono<Object> connectionInitPayload()

Provide a Mono that returns the payload for the "connection_init" message. The Mono is subscribed to every type a new WebSocket connection is established.

handleConnectionAck

default reactor.core.publisher.Mono<Void> handleConnectionAck(Map<String,Object> ackPayload)

Handler the "connection_ack" message received from the server at the start of the WebSocket connection.

Parameters:

ackPayload - the payload of the "connection_ack" message