Externalisation d’URL externalizing-urls
Dans AEM, Externalizer est un service OSGI qui vous permet de transformer, par programmation, un chemin d’accès aux ressources (/path/to/my/page) en une URL externe et absolue (https://www.mycompany.com/path/to/my/page, par exemple) en faisant précéder le chemin d’accès d’un DNS préconfiguré.
Comme une instance ne peut pas connaître son URL visible en externe si elle s’exécute derrière une couche web, et qu’il arrive qu’un lien doive être créé en dehors de la portée de la requête, ce service fournit un emplacement central pour configurer ces URL externes et les créer.
Cette page explique comment configurer la variable Externalizer et comment l’utiliser. Pour plus d’informations, reportez-vous à la section Javadocs.
Configuration du service Externalizer configuring-the-externalizer-service
Le service Externalizer vous permet de définir, de manière centralisée, plusieurs domaines pouvant être utilisés pour préfixer des chemins d’accès aux ressources par programmation. Chaque domaine est identifié par un nom unique utilisé pour référencer le domaine par programmation.
Pour définir un mappage de domaine pour la variable Externalizer service :
-
Accédez au gestionnaire de configuration via Outils, puis Console web ou saisissez
https://<host>:<port>/system/console/configMgr. -
Cliquez sur l’Externaliseur de lien Day CQ pour ouvrir la boîte de dialogue de configuration.
note note NOTE Le lien direct vers la configuration est https://<host>:<port>/system/console/configMgr/com.day.cq.commons.impl.ExternalizerImpl.
-
Définissez un mappage de domaine : un mappage se compose d’un nom unique qui peut être utilisé dans le code pour référencer le domaine, un espace et le domaine :
<unique-name> [scheme://]server[:port][/contextpath], où:- scheme est généralement http ou https, mais peut également être ftp, etc.; utilisez https pour appliquer les liens https, le cas échéant ; il sera utilisé si le code client ne remplace pas le schéma lors de la demande d’externalisation d’une URL.
- Server est le nom d’hôte (il peut s’agir d’un nom de domaine ou d’une adresse IP).
- Port (facultatif) est le numéro de port.
- contextpath (facultatif) est défini uniquement si AEM est installé en tant qu’application Web sous un autre chemin d’accès au contexte.
Par exemple :
production https://my.production.instanceLes noms de mappage suivants sont prédéfinis et doivent toujours être configurés, car AEM en dépend :
- local - instance locale
- author - le DNS du système de création
- publier - DNS du site web public
note note NOTE Une configuration personnalisée vous permet d’ajouter une nouvelle catégorie, telle que "production", "staging" ou même des systèmes non AEM externes tels que "my-internal-webservice". Elle s’avère utile pour éviter de coder en dur de telles URL à différents endroits dans le code base d’un projet. -
Cliquez sur Enregistrer pour enregistrer vos modifications.
Utilisation du service Externalizer using-the-externalizer-service
Cette section présente quelques exemples de la manière dont la fonction Externalizer peut être utilisé.
Pour obtenir le service Externalizer dans un JSP :
Externalizer externalizer = resourceResolver.adaptTo(Externalizer.class);
Pour externaliser un chemin d’accès avec le domaine « publish » :
String myExternalizedUrl = externalizer.publishLink(resolver, "/my/page") + ".html";
En supposant le mappage de domaine " publish https://www.website.com", myExternalizedUrl se termine par la valeur " https://www.website.com/contextpath/my/page.html".
Pour externaliser un chemin d’accès avec le domaine « author » :
String myExternalizedUrl = externalizer.authorLink(resolver, "/my/page") + ".html";
En supposant le mappage de domaine " author https://author.website.com", myExternalizedUrl se termine par la valeur " https://author.website.com/contextpath/my/page.html".
Pour externaliser un chemin d’accès avec le domaine « local », procédez comme suit :
String myExternalizedUrl = externalizer.externalLink(resolver, Externalizer.LOCAL, "/my/page") + ".html";
En supposant le mappage de domaine " local https://publish-3.internal", myExternalizedUrl se termine par la valeur " https://publish-3.internal/contextpath/my/page.html".
Vous trouverez d’autres exemples dans les Javadocs.