com.apollographql.apollo.interceptor

Interface ApolloInterceptor

All Known Implementing Classes:

ApolloAutoPersistedQueryInterceptor, ApolloCacheInterceptor, ApolloParseInterceptor, ApolloServerInterceptor

public interface ApolloInterceptor

ApolloInterceptor is responsible for observing and modifying the requests going out and the corresponding responses coming back in. Typical responsibilities include adding or removing headers from the request or response objects, transforming the returned responses from one type to another, etc.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ApolloInterceptor.CallBack Handles the responses returned by ApolloInterceptor
static class	ApolloInterceptor.FetchSourceType Fetch source type
static class	ApolloInterceptor.InterceptorRequest Request to be proceed with ApolloInterceptor
static class	ApolloInterceptor.InterceptorResponse InterceptorResponse class represents the response returned by the ApolloInterceptor.

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes of the resources which are no longer required.
void	interceptAsync(ApolloInterceptor.InterceptorRequest request, ApolloInterceptorChain chain, java.util.concurrent.Executor dispatcher, ApolloInterceptor.CallBack callBack) Intercepts the outgoing request and performs non blocking operations on the request or the response returned by the next set of interceptors in the chain.

Method Detail

interceptAsync

void interceptAsync(@NotNull
                    ApolloInterceptor.InterceptorRequest request,
                    @NotNull
                    ApolloInterceptorChain chain,
                    @NotNull
                    java.util.concurrent.Executor dispatcher,
                    @NotNull
                    ApolloInterceptor.CallBack callBack)

Intercepts the outgoing request and performs non blocking operations on the request or the response returned by the next set of interceptors in the chain.

Parameters:

request - outgoing request object.

chain - the ApolloInterceptorChain object containing the next set of interceptors.

dispatcher - the Executor which dispatches the non blocking operations on the request/response.

callBack - the Callback which will handle the interceptor's response or failure exception.

dispose

void dispose()

Disposes of the resources which are no longer required.

A use case for this method call would be when an ApolloCall needs to be cancelled and resources need to be disposed of.