Interface DebugSupport
- All Known Implementing Classes:
DefaultDebugSupport
public interface DebugSupport
Register this interface to add debug support to your service.
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptioncreateDebugResponse
(String debugFormat, DebugInformation debugInfo) Creates a debug response and delivers it back to the Olingo library.void
Initializes the debug support implementation.boolean
Ensures that the user that requested the debug output is authorized to see this output.
-
Field Details
-
ODATA_DEBUG_QUERY_PARAMETER
- See Also:
-
ODATA_DEBUG_JSON
- See Also:
-
ODATA_DEBUG_HTML
- See Also:
-
ODATA_DEBUG_DOWNLOAD
- See Also:
-
-
Method Details
-
init
Initializes the debug support implementation. Is called beforeisUserAuthorized()
andcreateDebugResponse(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
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 parameterdebugInfo
- all necessary information to construct debug output- Returns:
- a new debug response which will be sent to the client
-