Utiliser Dispatcher avec plusieurs domaines using-dispatcher-with-multiple-domains

NOTE
Les versions de Dispatcher sont indépendantes d’AEM. Vous avez peut-être fait l’objet d’une redirection vers cette page si vous avez suivi un lien vers la documentation de Dispatcher incluse dans la documentation CQ et AEM.

Utilisez le Dispatcher pour traiter les demandes de pages dans plusieurs domaines web tout en prenant en charge les conditions suivantes :

  • Le contenu web des deux domaines est stocké dans un référentiel AEM unique.
  • Les fichiers du cache de Dispatcher peuvent être invalidés séparément pour chaque domaine.

Par exemple, une entreprise publie des sites web pour deux de leurs marques : Marque A et Marque B. Le contenu des pages du site web est créé dans AEM et stocké sur le même espace de travail du référentiel :

/
| - content
   | - sitea
       | - content nodes
   | - siteb
       | - content nodes

Les pages pour BrandA.com sont stockées ci-dessous /content/sitea. Les requêtes client pour l’URL https://BrandA.com/en.html sont renvoyées à la page rendue pour le nœud /content/sitea/en. De même, les pages pour BrandB.com sont stockées sous /content/siteb.

Lorsque le Dispatcher est utilisé pour mettre en cache du contenu, des associations doivent être effectuées entre l’URL de la page de la requête HTTP client, le chemin d’accès au fichier mis en cache correspondant et le chemin d’accès au fichier correspondant dans le référentiel.

Demandes clients

Lorsque les clientes et clients envoient des requêtes HTTP au serveur web, l’URL de la page demandée doit être résolue en fonction du contenu du cache Dispatcher, puis du contenu du référentiel.

  1. Le système de noms de domaine détecte l’adresse IP du serveur web enregistré pour le nom de domaine dans la requête HTTP.
  2. La requête HTTP est envoyée au serveur web.
  3. La requête HTTP est transmise au Dispatcher.
  4. Dispatcher détermine si les fichiers mis en cache sont valides. Si tel est le cas, les fichiers mis en cache sont servis au client ou à la cliente.
  5. Si les fichiers mis en cache ne sont pas valides, Dispatcher demande les pages nouvellement rendues à l’instance de publication AEM.

Invalidation du cache

Lorsque les agents de réplication de purge de Dispatcher demandent que ce dernier invalide les fichiers mis en cache, le chemin d’accès au contenu du référentiel doit se résoudre sur le contenu du cache.

  • a - Une page est activée sur l’instance de création AEM et le contenu est répliqué sur l’instance de publication.
  • b - L’agent de purge de Dispatcher appelle Dispatcher afin d’invalider le cache pour le contenu répliqué.
  • c - Dispatcher traite un ou plusieurs fichiers .stat pour invalider les fichiers mis en cache.

Pour utiliser Dispatcher avec plusieurs domaines, vous devez configurer AEM, Dispatcher et votre serveur web. Les solutions décrites dans cette page sont générales et s’appliquent à la plupart des environnements. En raison de la complexité de certaines topologies AEM, votre solution peut nécessiter d’autres configurations personnalisées afin de résoudre des problèmes spécifiques. Vous devrez probablement adapter les exemples en fonction de votre infrastructure informatique et de vos politiques de gestion existantes.

Mappage d’URL url-mapping

Pour permettre la résolution des URL de domaine et des chemins de contenu vers des fichiers mis en cache, un chemin de fichier ou une URL de page doivent être traduits au cours du processus. Des descriptions des stratégies courantes suivantes sont fournies, dans lesquelles les traductions de chemin ou d’URL se produisent à différents stades du processus :

  • (Recommandé) L’instance de publication AEM utilise le mappage Sling pour la résolution des ressources afin d’implémenter des règles de réécriture d’URL internes. Les URL de domaine sont traduites en chemins de référentiel de contenu. Voir AEM réécrit les URL entrantes.
  • Le serveur web utilise des règles de réécriture des URL internes qui traduisent les URL de domaine en chemins d’accès au cache. Voir Le serveur web réécrit les URL entrantes.

Il est souhaitable d’utiliser des URL courtes pour les pages web. En règle générale, les URL des pages reflètent la structure des dossiers du référentiel contenant le contenu web. Cependant, les URL ne sont pas en mesure de lire les nœuds les plus élevés du référentiel, tels que /content. Le client ne connaît pas nécessairement la structure du référentiel AEM.

Conditions générales general-requirements

