DocumentaçãoAEM 6.5Guia do usuário

Externalizar URLs externalizing-urls

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • Desenvolvedor

No Adobe Experience Manager (AEM), o Externalizador é um serviço OSGI que permite transformar programaticamente um caminho de recurso (por exemplo, /path/to/my/page) em uma URL externa e absoluta (por exemplo, https://www.mycompany.com/path/to/my/page), prefixando o caminho com um DNS pré-configurado.

Como uma instância não pode saber seu URL visível externamente se estiver sendo executada por trás de uma camada da Web e porque, às vezes, um link precisa ser criado fora do escopo de solicitação, esse serviço fornece um local central para configurar esses URLs externos e criá-los.

Esta página explica como configurar o serviço Externalizador e como usá-lo. Para obter mais detalhes, consulte os Javadocs.

Configurar o serviço Externalizador configuring-the-externalizer-service

O serviço Externalizer permite definir centralmente vários domínios que podem ser usados para prefixar programaticamente caminhos de recursos. Cada domínio é identificado por um nome exclusivo usado para fazer referência programaticamente ao domínio.

Para definir um mapeamento de domínio para o serviço Externalizador:

  1. Navegue até o gerenciador de configurações via Ferramentas e, em seguida, Console da Web ou digite:

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

  2. Clique em Day CQ Link Externalizer para abrir a caixa de diálogo de configuração.

    note note
    NOTE
    O link direto para a configuração é https://<host>:<port>/system/console/configMgr/com.day.cq.commons.impl.ExternalizerImpl

    aem-externalizer-01

  3. Defina um mapeamento de Domínios: um mapeamento consiste em um nome exclusivo que pode ser usado no código para fazer referência ao domínio, a um espaço e ao domínio:

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

    Em que:

    • o esquema é http ou https, mas também pode ser ftp e assim por diante.

      • use https para aplicar links https, se desejado
      • ele é usado se o código do cliente não substituir o esquema ao solicitar a externalização de um URL.

    • servidor é o nome do host (pode ser um nome de domínio ou endereço ip).

    • porta (opcional) é o número da porta.

    • contextpath (opcional) só será definido se o AEM estiver instalado como um aplicativo web em um caminho de contexto diferente.

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

    Os seguintes nomes de mapeamento são predefinidos e devem ser definidos porque o AEM depende deles:

    • local - a instância local
    • author - o DNS do sistema de criação
    • publish - o DNS do site voltado para o público
    note note
    NOTE
    Uma configuração personalizada permite adicionar uma categoria, como production, staging, ou até mesmo sistemas externos não-AEM, como my-internal-webservice. É útil evitar a codificação rígida desses URLs em diferentes locais na base de código de um projeto.

  4. Clique em Salvar para salvar as alterações.

NOTE
O Adobe recomenda que você adicione a configuração ao repositório.

Usar o serviço Externalizador using-the-externalizer-service

Esta seção mostra alguns exemplos de como o serviço Externalizador pode ser usado:

  1. Para obter o serviço Externalizador em um JSP:

    code language-java 
    Externalizer externalizer = resourceResolver.adaptTo(Externalizer.class);

  2. Para externalizar um caminho com o domínio 'publicar':

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

    Considerando o mapeamento de domínio:

    • publish https://www.website.com

    myExternalizedUrl termina com o valor:

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

  3. Para externalizar um caminho com o domínio 'author':

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

    Considerando o mapeamento de domínio:

    • author https://author.website.com

    myExternalizedUrl termina com o valor:

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

  4. Para externalizar um caminho com o domínio 'local':

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

    Considerando o mapeamento de domínio:

    • local https://publish-3.internal

    myExternalizedUrl termina com o valor:

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

  5. Você pode encontrar mais exemplos nos Javadocs.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2