graphql.execution

Interface DataFetcherExceptionHandler

All Known Implementing Classes:

SimpleDataFetcherExceptionHandler

@PublicSpi
public interface DataFetcherExceptionHandler

This is called when an exception is thrown during DataFetcher.get(DataFetchingEnvironment) execution

Method Summary

Modifier and Type	Method and Description
default java.util.concurrent.CompletableFuture<DataFetcherExceptionHandlerResult>	handleException(DataFetcherExceptionHandlerParameters handlerParameters) When an exception occurs during a call to a DataFetcher then this handler is called to shape the errors that should be placed in the ExecutionResult.getErrors() list of errors.
default DataFetcherExceptionHandlerResult	onException(DataFetcherExceptionHandlerParameters handlerParameters) Deprecated. use handleException(DataFetcherExceptionHandlerParameters) instead which as an asynchronous version

Method Detail

onException

@Deprecated
default DataFetcherExceptionHandlerResult onException(DataFetcherExceptionHandlerParameters handlerParameters)

Deprecated. use handleException(DataFetcherExceptionHandlerParameters) instead which as an asynchronous version

When an exception occurs during a call to a DataFetcher then this handler is called to shape the errors that should be placed in the ExecutionResult.getErrors() list of errors.

Parameters:

handlerParameters - the parameters to this callback

Returns:

a result that can contain custom formatted GraphQLErrors

handleException

default java.util.concurrent.CompletableFuture<DataFetcherExceptionHandlerResult> handleException(DataFetcherExceptionHandlerParameters handlerParameters)

When an exception occurs during a call to a DataFetcher then this handler is called to shape the errors that should be placed in the ExecutionResult.getErrors() list of errors.

Parameters:

handlerParameters - the parameters to this callback

Returns:

a result that can contain custom formatted GraphQLErrors