Votre environnement doit mettre en œuvre les fonctionnalités suivantes pour prendre en charge Dispatcher fonctionnant avec plusieurs domaines :

  • Le contenu de chaque domaine réside dans des branches distinctes du référentiel (voir l’exemple d’environnement ci-dessous).
  • L’agent de réplication de purge de Dispatcher est configuré sur l’instance de publication AEM. (Voir Invalidation du cache de Dispatcher depuis une instance de publication).
  • Le système de noms de domaine résout les noms de domaine en adresse IP du serveur web.
  • Le cache de Dispatcher reflète la structure de répertoires du référentiel de contenu AEM. Les chemins d’accès aux fichiers situés sous la racine du document du serveur web sont les mêmes que les chemins d’accès des fichiers dans le référentiel.

Environnement pour les exemples proposés environment-for-the-provided-examples

Les exemples de solutions fournis s’appliquent à un environnement présentant les caractéristiques suivantes :

  • Les instances de création et de publication d’AEM sont déployées sur des systèmes Linux®.

  • Apache HTTPD est le serveur web qui est déployé sur un système Linux®.

  • Le référentiel de contenu AEM et la racine du document du serveur web utilisent les structures de fichiers suivantes (la racine du document du serveur web Apache est /usr/lib/apache/httpd-2.4.3/htdocs):

    Référentiel

  | - /content
    | - sitea
  |    | - content nodes
    | - siteb
       | - content nodes

Racine du document du serveur web

  | - /usr
    | - lib
      | - apache
        | - httpd-2.4.3
          | - htdocs
            | - content
              | - sitea
                 | - content nodes
              | - siteb
                 | - content nodes

AEM réécrit les URL entrantes. aem-rewrites-incoming-urls

Le mappage Sling pour la résolution des ressources vous permet d’associer les URL entrantes aux chemins de contenu d’AEM. Créez des mappages sur l’instance de publication d’AEM afin que les requêtes de rendu de Dispatcher soient résolues en contenu correct dans le référentiel.

Les requêtes de Dispatcher pour le rendu de page identifient la page à l’aide de l’URL transmise par le serveur web. Lorsque l’URL inclut un nom de domaine, les mappages Sling résolvent l’URL en contenu. Le graphique ci-dessous représente un mappage de l’URL branda.com/en.html sur le nœud /content/sitea/en.

Le cache de Dispatcher reflète la structure de nœuds du référentiel. Par conséquent, lorsque des activations de page se produisent, les requêtes qui en résultent pour l’invalidation de la page mise en cache ne requièrent aucune conversion d’URL ou de chemin d’accès.

Définir des hôtes virtuels sur le serveur web define-virtual-hosts-on-the-web-server

Définissez des hôtes virtuels sur le serveur web afin qu’une racine de document différente puisse être attribuée à chaque domaine web :

  • Le serveur web doit définir un domaine virtuel pour chacun de vos domaines web.
  • Pour chaque domaine, configurez la racine du document de sorte qu’elle coïncide avec le dossier du référentiel comportant le contenu web du domaine.
  • Chaque domaine virtuel doit également inclure les configurations associées à Dispatcher, comme indiqué à la page Installation de Dispatcher.

L’exemple de fichier suivant httpd.conf configure deux domaines virtuels pour un serveur web Apache :

  • Les noms des serveurs (qui coïncident avec les noms des domaines) sont branda.com (ligne 16) et brandb.com (ligne 30).
  • La racine du document de chaque domaine virtuel est le répertoire dans le cache du Dispatcher qui contient les pages du site. (Lignes 17 et 31)

Avec cette configuration, le serveur web effectue les actions suivantes lorsqu’il reçoit une requête pour https://branda.com/en/products.html :

  • Associe l’URL à l’hôte virtuel doté d’un ServerName de branda.com.

  • Transfère l’URL à Dispatcher.

httpd.conf httpd-conf

# load the Dispatcher module
LoadModule dispatcher_module modules/mod_dispatcher.so
# configure the Dispatcher module
<IfModule disp_apache2.c>
 DispatcherConfig conf/dispatcher.any
 DispatcherLog    logs/dispatcher.log
 DispatcherLogLevel 3
 DispatcherNoServerHeader 0
 DispatcherDeclineRoot 0
 DispatcherUseProcessedURL 0
 DispatcherPassError 0
</IfModule>

