Package org.apache.sling.api.servlets
Interface JakartaErrorHandler
@ConsumerType
public interface JakartaErrorHandler
The
JakartaErrorHandler
defines the interface of the service used by
the Sling to handle calls to jakarta.servlet.http.HttpServletResponse.sendError
and
to handle uncaught Throwable
s.- Since:
- 2.5
-
Method Summary
Modifier and TypeMethodDescriptionvoid
handleError
(int status, String message, SlingJakartaHttpServletRequest request, SlingJakartaHttpServletResponse response) Called to render a response for a HTTP status code.void
handleError
(Throwable throwable, SlingJakartaHttpServletRequest request, SlingJakartaHttpServletResponse response) Called to render a response for an uncaughtThrowable
.
-
Method Details
-
handleError
void handleError(int status, String message, SlingJakartaHttpServletRequest request, SlingJakartaHttpServletResponse response) throws IOException Called to render a response for a HTTP status code. This method should set the response status and print the status code and optional message.If the response has already been committed, an error message should be logged but no further processing should take place.
- Parameters:
status
- The HTTP status code to setmessage
- An optional message to write to the response. This message may benull
.request
- The request object providing more information on the request.response
- The response object used to send the status and message.- Throws:
IOException
- May be thrown if an error occurrs sending the response.
-
handleError
void handleError(Throwable throwable, SlingJakartaHttpServletRequest request, SlingJakartaHttpServletResponse response) throws IOException Called to render a response for an uncaughtThrowable
.If the response has already been committed, an error message should be logged but no further processing should take place.
- Parameters:
throwable
- TheThrowable
causing this method to be called.request
- The request object providing more information on the request.response
- The response object used to send the status and message.- Throws:
IOException
- May be thrown if an error occurrs sending the response.
-