Configuração do Dispatcher

As seções a seguir descrevem como configurar vários aspectos do Dispatcher.

Suporte para IPv4 e IPv6

Todos os elementos do AEM e do Dispatcher podem ser instalados em redes IPv4 e IPv6. Consulte IPV4 e IPV6.

Arquivos de configuração do Dispatcher

Por padrão, a configuração do Dispatcher é armazenada no arquivo de texto dispatcher.any, embora você possa alterar o nome e o local desse arquivo durante a instalação.

O arquivo de configuração contém uma série de propriedades com valor único ou com vários valores que controlam o comportamento do Dispatcher:

• Os nomes de propriedades recebem o prefixo de uma barra /.
• As propriedades com vários valores incluem itens secundários usando chaves { }.

Um exemplo de configuração é estruturado da seguinte maneira:

# name of the dispatcher
/name "internet-server"

# each farm configures a set off (loadbalanced) renders
/farms
 {
  # first farm entry (label is not important, just for your convenience)
   /website
     {
     /clientheaders
       {
       # List of headers that are passed on
       }
     /virtualhosts
       {
       # List of URLs for this Web site
       }
     /sessionmanagement
       {
       # settings for user authentification
       }
     /renders
       {
       # List of AEM instances that render the documents
       }
     /filter
       {
       # List of filters
       }
     /vanity_urls
       {
       # List of vanity URLs
       }
     /cache
       {
       # Cache configuration
       /rules
         {
         # List of cachable documents
         }
       /invalidate
         {
         # List of auto-invalidated documents
         }
       }
     /statistics
       {
       /categories
         {
         # The document categories that are used for load balancing estimates
         }
       }
     /stickyConnectionsFor "/myFolder"
     /health_check
       {
       # Page gets contacted when an instance returns a 500
       }
     /retryDelay "1"
     /numberOfRetries "5"
     /unavailablePenalty "1"
     /failover "1"
     }
 }

Você pode incluir outros arquivos que contribuem para a configuração:

• Se o arquivo de configuração for grande, é possível dividi-lo em vários arquivos menores (que são mais fáceis de gerenciar) e incluí-los.
• Para incluir arquivos gerados automaticamente.

Por exemplo, para incluir o arquivo myFarm.any na configuração de /farms, use o seguinte código:

/farms
  {
  $include "myFarm.any"
  }

Use o asterisco (*) como um curinga para especificar um intervalo de arquivos a serem incluídos.

Por exemplo, se os arquivos farm_1.any até farm_5.any contiverem a configuração de farms de um a cinco, você poderá incluí-los da seguinte maneira:

/farms
  {
  $include "farm_*.any"
  }

Uso de variáveis de ambiente

Você pode usar variáveis de ambiente em propriedades com valores de cadeias de caracteres no arquivo dispatcher.any, em vez de codificar os valores. Para incluir o valor de uma variável de ambiente, use o formato ${variable_name}.

Por exemplo, se o arquivo dispatcher.any estiver localizado no mesmo diretório do cache, o seguinte valor para a propriedade docroot poderá ser usado:

/docroot "${PWD}/cache"

Como outro exemplo, se você criar uma variável de ambiente chamada PUBLISH_IP, que armazena o nome do host da instância de publicação do AEM, a seguinte configuração da propriedade /renders poderá ser usada:

/renders {
  /0001 {
    /hostname "${PUBLISH_IP}"
    /port "8443"
  }
}

Nomenclatura da instância do Dispatcher

Use a propriedade /name para especificar um nome exclusivo que identifique a instância do Dispatcher. A propriedade /name é uma propriedade de nível superior na estrutura de configuração.

Definição de farms

A propriedade /farms define um ou mais conjuntos de comportamentos do Dispatcher, em que cada conjunto é associado a sites ou URLs diferentes. A propriedade /farms pode incluir um único farm ou vários farms:

• Use um único farm quando quiser que o Dispatcher lide com todas as páginas da Web ou sites da mesma maneira.
• Crie vários farms quando áreas diferentes do seu site ou sites diferentes exigirem um comportamento diferente do Dispatcher.

A propriedade /farms é uma propriedade de nível superior na estrutura de configuração. Para definir um farm, adicione uma propriedade secundária à propriedade /farms. Use um nome de propriedade que identifique exclusivamente o farm na instância do Dispatcher.

A propriedade /farmname tem vários valores e contém outras propriedades que definem o comportamento do Dispatcher:

• Os URLs das páginas às quais o farm se aplica.
• Um ou mais URLs de serviço (normalmente de instâncias de publicação do AEM) para usar na renderização de documentos.
• As estatísticas que serão usadas para balanceamento de carga em vários renderizadores de documento.
• Vários outros comportamentos, como quais arquivos armazenar em cache e onde.

O valor pode incluir qualquer caractere alfanumérico (a-z, 0-9). O exemplo a seguir mostra a definição do esqueleto para dois farms chamados /daycom e /docsdaycom:

#name of dispatcher
/name "day sites"

#farms section defines a list of farms or sites
/farms
{
   /daycom
   {
       ...
   }
   /docdaycom
   {
      ...
   }
}

Cada propriedade farm pode conter as seguintes propriedades secundárias:

Especificação de uma página padrão (somente IIS) - /homepage

Especificação dos cabeçalhos HTTP que serão transmitidos

A propriedade /clientheaders define uma lista de cabeçalhos HTTP que o Dispatcher transmite da solicitação HTTP do cliente para o renderizador (instância do AEM).

Por padrão, o Dispatcher encaminha os cabeçalhos HTTP padrão para a instância do AEM. Em algumas instâncias, você pode encaminhar cabeçalhos adicionais ou remover cabeçalhos específicos:

• Adicione cabeçalhos, como cabeçalhos personalizados, que sua instância do AEM espera na solicitação HTTP.
• Remova cabeçalhos, como cabeçalhos de autenticação, que são relevantes apenas para o servidor Web.

Se você personalizar o conjunto de cabeçalhos que serão transmitidos, será necessário especificar uma lista exaustiva de cabeçalhos, incluindo aqueles que normalmente são incluídos por padrão.

Por exemplo, uma instância do Dispatcher que lida com solicitações de ativação de página para instâncias de publicação requer o cabeçalho PATH na seção /clientheaders. O cabeçalho PATH permite a comunicação entre o agente de replicação e o Dispatcher.

O código a seguir é um exemplo de configuração para /clientheaders:

/clientheaders
  {
  "CSRF-Token"
  "X-Forwarded-Proto"
  "referer"
  "user-agent"
  "authorization"
  "from"
  "content-type"
  "content-length"
  "accept-charset"
  "accept-encoding"
  "accept-language"
  "accept"
  "host"
  "max-forwards"
  "proxy-authorization"
  "proxy-connection"
  "range"
  "cookie"
  "cq-action"
  "cq-handle"
  "handle"
  "action"
  "cqstats"
  "depth"
  "translate"
  "expires"
  "date"
  "dav"
  "ms-author-via"
  "if"
  "lock-token"
  "x-expected-entity-length"
  "destination"
  "PATH"
  }

Identificação de hosts virtuais

A propriedade /virtualhosts define uma lista de todas as combinações de nome de host/URI aceitas pelo Dispatcher para este farm. Você pode usar o caractere asterisco (*) como curinga. Os valores para a propriedade / virtualhosts usam o seguinte formato:

[scheme]host[uri][*]

• scheme: (Opcional) https:// ou https://.
• host: O nome ou endereço IP do computador host e o número da porta, se necessário. (Consulte https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.23)
• uri: (Opcional) O caminho para os recursos.

O exemplo de configuração a seguir lida com solicitações para os domínios .com e .ch de myCompany e todos os domínios de mySubDivision:

   /virtualhosts
    {
    "www.myCompany.com"
    "www.myCompany.ch"
    "www.mySubDivison.*"
    }

A configuração a seguir lida com todas as solicitações:

   /virtualhosts
    {
    "*"
    }

Resolução do host virtual

Quando o Dispatcher recebe uma solicitação HTTP ou HTTPS, ele encontra o valor do host virtual que melhor corresponde aos cabeçalhos host, uri e scheme da solicitação. O Dispatcher avalia os valores nas propriedades virtualhosts na seguinte ordem:

