Personnalisation des pages affichées par le gestionnaire d’erreurs

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

chlimage_1-67

Il existe des scripts fournis par le système (sous /libs/sling/servlet/errorhandler) pour répondre aux codes d’erreur. Par défaut, les scripts suivants sont disponibles avec une instance CQ standard :

  • 403.jsp
  • 404.jsp
REMARQUE

AEM est basé sur Apache Sling. Voir https://sling.apache.org/site/errorhandling.html pour plus d’informations sur la gestion des erreurs Sling.

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. Vos pages personnalisées seront créées sous /apps et recouvriront les pages par défaut (qui se trouvent sous /libs).

REMARQUE

Pour plus d’informations, voir Utilisation de recouvrements.

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

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

    Puisque le chemin de destination n’existe pas par défaut, vous devez 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
    • Créer un script, et le modifier, pour le code requis
  3. Enregistrez les modifications et effectuez un test.

ATTENTION

Les gestionnaires 404.jsp et 403.jsp ont été spécialement conçus pour prendre en compte l’authentification CQ5 ; en particulier, pour permettre une connexion système si ces erreurs se produisent.

Par conséquent, le remplacement de ces deux gestionnaires doit être effectué avec précaution.

Personnalisation de la réponse aux erreurs HTTP 500

Les erreurs HTTP 500 sont dues à des exceptions côté serveur.

Lorsque le traitement des requêtes génère une exception, la structure Apache Sling (sur laquelle l’AEM est créée) :

  • consigne l’exception ;

  • renvoie :

    • le code de réponse HTTP 500 ;
    • la trace de la pile d’exception

    dans le corps de la réponse.

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