Package graphql.kickstart.servlet.core

Interface GraphQLServletListener.RequestCallback

Enclosing interface:
GraphQLServletListener
public static interface GraphQLServletListener.RequestCallback
The callback which used to add additional listeners for GraphQL request execution.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    beforeFlush(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
    Called right before the response will be written and flushed.
    default void
    onError(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Throwable throwable)
    Called when GraphQL was failed and the response was written already.
    default void
    onFinally(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
    Called finally once on both success and failed GraphQL invocation.
    default void
    onParseError(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Throwable throwable)
    Called when failed to parse InvocationInput and the response was not written.
    default void
    onSuccess(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
    Called when GraphQL invoked successfully and the response was written already.

  • Method Details

    • onParseError

      default void onParseError(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Throwable throwable)
      Called when failed to parse InvocationInput and the response was not written.
      Parameters:
      request - http request
      response - http response

    • beforeFlush

      default void beforeFlush(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
      Called right before the response will be written and flushed. Can be used for applying some changes to the response object, like adding response headers.
      Parameters:
      request - http request
      response - http response

    • onSuccess

      default void onSuccess(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
      Called when GraphQL invoked successfully and the response was written already.
      Parameters:
      request - http request
      response - http response

    • onError

      default void onError(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Throwable throwable)
      Called when GraphQL was failed and the response was written already.
      Parameters:
      request - http request
      response - http response

    • onFinally

      default void onFinally(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
      Called finally once on both success and failed GraphQL invocation. The response is also already written.
      Parameters:
      request - http request
      response - http response