• O Dispatcher começa no farm mais baixo e avança para cima no arquivo dispatcher.any.
• Para cada farm, o Dispatcher começa com o valor mais alto na propriedade virtualhosts e avança para baixo na lista de valores.

O Dispatcher encontra o melhor valor de host virtual correspondente da seguinte maneira:

• O primeiro host virtual encontrado que corresponde a todos os três do host, o scheme e o uri da solicitação é usado.
• Se nenhum valor de virtualhosts tiver partes scheme e uri que correspondam a scheme e uri da solicitação, o primeiro host virtual encontrado que corresponda a host da solicitação será usado.
• Se nenhum valor virtualhosts tiver uma parte do host que corresponda ao host da solicitação, o host virtual mais acima do farm mais acima será usado.

Portanto, você deve colocar seu host virtual padrão na parte superior da propriedade virtualhosts no farm mais acima do arquivo dispatcher.any.

Exemplo de resolução de host virtual

O exemplo a seguir representa um trecho de um arquivo dispatcher.any que define dois farms do Dispatcher, e cada farm define uma propriedade virtualhosts.

/farms
  {
  /myProducts
    {
    /virtualhosts
      {
      "www.mycompany.com"
      }
    /renders
      {
      /hostname "server1.myCompany.com"
      /port "80"
      }
    }
  /myCompany
    {
    /virtualhosts
      {
      "www.mycompany.com/products/*"
      }
    /renders
      {
      /hostname "server2.myCompany.com"
      /port "80"
      }
    }
  }

Usando este exemplo, a tabela a seguir mostra os hosts virtuais que são resolvidos para as solicitações HTTP fornecidas:

Ativação de sessões seguras - /sessionmanagement

Crie uma sessão segura para acessar o farm de renderização de modo que os usuários precisem fazer logon para acessar qualquer página no farm. Depois de fazer logon, os usuários podem acessar as páginas no farm. Consulte Criação de um grupo fechado de usuários para informações sobre como usar este recurso com CUGs. Além disso, consulte a Lista de verificação de segurança do Dispatcher antes de entrar em atividade.

A propriedade /sessionmanagement é uma subpropriedade de /farms.

/sessionmanagement tem vários subparâmetros:

/directory (obrigatório)

O diretório que armazena as informações da sessão. Se o diretório não existir, ele será criado.

/sessionmanagement
  {
  /directory "/usr/local/apache/.sessions"
  }

/encode (opcional)

Como as informações da sessão são codificadas. Use md5 para criptografia usando o algoritmo md5 ou hex para codificação hexadecimal. Se você criptografar os dados da sessão, um usuário com acesso ao sistema de arquivos não poderá ler o conteúdo da sessão. O padrão é md5.

/header (opcional)

O nome do cabeçalho ou cookie HTTP que armazena as informações de autorização. Se você armazenar as informações no cabeçalho http, use HTTP:<header-name>. Para armazenar as informações em um cookie, use Cookie:<header-name>. Se você não especificar um valor, HTTP:authorization será usado.

/timeout (opcional)

O número de segundos até que a sessão atinja o tempo limite após ter sido usada por último. Se "800" não especificado for usado, a sessão expira pouco mais de 13 minutos após a última solicitação do usuário.

Um exemplo de configuração tem a seguinte aparência:

/sessionmanagement
  {
  /directory "/usr/local/apache/.sessions"
  /encode "md5"
  /header "HTTP:authorization"
  /timeout "800"
  }

Definição de renderizadores de página

A propriedade /renders define o URL para o qual o Dispatcher envia solicitações para renderizar um documento. O exemplo de seção /renders a seguir identifica uma única instância do AEM para renderização:

/renders
  {
    /myRenderer
      {
      # hostname or IP of the renderer
      /hostname "aem.myCompany.com"
      # port of the renderer
      /port "4503"
      # connection timeout in milliseconds, "0" (default) waits indefinitely
      /timeout "0"
      }
  }

O exemplo de seção /renders a seguir identifica uma instância do AEM que é executada no mesmo computador que o Dispatcher:

/renders
  {
    /myRenderer
     {
     /hostname "127.0.0.1"
     /port "4503"
     }
  }

O exemplo de seção /renders a seguir distribui as solicitações de renderização igualmente entre duas instâncias do AEM:

/renders
  {
    /myFirstRenderer
      {
      /hostname "aem.myCompany.com"
      /port "4503"
      }
    /mySecondRenderer
      {
      /hostname "127.0.0.1"
      /port "4503"
      }
  }

Opções de renderização

/timeout

Especifica o tempo limite da conexão acessando a instância do AEM em milissegundos. O padrão é "0", fazendo com que o Dispatcher aguarde indefinidamente.

/receiveTimeout

Especifica o tempo em milissegundos que uma resposta pode demorar. O padrão é "600000", fazendo com que o Dispatcher aguarde 10 minutos. Uma configuração de "0" elimina completamente o tempo limite.

Se o tempo limite for atingido durante a análise dos cabeçalhos de resposta, um Status HTTP de 504 (Gateway incorreto) será retornado. Se o tempo limite for atingido enquanto o corpo da resposta for lido, o Dispatcher retornará a resposta incompleta ao cliente, mas excluirá qualquer arquivo de cache que tenha sido gravado.

/ipv4

Especifica se o Dispatcher usa a função getaddrinfo (para IPv6) ou a função gethostbyname (para IPv4) para obter o endereço IP da renderização. Um valor de 0 faz com que getaddrinfo seja usado. Um valor 1 faz com que gethostbyname seja usado. O valor padrão é 0.

A função getaddrinfo retorna uma lista de endereços IP. O Dispatcher repete a lista de endereços até estabelecer uma conexão TCP/IP. Portanto, a propriedade ipv4 é importante quando o nome do host de renderização está associado a vários endereços IP e o host, em resposta à função getaddrinfo, retorna uma lista de endereços IP que estão sempre na mesma ordem. Nessa situação, você deve usar a função gethostbyname para que o endereço IP com o qual o Dispatcher se conecte seja aleatório.

O Elastic Load Balancing (ELB) da Amazon é um serviço que responde a getaddrinfo com uma lista de endereços IP potencialmente iguais.

/secure

Se a propriedade /secure tiver um valor "1", o Dispatcher usará HTTPS para se comunicar com a instância do AEM. Para obter detalhes adicionais, consulte também Configuração do Dispatcher para usar SSL.

/always-resolve

Com a versão do Dispatcher 4.1.6, você pode configurar a propriedade /always-resolve da seguinte maneira:

• Quando definido como "1", ele resolverá o nome do host em cada solicitação (o Dispatcher nunca armazenará em cache nenhum endereço IP). Pode haver um pequeno impacto no desempenho devido à chamada adicional necessária para obter as informações do host para cada solicitação.
• Se a propriedade não for definida, o endereço IP será armazenado em cache por padrão.

Além disso, essa propriedade pode ser usada caso você tenha problemas de resolução de IP dinâmico, conforme mostrado no exemplo a seguir:

/renders {
  /0001 {
     /hostname "host-name-here"
     /port "4502"
     /ipv4 "1"
     /always-resolve "1"
     }
  }

Configuração do acesso ao conteúdo

Use a seção /filter para especificar as solicitações HTTP aceitas pelo Dispatcher. Todas as outras solicitações são enviadas de volta ao servidor Web com um código de erro 404 (página não encontrada). Se não existir nenhuma seção /filter, todas as solicitações serão aceitas.

Observação: as solicitações para o arquivo de status são sempre rejeitadas.

A seção /filter consiste em uma série de regras que negam ou permitem acesso ao conteúdo de acordo com os padrões na parte da linha de solicitação da solicitação HTTP. Você deve usar uma estratégia de lista de permissões para sua seção /filter:

• Primeiro, negar acesso a tudo.
• Permita acesso ao conteúdo conforme necessário.

Definição de um filtro

Cada item na seção /filter inclui um tipo e um padrão que são combinados com um elemento específico da linha de solicitação ou de toda a linha de solicitação. Cada filtro pode conter os seguintes itens:

• Tipo: o /type indica se o acesso às solicitações que correspondem ao padrão deve ser permitido ou negado. O valor pode ser allow ou deny.

• Elemento da linha de solicitação: inclua /method, /url, /query ou /protocol e um padrão para filtrar solicitações de acordo com essas partes específicas da parte da linha de solicitação da solicitação HTTP. A filtragem de elementos da linha de solicitação (em vez da linha de solicitação inteira) é o método de filtro preferido.

