org.springframework.graphql.client

Interface WebSocketGraphQlClient

All Superinterfaces:

GraphQlClient, WebGraphQlClient

public interface WebSocketGraphQlClient
extends WebGraphQlClient

GraphQL over WebSocket client that uses WebSocketClient.

Since:

1.0.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WebSocketGraphQlClient.Builder<B extends WebSocketGraphQlClient.Builder<B>> Builder for a GraphQL over WebSocket client.

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

GraphQlClient.RequestSpec, GraphQlClient.RetrieveSpec, GraphQlClient.RetrieveSubscriptionSpec

Method Summary

Modifier and Type	Method and Description
static WebSocketGraphQlClient.Builder<?>	builder(String url, WebSocketClient webSocketClient) Return a builder for a WebSocketGraphQlClient.
static WebSocketGraphQlClient.Builder<?>	builder(URI url, WebSocketClient webSocketClient) Return a builder for a WebSocketGraphQlClient.
static WebSocketGraphQlClient	create(URI url, WebSocketClient webSocketClient) Create a WebSocketGraphQlClient.
WebSocketGraphQlClient.Builder<?>	mutate() Return a builder initialized from the configuration of "this" client to use to build a new, independently configured client instance.
reactor.core.publisher.Mono<Void>	start() Start the GraphQL session by connecting the WebSocket, sending the "connection_init" and receiving the "connection_ack" message.
reactor.core.publisher.Mono<Void>	stop() Stop the GraphQL session by closing the WebSocket with CloseStatus.NORMAL and terminating in-progress requests with an error signal.

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

builder, document, documentName

Method Detail

start

reactor.core.publisher.Mono<Void> start()

Start the GraphQL session by connecting the WebSocket, sending the "connection_init" and receiving the "connection_ack" message.

Note: Only one session is started at a time. Additional attempts to start have no impact while a session is active.

Returns:

Mono that completes when the WebSocket is connected and the GraphQL session is ready to send requests

stop

reactor.core.publisher.Mono<Void> stop()

Stop the GraphQL session by closing the WebSocket with CloseStatus.NORMAL and terminating in-progress requests with an error signal.

New requests are rejected from the time of this call. If necessary, call start() to allow requests again.

Returns:

Mono that completes when the underlying session is closed

mutate

WebSocketGraphQlClient.Builder<?> mutate()

Description copied from interface: GraphQlClient

Return a builder initialized from the configuration of "this" client to use to build a new, independently configured client instance.

Specified by:

mutate in interface GraphQlClient

Specified by:

mutate in interface WebGraphQlClient

create

static WebSocketGraphQlClient create(URI url,
                                     WebSocketClient webSocketClient)

Create a WebSocketGraphQlClient.

Parameters:

url - the GraphQL endpoint URL

webSocketClient - the underlying transport client to use

builder

static WebSocketGraphQlClient.Builder<?> builder(String url,
                                                 WebSocketClient webSocketClient)

Return a builder for a WebSocketGraphQlClient.

Parameters:

url - the GraphQL endpoint URL

webSocketClient - the underlying transport client to use

builder

static WebSocketGraphQlClient.Builder<?> builder(URI url,
                                                 WebSocketClient webSocketClient)

Return a builder for a WebSocketGraphQlClient.

Parameters:

url - the GraphQL endpoint URL

webSocketClient - the underlying transport client to use