com.apollographql.apollo.internal.interceptor

Class ApolloCacheInterceptor

java.lang.Object

com.apollographql.apollo.internal.interceptor.ApolloCacheInterceptor

All Implemented Interfaces:

ApolloInterceptor

public final class ApolloCacheInterceptor
extends java.lang.Object
implements ApolloInterceptor

ApolloCacheInterceptor is a concrete ApolloInterceptor responsible for serving requests from the normalized cache. It takes the following actions based on the CacheControl set:

1. CACHE_ONLY: First tries to get the data from the normalized cache. If the data doesn't exist or there was an error inflating the models, it returns the ApolloInterceptor.InterceptorResponse with the GraphQL Operation object wrapped inside.
2. CACHE_FIRST: First tries to get the data from the normalized cache. If the data doesn't exist or there was an error inflating the models, it then makes a network request.
3. NETWORK_FIRST: First tries to get the data from the network. If there was an error getting data from the network, it tries to get it from the normalized cache. If it is not present in the cache, then it rethrows the network exception.
4. NETWORK_ONLY: First tries to get the data from the network. If the network request fails, it throws an exception.

Nested Class Summary

Nested classes/interfaces inherited from interface com.apollographql.apollo.interceptor.ApolloInterceptor

ApolloInterceptor.CallBack, ApolloInterceptor.InterceptorResponse

Constructor Summary

Constructors

Constructor and Description
ApolloCacheInterceptor(ApolloStore apolloStore, CacheControl cacheControl, CacheHeaders cacheHeaders, com.apollographql.apollo.api.ResponseFieldMapper responseFieldMapper, java.util.Map<com.apollographql.apollo.api.ScalarType,CustomTypeAdapter> customTypeAdapters, java.util.concurrent.ExecutorService dispatcher, ApolloLogger logger)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApolloCacheInterceptor

public ApolloCacheInterceptor(@Nonnull
                              ApolloStore apolloStore,
                              @Nonnull
                              CacheControl cacheControl,
                              @Nonnull
                              CacheHeaders cacheHeaders,
                              @Nonnull
                              com.apollographql.apollo.api.ResponseFieldMapper responseFieldMapper,
                              @Nonnull
                              java.util.Map<com.apollographql.apollo.api.ScalarType,CustomTypeAdapter> customTypeAdapters,
                              @Nonnull
                              java.util.concurrent.ExecutorService dispatcher,
                              @Nonnull
                              ApolloLogger logger)

Method Detail

intercept

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

Description copied from interface: ApolloInterceptor

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.

Specified by:

intercept in interface ApolloInterceptor

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

public void interceptAsync(@Nonnull
                           com.apollographql.apollo.api.Operation operation,
                           @Nonnull
                           ApolloInterceptorChain chain,
                           @Nonnull
                           java.util.concurrent.ExecutorService dispatcher,
                           @Nonnull
                           ApolloInterceptor.CallBack callBack)

Description copied from interface: ApolloInterceptor

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.

Specified by:

interceptAsync in interface ApolloInterceptor

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

public void dispose()

Description copied from interface: ApolloInterceptor

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.

Specified by:

dispose in interface ApolloInterceptor