• Elementos avançados da linha de solicitação: a partir do Dispatcher 4.2.0, quatro novos elementos de filtro estarão disponíveis para uso. Esses novos elementos são /path, /selectors, /extension e /suffix respectivamente. Inclua um ou mais desses itens para controlar ainda mais os padrões de URL.

• Propriedade glob: a propriedade /glob é usada para corresponder a toda a linha de solicitação da solicitação HTTP.

A parte da linha de solicitação de solicitações HTTP

HTTP/1.1 define o request-line da seguinte maneira:

Method Request-URI HTTP-Version<CRLF>

Os caracteres <CRLF> representam um retorno de carro seguido por um feed de linha. O exemplo a seguir é a linha de solicitação recebida quando um cliente solicita a página em inglês dos EUA do site WKND:

GET /content/wknd/us/en.html HTTP.1.1<CRLF>

Seus padrões devem levar em conta os caracteres de espaço na linha de solicitação e os caracteres <CRLF>.

Aspas duplas vs. aspas simples

Ao criar suas regras de filtro, use aspas duplas "pattern" para padrões simples. Se você estiver usando o Dispatcher 4.2.0 ou posterior e seu padrão incluir uma expressão regular, será necessário colocar o padrão regex '(pattern1|pattern2)' entre aspas simples.

Expressões regulares

Nas versões posteriores do Dispatcher 4.2.0, é possível incluir expressões regulares POSIX estendidas nos padrões de filtro.

Resolução de problemas de filtros

Se os filtros não estiverem acionando da maneira esperada, ative Rastrear log no Dispatcher para ver qual filtro está interceptando a solicitação.

Exemplo de filtro: Negar tudo

O exemplo de seção de filtro a seguir faz com que o Dispatcher negue solicitações para todos os arquivos. Você deve negar acesso a todos os arquivos e permitir acesso a áreas específicas.

/0001  { /type "deny" /url "*"  }

As solicitações para uma área explicitamente negada resultam no retorno de um código de erro 404 (página não encontrada).

Exemplo de filtro: Negar acesso a áreas específicas

Os filtros também permitem negar acesso a vários elementos, por exemplo, páginas ASP e áreas confidenciais em uma instância de publicação. O filtro a seguir nega acesso a páginas ASP:

/0002  { /type "deny" /url "*.asp"  }

Exemplo de filtro: Ativar solicitações POST

O exemplo de filtro a seguir permite o envio de dados de formulário pelo método POST:

/filter {
    /0001  { /glob "*" /type "deny" }
    /0002 { /type "allow" /method "POST" /url "/content/[.]*.form.html" }
}

Exemplo de filtro: Permitir acesso ao console Fluxo de trabalho

O exemplo a seguir mostra um filtro usado para negar acesso externo ao console Fluxo de trabalho:

/filter {
    /0001  { /glob "*" /type "deny" }
    /0002  {  /type "allow"  /url "/libs/cq/workflow/content/console*"  }
}

Se a instância de publicação usar um contexto de aplicativo web (por exemplo, publicar), ele também poderá ser adicionado à definição do filtro.

/0003   { /type "deny"  /url "/publish/libs/cq/workflow/content/console/archive*"  }

Se ainda precisar acessar páginas únicas na área restrita, você poderá permitir acesso a elas. Por exemplo, para permitir o acesso à guia Arquivo, no console Fluxo de trabalho, adicione a seguinte seção:

/0004  { /type "allow"  /url "/libs/cq/workflow/content/console/archive*"   }

Exemplo de filtro: Usar expressões regulares

Esse filtro permite extensões em diretórios de conteúdo não acessível ao público usando uma expressão regular, definida aqui entre aspas simples:

/005  {  /type "allow" /extension '(css|gif|ico|js|png|swf|jpe?g)' }

Exemplo de filtro: Filtrar elementos adicionais de um URL de solicitação

Abaixo há um exemplo de regra que bloqueia a captura de conteúdo do caminho /content e de sua subárvore, usando filtros para caminho, seletores e extensões:

/006 {
        /type "deny"
        /path "/content/*"
        /selectors '(feed|rss|pages|languages|blueprint|infinity|tidy|sysview|docview|query|jcr:content|_jcr_content|search|childrenlist|ext|assets|assetsearch|[0-9-]+)'
        /extension '(json|xml|html|feed))'
        }

Exemplo de seção /filtro

Ao configurar o Dispatcher, você deve restringir o acesso externo o máximo possível. O exemplo a seguir fornece acesso mínimo para visitantes externos:

• /content

• conteúdos diversos, como projetos e bibliotecas de clientes. Por exemplo:

  • /etc/designs/default*
  • /etc/designs/mydesign*

Depois de criar filtros, teste o acesso à página para garantir que sua instância do AEM esteja segura.

A seguinte seção /filter, do arquivo dispatcher.any, pode ser usada como base em seu Arquivo de configuração do Dispatcher.

Este exemplo é baseado no arquivo de configuração padrão fornecido com o Dispatcher e destina-se a ser usado como exemplo em um ambiente de produção. Os itens com o prefixo # estão desativados (comentados). Tenha cuidado ao decidir ativar qualquer um desses itens (removendo o # nessa linha), pois isso pode ter um impacto na segurança.

Você deve negar acesso a tudo e, em seguida, permitir acesso a elementos específicos (limitados):

  /filter
      {
      # Deny everything first and then allow specific entries
      /0001  { /type "deny" /url "*"  }

      # Open consoles
#     /0011 { /type "allow" /url "/admin/*"  }  # allow servlet engine admin
#     /0012 { /type "allow" /url "/crx/*"    }  # allow content repository
#     /0013 { /type "allow" /url "/system/*" }  # allow OSGi console

      # Allow non-public content directories
#     /0021 { /type "allow" /url "/apps/*"   }  # allow apps access
#     /0022 { /type "allow" /url "/bin/*"    }
      /0023 { /type "allow" /url "/content*" }  # disable this rule to allow mapped content only

#     /0024 { /type "allow" /url "/libs/*"   }
#     /0025 { /type "deny"  /url "/libs/shindig/proxy*" } # if you enable /libs close access to proxy

#     /0026 { /type "allow" /url "/home/*"   }
#     /0027 { /type "allow" /url "/tmp/*"    }
#     /0028 { /type "allow" /url "/var/*"    }

      # Enable extensions in non-public content directories, using a regular expression
      /0041
        {
        /type "allow"
        /extension '(css|gif|ico|js|png|swf|jpe?g)'
        }

      # Enable features
      /0062 { /type "allow" /url "/libs/cq/personalization/*"  }  # enable personalization

      # Deny content grabbing, on all accessible pages, using regular expressions
      /0081
        {
        /type "deny"
        /selectors '((sys|doc)view|query|[0-9-]+)'
        /extension '(json|xml)'
        }
      # Deny content grabbing for /content and its subtree
      /0082
        {
        /type "deny"
        /path "/content/*"
        /selectors '(feed|rss|pages|languages|blueprint|infinity|tidy)'
        /extension '(json|xml|html)'
        }

#     /0087 { /type "allow" /method "GET" /extension 'json' "*.1.json" }  # allow one-level json requests
}

Considere as seguintes recomendações se optar por estender o acesso:

• O acesso externo a /admin deve estar sempre completamente desativado se estiver usando o CQ versão 5.4 ou uma versão anterior.

• Tenha cuidado ao permitir o acesso a arquivos em /libs. O acesso deve ser permitido de maneira individual.

• Negar acesso à configuração de replicação para que ela não possa ser vista:

  • /etc/replication.xml*
  • /etc/replication.infinity.json*

• Negar acesso ao proxy reverso de Google Gadgets:

  • /libs/opensocial/proxy*

Dependendo da sua instalação, pode haver recursos adicionais em /libs, /apps ou em outro lugar, que devem ser disponibilizados. Você pode usar o arquivo access.log como um método para determinar os recursos que estão sendo acessados externamente.

Restrição de cadeias de caracteres de consulta

Desde a versão 4.1.5 do Dispatcher, use a seção /filter para restringir cadeias de caracteres de consulta. É altamente recomendável permitir explicitamente cadeias de caracteres de consulta e excluir a permissão genérica por meio de elementos de filtro allow.

