Utilisation de Sling Resource Merger dans AEM as a Cloud Service

Objectif

Sling Resource Merger propose des services pour accéder à des ressources et les fusionner. Il fournit des mécanismes de différenciation pour les deux éléments ci-après :

• Recouvrements de ressources à l’aide de chemins de recherche.

• Remplacements de boîtes de dialogue de composant pour l’interface utilisateur tactile (cq:dialog), à l’aide de la hiérarchie des types de ressource (par le biais de la propriété sling:resourceSuperType).

Avec Sling Resource Merger, les ressources et/ou propriétés de recouvrement/remplacement sont fusionnées avec les ressources/propriétés d’origine :

• Le contenu de la définition personnalisée a une priorité plus élevée que celle d’origine (en d’autres termes, elle la recouvre ou la remplace).

• Si nécessaire, les propriétés définies dans la personnalisation indiquent comment utiliser le contenu fusionné à partir de l’original.

Objectifs pour AEM

Sling Resource Merger est utilisé dans AEM pour deux raisons principales :

• S’assurer que les changements de personnalisation ne sont pas effectués dans /libs.

• Réduire la structure qui est répliquée à partir de /libs.

  Lorsque vous utilisez Sling Resource Merger, il est déconseillé de copier toute la structure depuis /libs, car cela entraînerait le stockage d’une trop grande quantité d’informations dans la personnalisation (généralement /apps). Dupliquer les informations augmente inutilement le risque que des problèmes surviennent lorsque le système est mis à niveau.

Propriétés

Resource Merger fournit les propriétés suivantes :

• sling:hideProperties (String ou String[])

  Indique la propriété, ou la liste des propriétés, à masquer.

  Le caractère générique * masque tout.

• sling:hideResource (Boolean)

  Indique si les ressources doivent être complètement masquées, y compris leurs enfants.

• sling:hideChildren (String ou String[])

  Contient le nœud enfant, ou la liste des nœuds enfants, à masquer. Les propriétés du nœud sont conservées.

  Le caractère générique * masque tout.

• sling:orderBefore (String)

  Contient le nom du nœud frère devant lequel le nœud actuel doit être positionné.

Ces propriétés déterminent la façon dont les ressources/propriétés correspondantes/d’origine (issues de /libs) sont utilisées par le recouvrement/remplacement (souvent dans /apps).

Création de la structure

Pour créer un recouvrement ou un remplacement, vous devez recréer le nœud d’origine, avec la structure équivalente, sous la destination (qui est généralement /apps). Par exemple :

• Recouvrement

  • La définition de l’entrée de navigation pour la console Sites, comme illustrée dans le rail, est définie à l’emplacement suivant :

    /libs/cq/core/content/nav/sites/jcr:title

  • Pour recouvrir cela, créez le nœud suivant :

    /apps/cq/core/content/nav/sites

    Mettez ensuite la propriété jcr:title à jour selon les besoins.

• Remplacement

  • La définition de la boîte de dialogue tactile pour la console Textes est définie à l’emplacement suivant :

    /libs/foundation/components/text/cq:dialog

  • Pour remplacer cela, créez le nœud suivant ; par exemple :

    /apps/the-project/components/text/cq:dialog

Pour créer l’un de ces éléments, vous devez simplement recréer l’ossature. Pour simplifier la reconstitution de la structure, tous les nœuds intermédiaires peuvent être de type nt:unstructured (ils ne doivent pas nécessairement refléter le type de nœud d’origine ; par exemple, dans /libs).

Ainsi, dans l’exemple de recouvrement ci-dessus, les nœuds suivants sont nécessaires :

/apps
  /cq
    /core
      /content
        /nav
          /sites

Cas d’utilisation

Ceux-ci, associés aux fonctionnalités standard, vous permettent d’effectuer les opérations suivantes :

• Ajouter une propriété

  La propriété n’existe pas dans la définition /libs, mais elle est requise dans le recouvrement/remplacement /apps.

  1. Créez le nœud correspondant dans /apps.
  2. Créez la propriété sur ce nœud.

