Interface DebugSupport

All Known Implementing Classes:
DefaultDebugSupport

public interface DebugSupport
Register this interface to add debug support to your service.
  • Field Details

  • Method Details

    • init

      void init(OData odata)
      Initializes the debug support implementation. Is called before isUserAuthorized() and createDebugResponse(String, DebugInformation).
      Parameters:
      odata - related OData/Olingo service factory
    • isUserAuthorized

      boolean isUserAuthorized()
      Ensures that the user that requested the debug output is authorized to see this output.
      Returns:
      true if the current user is authorized
    • createDebugResponse

      ODataResponse createDebugResponse(String debugFormat, DebugInformation debugInfo)
      Creates a debug response and delivers it back to the Olingo library. This method MUST NEVER throw an exception.
      Parameters:
      debugFormat - the value of the odata-debug query parameter
      debugInfo - all necessary information to construct debug output
      Returns:
      a new debug response which will be sent to the client