Uma única entrada pode ter glob ou alguma combinação de method, url, query e version, mas não ambos. O exemplo a seguir permite a cadeia de caracteres de consulta a=* e nega todas as outras para URLs resolvidos para o nó /etc:

/filter {
 /0001 { /type "deny" /method "POST" /url "/etc/*" }
 /0002 { /type "allow" /method "GET" /url "/etc/*" /query "a=*" }
}

/filter {
>/0001 { /type "deny" /method “*" /url "/path/*" }
>/0002 { /type "allow" /method "GET" /url "/path/*" }
>/0003 { /type “deny" /method "GET" /url "/path/*" /query "*" }
>/0004 { /type "allow" /method "GET" /url "/path/*" /query "a=*" }
}

Teste da segurança do Dispatcher

Os filtros do Dispatcher devem bloquear o acesso às seguintes páginas e scripts nas instâncias de publicação do AEM. Use um navegador da Web para tentar abrir as seguintes páginas, como um visitante do site faria, e verificar se um código 404 é retornado. Se qualquer outro resultado for obtido, ajuste os filtros.

Observe que você deve ver a renderização normal da página para /content/add_valid_page.html?debug=layout.

• /admin
• /system/console
• /dav/crx.default
• /crx
• /bin/crxde/logs
• /jcr:system/jcr:versionStorage.json
• /_jcr_system/_jcr_versionStorage.json
• /libs/wcm/core/content/siteadmin.html
• /libs/collab/core/content/admin.html
• /libs/cq/ui/content/dumplibs.html
• /var/linkchecker.html
• /etc/linkchecker.html
• /home/users/a/admin/profile.json
• /home/users/a/admin/profile.xml
• /libs/cq/core/content/login.json
• /content/../libs/foundation/components/text/text.jsp
• /content/.{.}/libs/foundation/components/text/text.jsp
• /apps/sling/config/org.apache.felix.webconsole.internal.servlet.OsgiManager.config/jcr%3acontent/jcr%3adata
• /libs/foundation/components/primary/cq/workflow/components/participants/json.GET.servlet
• /content.pages.json
• /content.languages.json
• /content.blueprint.json
• /content.-1.json
• /content.10.json
• /content.infinity.json
• /content.tidy.json
• /content.tidy.-1.blubber.json
• /content/dam.tidy.-100.json
• /content/content/geometrixx.sitemap.txt
• /content/add_valid_page.query.json?statement=//*
• /content/add_valid_page.qu%65ry.js%6Fn?statement=//*
• /content/add_valid_page.query.json?statement=//*[@transportPassword]/(@transportPassword%20|%20@transportUri%20|%20@transportUser)
• /content/add_valid_path_to_a_page/_jcr_content.json
• /content/add_valid_path_to_a_page/jcr:content.json
• /content/add_valid_path_to_a_page/_jcr_content.feed
• /content/add_valid_path_to_a_page/jcr:content.feed
• /content/add_valid_path_to_a_page/pagename._jcr_content.feed
• /content/add_valid_path_to_a_page/pagename.jcr:content.feed
• /content/add_valid_path_to_a_page/pagename.docview.xml
• /content/add_valid_path_to_a_page/pagename.docview.json
• /content/add_valid_path_to_a_page/pagename.sysview.xml
• /etc.xml
• /content.feed.xml
• /content.rss.xml
• /content.feed.html
• /content/add_valid_page.html?debug=layout
• /projects
• /tagging
• /etc/replication.html
• /etc/cloudservices.html
• /welcome

Emita o seguinte comando em um terminal ou prompt de comando para determinar se o acesso de gravação anônimo está ativado. Não deverá ser possível gravar dados no nó.

curl -X POST "https://anonymous:anonymous@hostname:port/content/usergenerated/mytestnode"

Execute o seguinte comando em um terminal ou prompt de comando para tentar invalidar o cache do Dispatcher e garantir que você receba uma resposta de código 403:

curl -H "CQ-Handle: /content" -H "CQ-Path: /content" https://yourhostname/dispatcher/invalidate.cache

Ativação do acesso a URLs personalizados

Configure o Dispatcher para ativar o acesso a URLs personalizados que estão configurados para suas páginas do AEM.

Quando o acesso a URLs personalizados está ativado, o Dispatcher chama periodicamente um serviço que é executado na instância de renderização para obter uma lista de URLs personalizados. O Dispatcher armazena essa lista em um arquivo local. Quando uma solicitação de página é negada devido a um filtro na seção /filter, o Dispatcher consulta a lista de URLs personalizados. Se o URL negado estiver na lista, o Dispatcher permitirá acesso ao URL personalizado.

Para habilitar o acesso a URLs personalizados, adicione uma seção /vanity_urls à seção /farms, semelhante ao exemplo a seguir:

 /vanity_urls {
      /url "/libs/granite/dispatcher/content/vanityUrls.html"
      /file "/tmp/vanity_urls"
      /delay 300
 }

A seção /vanity_urls contém as seguintes propriedades:

• /url: o caminho para o serviço de URL personalizado que é executado na instância de renderização. O valor dessa propriedade deve ser "/libs/granite/dispatcher/content/vanityUrls.html".

• /file: o caminho para o arquivo local onde o Dispatcher armazena a lista de URLs personalizados. Verifique se o Dispatcher tem acesso de gravação a esse arquivo.

• /delay: (segundos) o tempo entre chamadas para o serviço de URL personalizado.

Use o procedimento a seguir para habilitar o acesso a URLs personalizados.

1. Se o serviço de renderização for uma instância do AEM, instale o pacote com.adobe.granite.dispatcher.vanityurl.content na instância de publicação (consulte a nota acima).
2. Para cada URL personalizado que você configurou para uma página do AEM ou do CQ, verifique se a configuração /filter nega o URL. Se necessário, adicione um filtro que negue o URL.
3. Adicione a seção /vanity_urls abaixo de /farms.
4. Reinicie o Apache Web Server.

Encaminhamento de solicitações de sindicalização - /propagateSyndPost

Normalmente, as solicitações de sindicalização são destinadas apenas ao Dispatcher, de modo que, por padrão, não são enviadas ao renderizador (por exemplo, uma instância do AEM).

Se necessário, defina a propriedade /propagateSyndPost como "1" para encaminhar solicitações de sindicalização ao Dispatcher. Se definido, você deve garantir que as solicitações POST não sejam negadas na seção de filtro.

Configuração do cache do Dispatcher - /cache

A seção /cache controla como o Dispatcher armazena documentos em cache. Configure várias subpropriedades para implementar suas estratégias de armazenamento em cache:

• /docroot
• /statfile
• /serveStaleOnError
• /allowAuthorized
• /rules
• /statfileslevel
• /invalidate
• /invalidateHandler
• /allowedClients
• /ignoreUrlParams
• /headers
• /mode
• /gracePeriod
• /enableTTL

Um exemplo de seção de cache pode se parecer como o seguinte:

/cache
  {
  /docroot "/opt/dispatcher/cache"
  /statfile  "/tmp/dispatcher-website.stat"
  /allowAuthorized "0"

  /rules
    {
    # List of files that are cached
    }

  /invalidate
    {
    # List of files that are auto-invalidated
    }
  }

Especificação do diretório de cache

A propriedade /docroot identifica o diretório em que os arquivos em cache são armazenados.

Se você usar vários farms, cada farm deverá usar uma raiz de documento diferente.

Nomenclatura do arquivo de status

A propriedade /statfile identifica o arquivo a ser usado como o arquivo de status. O Dispatcher usa esse arquivo para registrar a hora da atualização de conteúdo mais recente. O arquivo de status pode ser qualquer arquivo no servidor Web.

O arquivo de status não tem conteúdo. Quando o conteúdo é atualizado, o Dispatcher atualiza o carimbo de data e hora. O arquivo de status padrão é nomeado como .stat e armazenado no docroot. O Dispatcher bloqueia o acesso ao arquivo.

Entrega de documentos obsoletos em caso de erros

A propriedade /serveStaleOnError controla se o Dispatcher retorna documentos invalidados quando o servidor de renderização retorna um erro. Por padrão, quando um arquivo de status é tocado e invalida o conteúdo em cache, o Dispatcher exclui o conteúdo em cache na próxima vez que for solicitado.

Se /serveStaleOnError estiver definido como "1", o Dispatcher não excluirá o conteúdo invalidado do cache, a menos que o servidor de renderização retorne uma resposta bem-sucedida. Uma resposta 5xx do AEM ou um tempo limite de conexão faz com que o Dispatcher forneça o conteúdo desatualizado e responda com e o Status HTTP de 111 (Falha na revalidação).

Armazenamento em cache quando a autenticação é usada

A propriedade /allowAuthorized controla se as solicitações que contêm qualquer uma das seguintes informações de autenticação são armazenadas em cache:

• O cabeçalho authorization
• Um cookie chamado authorization
• Um cookie chamado login-token

Por padrão, as solicitações que incluem essas informações de autenticação não são armazenadas em cache porque a autenticação não é executada quando um documento em cache é retornado ao cliente. Essa configuração impede que o Dispatcher forneça documentos em cache para usuários que não têm os direitos necessários.

No entanto, se seus requisitos permitirem o armazenamento em cache de documentos autenticados, defina /allowAuthorized como um:

/allowAuthorized "1"

Especificação de documentos a serem armazenados em cache

A propriedade /rules controla quais documentos são armazenados em cache de acordo com o caminho do documento. Independentemente da propriedade /rules, o Dispatcher nunca armazena em cache um documento nas seguintes circunstâncias:

• Se o URI da solicitação tiver um ponto de interrogação (?).

  • Isso geralmente indica uma página dinâmica, como um resultado de pesquisa, que não precisa ser armazenado em cache.

• A extensão do arquivo está ausente.

  • O servidor Web precisa da extensão para determinar o tipo de documento (o tipo MIME).

• O cabeçalho de autenticação está definido (isso pode ser configurado).

• Se a instância do AEM responder com os seguintes cabeçalhos:

  • no-cache
  • no-store
  • must-revalidate

Cada item na propriedade /rules inclui um padrão glob e um tipo:

• O padrão glob é usado para corresponder ao caminho do documento.
• O tipo indica se os documentos que correspondem ao padrão glob devem ser armazenados em cache. O valor pode ser permitir (para armazenar o documento em cache) ou negar (para sempre renderizar o documento).

Se você não tiver páginas dinâmicas (além das já excluídas pelas regras acima), poderá configurar o Dispatcher para armazenar tudo em cache. A seção de regras para isso se parece com o seguinte:

/rules
  {
    /0000  {  /glob "*"   /type "allow" }
  }

Para obter informações sobre propriedades glob, consulte Criação de padrões para propriedades glob.

Se houver seções na sua página que sejam dinâmicas (por exemplo, um aplicativo de notícias) ou em um grupo fechado de usuários, você poderá definir exceções:

/rules
  {
   /0000  { /glob "*" /type "allow" }
   /0001  { /glob "/en/news/*" /type "deny" }
   /0002  { /glob "*/private/*" /type "deny"  }
  }

Compactação

Nos servidores Web Apache, é possível compactar os documentos em cache. A compactação permite que o Apache retorne o documento em formato compactado, se solicitado pelo cliente. A compactação é feita automaticamente ao habilitar o módulo Apache mod_deflate, por exemplo:

AddOutputFilterByType DEFLATE text/plain

O módulo é instalado por padrão com o Apache 2.x.

Invalidação de arquivos por nível de pasta

Use a propriedade /statfileslevel para invalidar arquivos em cache de acordo com o caminho de cada um deles:

• O Dispatcher cria arquivos .stat em cada pasta da pasta docroot para o nível especificado. A pasta docroot é de nível 0.

• Os arquivos são invalidados ao tocar no arquivo .stat. A data da última modificação do arquivo .stat é comparada com a data da última modificação de um documento em cache. O documento será recuperado se o arquivo .stat for mais recente.

• Quando um arquivo localizado em um determinado nível é invalidado, todos os arquivos todos os arquivos .stat, desde o docroot até o nível do arquivo invalidado ou o statsfilevel configurado (o que for menor), serão tocados.

  • Por exemplo: se você definir a propriedade statfileslevel como 6 e um arquivo for invalidado no nível 5, cada arquivo .stat, desde o docroot até o 5, será tocado. Continuando com este exemplo, se um arquivo for invalidado no nível 7, então cada arquivo .stat, desde o docroot até o 6, será tocado (desde que /statfileslevel = "6").

Somente os recursos no caminho para o arquivo invalidado são afetados. Considere o exemplo a seguir: um site usa a estrutura /content/myWebsite/xx/. Se você definir statfileslevel como 3, um arquivo .stat será criado da seguinte maneira:

• docroot
• /content
• /content/myWebsite
• /content/myWebsite/*xx*

Quando um arquivo em /content/myWebsite/xx é invalidado, cada arquivo .stat, de docroot para baixo até /content/myWebsite/xx, é tocado. Esse seria o caso somente para /content/myWebsite/xx e não, por exemplo, para /content/myWebsite/yy ou /content/anotherWebSite.

Invalidação automática de arquivos em cache

A propriedade /invalidate define os documentos que são invalidados automaticamente quando o conteúdo é atualizado.

Com a invalidação automática, o Dispatcher não exclui arquivos em cache após uma atualização de conteúdo, mas verifica a validade deles na próxima vez que forem solicitados. Os documentos no cache que não forem invalidados automaticamente permanecerão no cache até que uma atualização de conteúdo os exclua explicitamente.

A invalidação automática geralmente é usada para páginas HTML. As páginas HTML geralmente contêm links para outras páginas, o que torna difícil determinar se uma atualização de conteúdo afeta uma página. Para garantir que todas as páginas relevantes sejam invalidadas quando o conteúdo for atualizado, invalide automaticamente todas as páginas HTML. A configuração a seguir invalida todas as páginas HTML:

  /invalidate
  {
   /0000  { /glob "*" /type "deny" }
   /0001  { /glob "*.html" /type "allow" }
  }

Para obter informações sobre propriedades glob, consulte Criação de padrões para propriedades glob.

Essa configuração causa a seguinte atividade quando /content/wknd/us/en é ativado:

• Todos os arquivos com padrão en.* são removidos da pasta /content/wknd/us.
• A pasta /content/wknd/us/en./_jcr_content é removida.
• Todos os outros arquivos que correspondem à configuração /invalidate não são excluídos imediatamente. Esses arquivos são excluídos quando ocorre a próxima solicitação. No nosso exemplo, /content/wknd.html não é excluído. Ele será excluído quando /content/wknd.html for solicitado.

Se você oferecer arquivos PDF e ZIP gerados automaticamente para download, também pode ser necessário invalidar automaticamente esses arquivos. Um exemplo de configuração como esta seria o seguinte:

/invalidate
  {
   /0000 { /glob "*" /type "deny" }
   /0001 { /glob "*.html" /type "allow" }
   /0002 { /glob "*.zip" /type "allow" }
   /0003 { /glob "*.pdf" /type "allow" }
  }

A integração do AEM com o Adobe Analytics fornece dados de configuração em um arquivo analytics.sitecatalyst.js em seu site. O arquivo de exemplo dispatcher.any fornecido com o Dispatcher inclui a seguinte regra de invalidação para esse arquivo:

{
   /glob "*/analytics.sitecatalyst.js"  /type "allow"
}

Uso de scripts de invalidação personalizados

A propriedade /invalidateHandler permite definir um script que seja chamado para cada solicitação de invalidação recebida pelo Dispatcher.

Ele é chamado com os seguintes argumentos:

• Handle - O caminho do conteúdo que é invalidado
• Action - A ação de replicação (por exemplo, Ativar, Desativar)
• Action Scope - O escopo da ação de replicação (vazio, a menos que um cabeçalho CQ-Action-Scope: ResourceOnly seja enviado. Consulte Invalidação de páginas em cache do AEM para obter detalhes)

Isso pode ser usado para abranger vários casos de uso diferentes, como invalidar outros caches específicos do aplicativo, ou para lidar com casos em que o URL externo de uma página e seu local na raiz não correspondam ao caminho de conteúdo.

O exemplo de script abaixo registra cada solicitação de invalidação em um arquivo.

/invalidateHandler "/opt/dispatcher/scripts/invalidate.sh"

Exemplo de script de manipulador de invalidação

#!/bin/bash

printf "%-15s: %s %s" $1 $2 $3>> /opt/dispatcher/logs/invalidate.log

Limitação de clientes que podem liberar o cache

A propriedade /allowedClients define clientes específicos que têm permissão para liberar o cache. Os padrões do recurso de curinga são comparados com o IP.

O exemplo a seguir:

1. nega acesso a qualquer cliente
2. permite explicitamente o acesso ao host local

/allowedClients
  {
   /0001 { /glob "*.*.*.*"  /type "deny" }
   /0002 { /glob "127.0.0.1" /type "allow" }
  }

Para obter informações sobre propriedades glob, consulte Criação de padrões para propriedades glob.

Ignorar parâmetros de URL

A seção ignoreUrlParams define quais parâmetros de URL são ignorados ao determinar se uma página é armazenada em cache ou entregue do cache:

• Quando um URL de solicitação contém parâmetros que são ignorados, a página é armazenada em cache.
• Quando um URL de solicitação contém um ou mais parâmetros que não são ignorados, a página não é armazenada em cache.

Quando um parâmetro é ignorado para uma página, ela é armazenada em cache na primeira vez que a página é solicitada. As solicitações subsequentes da página são enviadas para a página em cache, independentemente do valor do parâmetro na solicitação.

Para especificar quais parâmetros são ignorados, adicione regras glob à propriedade ignoreUrlParams:

• Para armazenar em cache uma página, apesar da solicitação que contém um parâmetro de URL, crie uma propriedade glob que permita o parâmetro (a ser ignorado).
• Para evitar que a página seja armazenada em cache, crie uma propriedade glob que negue o parâmetro (a ser ignorado).

O exemplo a seguir faz com que o Dispatcher ignore todos os parâmetros, exceto o parâmetro nocache. Sendo assim, URLs de solicitação que incluam o parâmetro nocache nunca serão armazenadas em cache pelo Dispatcher:

/ignoreUrlParams
{
    # allow-the-url-parameter-nocache-to-bypass-dispatcher-on-every-request
    /0001 { /glob "nocache" /type "deny" }
    # all-other-url-parameters-are-ignored-by-dispatcher-and-requests-are-cached
    /0002 { /glob "*" /type "allow" }
}

No contexto do exemplo da configuração ignoreUrlParams acima, a seguinte solicitação HTTP faz com que a página seja armazenada em cache porque o parâmetro willbecached é ignorado:

GET /mypage.html?willbecached=true

Usando a configuração ignoreUrlParams como exemplo, a seguinte solicitação HTTP faz com que a página não seja armazenada em cache porque o parâmetro nocache não é ignorado:

GET /mypage.html?nocache=true
GET /mypage.html?nocache=true&willbecached=true

Para obter informações sobre propriedades glob, consulte Criação de padrões para propriedades glob.

Armazenamento em cache de cabeçalhos de resposta HTTP

A propriedade /headers permite definir os tipos de cabeçalho HTTP que serão armazenados em cache pelo Dispatcher. Na primeira solicitação para um recurso não armazenado em cache, todos os cabeçalhos que correspondem a um dos valores configurados (consulte a amostra de configuração abaixo) são armazenados em um arquivo separado, ao lado do arquivo de cache. Em solicitações subsequentes do recurso em cache, os cabeçalhos armazenados são adicionados à resposta.

Veja abaixo um exemplo da configuração padrão:

/cache {
  ...
  /headers {
    "Cache-Control"
    "Content-Disposition"
    "Content-Type"
    "Expires"
    "Last-Modified"
    "X-Content-Type-Options"
    "Last-Modified"
  }
}

FileETag none

Permissões de arquivos de cache do Dispatcher

A propriedade mode especifica que permissões de arquivos são aplicadas a novos diretórios e arquivos no cache. Essa configuração é restrita pelo umask do processo de chamada. É um número octal construído a partir da soma de um ou mais dos seguintes valores:

• 0400 Permitir leitura pelo proprietário.
• 0200 Permitir gravação pelo proprietário.
• 0100 Permitir que o proprietário pesquise em diretórios.
• 0040 Permitir leitura pelos membros do grupo.
• 0020 Permitir gravação pelos membros do grupo.
• 0010 Permitir que membros do grupo pesquisem no diretório.
• 0004 Permitir leitura por outros.
• 0002 Permitir gravação por outros.
• 0001 Permitir que outras pessoas pesquisem no diretório.

O valor padrão é 0755, que permite que o proprietário leia, grave ou pesquise, e o grupo e outros leiam ou pesquisem.

Limitação de toque do arquivo .stat

Com a propriedade /invalidate padrão, cada ativação invalida efetivamente todos os arquivos .html (quando o caminho de cada um deles corresponde à seção /invalidate). Em um site com tráfego considerável, várias ativações subsequentes aumentarão a carga da cpu no back-end. Nesse cenário, seria desejável “limitar” o toque ao arquivo .stat para manter o site responsivo. Você pode fazer isso usando a propriedade /gracePeriod.

A propriedade /gracePeriod define o número de segundos em que um recurso obsoleto e invalidado automaticamente ainda pode ser enviado do cache após a última ativação. A propriedade pode ser usada em uma configuração em que um lote de ativações invalidaria repetidamente todo o cache. O valor recomendado é de 2 segundos.

Para obter detalhes adicionais, leia também as seções /invalidate e /statfileslevel acima.

Configuração da invalidação de cache baseada em tempo - /enableTTL

Se definida para 1 (/enableTTL "1"), a propriedade /enableTTL avaliará os cabeçalhos de resposta do back-end e, se eles tiverem um max-age de Cache-Control ou data de Expires, um arquivo auxiliar e vazio ao lado do arquivo de cache será criado, com o tempo de modificação igual à data de expiração. Quando o arquivo em cache é solicitado depois do tempo de modificação, ele é automaticamente solicitado outra vez no back-end.

Configuração do balanceamento de carga - /statistics

A seção /statistics define categorias de arquivos para as quais o Dispatcher classifica a capacidade de resposta de cada renderização. O Dispatcher usa as pontuações para determinar qual renderizador enviará uma solicitação.

Cada categoria criada define um padrão glob. O Dispatcher compara o URI do conteúdo solicitado a esses padrões para determinar a categoria do conteúdo solicitado:

• A ordem das categorias determina a ordem em que são comparadas ao URI.
• O primeiro padrão de categoria que corresponde ao URI é a categoria do arquivo. Não são avaliados mais padrões de categoria.

O Dispatcher oferece suporte a no máximo 8 categorias de estatísticas. Se você definir mais de 8 categorias, somente as primeiras 8 serão usadas.

Seleção de renderizador

Sempre que o Dispatcher exigir uma página renderizada, ele usa o seguinte algoritmo para selecionar o renderizador:

1. Se a solicitação tiver o nome do renderizador em um cookie renderid, o Dispatcher usará esse renderizador.

2. Se a solicitação não incluir o cookie renderid, o Dispatcher compara as estatísticas de renderização:

   1. O Dispatcher determina a categoria do URI da solicitação.
   2. O Dispatcher determina qual renderizador tem a pontuação de resposta mais baixa para essa categoria e seleciona esse renderizador.

3. Se nenhum renderizador ainda não estiver selecionado, use o primeiro renderizador da lista.

A pontuação para uma categoria de renderizador é baseada em tempos de resposta anteriores, bem como em conexões com falha e sucesso anteriores de tentativas do Dispatcher. Para cada tentativa, a pontuação para a categoria do URI solicitado é atualizada.

Definição de categorias de estatísticas

Defina uma categoria para cada tipo de documento para o qual deseja manter estatísticas para a seleção de renderizador. A seção /statistics contém uma seção /categories. Para definir uma categoria, adicione uma linha abaixo da seção /categories que tenha o seguinte formato:

/name { /glob "pattern"}

A categoria name deve ser exclusiva do farm. O pattern é descrito na seção Criação de padrões para propriedades glob.

Para determinar a categoria de um URI, o Dispatcher compara o URI com cada padrão de categoria até que uma correspondência seja encontrada. O Dispatcher começa com a primeira categoria na lista e continua nessa ordem. Portanto, coloque primeiro as categorias com padrões mais específicos.

Por exemplo, no arquivo padrão dispatcher.any, o Dispatcher define uma categoria HTML, e depois outras categorias. A categoria HTML é mais específica, portanto, aparece primeiro:

/statistics
  {
  /categories
    {
      /html { /glob "*.html" }
      /others  { /glob "*" }
    }
  }

O exemplo a seguir também inclui uma categoria para páginas de pesquisa:

/statistics
  {
  /categories
    {
      /search { /glob "*search.html" }
      /html { /glob "*.html" }
      /others  { /glob "*" }
    }
  }

Indisponibilidade do servidor refletida nas estatísticas do Dispatcher

A propriedade /unavailablePenalty define o tempo (em décimos de segundos) que é aplicado às estatísticas de renderização quando uma conexão com a renderização falha. O Dispatcher adiciona o tempo à categoria de estatísticas que corresponde ao URI solicitado.

Por exemplo, a penalidade é aplicada quando a conexão TCP/IP com o nome de host/porta designado não pode ser estabelecida, seja porque o AEM não está sendo executado (nem acompanhando) ou devido a um problema relacionado à rede.

A propriedade /unavailablePenalty é um filho direto da seção /farm (um irmão da seção /statistics).

Se nenhuma propriedade /unavailablePenalty existir, um valor "1" será usado.

/unavailablePenalty "1"

Identificação de uma pasta de conexão adesiva - /stickyConnectionsFor

A propriedade /stickyConnectionsFor define uma pasta que contém documentos fixos, que será acessada usando o URL. O Dispatcher envia todas as solicitações, de um único usuário, que estão nessa pasta, para a mesma instância de renderização. As conexões adesivas garantem que os dados da sessão estejam presentes e sejam consistentes para todos os documentos. Esse mecanismo usa o cookie renderid.

O exemplo a seguir define uma conexão adesiva à pasta /products:

/stickyConnectionsFor "/products"

Quando uma página é composta de conteúdo de vários nós de conteúdo, inclua a propriedade /paths, que lista os caminhos para o conteúdo. Por exemplo, uma página trm conteúdo de /content/image, /content/video e /var/files/pdfs. A seguinte configuração ativa conexões adesivas para todo o conteúdo da página:

/stickyConnections {
  /paths {
    "/content/image"
    "/content/video"
    "/var/files/pdfs"
  }
}

httpOnly

Quando conexões adesivas são ativadas, o módulo Dispatcher define o cookie renderid. Este cookie não tem o sinalizador httponly, que deve ser adicionado para melhorar a segurança. Você pode fazer isso definindo a propriedade httpOnly no nó /stickyConnections de um arquivo de configuração dispatcher.any. O valor da propriedade ( 0 ou 1) define se o cookie renderid tem o atributo HttpOnly anexado. O valor padrão é 0, o que significa que o atributo não será adicionado.

Para obter informações adicionais sobre o sinalizador httponly, leia esta página.

segurança

Quando conexões adesivas são ativadas, o módulo Dispatcher define o cookie renderid. Este cookie não tem o sinalizador secure, que deve ser adicionado para melhorar a segurança. Você pode fazer isso definindo a propriedade secure no nó /stickyConnections de um arquivo de configuração dispatcher.any. O valor da propriedade ( 0 ou 1) define se o cookie renderid tem o atributo secure anexado. O valor padrão é 0, o que significa que o atributo será adicionado se a solicitação recebida estiver segura. Se o valor for definido como 1, o sinalizador de segurança será adicionado independentemente da solicitação de entrada ser segura ou não.

Lidar com erros de conexão de renderização

Configure o comportamento do Dispatcher quando o servidor de renderização retornar um erro 500 ou estiver indisponível.

Especificação de uma página de verificação de integridade

Use a propriedade /health_check para especificar um URL que é verificado quando ocorre um código de status 500. Se essa página também retornar um código de status 500, a instância será considerada indisponível e uma sanção de tempo configurável ( /unavailablePenalty) será aplicada à renderização antes de uma nova tentativa.

/health_check
  {
  # Page gets contacted when an instance returns a 500
  /url "/health_check.html"
  }

Especificação do atraso de repetição de página

A propriedade /retryDelay define o tempo (em segundos) que o Dispatcher aguarda entre rodadas de tentativas de conexão com os renderizadores do farm. Para cada rodada, o número máximo de vezes que o Dispatcher tenta uma conexão com um renderizador é o número de renderizações no farm.

O Dispatcher usa um valor "1" se /retryDelay não estiver explicitamente definido. O valor padrão é apropriado na maioria dos casos.

/retryDelay "1"

Configuração do número de tentativas

A propriedade /numberOfRetries define o número máximo de rodadas de tentativas de conexão executadas pelo Dispatcher com os renderizadores. Se o Dispatcher não conseguir se conectar com êxito a um renderizador após esse número de tentativas, ele retornará uma resposta com falha.

Para cada rodada, o número máximo de vezes que o Dispatcher tenta uma conexão com um renderizador é o número de renderizações no farm. Portanto, o número máximo de vezes que o Dispatcher tenta uma conexão é ( /numberOfRetries) x (o número de renderizadores).

Se o valor não estiver definido explicitamente, o valor padrão será 5.

/numberOfRetries "5"

Utilização do mecanismo de failover

Ative o mecanismo de failover no farm do Dispatcher para reenviar solicitações a renderizadores diferentes quando a solicitação original falhar. Quando o failover é ativado, o Dispatcher apresenta o seguinte comportamento:

• Quando uma solicitação para um renderizador retorna o status HTTP 503 (INDISPONÍVEL), o Dispatcher envia a solicitação para um renderizador diferente.
• Quando uma solicitação para um renderizador retorna o status HTTP 50x (diferente de 503), o Dispatcher envia uma solicitação para a página configurada para a propriedade health_check.
  • Se a verificação de integridade retornar 500 (INTERNAL_SERVER_ERROR), o Dispatcher enviará a solicitação original para um renderizador diferente.
  • Se a verificação de integridade retornar o status HTTP 200, o Dispatcher retornará o erro inicial HTTP 500 ao cliente.

Para habilitar o failover, adicione a seguinte linha no farm (ou site):

/failover "1"

Erros de Interrupção ignorados - /ignoreEINTR

Qualquer chamada de sistema orientada pelo sistema de arquivos pode ser interrompida EINTR se o objeto da chamada do sistema estiver localizado em um sistema remoto acessado via NFS. O fato de essas chamadas do sistema expirarem ou serem interrompidas se baseia em como o sistema de arquivos subjacente foi montado no computador local.

Use o parâmetro /ignoreEINTR se a instância tiver essa configuração e o log tiver a seguinte mensagem:

Error while reading response: Interrupted system call

Internamente, o Dispatcher lê a resposta do servidor remoto (ou seja, do AEM) usando um loop que pode ser representado como:

while (response not finished) {
read more data
}

Essas mensagens podem ser geradas quando o EINTR ocorrer na seção " read more data" e são causadas pela recepção de um sinal antes de quaisquer dados serem recebidos.

Para ignorar essas interrupções, você pode adicionar o seguinte parâmetro a dispatcher.any (antes de /farms):

/ignoreEINTR "1"

Configurar /ignoreEINTR como "1" faz com que o Dispatcher continue tentando ler os dados até que a resposta completa seja lida. O valor padrão é 0 e desativa a opção.

Criação de padrões para propriedades glob

Várias seções no arquivo de configuração do Dispatcher usam propriedades glob como critérios de seleção para solicitações de clientes. Os valores das propriedades glob são padrões que o Dispatcher compara a um aspecto da solicitação, como o caminho do recurso solicitado ou o endereço IP do cliente. Por exemplo, os itens na seção /filter usam os padrões glob para identificar os caminhos das páginas em que o Dispatcher atua ou rejeita.

Os valores glob podem incluir caracteres curingas e caracteres alfanuméricos para definir o padrão.

Logs

Na configuração do servidor Web, é possível definir:

• O local do arquivo de log do Dispatcher.
• O nível de log.

Consulte a documentação do servidor Web e o arquivo readme da instância do Dispatcher para obter mais informações.

Logs rotacionados/canalizados do Apache

Se estiver usando um servidor Web Apache, você pode usar a funcionalidade padrão para logs rotacionados e/ou canalizados. Por exemplo, usando logs canalizados:

DispatcherLog "| /usr/apache/bin/rotatelogs logs/dispatcher.log%Y%m%d 604800"

Ele girará automaticamente:

• o arquivo de log do Dispatcher; com um carimbo de data e hora na extensão (logs/dispatcher.log%Y%m%d).
• semanalmente (60 x 60 x 24 x 7 = 604.800 segundos).

Consulte a documentação do Apache Web Server sobre Rotação de logs e logs canalizados. Por exemplo Apache 2.4.

Registro de rastreamento

Entre outros aprimoramentos para o Dispatcher, a versão 4.2.0 também introduz o Registro de rastreamento.

Está em um nível superior ao do Registro de depuração, mostrando informações adicionais nos logs. Ele adiciona registro para:

• Os valores dos cabeçalhos encaminhados;
• A regra que está sendo aplicada para uma determinada ação.

Você pode ativar o Registro de rastreamento definindo o nível de log como 4 em seu servidor Web.

Veja abaixo um exemplo de logs com rastreamento ativado:

[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[Host] = "localhost:8443"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[User-Agent] = "curl/7.43.0"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[Accept] = "*/*"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-SSL-Client-Cert] = "(null)"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[Via] = "1.1 localhost:8443 (dispatcher)"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-For] = "::1"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-SSL] = "on"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-SSL-Cipher] = "DHE-RSA-AES256-SHA"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-SSL-Session-ID] = "ba931f5e4925c2dde572d766fdd436375e15a0fd24577b91f4a4d51232a934ae"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-Port] = "8443"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[Server-Agent] = "Communique-Dispatcher"

