com.apollographql.apollo.interceptor

Interface ApolloInterceptor

All Known Implementing Classes:

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.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.
ApolloInterceptor.InterceptorResponse	intercept(com.apollographql.apollo.api.Operation operation, ApolloInterceptorChain chain) Intercepts the outgoing request, performs blocking operations on the request or the response returned by the next set of interceptors in the chain, and returns an ApolloInterceptor.InterceptorResponse if the operations succeeded or throws an exception if the operations failed.
void	interceptAsync(com.apollographql.apollo.api.Operation operation, ApolloInterceptorChain chain, java.util.concurrent.ExecutorService 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

intercept

@Nonnull
ApolloInterceptor.InterceptorResponse intercept(com.apollographql.apollo.api.Operation operation,
                                                         ApolloInterceptorChain chain)
                                                  throws ApolloException

Intercepts the outgoing request, performs blocking operations on the request or the response returned by the next set of interceptors in the chain, and returns an ApolloInterceptor.InterceptorResponse if the operations succeeded or throws an exception if the operations failed.

Parameters:

operation - the GraphQL Operation object contained within the outgoing request.

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

Returns:

This interceptor's response after performing operations.

Throws:

ApolloException - if an error occurred while performing operations on the request/response.

interceptAsync

void interceptAsync(@Nonnull
                    com.apollographql.apollo.api.Operation operation,
                    @Nonnull
                    ApolloInterceptorChain chain,
                    @Nonnull
                    java.util.concurrent.ExecutorService dispatcher,
                    @Nonnull
                    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:

operation - the GraphQL Operation object contained within the outgoing request.

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

dispatcher - the ExecutorService 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.