Class HttpRequestHeaderInterceptor

java.lang.Object

org.springframework.graphql.server.support.HttpRequestHeaderInterceptor

All Implemented Interfaces:

WebGraphQlInterceptor

public final class HttpRequestHeaderInterceptor
extends Object
implements WebGraphQlInterceptor

Interceptor that copies HTTP request headers to the GraphQL context to make them available to data fetchers such as annotated controllers, which can use @ContextValue method parameters to access the headers as context values.

User builder() to build an instance, and specify headers of interest that should be copied to the GraphQL context.

Since:

2.0.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HttpRequestHeaderInterceptor.Builder	Builder for HttpRequestHeaderInterceptor.

Nested classes/interfaces inherited from interface org.springframework.graphql.server.WebGraphQlInterceptor

WebGraphQlInterceptor.Chain

Method Summary

Modifier and Type	Method	Description
static HttpRequestHeaderInterceptor.Builder	builder()	Return a builder to create an HttpRequestHeaderInterceptor.
reactor.core.publisher.Mono<WebGraphQlResponse>	intercept(WebGraphQlRequest request, WebGraphQlInterceptor.Chain chain)	Intercept a request and delegate to the rest of the chain including other interceptors and a ExecutionGraphQlService.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.graphql.server.WebGraphQlInterceptor

andThen, apply

Method Details

intercept

public reactor.core.publisher.Mono<WebGraphQlResponse> intercept(WebGraphQlRequest request,
 WebGraphQlInterceptor.Chain chain)

Description copied from interface: WebGraphQlInterceptor

Intercept a request and delegate to the rest of the chain including other interceptors and a ExecutionGraphQlService.

Specified by:

intercept in interface WebGraphQlInterceptor

Parameters:

request - the request which may be a WebSocketGraphQlRequest when intercepting a GraphQL request over WebSocket

chain - the rest of the chain to execute the request

Returns:

a Mono with the response

builder

public static HttpRequestHeaderInterceptor.Builder builder()

Return a builder to create an HttpRequestHeaderInterceptor.