# Define virtual host for brandA.com
<VirtualHost *:80>
  ServerName branda.com
  DocumentRoot /usr/lib/apache/httpd-2.4.3/htdocs/content/sitea
   <Directory /usr/lib/apache/httpd-2.4.3/htdocs/content/sitea>
     <IfModule disp_apache2.c>
       SetHandler dispatcher-handler
       ModMimeUsePathInfo On
     </IfModule>
     Options FollowSymLinks
     AllowOverride None
   </Directory>
</VirtualHost>

# define virtual host for brandB.com
<VirtualHost *:80>
  ServerName brandB.com
  DocumentRoot /usr/lib/apache/httpd-2.4.3/htdocs/content/siteb
   <Directory /usr/lib/apache/httpd-2.4.3/htdocs/content/siteb>
     <IfModule disp_apache2.c>
       SetHandler dispatcher-handler
       ModMimeUsePathInfo On
     </IfModule>
     Options FollowSymLinks
     AllowOverride None
   </Directory>
</VirtualHost>

# document root for web server
DocumentRoot "/usr/lib/apache/httpd-2.4.3/htdocs"

Les hôtes virtuels héritent de la valeur de propriété DispatcherConfig qui est configurée dans la section du serveur principal. Les hôtes virtuels peuvent inclure leur propre propriété DispatcherConfig pour remplacer la configuration du serveur principal.

Configuration de Dispatcher pour gérer plusieurs domaines configure-dispatcher-to-handle-multiple-domains

Pour prendre en charge les URL qui incluent des noms de domaine et leurs hôtes virtuels correspondants, définissez les batteries Dispatcher suivantes :

  • Configurez une batterie Dispatcher pour chaque hôte virtuel. Ces fermes de serveurs traitent les demandes provenant du serveur web pour chaque domaine, vérifient les fichiers mis en cache et demandent des pages aux rendus.
  • Configurez une batterie Dispatcher utilisée pour invalider le contenu dans le cache, quel que soit le domaine auquel appartient le contenu. Cette batterie gère les requêtes d’invalidation de fichiers provenant des agents de réplication Dispatcher de purge.

Création de fermes de serveurs de Dispatcher pour les hôtes virtuels

Les fermes de serveurs pour les hôtes virtuels doivent comporter les configurations suivantes afin que les URL des requêtes HTTP du client soient résolues sur les fichiers appropriés du cache de Dispatcher :

  • La propriété /virtualhosts est définie sur le nom de domaine. Cette propriété permet au Dispatcher d’associer la batterie au domaine.

  • La propriété /filter autorise l’accès au chemin d’accès de l’URL de requête tronquée après la partie du nom de domaine. Par exemple, pour l’URL https://branda.com/en.html, le chemin d’accès est interprété comme /en.html afin que le filtre autorise l’accès à ce chemin.

  • La propriété /docroot est définie sur le chemin du répertoire racine. En d’autres termes, le répertoire racine du contenu du site du domaine dans le cache du Dispatcher. Ce chemin est utilisé comme préfixe pour l’URL concaténée de la demande d’origine. Par exemple, la docroot de /usr/lib/apache/httpd-2.4.3/htdocs/sitea entraîne la résolution de la requête pour https://branda.com/en.html vers le fichier /usr/lib/apache/httpd-2.4.3/htdocs/sitea/en.html.

De plus, l’instance de publication d’AEM doit être désignée comme rendu pour l’hôte virtuel. Configurez d'autres propriétés de batterie le cas échéant. Le code suivant est une configuration de batterie abrégée pour le domaine branda.com :

/farm_sitea  {
    ...
    /virtualhosts { "branda.com" }
    /renders {
      /rend01  { /hostname "127.0.0.1"  /port "4503" }
    }
    /filter {
      /0001 { /type "deny"  /glob "*" }
      /0023 { /type "allow" /glob "*/en*" }
      ...
     }
    /cache {
      /docroot "/usr/lib/apache/httpd-2.4.3/htdocs/content/sitea"
      ...
   }
   ...
}

Création d’une ferme de serveurs de Dispatcher pour l’invalidation du cache

Une batterie Dispatcher est requise pour traiter les requêtes d'invalidation de fichiers mis en cache. Cette batterie doit pouvoir accéder aux fichiers .stat dans les répertoires docroot de chaque hôte virtuel.

Les configurations de propriétés suivantes permettent au Dispatcher de résoudre les fichiers du référentiel de contenu AEM à partir des fichiers présents dans le cache :

  • La propriété /docroot est définie sur le répertoire docroot par défaut du serveur web. En règle générale, il s’agit du répertoire docroot dans lequel le dossier /content est créé. Un exemple de valeur pour Apache sous Linux® est /usr/lib/apache/httpd-2.4.3/htdocs.
  • La propriété /filter permet d’accéder aux fichiers en-dessous du répertoire /content.