E um evento registrado quando um arquivo que corresponde a uma regra de bloqueio é solicitado:

[Thu Mar 03 14:42:45 2016] [T] [11831] 'GET /content.infinity.json HTTP/1.1' was blocked because of /0082

Confirmação da operação básica

Para confirmar a operação básica e a interação do servidor Web, do Dispatcher e da instância do AEM, você pode usar as seguintes etapas:

1. Defina o loglevel como 3.

2. Iniciar o servidor Web; também inicia o Dispatcher.

3. Inicie a instância do AEM.

4. Verifique os arquivos de log e de erro do servidor Web e do Dispatcher.

   • Dependendo do servidor Web, você deve ver mensagens como:
     • [Thu May 30 05:16:36 2002] [notice] Apache/2.0.50 (Unix) configured e
     • [Fri Jan 19 17:22:16 2001] [I] [19096] Dispatcher initialized (build XXXX)

5. Navegue pelo site por meio do servidor Web. Confirme se o conteúdo está sendo exibido conforme exigido.
   Por exemplo, em uma instalação local em que o AEM é executado na porta 4502 e o servidor Web em 80 acesse o console Webites usando:

   • https://localhost:4502/libs/wcm/core/content/siteadmin.html
   • https://localhost:80/libs/wcm/core/content/siteadmin.html
   • Os resultados devem ser idênticos. Confirme o acesso a outras páginas com o mesmo mecanismo.

