Recouvrements

Dernière mise à jour : 2023-12-18

Adobe Experience Manager (AEM), et auparavant CQ, applique depuis longtemps le principe des recouvrements pour vous permettre d’étendre et de personnaliser les consoles et d’autres fonctionnalités (par exemple, la création de pages).

Le terme « recouvrement » est utilisé dans de nombreux contextes. Dans ce contexte (extension d’AEM), le recouvrement désigne l’utilisation de la fonctionnalité prédéfinie et l’application de vos propres définitions par-dessus (afin de personnaliser la fonctionnalité standard).

Dans une instance standard, la fonctionnalité prédéfinie est conservée sous /libs et il est conseillé de définir votre recouvrement (personnalisations) sous la branche /apps. AEM utilise un chemin de recherche pour localiser une ressource, en commençant par la branche /apps, puis la branche /libs (le chemin de recherche peut être configuré). Ce mécanisme signifie que votre recouvrement (et les personnalisations qui y sont définies) est prioritaire.

Depuis AEM 6.0, des modifications ont été apportées à la manière dont les recouvrements sont mis en place et utilisés :

  • AEM 6.0 et versions ultérieures - pour les recouvrements liés à Granite (c’est-à-dire, l’IU optimisée pour les écrans tactiles)

    • Méthode

      • Recréez la structure /libs appropriée sous /apps.

        Cela ne nécessite aucune copie 1:1 ; Sling Resource Merger est utilisé pour effectuer des références croisées avec les définitions d’origine qui sont requises. Sling Resource Merger propose des services pour accéder à des ressources et les fusionner par le biais de mécanismes de différenciation (diff).

      • Sous /apps, apportez vos éventuelles modifications.

    • Avantages

      • Plus résistant aux modifications sous /libs.
      • Vous ne devez redéfinir que ce qui est réellement nécessaire.
  • Recouvrements non liés à Granite et recouvrements avant AEM 6.0

    • Méthode

      • Copiez le contenu de /libs vers /apps.

        Copiez la sous-branche entière, y compris les propriétés.

      • Sous /apps, apportez vos éventuelles modifications.

    • Inconvénients

      • La modification d’un élément sous /libs n’entraînera pas la perte des changements effectués. Cependant, il se peut que vous deviez recréer certaines modifications affectant votre recouvrement sous /apps.
ATTENTION

Sling Resource Merger et les méthodes connexes ne peuvent être utilisés qu’avec Granite. Cela signifie que la création d’un recouvrement avec une ossature n’est appropriée que pour l’interface utilisateur (IU) tactile standard.

Les recouvrements pour d’autres zones (y compris l’interface utilisateur classique) impliquent la copie du nœud approprié et de l’ensemble de la sous-structure, puis l’apport des modifications requises.

Il est conseillé de recourir aux recouvrements pour de nombreuses modifications, par exemple, pour configurer vos consoles ou créer votre catégorie de sélection dans l’explorateur de ressources au niveau du panneau latéral (lors de la création de pages). Ils sont requis pour les raisons suivantes :

  • Vous **ne devez pas effectuer de modifications dans la /libsbranche **.
    Les modifications que vous effectuez risquent d’être perdues, car cette branche est sensible aux modifications lorsque vous :

    • procédez à une mise à niveau sur votre instance
    • appliquez un correctif
    • installez un Pack de fonctionnalités
  • Ils centralisent vos modifications dans un seul emplacement ; ils facilitent le suivi, la migration, la sauvegarde ou le débogage de vos modifications, suivant les besoins.

Configurer les chemins de recherche

Dans le cas des recouvrements, la ressource diffusée est un regroupement des ressources et propriétés récupérées, en fonction des chemins de recherche qui peuvent être définis :

  • La ressource Resolver Search Path, telle qu’elle est définie dans la configuration OSGi pour Apache Sling Resource Resolver Factory.

    • L’ordre décroissant des chemins de recherche indique leurs priorités respectives.
    • Dans une installation standard, les principales valeurs par défaut sont les suivantes : /apps, /libs. Par conséquent, le contenu de /apps a une priorité supérieure à celui de /libs (en d’autres termes, il le recouvre).
  • Deux utilisateurs du service ont besoin d’un accès JCR:READ à l’emplacement de stockage des scripts. Ces utilisateurs sont : components-search-service (utilisé par les composants de cache et d’accès com.day.cq.wcm.coreto) et sling-scripting (utilisé par org.apache.sling.servlets.resolver pour rechercher des servlets).

  • La configuration suivante doit également être définie en fonction de l’emplacement de stockage des scripts (dans cet exemple sous /etc, /libs ou /apps).

    PID = org.apache.sling.jcr.resource.internal.JcrResourceResolverFactoryImpl
    resource.resolver.searchpath=["/etc","/apps","/libs"]
    resource.resolver.vanitypath.whitelist=["/etc/","/apps/","/libs/","/content/"]
    
  • Enfin, le résolveur de servlet doit également être configuré (dans cet exemple, pour ajouter également /etc).

    PID = org.apache.sling.servlets.resolver.SlingServletResolver
    servletresolver.paths=["/bin/","/libs/","/apps/","/etc/","/system/","/index.servlet","/login.servlet","/services/"]
    

Exemple d’utilisation

Voici quelques exemples présentés dans les cas suivants :

Sur cette page