Class GraphQlRequestPredicates

java.lang.Object

org.springframework.graphql.server.webflux.GraphQlRequestPredicates

public final class GraphQlRequestPredicates
extends Object

RequestPredicate implementations tailored for GraphQL reactive endpoints.

Since:

1.3.0

Author:

Brian Clozel, Rossen Stoyanchev

Method Summary

Modifier and Type	Method	Description
static RequestPredicate	graphQlHttp(String path)	Create a predicate that matches GraphQL HTTP requests for the configured path.
static RequestPredicate	graphQlHttp(String path, Set<HttpMethod> methods)	Variant of graphQlHttp(String) that matches GraphQL HTTP requests using one of the given HTTP methods.
static RequestPredicate	graphQlSse(String path)	Create a predicate that matches GraphQL SSE over HTTP requests for the configured path.
static RequestPredicate	graphQlSse(String path, Set<HttpMethod> methods)	Variant of graphQlSse(String) that matches GraphQL SSE over HTTP requests using one of the given HTTP methods.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

graphQlHttp

public static RequestPredicate graphQlHttp(String path)

Create a predicate that matches GraphQL HTTP requests for the configured path.

Matches only HTTP POST requests. To also match other HTTP methods, use graphQlHttp(String, Set).

Parameters:

path - the path on which the GraphQL HTTP endpoint is mapped

See Also:

• GraphQlHttpHandler

graphQlHttp

public static RequestPredicate graphQlHttp(String path,
 Set<HttpMethod> methods)

Variant of graphQlHttp(String) that matches GraphQL HTTP requests using one of the given HTTP methods.

Parameters:

path - the path on which the GraphQL HTTP endpoint is mapped

methods - the HTTP methods to match

Since:

2.1.0

See Also:

• GraphQlHttpHandler

graphQlSse

public static RequestPredicate graphQlSse(String path)

Create a predicate that matches GraphQL SSE over HTTP requests for the configured path.

Matches only HTTP POST requests. To also match other HTTP methods, use graphQlSse(String, Set).

Parameters:

path - the path on which the GraphQL SSE endpoint is mapped

See Also:

• GraphQlSseHandler

graphQlSse

public static RequestPredicate graphQlSse(String path,
 Set<HttpMethod> methods)

Variant of graphQlSse(String) that matches GraphQL SSE over HTTP requests using one of the given HTTP methods.

Parameters:

path - the path on which the GraphQL SSE endpoint is mapped

methods - the HTTP methods to match

Since:

2.1.0

See Also:

• GraphQlSseHandler