6. Verifique se o diretório de cache está sendo preenchido.

7. Ative uma página para verificar se o cache está sendo liberado corretamente.

8. Se tudo estiver funcionando corretamente, você poderá reduzir o loglevel para 0.

Uso de vários Dispatchers

Em configurações complexas, você pode usar vários Dispatchers. Por exemplo, você pode usar:

• um Dispatcher para publicar um site na Intranet
• um segundo Dispatcher, em um endereço diferente e com configurações de segurança diferentes, para publicar o mesmo conteúdo na Internet.

Nesse caso, verifique se cada solicitação passa por apenas um Dispatcher. Um Dispatcher não lida com solicitações provenientes de outro Dispatcher. Portanto, verifique se ambos os Dispatchers acessam o site do AEM diretamente.

Depuração

Ao adicionar o cabeçalho X-Dispatcher-Info a uma solicitação, o Dispatcher responde se o destino foi armazenado em cache, retornado do armazenamento em cache ou não armazenável em cache. O cabeçalho de resposta X-Cache-Info contém essas informações em um formulário legível. Você pode usar esses cabeçalhos de resposta para depurar problemas envolvendo respostas armazenadas em cache pelo Dispatcher.

Essa funcionalidade não está habilitada por padrão, portanto, para que o cabeçalho de resposta X-Cache-Info seja incluído, o farm deve conter a seguinte entrada:

