org.springframework.graphql.test.tester

Interface WebSocketGraphQlTester

All Superinterfaces:

GraphQlTester, WebGraphQlTester

public interface WebSocketGraphQlTester
extends WebGraphQlTester

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	WebSocketGraphQlTester.Builder<B extends WebSocketGraphQlTester.Builder<B>> Builder for a GraphQL over WebSocket tester.

Nested classes/interfaces inherited from interface org.springframework.graphql.test.tester.GraphQlTester

GraphQlTester.Entity<D,S extends GraphQlTester.Entity<D,S>>, GraphQlTester.EntityList<E>, GraphQlTester.Errors, GraphQlTester.Path, GraphQlTester.Request<T extends GraphQlTester.Request<T>>, GraphQlTester.Response, GraphQlTester.Subscription, GraphQlTester.Traversable

Method Summary

Modifier and Type	Method and Description
static WebSocketGraphQlTester.Builder<?>	builder(String url, WebSocketClient webSocketClient) Return a builder for a WebSocketGraphQlClient.
static WebSocketGraphQlTester.Builder<?>	builder(URI url, WebSocketClient webSocketClient) Return a builder for a WebSocketGraphQlClient.
static WebSocketGraphQlTester	create(URI url, WebSocketClient webSocketClient) Create a WebSocketGraphQlTester.
WebSocketGraphQlTester.Builder<?>	mutate() Create a builder initialized from the configuration of "this" tester.
reactor.core.publisher.Mono<Void>	start() This is delegated to the start() method of the underlying WebSocketGraphQlClient.
reactor.core.publisher.Mono<Void>	stop() This is delegated to the stop() method of the underlying WebSocketGraphQlClient.

Methods inherited from interface org.springframework.graphql.test.tester.WebGraphQlTester

builder, create

Methods inherited from interface org.springframework.graphql.test.tester.GraphQlTester

builder, document, documentName

Method Detail

start

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

This is delegated to the start() method of the underlying WebSocketGraphQlClient.

stop

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

This is delegated to the stop() method of the underlying WebSocketGraphQlClient.

mutate

WebSocketGraphQlTester.Builder<?> mutate()

Description copied from interface: GraphQlTester

Create a builder initialized from the configuration of "this" tester. Use it to build a new, independently configured instance.

Specified by:

mutate in interface GraphQlTester

Specified by:

mutate in interface WebGraphQlTester

create

static WebSocketGraphQlTester create(URI url,
                                     WebSocketClient webSocketClient)

Create a WebSocketGraphQlTester.

Parameters:

url - the GraphQL endpoint URL

webSocketClient - the underlying transport client to use

builder

static WebSocketGraphQlTester.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 WebSocketGraphQlTester.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