Externalización de direcciones URL

En AEM, la variable Externalizador es un servicio OSGi que le permite transformar mediante programación una ruta de recursos (p. ej. /path/to/my/page) en una dirección URL externa y absoluta (por ejemplo, https://www.mycompany.com/path/to/my/page) añadiendo un prefijo a la ruta con un DNS preconfigurado.

Dado que una instancia as a Cloud Service AEM no puede saber su URL visible externamente y que a veces se debe crear un vínculo fuera del ámbito de la solicitud, este servicio proporciona un lugar central para configurar esas URL externas y crearlas.

Este artículo explica cómo configurar el servicio externalizador y cómo utilizarlo. Para obtener información técnica sobre el servicio, consulte la Javadocs.

Comportamiento predeterminado del externalizador y cómo ignorarlo

De forma predeterminada, el servicio externalizador asigna un puñado de identificadores de dominio a prefijos de URL absolutos que coinciden con las direcciones URL del servicio de AEM que se han generado para el entorno, como author https://author-p12345-e6789.adobeaemcloud.com y publish https://publish-p12345-e6789.adobeaemcloud.com. Las direcciones URL base de cada uno de estos dominios predeterminados se leen desde variables de entorno definidas por Cloud Manager.

Como referencia, la configuración OSGi predeterminada para com.day.cq.commons.impl.ExternalizerImpl.cfg.json es eficaz:

{
   "externalizer.domains": [
      "local $[env:AEM_EXTERNALIZER_LOCAL;default=http://localhost:4502]",
      "author $[env:AEM_EXTERNALIZER_AUTHOR;default=http://localhost:4502]",
      "publish $[env:AEM_EXTERNALIZER_PUBLISH;default=http://localhost:4503]",
      "preview $[env:AEM_EXTERNALIZER_PREVIEW;default=http://localhost:4503]"
   ]
}

Para anular la variable preview y publish utilice las variables de entorno de Cloud Manager como se describe en el artículo Configuración de OSGi para AEM as a Cloud Service y configurar los AEM_CDN_DOMAIN_PUBLISH y AEM_CDN_DOMAIN_PREVIEW variables.

Configuración del servicio externalizador

El servicio externalizador le permite definir de forma centralizada el dominio que se puede utilizar para prefijar programáticamente las rutas de recursos. El servicio externalizador solo debe utilizarse para aplicaciones con un solo dominio.

Para definir una asignación de dominio para el servicio externalizador:

1. Vaya al Administrador de configuración mediante:

   https://<host>:<port>/system/console/configMgr

2. Haga clic en Externalizador de vínculos de CQ de día para abrir el cuadro de diálogo de configuración.

   

   NOTA

   El vínculo directo a la configuración es https://<host>:<port>/system/console/configMgr/com.day.cq.commons.impl.ExternalizerImpl

3. Defina un Dominios asignación. Una asignación consiste en un nombre único que se puede utilizar en el código para hacer referencia al dominio, un espacio y el dominio:

   <unique-name> [scheme://]server[:port][/contextpath]

   Donde:

   • scheme generalmente es http o https, pero puede ser otro protocolo.

     • Se recomienda utilizar https para aplicar los vínculos https.
     • Se utilizará si el código de cliente no anula el esquema al solicitar la externalización de una URL.

   • server es el nombre de host (un nombre de dominio o una dirección ip).

   • port (opcional) es el número de puerto.

   • contextpath (opcional) solo se establece si AEM está instalado como una aplicación web en una ruta de contexto diferente.

   Por ejemplo: production https://my.production.instance

   Los siguientes nombres de asignación están predefinidos y siempre deben configurarse como AEM dependen de ellos:

   • local : la instancia local
   • author - el DNS del sistema de creación
   • publish - el sitio web DNS de cara al público
   NOTA

   Una configuración personalizada le permite agregar una nueva categoría, como production, staging o incluso sistemas externos no AEM como my-internal-webservice. Es útil evitar codificar dichas URL en distintos lugares de la base de código de un proyecto.

4. Haga clic en Guardar para guardar los cambios.

Uso del servicio externalizador

Esta sección muestra algunos ejemplos de cómo se puede utilizar el servicio externalizador.

• Para externalizar una ruta con el dominio "publicar":

  String myExternalizedUrl = externalizer.publishLink(resolver, "/my/page") + ".html";
  

  Suponiendo la asignación de dominios:

  • publish https://www.website.com

  • myExternalizedUrl termina con el valor:

  • https://www.website.com/contextpath/my/page.html

• Para externalizar una ruta con el dominio "autor":

  String myExternalizedUrl = externalizer.authorLink(resolver, "/my/page") + ".html";
  

  Suponiendo la asignación de dominios:

  • author https://author.website.com

  • myExternalizedUrl termina con el valor:

  • https://author.website.com/contextpath/my/page.html

• Para externalizar una ruta con el dominio "local":

  String myExternalizedUrl = externalizer.externalLink(resolver, Externalizer.LOCAL, "/my/page") + ".html";
  

  Suponiendo la asignación de dominios:

  • local https://publish-3.internal

  • myExternalizedUrl termina con el valor:

  • https://publish-3.internal/contextpath/my/page.html

Recursos de Business.Adobe.com