/info "1"

Por exemplo,

/farm
{
    /mywebsite
    {
        # Include X-Cache-Info response header if X-Dispatcher-Info is in request header
        /info "1"
    }
}

Além disso, o cabeçalho X-Dispatcher-Info não precisa de um valor, mas, se você usar curl para testes, deverá fornecer um valor para enviar o cabeçalho, como:

curl -v -H "X-Dispatcher-Info: true" https://localhost/content/wknd/us/en.html

Veja abaixo uma lista contendo os cabeçalhos de resposta que X-Dispatcher-Info retornará:

• em cache
  O arquivo de destino está contido no cache e o Dispatcher determinou que é válido entregá-lo.
• armazenamento em cache
  O arquivo de destino não está contido no cache e o Dispatcher determinou que é válido armazenar a saída em cache e entregá-la.
• armazenamento em cache: o arquivo de status é mais recente
  O arquivo de destino está contido no cache, no entanto, ele é invalidado por um arquivo de status mais recente. O Dispatcher excluirá o arquivo de destino, recriará o arquivo a partir da saída e o entregará.
• não armazenável em cache: nenhuma raiz do documento
  A configuração do farm não contém uma raiz do documento (elemento de configuração
  cache.docroot).
• não armazenável em cache: caminho do arquivo de cache muito longo
  O arquivo de destino - a concatenação da raiz do documento e do arquivo de URL - excede o maior nome de arquivo possível no sistema.
