Personnalisation des pages d’erreur

AEM s’accompagne d’un outil standard destiné à la gestion des erreurs HTTP, en affichant, par exemple :

Message d’erreur standard

Pour répondre aux erreurs, AEM fournit un script 404.jsp sous /libs/sling/servlet/errorhandler.

CONSEIL

Comme AEM repose sur Apache Sling, des informations complémentaires sont disponibles dans la documentation relative à la gestion des erreurs Apache.

REMARQUE

Sur une instance de création, le filtre de débogage de la gestion du contenu web CQ est activé par défaut. Cela donne toujours comme résultat le code de réponse 200. Le gestionnaire d’erreurs par défaut répond en écrivant la trace de pile complète sur la réponse.

Sur une instance de publication, le filtre de débogage de la gestion du contenu web CQ est toujours désactivé (même s’il est configuré comme étant activé).

Méthode de personnalisation des pages affichées par le gestionnaire d’erreurs

Vous pouvez développer vos propres scripts afin de personnaliser les pages affichées par le gestionnaire d’erreurs lors de la détection d’une erreur. Vous utiliserez pour cela le mécanisme d’incrustation standard d’AEM afin que vos pages personnalisées soient créées sous /apps et recouvrent les pages par défaut sous /libs.

  1. Dans le référentiel, copiez le ou les scripts par défaut :

    • de /libs/sling/servlet/errorhandler/
    • vers /apps/sling/servlet/errorhandler/

    Le chemin de destination n’existe pas par défaut. Vous devez donc le créer lorsque vous effectuez cette opération pour la première fois.

  2. Accédez à /apps/sling/servlet/errorhandler. Ici, vous pouvez effectuer l’une des opérations suivantes :

    • Modifier le script existant approprié pour fournir les informations requises Ou
    • Créer un script, et le modifier, pour le code requis
  3. Enregistrez les modifications et effectuez un test.

ATTENTION

Le script 404.jsp a été spécialement conçu pour permettre l’authentification AEM, et en particulier la connexion au système si ces erreurs surviennent.

Le remplacement de ce script doit donc être effectué avec précaution.

Personnalisation de la réponse aux erreurs HTTP 500

500 – Erreur interne du serveur HTTP indique une erreur côté serveur, par exemple que le serveur a rencontré une condition inattendue l’empêchant de satisfaire la demande.

Lorsque le traitement des demandes provoque une exception, la structure Apache Sling (sur laquelle AEM est basé) :

  • Consigne l’exception
  • Et renvoie dans le corps de la réponse :
    • Le code de réponse HTTP 500
    • La trace de la pile d’exception

La personnalisation des pages affichées par le gestionnaire d’erreurs permet de créer un script 500.jsp. Cependant, il n’est utilisé que si HttpServletResponse.sendError(500) est exécuté de manière explicite ; c’est-à-dire à partir d’un détecteur d’exceptions.

Dans le cas contraire, le code de réponse est défini sur 500, mais le script 500.jsp n’est pas exécuté.

Pour gérer les erreurs de type 500, le nom de fichier du script de gestionnaire d’erreurs doit être identique à la classe d’exception (ou superclasse). Pour gérer toutes ces exceptions, vous pouvez créer un script /apps/sling/servlet/errorhandler/Throwable.jsp ou /apps/sling/servlet/errorhandler/Exception.jsp.

ATTENTION

Sur une instance de création, le filtre de débogage de la gestion du contenu web CQ est activé par défaut. Cela donne toujours comme résultat le code de réponse 200. Le gestionnaire d’erreurs par défaut répond en écrivant la trace de pile complète sur la réponse.

Des réponses avec le code 500 sont nécessaires pour un gestionnaire d’erreurs personnalisé. Par conséquent, le filtre de débogage de la gestion du contenu web CQ doit être désactivé. Cela garantit le renvoi du code de réponse 500 qui, à son tour, déclenche le gestionnaire d’erreurs Sling approprié.

Sur une instance de publication, le filtre de débogage de la gestion du contenu web CQ est toujours désactivé (même s’il est configuré comme étant activé).

Sur cette page