Home » Documentation » The Sling Engine


The Sling Engine includes support for handling uncaught Throwable as well as rendering custom HTTP status code pages. This is implemented by expecting a (single) org.apache.sling.engine.servlets.ErrorHandler service to which handling of uncaught Throwable and HTTP status responses are delegated.

The Sling Servlet Resolver bundle implements this interface by providing an elaborate mechanism to find the correct error handling script or servlet using the same algorithms as are used to select the scripts or servlets to handle regular requests.

This page provides more information on how error handler scripts are selected and what is provided out of the box.

The ErrorHandlingTest in our integration tests suite provides working examples of various error handling scenarios.

Resetting the Response

Errorhandler scripts and servlets are script with the current response. Before setting the status and writing to the response such handlers should do the following:

HTTP Status Codes

The Sling engine implements the HttpServletResponse.sendError methods by calling the ErrorHandler.handleError(int status, String message, SlingHttpServletRequest request, SlingHttpServletResponse response) method.

The Servlet Resolver bundle implementation looks up a script to handle the status code as follows:


Uncaught Throwables

To handle uncaught Throwables the simple name (Class.getSimpleName()) of the Throwable class is used as request extension. Similarly to the Java try-catch clauses the class hierarchy is supported. That is to handle an uncaught FileNotFoundException, the names FileNotFoundException, IOException, Exception, Throwable are checked for a Servlet and the first one found is then used. Again, the Serlvet may be a Servlet registered as an OSGi service or may be a plain script stored in the JCR repository or provided through some custom Resource provider.

Example: To register a catch-all handler for any uncaught Throwables you might create a script /apps/sling/servlet/errorhandler/Throwable.esp.

Note: If no script or servlet to handle an uncaught Throwable is registered, the default handler kicks in, which sends back a 500/INTERNAL SERVER ERROR response containing the Throwable and the stack trace. This response is not handled by the HTTP Status Code handling described above because the response status is sent using HttpServletResponse.setStatus(int, String). To prevent this default response you have to implement a catch-all handler for the Throwable class as shown in the example.

Default Handler

The Sling Servlet Resolver bundle provides a default error handler servlet which is used if the algorithms described above do not resolve to a handler script or servlet. The provided error handler servlet does the following:

Starting with Sling Servlet Resolver version 2.0.10 the default error handler servlet is looked up using the string default as the request extension and the provided default servlet is registered as <prefix>/sling/servlet/errorhandler/default.servlet where is the last entry in the resource resolver search path, /libs by default.

Thus to overwrite the default error handler servlet provide a servlet or script for the default extension, for example /apps/sling/servlet/errorhandler/default.groovy.

Rev. 1689335 by bdelacretaz on Mon, 6 Jul 2015 08:23:41 +0000
Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.