Exteriorização de URLs

Em AEM, a variável Externalizador é um serviço OSGI que permite transformar programaticamente um caminho de recurso (por exemplo, /path/to/my/page) em um URL externo e absoluto (por exemplo, https://www.mycompany.com/path/to/my/page) ao prefixar o caminho com um DNS pré-configurado.

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

Esta página explica como configurar a variável Externalizador e como usá-lo. Para obter mais detalhes, consulte o Javadocs.

Configurar o serviço Externalizador

O Externalizador 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 a variável Externalizador serviço:

  1. Navegue até o gerenciador de configuração por meio de Ferramentas, em seguida Console da Web ou digite:

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

  2. Clique em Externalizador de links CQ do dia para abrir a caixa de diálogo de configuração.

    OBSERVAÇÃO

    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 Domínios mapeamento: 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:

    • esquema geralmente é http ou https, mas também pode ser ftp, etc.

      • usar https para aplicar links https, se desejado
      • ele será usado se o código do cliente não substituir o esquema ao solicitar a externalização de um URL.
    • server é 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 AEM for 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 sempre ser definidos conforme AEM dependem deles:

    • local - a instância local
    • author - DNS do sistema de criação
    • publish - DNS, o sítio web público
    OBSERVAÇÃO

    Uma configuração personalizada permite adicionar uma nova categoria, como production, staging ou 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.

OBSERVAÇÃO

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

Uso do serviço Externalizador

Esta seção mostra alguns exemplos de como a variável Externalizador pode ser usado:

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

    Externalizer externalizer = resourceResolver.adaptTo(Externalizer.class);
    
  2. Para exteriorizar um caminho com o domínio "publicar":

    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 exteriorizar um caminho com o domínio "autor":

    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 exteriorizar um caminho com o domínio "local":

    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 na Javadocs.

Nesta página