• não armazenável em cache: caminho de arquivo temporário muito longo
  O modelo de nome de arquivo temporário excede o nome de arquivo mais longo possível no sistema. O Dispatcher cria um arquivo temporário primeiro, antes de realmente criar ou substituir o arquivo em cache. O nome de arquivo temporário é o nome de arquivo de destino com os caracteres _YYYYXXXXXX anexados a ele, em que Y e X serão substituídos para criar um nome exclusivo.
• não armazenável em cache: o URL da solicitação não tem extensão
  O URL da solicitação não tem extensão ou há um caminho após a extensão de arquivo, por exemplo: /test.html/a/path.
• não armazenável em cache: a solicitação não era um GET ou HEAD
  O método HTTP não é um GET nem um HEAD. O Dispatcher presume que a saída conterá dados dinâmicos que não devem ser armazenados em cache.
• não armazenável em cache: a solicitação continha uma cadeia de caracteres de consulta
  A solicitação continha uma cadeia de caracteres de consulta. O Dispatcher presume que a saída depende da cadeia de caracteres de consulta fornecida e, portanto, não armazena em cache.
• não armazenável em cache: o gerenciador de sessão não autenticou
  O cache do farm é regido por um gerenciador de sessão (a configuração contém um nó sessionmanagement) e a solicitação não continha as informações de autenticação apropriadas.
• não armazenável em cache: a solicitação contém autorização
  O farm não tem permissão para armazenar em cache a saída ( allowAuthorized 0) e a solicitação contém informações de autenticação.
• não armazenável em cache: o destino é um diretório
  O arquivo de destino é um diretório. Pode apontar para algum erro conceitual, em que um URL e algum sub-URL contêm saída em cache, por exemplo, se uma solicitação para /test.html/a/file.ext vem primeiro e contém saída em cache, o Dispatcher não poderá armazenar a saída de uma solicitação subsequente em /test.html.
• não armazenável em cache: o URL de solicitação tem uma barra à direita
  O URL da solicitação tem uma barra à direita.
• não armazenável em cache: o URL de solicitação não está nas regras de cache
  As regras de cache do farm negam explicitamente o armazenamento em cache da saída de algum URL de solicitação.
• não armazenável em cache: acesso negado pelo verificador de autorização
  O verificador de autorização do farm negou acesso ao arquivo armazenado em cache.
• não armazenável em cache: sessão não válida
  O cache do farm é controlado por um gerenciador de sessão (a configuração contém um nó sessionmanagement) e a sessão do usuário não é válida ou não é mais válida.
• não armazenável em cache: a resposta contémno_cache
  o servidor remoto retornou um cabeçalho
  cabeçalho Dispatcher: no_cache, proibindo o Dispatcher de armazenar a saída em cache.
• não armazenável em cache: o comprimento do conteúdo da resposta é zero
  O comprimento do conteúdo da resposta é zero; o Dispatcher não criará um arquivo de comprimento zero.

Recursos do Business.Adobe.com

Ecommerce Integrations Content Insights Style System Personalized Experiences Content Intelligence Embedded Charts