La propriété/statfileslevel doit être suffisamment élevée pour que les fichiers .stat soient créés dans le répertoire racine de chaque hôte virtuel. Cette propriété permet au cache de chaque domaine d’être invalidé séparément. Pour l’exemple de configuration, une valeur /statfileslevel de 2 crée des fichiers .stat dans le répertoire *docroot*/content/sitea et le répertoire *docroot*/content/siteb.

De plus, l’instance de publication doit être désignée comme rendu de l’hôte virtuel. Configurez d'autres propriétés de batterie le cas échéant. Le code suivant est une configuration abrégée de la batterie utilisée pour l’invalidation du cache :

/farm_flush {
    ...
    /virtualhosts   { "invalidation_only" }
    /renders  {
      /rend01  { /hostname "127.0.0.1" /port "4503" }
    }
    /filter   {
      /0001 { /type "deny"  /glob "*" }
      /0023 { /type "allow" /glob "*/content*" }
      ...
      }
    /cache  {
       /docroot "/usr/lib/apache/httpd-2.4.3/htdocs"
       /statfileslevel "2"
       ...
   }
   ...
}

Lorsque vous démarrez le serveur web, le log de Dispatcher (en mode débogage) indique l’initialisation de toutes les batteries :

Dispatcher initializing (build 4.1.2)
[Fri Nov 02 16:27:18 2012] [D] [24974(140006182991616)] farms[farm_sitea].cache.docroot = /usr/lib/apache/httpd-2.4.3/htdocs/content/sitea
[Fri Nov 02 16:27:18 2012] [D] [24974(140006182991616)] farms[farm_siteb].cache.docroot = /usr/lib/apache/httpd-2.4.3/htdocs/content/siteb
[Fri Nov 02 16:27:18 2012] [D] [24974(140006182991616)] farms[farm_flush].cache.docroot = /usr/lib/apache/httpd-2.4.3/htdocs
[Fri Nov 02 16:27:18 2012] [I] [24974(140006182991616)] Dispatcher initialized (build 4.1.2)

Configuration du mappage Sling pour la résolution des ressources configure-sling-mapping-for-resource-resolution

Utilisez le mappage Sling pour la résolution des ressources afin que les URL basées sur des domaines soient résolues en tant que contenu dans l’instance de publication AEM. Le mappage des ressources convertit les URL entrantes provenant de Dispatcher (provenant à l’origine des requêtes HTTP des clients) en nœuds de contenu.

Pour en savoir plus sur le mappage Sling des ressources, consultez Mappages pour la résolution des ressources dans la documentation Sling.

En règle générale, les mappages sont nécessaires pour les ressources suivantes, bien que d’autres mappages puissent être nécessaires :

  • Nœud racine de la page de contenu (sous /content)
  • Nœud de conception que les pages utilisent (sous /etc/designs)
  • Le dossier /libs

Après avoir créé le mappage pour la page de contenu, pour découvrir les mappages supplémentaires requis, utilisez un navigateur web pour ouvrir une page sur le serveur web. Dans le fichier error.log de l’instance de publication, recherchez des messages concernant des ressources introuvables. L’exemple de message suivant indique qu’un mappage pour /etc/clientlibs est requis :

01.11.2012 15:59:24.601 *INFO* [10.36.34.243 [1351799964599] GET /etc/clientlibs/foundation/jquery.js HTTP/1.1] org.apache.sling.engine.impl.SlingRequestProcessorImpl service: Resource /content/sitea/etc/clientlibs/foundation/jquery.js not found
NOTE
Le transformateur du vérificateur de lien du module de réécriture Apache Sling par défaut modifie automatiquement les hyperliens dans la page pour éviter la présence de liens rompus. Cependant, la réécriture des liens n’est effectuée que lorsque la cible du lien est un fichier HTML ou HTM. Pour mettre à jour les liens sur d’autres types de fichiers, créez un composant du transformateur et ajoutez-le à un pipeline de réécriture HTML.

Exemple de nœuds de mappage de ressources

Le tableau suivant répertorie les nœuds qui mettent en œuvre le mappage des ressources pour le domaine marquea.com. Des nœuds similaires sont créés pour le domaine brandb.com, par exemple /etc/map/http/brandb.com. Dans tous les cas, des mappages sont requis lorsque les références dans la page HTML ne se résolvent pas correctement dans le contexte Sling.