• Redéfinir une propriété (pas les propriétés créées automatiquement)

  La propriété est définie dans /libs, mais une nouvelle valeur est requise dans le recouvrement/remplacement /apps.

  1. Créez le nœud correspondant dans /apps.

  2. Créez la propriété correspondante sur ce nœud (sous /apps).

     • La propriété aura une priorité basée sur la configuration du résolveur de ressources Sling.

     • La modification du type de propriété est prise en charge.

       Si vous utilisez un type de propriété différent de celui utilisé dans /libs, c’est le type que vous avez défini qui est utilisé.

  REMARQUE

  La modification du type de propriété est prise en charge.

• Redéfinir une propriété créée automatiquement

  Par défaut, les propriétés créées automatiquement (telles que jcr:primaryType) ne sont pas soumises à une opération de recouvrement/remplacement pour s’assurer que le type de nœud défini actuellement sous /libs est respecté. Pour imposer un recouvrement/remplacement, vous devez recréer le nœud dans /apps, masquer explicitement la propriété, puis la redéfinir :

  1. Créez le nœud correspondant sous /apps avec la propriété jcr:primaryType souhaitée.

  2. Créez la propriété sling:hideProperties sur ce nœud, avec la valeur définie sur celle de la propriété créée automatiquement ; par exemple, jcr:primaryType

     Cette propriété, définie sous /apps, est désormais prioritaire par rapport à celle définie sous /libs

• Redéfinir un nœud et ses enfants

  Le nœud et ses enfants sont définis dans /libs, mais une nouvelle configuration est requise dans le recouvrement/remplacement de /apps.

  1. Combinez les actions des éléments suivants :

     1. Masquer les enfants d’un nœud (en conservant les propriétés du nœud)
     2. Redéfinir la ou les propriétés

• Masquer une propriété

  La propriété est définie dans /libs, mais elle n’est pas requise dans le recouvrement/remplacement de /apps.

  1. Créez le nœud correspondant dans /apps.

  2. Créez une propriété sling:hideProperties de type String ou String[]. Utilisez cette option pour spécifier les propriétés à masquer ou à ignorer. Vous pouvez également utiliser des caractères génériques. Par exemple :

     • *
     • ["*"]
     • jcr:title
     • ["jcr:title", "jcr:description"]

• Masquer un nœud et ses enfants

  Le nœud et ses enfants sont définis dans /libs, mais ils ne sont pas nécessaires dans le recouvrement/remplacement de /apps.

  1. Créez le nœud correspondant sous /apps.

  2. Créez une propriété sling:hideResource

     • type : Boolean
     • value : true

• Masquer les enfants d’un nœud (tout en conservant les propriétés du nœud)

  Le nœud, ses propriétés et ses enfants sont définis dans /libs. Le noeud et ses propriétés sont requis dans la variable /apps overlay/override, mais certains ou tous les noeuds enfants ne sont pas nécessaires dans la variable /apps superposition/remplacement.

  1. Créez le nœud correspondant sous /apps

  2. Créez la propriété sling:hideChildren :

     • type : String[]
     • value : liste des nœuds enfants (tels que définis dans /libs) à masquer/ignorer

     Le caractère générique * peut être utilisé pour masquer/ignorer tous les nœuds enfants.

• Réorganiser les nœuds

  Le nœud et ses frères sont définis dans /libs. Une nouvelle position est requise pour que le nœud soit recréé dans le recouvrement/remplacement de /apps. Cette position y est définie en référence au nœud frère approprié dans /libs.

  • Utilisez la propriété sling:orderBefore :

    1. Créez le nœud correspondant sous /apps

    2. Créez la propriété sling:orderBefore :

       Cela spécifie le nœud (comme dans /libs) devant lequel le nœud actif doit être positionné :

       • type : String
       • value : <before-SiblingName>

Appel de Sling Resource Merger à partir de votre code

Sling Resource Merger comprend deux fournisseurs de ressources personnalisés : un pour les recouvrements et un autre pour les remplacements. Chacun d’eux peut être appelé dans votre code à l’aide d’un point de montage :

• Recouvrement :

  • Objectif : fusionner les ressources en fonction de leur chemin de recherche

  • Point de montage :/mnt/overlay

  • Usage : mount point + relative path

  • Exemple :

    • getResource('/mnt/overlay' + '<relative-path-to-resource>');

• Remplacement :

  • Objectif : fusionner les ressources en fonction de leur super-type

  • Point de montage :/mnt/overide

  • Usage : mount point + absolute path

  • Exemple :

    • getResource('/mnt/override' + '<absolute-path-to-resource>');