DocumentationAEM 6.4Developing Guide

Customizing Pages shown by the Error Handler customizing-pages-shown-by-the-error-handler

Last update: Wed May 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
CAUTION
AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.

AEM comes with a standard error handler for handling HTTP errors; for example, by showing:

chlimage_1-67

System provided scripts exist (under /libs/sling/servlet/errorhandler) to respond to error codes, by default the following are available with a standard CQ instance:

  • 403.jsp
  • 404.jsp
NOTE
AEM is based on Apache Sling, so see https://sling.apache.org/site/errorhandling.html for detailed information about Sling Error Handling.
NOTE
On an author instance, CQ WCM Debug Filter is enabled by default. This always results in the response code 200. The default error handler responds by writing the full stack trace to the response.
On a publish instance, CQ WCM Debug Filter is always disabled (even if configured as enabled).

How to Customize Pages shown by the Error Handler how-to-customize-pages-shown-by-the-error-handler

You can develop your own scripts to customize the pages shown by the error handler when an error is encountered. Your customized pages will be created under /apps and overlay the default pages (that are under /libs).

NOTE
See Using Overlays for more details.

  1. In the repository, copy the default script(s):

    • from /libs/sling/servlet/errorhandler/
    • to /apps/sling/servlet/errorhandler/

    As the destination path does not exist by default you will need to create it when doing this for the first time.

  2. Navigate to /apps/sling/servlet/errorhandler. Here you can either:

    • edit the appropriate existing script to supply the information required.
    • create, and edit, a new script for the required code.

  3. Save the changes and test.

CAUTION
The 404.jsp and 403.jsp handlers have been specifically designed to cater for CQ5 authentication; in particular, to allow for system login in the case of these errors.
Therefore, replacement of these two handlers should be done with great care.

Customizing the Response to HTTP 500 Errors customizing-the-response-to-http-errors

HTTP 500 errors are caused by server side exceptions.

When request processing results in an exception, the Apache Sling framework (that AEM is built on):

  • logs the exception

  • returns:

    • the HTTP response code 500
    • the exception stack trace

    in the body of the response.

By customizing the pages shown by the error handler a 500.jsp script can be created. However, it is only used if HttpServletResponse.sendError(500) is executed explicitly; i.e. from an exception catcher.

Otherwise, the response code is set to 500, but the 500.jsp script is not executed.

To handle 500 errors, the file name of the error handler script must be the same as the exception class (or superclass). To handle all such exceptions you can create a script /apps/sling/servlet/errorhandler/Throwable.jsp or /apps/sling/servlet/errorhandler/Exception.jsp.

CAUTION
On an author instance, CQ WCM Debug Filter is enabled by default. This always results in the response code 200. The default error handler responds by writing the full stack trace to the response.
For a custom error-handler, responses with code 500 are needed - so the CQ WCM Debug Filter needs to be disabled. This ensures that the response code 500 is returned, which in turn triggers the correct Sling error-handler.
On a publish instance, CQ WCM Debug Filter is always disabled (even if configured as enabled).
recommendation-more-help
2315f3f5-cb4a-4530-9999-30c8319c520e