Chemin d’accès du nœud
Type
Propriété
/etc/map/http/branda.com
sling:Mapping
Name: sling:internalRedirect Type: String Value: /content/sitea
/etc/map/http/branda.com/libs
sling:Mapping
Name: sling:internalRedirect <br/>Type: String <br/>Value: /libs
/etc/map/http/branda.com/etc
sling:Mapping
/etc/map/http/branda.com/etc/designs
sling:Mapping
Name: sling:internalRedirect <br/>VType: String <br/>VValue: /etc/designs
/etc/map/http/branda.com/etc/clientlibs
sling:Mapping
Name: sling:internalRedirect <br/>VType: String <br/>VValue: /etc/clientlibs

Configurer l’agent de réplication de purge de Dispatcher configuring-the-dispatcher-flush-replication-agent

L’agent de réplication de purge de Dispatcher sur l’instance de publication AEM doit envoyer des requêtes d’invalidation à la batterie Dispatcher appropriée. Pour cibler une batterie, utilisez la propriété URI de l’agent de réplication de purge de Dispatcher (dans l’onglet Transport). Incluez la valeur de la propriété /virtualhost pour la ferme de serveurs de Dispatcher configurée pour invalider le cache :

https://*webserver_name*:*port*/*virtual_host*/dispatcher/invalidate.cache

Par exemple, pour utiliser la ferme de serveurs farm_flush de l’exemple précédent, l’URI est https://localhost:80/invalidation_only/dispatcher/invalidate.cache.

Le serveur web réécrit les URL entrantes. the-web-server-rewrites-incoming-urls

Pour convertir les URL basées sur un domaine en chemins d’accès aux fichiers dans le cache de Dispatcher, utilisez la fonctionnalité de réécriture d’URL interne de votre serveur web. Par exemple, les requêtes client pour la page https://brandA.com/en.html sont converties vers le fichier content/sitea/en.html dans la racine du document du serveur web.

Le cache de Dispatcher reflète la structure de nœuds du référentiel. Par conséquent, lorsque des activations de page se produisent, les requêtes qui en résultent pour l’invalidation de la page mise en cache ne requièrent aucune conversion d’URL ou de chemin d’accès.

Définir les hôtes virtuels et les règles de réécriture du serveur web define-virtual-hosts-and-rewrite-rules-on-the-web-server

Configurez les aspects suivants sur le serveur web :

  • Définissez un hôte virtuel pour chacun de vos domaines web.
  • Pour chaque domaine, configurez la racine du document de sorte qu’elle coïncide avec le dossier du référentiel comportant le contenu web du domaine.
  • Pour chaque domaine virtuel, créez une règle de changement de nom de l’URL qui convertisse l’URL entrante en chemin du fichier mis en cache.
  • Chaque domaine virtuel doit également inclure les configurations associées à Dispatcher, comme indiqué à la page Installation de Dispatcher.
  • Le module de Dispatcher doit être configuré pour utiliser l’URL que le serveur web a réécrite. (Voir la propriété DispatcherUseProcessedURL dans Installation de Dispatcher.)

L’exemple de fichier httpd.conf suivant configure deux hôtes virtuels pour un serveur web Apache :

  • Les noms des serveurs (qui coïncident avec les noms des domaines) sont brandA.com (ligne 16) et brandB.com (ligne 32).

  • La racine du document de chaque domaine virtuel est le répertoire dans le cache du Dispatcher qui contient les pages du site. (Lignes 20 et 33)

  • La règle de réécriture d’URL pour chaque domaine virtuel est une expression régulière. L’expression régulière préfixe le chemin d’accès à la page demandée. Elle comporte le préfixe du chemin d’accès aux pages du cache. (Lignes 19 et 35)

  • La propriété DispatcherUseProcessedURL est définie sur 1. (Ligne 10)

Par exemple, le serveur web effectue les actions suivantes lorsqu’il reçoit une demande avec l’URL https://brandA.com/en/products.html :

  • Associe l’URL à l’hôte virtuel doté d’un ServerName de brandA.com.
  • Réécrit l’URL pour qu’elle devienne /content/sitea/en/products.html.
  • Transfère l’URL à Dispatcher.

httpd.conf httpd-conf-1

# load the Dispatcher module
LoadModule dispatcher_module modules/mod_dispatcher.so
# configure the Dispatcher module
<IfModule disp_apache2.c>
 DispatcherConfig conf/dispatcher.any
 DispatcherLog    logs/dispatcher.log
 DispatcherLogLevel 3
 DispatcherNoServerHeader 0
 DispatcherDeclineRoot 0
 DispatcherUseProcessedURL 1
 DispatcherPassError 0
</IfModule>

# Define virtual host for brandA.com
<VirtualHost *:80>
  ServerName branda.com
  DocumentRoot /usr/lib/apache/httpd-2.4.3/htdocs/content/sitea
  RewriteEngine  on
  RewriteRule    ^/(.*)\.html$  /content/sitea/$1.html [PT]
   <Directory /usr/lib/apache/httpd-2.4.3/htdocs/content/sitea>
     <IfModule disp_apache2.c>
       SetHandler dispatcher-handler
       ModMimeUsePathInfo On
     </IfModule>
     Options FollowSymLinks
     AllowOverride None
   </Directory>
</VirtualHost>

# define virtual host for brandB.com
<VirtualHost *:80>
  ServerName brandB.com
  DocumentRoot /usr/lib/apache/httpd-2.4.3/htdocs/content/siteb
  RewriteEngine  on
  RewriteRule    ^/(.*)\.html$  /content/siteb/$1.html [PT]
   <Directory /usr/lib/apache/httpd-2.4.3/htdocs/content/siteb>
     <IfModule disp_apache2.c>
       SetHandler dispatcher-handler
       ModMimeUsePathInfo On
     </IfModule>
     Options FollowSymLinks
     AllowOverride None
   </Directory>
</VirtualHost>

# document root for web server
DocumentRoot "/usr/lib/apache/httpd-2.4.3/htdocs"

Configurer une batterie de Dispatcher configure-a-dispatcher-farm

Lorsque le serveur web réécrit les URL, Dispatcher a besoin d’une seule ferme de serveurs définie selon la section Configuration de Dispatcher. Les configurations suivantes sont requises pour prendre en charge les hôtes virtuels et les règles de changement de nom des URL du serveur web :

  • La propriété /virtualhosts doit inclure les valeurs ServerName pour toutes les définitions VirtualHost.
  • La propriété /statfileslevel doit être suffisamment élevée pour créer des fichiers .stat dans les répertoires comportant les fichiers de contenu pour chaque domaine.

L’exemple de fichier de configuration suivant est basé sur l’exemple de fichier dispatcher.any qui est installé avec Dispatcher. Les modifications suivantes sont nécessaires pour la prise en charge des configurations de serveur web du fichier httpd.conf précédent :

  • La propriété /virtualhosts force Dispatcher à traiter les requêtes des domaines brandA.com et brandB.com. (Ligne 12)
  • La propriété /statfileslevel est définie sur 2, de sorte que des fichiers .stat sont créés dans chaque répertoire qui contient le contenu web du domaine (ligne 41) : /statfileslevel "2"

Comme d’habitude, la racine du document du cache est identique à la racine du document du serveur web (ligne 40) : /usr/lib/apache/httpd-2.4.3/htdocs

dispatcher.any dispatcher-any

/name "testDispatcher"
/farms
  {
  /dispfarm0
    {
    /clientheaders
      {
      "*"
      }
    /virtualhosts
      {
      "brandA.com" "brandB.com"
      }
    /renders
      {
      /rend01    {  /hostname "127.0.0.1"   /port "4503"  }
      }
    /filter
      {
      /0001 { /type "deny"  /glob "*" }
      /0023 { /type "allow" /glob "*/content*" }  # disable this rule to allow mapped content only
      /0041 { /type "allow" /glob "* *.css *"   }  # enable css
      /0042 { /type "allow" /glob "* *.gif *"   }  # enable gifs
      /0043 { /type "allow" /glob "* *.ico *"   }  # enable icos
      /0044 { /type "allow" /glob "* *.js *"    }  # enable javascript
      /0045 { /type "allow" /glob "* *.png *"   }  # enable png
      /0046 { /type "allow" /glob "* *.swf *"   }  # enable flash
      /0061 { /type "allow" /glob "POST /content/[.]*.form.html" }  # allow POSTs to form selectors under content
      /0062 { /type "allow" /glob "* /libs/cq/personalization/*"  }  # enable personalization
      /0081 { /type "deny"  /glob "GET *.infinity.json*" }
      /0082 { /type "deny"  /glob "GET *.tidy.json*"     }
      /0083 { /type "deny"  /glob "GET *.sysview.xml*"   }
      /0084 { /type "deny"  /glob "GET *.docview.json*"  }
      /0085 { /type "deny"  /glob "GET *.docview.xml*"  }
      /0086 { /type "deny"  /glob "GET *.*[0-9].json*" }
      /0090 { /type "deny"  /glob "* *.query.json*" }
      }
    /cache
      {
      /docroot "/usr/lib/apache/httpd-2.4.3/htdocs"
      /statfileslevel "2"
      /allowAuthorized "0"
      /rules
        {
        /0000  { /glob "*"     /type "allow"  }
        }
      /invalidate
        {
        /0000  {   /glob "*" /type "deny"  }
        /0001 {  /glob "*.html" /type "allow"  }
        }
      /allowedClients
        {
        }
      }
    /statistics
      {
      /categories
        {
        /html  { /glob "*.html" }
        /others  {  /glob "*"  }
        }
      }
    }
  }
NOTE
Étant donné qu’une seule batterie de Dispatcher est définie, l’agent de réplication de purge de Dispatcher sur l’instance de publication AEM ne nécessite aucune configuration particulière.

Pour réécrire des références à des fichiers dont l’extension est autre que .html ou .htm, créez un composant de transformateur de réécriture Sling et ajoutez-le au pipeline de réécriture par défaut.

Réécrivez les références lorsque les chemins de ressources ne sont pas résolus correctement dans le contexte du serveur web. Par exemple, un transformateur est requis lorsque des composants générateurs d’images créent des liens tels que /content/sitea/en/products.navimage.png. Le composant topnav de la section Créer un site web complet crée de tels liens.

Le module de réécriture Sling effectue le post-traitement de la sortie Sling. Les mises en œuvre de pipeline SAX du module de réécriture se composent d’un générateur, d’un ou de plusieurs transformateurs et d’un sérialiseur :

  • Générateur : analyse le flux de sortie Sling (document HTML) et génère des événements SAX lorsqu’il rencontre des types d’éléments spécifiques.
  • Transformateur : écoute les événements SAX et modifie par conséquent la cible de l’événement (un élément HTML). Un pipeline de réécriture contient zéro, un ou plusieurs transformateurs. Les transformateurs sont exécutés en séquence, transmettant les événements SAX au transformateur suivant dans la séquence.
  • Sérialiseur : sérialise la sortie, y compris les modifications de chaque transformateur.

Pipeline de module de réécriture par défaut d’AEM the-aem-default-rewriter-pipeline

AEM utilise un module de réécriture de pipeline par défaut qui traite les documents de type texte/HTML :

  • Le générateur analyse les documents HTML et génère des événements SAX lorsqu’il rencontre des éléments a, d’image, de zone, de formulaire, de base, de lien, de script et de corps. L’alias du générateur est htmlparser.
  • Le pipeline inclut les transformateurs suivants : linkchecker, mobile, mobiledebug, contentsync. Le transformateur linkchecker externalise les chemins d’accès aux fichiers HTML ou HTM référencés pour éviter les liens rompus.
  • Le sérialiseur écrit la sortie HTML. L’alias du sérialiseur est htmlwriter.

Le nœud /libs/cq/config/rewriter/default définit le pipeline.

Créer un transformateur creating-a-transformer

Pour créer un composant du transformateur et l’utiliser dans un pipeline, effectuez les tâches suivantes :

  1. Mettez en œuvre l’interface org.apache.sling.rewriter.TransformerFactory. Cette classe crée des instances de la classe du transformateur. Spécifiez les valeurs de la propriété transformer.type (l’alias du transformateur) et configurez la classe comme un composant du service OSGi.
  2. Mettez en œuvre l’interface org.apache.sling.rewriter.Transformer. Afin de réduire la charge de travail, vous pouvez étendre la classe org.apache.cocoon.xml.sax.AbstractSAXPipe. Pour personnaliser le comportement de réécriture, remplacez la méthode startElement. Cette méthode est appelée pour chaque événement SAX transmis au transformateur.
  3. Regroupez et déployez les classes.
  4. Pour ajouter le transformateur au pipeline, ajoutez un nœud de configuration à votre application AEM.
TIP
Vous pouvez à la place configurer TransformerFactory afin que le transformateur soit inséré dans chaque module de réécriture défini. Ainsi, vous n’avez pas besoin de configurer un pipeline :
  • Définissez la propriété pipeline.mode sur global.
  • Définissez la propriété service.ranking sur un entier positif.
  • N’incluez pas de propriété pipeline.type.
NOTE
Pour créer votre projet Maven, utilisez l’archétype multimodule du plug-in package de contenu Maven. Les POM créent et installent automatiquement un package de contenu.

Les exemples suivants mettent en œuvre un transformateur qui réécrit les références aux fichiers image.

  • La classe MyRewriterTransformerFactory instancie des objets MyRewriterTransformer. La propriété pipeline.type définit l’alias du transformateur sur mytransformer. Pour inclure l’alias dans un pipeline, le nœud de configuration du pipeline doit inclure cet alias dans la liste des transformateurs.
  • La classe MyRewriterTransformer remplace la méthode startElement de la classe AbstractSAXTransformer. La méthode startElement réécrit la valeur des attributs src des éléments img.

Les exemples ne sont pas robustes. Ne les utilisez pas dans un environnement de production.

Exemple de mise en œuvre de TransformerFactory example-transformerfactory-implementation

package com.adobe.example;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Service;
import org.apache.felix.scr.annotations.Property;

import org.apache.sling.rewriter.Transformer;
import org.apache.sling.rewriter.TransformerFactory;

@Component
@Service
public class MyRewriterTransformerFactory implements TransformerFactory {
    /* Define the alias */
    @Property(value="mytransformer")
    static final String PIPELINE_TYPE ="pipeline.type";

    public Transformer createTransformer() {

        return new MyRewriterTransformer ();
    }
}

Exemple de mise en œuvre de transformateur example-transformer-implementation

package com.adobe.example;

import java.io.IOException;

import org.apache.cocoon.xml.sax.AbstractSAXPipe;

import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.rewriter.ProcessingComponentConfiguration;
import org.apache.sling.rewriter.ProcessingContext;
import org.apache.sling.rewriter.Transformer;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.AttributesImpl;

import javax.servlet.http.HttpServletRequest;

public class MyRewriterTransformer extends AbstractSAXPipe implements Transformer {

 private static final Logger log = LoggerFactory.getLogger(MyRewriterTransformer.class);
 private SlingHttpServletRequest httpRequest;
 /* The element and attribute to act on  */
 private static final String ATT_NAME = new String("src");
 private static final String EL_NAME = new String("img");

 public MyRewriterTransformer () {
 }
 public void dispose() {
 }
 public void init(ProcessingContext context, ProcessingComponentConfiguration config) throws IOException {
  this.httpRequest = context.getRequest();
  log.debug("Transforming request {}.", httpRequest.getRequestURI());
 }
 @Override
 public void startElement (String nsUri, String localname, String qname, Attributes atts) throws SAXException {
  /* copy the element attributes */
  AttributesImpl linkAtts = new AttributesImpl(atts);
  /* Only interested in EL_NAME elements */
  if(EL_NAME.equalsIgnoreCase(localname)){

   /* iterate through the attributes of the element and act only on ATT_NAME attributes */
   for (int i=0; i < linkAtts.getLength(); i++) {
    if (ATT_NAME.equalsIgnoreCase(linkAtts.getLocalName(i))) {
     String path_in_link = linkAtts.getValue(i);

     /* use the resource resolver of the http request to reverse-resolve the path  */
     String mappedPath = httpRequest.getResourceResolver().map(httpRequest, path_in_link);

     log.info("Tranformed {} to {}.", path_in_link,mappedPath);

     /* update the attribute value */
     linkAtts.setValue(i,mappedPath);
    }
   }

  }
        /* return updated attributes to super and continue with the transformer chain */
 super.startElement(nsUri, localname, qname, linkAtts);
 }
}

Ajouter le transformateur à un pipeline de module de réécriture adding-the-transformer-to-a-rewriter-pipeline

Créez un nœud JCR qui définit un pipeline utilisant votre transformateur. La définition de nœud suivante crée un pipeline qui traite les fichiers texte/html. Le générateur et l’analyseur AEM par défaut pour HTML sont utilisés.

NOTE
Si vous définissez la propriété du transformateur pipeline.mode sur global, il n’est pas nécessaire de configurer un pipeline. Le mode global insère le transformateur dans tous les pipelines.

Nœud de configuration du module de réécriture - Représentation XML rewriter-configuration-node-xml-representation

<?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:jcr="https://www.jcp.org/jcr/1.0" xmlns:nt="https://www.jcp.org/jcr/nt/1.0"
    jcr:primaryType="nt:unstructured"
    contentTypes="[text/html]"
    enabled="{Boolean}true"
    generatorType="htmlparser"
    order="5"
    serializerType="htmlwriter"
    transformerTypes="[mytransformer]">
</jcr:root>

Le graphique suivant affiche la représentation CRXDE Lite du nœud :

recommendation-more-help
ce382601-480f-4a99-8be7-73178d4b6ef5