Configurando o 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 de valor único ou valores múltiplos que controlam o comportamento do Dispatcher:

• Os nomes de propriedades recebem o prefixo de uma barra /.
• As propriedades de vários valores incluem itens filhos 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, você poderá dividi-lo em vários arquivos menores (que são mais fáceis de gerenciar) e incluí-los.
• Para incluir arquivos que são gerados automaticamente.

Por exemplo, para incluir o arquivo myFarm.any na configuração /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 farm de um a cinco, você poderá incluí-los da seguinte maneira:

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

Usando variáveis de Ambiente

Você pode usar variáveis de ambiente em propriedades com valores de sequência 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 diretório de 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 AEM, a seguinte configuração da propriedade /renders poderá ser usada:

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

Nomear a Instância do Dispatcher

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

Definindo Farms

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

• Use um único farm quando quiser que o Dispatcher manipule todas as suas páginas da Web ou sites da mesma maneira.
• Crie vários farm quando diferentes áreas do 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 filho à 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 AEM instâncias de publicação) a serem usados para renderizar documentos.
• As estatísticas a serem usadas para o balanceamento de carga de vários renderizadores de documento.
• Vários outros comportamentos, como quais arquivos serão armazenados em cache e onde.

O valor pode ter qualquer caractere alfanumérico (a-z, 0-9). O exemplo a seguir mostra a definição do esqueleto para duas fazendas chamadas /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:

Especificar uma página padrão (somente IIS) - /homepage

Especificação dos cabeçalhos HTTP a serem passados

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 AEM).

Por padrão, o Dispatcher encaminha os cabeçalhos HTTP padrão para a instância AEM. Em alguns casos, talvez você queira encaminhar cabeçalhos adicionais ou remover cabeçalhos específicos:

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

Se você personalizar o conjunto de cabeçalhos para passar, deverá especificar uma lista exaustiva de cabeçalhos, incluindo aqueles normalmente 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 expedidor.

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"
  "if-match"
  "if-none-match"
  "if-range"
  "if-unmodified-since"
  "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 do 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) Ou 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 da myCompany e todos os domínios da mySubDivision:

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

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

   /virtualhosts
    {
    "*"
    }

Resolvendo o Host Virtual

Quando o Dispatcher recebe uma solicitação HTTP ou HTTPS, 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 de host, scheme e uri da solicitação é usado.
• Se nenhum valor virtualhosts tiver scheme e uri partes que correspondam a scheme e uri da solicitação, o primeiro host virtual encontrado que corresponde 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 alto do farm mais alto será usado.

Portanto, você deve colocar seu host virtual padrão na parte superior da propriedade virtualhosts no farm mais alto 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 farm 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:

Habilitar Sessões Seguras - /sessionmanagement

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

A propriedade /sessionmanagement é uma subpropriedade de /farms.

/ sessionmanagement.thas vários sub-parâmetros:

/diretory (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 HTTP ou cookie 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 ser usada por último. Se "800" não for especificado, então 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"
  }

Definindo renderizadores de página

A propriedade /renders define o URL para o qual o Dispatcher envia solicitações para renderizar um documento. A seção /renders do exemplo a seguir identifica uma única instância 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"
      }
  }

A seção exemplo/renders a seguir identifica uma instância AEM que é executada no mesmo computador que o dispatcher:

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

A seção exemplo/renderiza a seguir distribui as solicitações de renderização igualmente entre duas instâncias 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 de conexão acessando a instância AEM em milissegundos. O padrão é "0", fazendo com que o Dispatcher aguarde indefinidamente.

/receiveTimeout

Especifica o tempo, em milissegundos, que uma resposta pode levar. 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 504 (Gateway inválido) 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 possa ter 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 de 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 é 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 ao qual o Dispatcher se conecte seja aleatório.

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

/secure

Se a propriedade /secure tiver um valor de "1", o Dispatcher usará HTTPS para se comunicar com a instância 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 estiver definida, o endereço IP será armazenado em cache por padrão.

Além disso, essa propriedade pode ser usada no caso de problemas de resolução dinâmica de IP, conforme mostrado na amostra a seguir:

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

Configurando o 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 da Web com um código de erro 404 (página não encontrada). Se nenhuma seção /filter existir, todas as solicitações serão aceitas.

Observação: as solicitações para o 🔗 statfileare sempre são rejeitadas.

A seção /filter consiste em uma série de regras que negam ou permitem acesso ao conteúdo de acordo com 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 o acesso ao conteúdo, conforme necessário.

Definindo um Filtro

Cada item na seção /filter inclui um tipo e um padrão que são correspondentes a um elemento específico da linha de solicitação ou a 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, /urlou /query /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 em elementos da linha de solicitação (em vez de na linha de solicitação inteira) é o método de filtro preferencial.

• Elementos avançados da linha de solicitação: a partir do Dispatcher 4.2.0, quatro novos elementos de filtro estã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 global: A /glob propriedade é usada para corresponder a toda a linha de solicitação da solicitação HTTP.

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

O HTTP/1.1 define linha de solicitação da seguinte forma:

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

Duplo-aspas versus aspas simples

Ao criar suas regras de filtro, use aspas de duplo "pattern" para obter 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 do Dispatcher posteriores à 4.2.0, é possível incluir Expressões regulares POSIX Extended nos padrões de filtro.

Solução de problemas de Filtros

Se os filtros não estiverem acionando da maneira que você esperaria, ative Rastreamento de log no dispatcher para que você possa ver qual filtro está interceptando a solicitação.

Exemplo de filtro: Negar tudo

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

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

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

Filtros também permitem negar o 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 às páginas ASP:

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

Exemplo de filtro: Ativar solicitações de POST

O filtro de exemplo 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 de 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 sua instância de publicação usar um contexto de aplicativo da Web (por exemplo, publicar), isso 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 dentro da área restrita, você poderá permitir o 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: Usando Expressões Regulares

Esse filtro permite extensões em diretórios de conteúdo não 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 está 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)'
        /extension '(json|xml|html)'
        }

Exemplo /seção de 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, tais como desenhos 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 AEM esteja segura.

A seção /filter a seguir do arquivo dispatcher.any pode ser usada como base no arquivo de configuração Dispatcher.

Este exemplo é baseado no arquivo de configuração padrão fornecido com o Dispatcher e serve como exemplo para uso em um ambiente de produção. Os itens prefixados com # estão desativados (comentados), tenha cuidado se decidir ativar qualquer um desses itens (removendo # 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" /glob "*" }

      # 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 você 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.

• É necessário ter cuidado ao permitir o acesso aos arquivos em /libs. O acesso deve ser permitido numa base 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 do Google Gadgets:

  • /libs/opensocial/proxy*

Dependendo da sua instalação, pode haver recursos adicionais em /libs, /apps ou em qualquer outro lugar que precisam 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 sequências de caracteres de Query

Como o Dispatcher versão 4.1.5, use a seção /filter para restringir strings de query. É altamente recomendável permitir explicitamente strings de query 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 string de query a=* e nega todas as outras strings de query para URLs que são 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=*" }  
}  

Testando o Dispatcher Security

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

Observe que você deve ver a renderização de página normal 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

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

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

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

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

Ativando o acesso a URLs personalizados

Configure o Dispatcher para ativar o acesso a URLs personalizados configurados para suas páginas 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 ativar 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 as chamadas para o serviço vanity URL.

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

1. Se o serviço de renderização for uma instância 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 AEM ou 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 servidor Web Apache.

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

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

Se necessário, defina a propriedade /propagateSyndPost como "1" para encaminhar solicitações de sindicalização ao Dispatcher. Se estiver definido, verifique se as solicitações de POST não foram 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 cache:

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

Uma seção de cache de exemplo pode ter a seguinte aparência:

/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 onde os arquivos em cache são armazenados.

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

Como nomear o 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 da 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 é chamado de .stat e é armazenado no ponto. O Dispatcher bloqueia o acesso ao arquivo de status.

Servindo Documentos obsoletos quando ocorrem 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 de AEM ou um tempo limite de conexão faz com que o Dispatcher sirva o conteúdo desatualizado e responda com o Status HTTP 111 (Falha na Revalidação).

Armazenamento em Cache Quando a Autenticação for 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 disponibilize documentos em cache para usuários que não tenham 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 dos Documentos para 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 um documento em cache nas seguintes circunstâncias:

• Se o URI da solicitação contiver 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 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 daquelas já excluídas pelas regras acima), poderá configurar o Dispatcher para armazenar tudo em cache. A seção de regras para isso é a seguinte:

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

Para obter mais informações sobre propriedades globais, consulte Criar padrões para propriedades globais.

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

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

Compactação

Em servidores da Web Apache, é possível compactar os documentos em cache. A compactação permite que o Apache devolva o documento em um formulário 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.

Invalidando arquivos pelo nível de pasta

Use a propriedade /statfileslevel para invalidar arquivos em cache de acordo com seu caminho:

• O Dispatcher cria .statarquivos em cada pasta a partir da pasta de ponto até o nível especificado. A pasta docroot é do nível 0.

• Os arquivos são invalidados tocando no arquivo .stat. A última data de modificação do arquivo .stat é comparada à última data de modificação de um documento em cache. O documento será buscado novamente se o arquivo .stat for mais recente.

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

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

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

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

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

Invalidando automaticamente arquivos em cache

A propriedade /invalidate define os documentos que são automaticamente invalidados 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 sua validade 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. Geralmente, as páginas HTML contêm links para outras páginas, tornando 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 mais informações sobre propriedades globais, consulte Criar padrões para propriedades globais.

Essa configuração gera 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 foi removida.
• Todos os outros arquivos que correspondem à configuração /invalidate não são excluídos imediatamente. Esses arquivos são excluídos quando a próxima solicitação ocorrer. Em nosso exemplo, /content/wknd.html não é excluído, ele será excluído quando /content/wknd.html for solicitado.

Se você oferta arquivos PDF e ZIP gerados automaticamente para download, talvez seja necessário invalidá-los automaticamente também. Um exemplo de configuração é 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 AEM com a 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 este arquivo:

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

Uso de scripts de invalidação personalizados

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

É chamado com os seguintes argumentos:

• Identificador - o caminho de conteúdo que é invalidado
• Ação - a ação de replicação (por exemplo, Ativar, Desativar)
• Escopo da ação - o Escopo da ação de replicação (vazio, a menos que um cabeçalho de CQ-Action-Scope: ResourceOnly seja enviado, consulte Invalidando Páginas em Cache de AEM para obter detalhes)

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

Abaixo do exemplo, o script registra cada solicitação de invalidação em um arquivo.

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

exemplo de script do manipulador de invalidação

#!/bin/bash

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

Limitação dos clientes que podem liberar o cache

A propriedade /allowedClients define clientes específicos que podem liberar o cache. Os padrões de globalização 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 mais informações sobre propriedades globais, consulte Criar padrões para propriedades globais.

Ignorando 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 todos 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 atendidas 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 de valor global à propriedade ignoreUrlParams:

• Para ignorar um parâmetro, crie uma propriedade global que permita o parâmetro.
• Para impedir que a página seja armazenada em cache, crie uma propriedade global que negue o parâmetro.

O exemplo a seguir faz com que o Dispatcher ignore o parâmetro q, para que os URLs de solicitação que incluem o parâmetro q sejam armazenados em cache:

/ignoreUrlParams
{
    /0001 { /glob "*" /type "deny" }
    /0002 { /glob "q" /type "allow" }
}

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

GET /mypage.html?q=5

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

GET /mypage.html?q=5&p=4

Para obter mais informações sobre propriedades globais, consulte Criar padrões para propriedades globais.

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 a 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 ao recurso em cache, os cabeçalhos armazenados são adicionados à resposta.

Abaixo é apresentada uma amostra 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 Arquivo de Cache do Dispatcher

A propriedade mode especifica quais permissões de arquivo 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 por proprietário.
• 0200 Permitir gravação por proprietário.
• 0100 Permitir que o proprietário pesquise em diretórios.
• 0040 Permitir leitura por membros do grupo.
• 0020 Permitir gravação por membros do grupo.
• 0010 Permitir que os membros do grupo pesquisem no diretório.
• 0004 Permitir leitura por outras pessoas.
• 0002 Permitir a escrita de outras pessoas.
• 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 que o grupo e outros leiam ou pesquisem.

A limitar o ficheiro .stat a tocar

Com a propriedade padrão /invalidate, cada ativação invalida efetivamente todos os arquivos .html (quando seu caminho corresponde à seção /invalidate). Em um site com tráfego considerável, várias ativações subsequentes aumentarão a carga da cpu no backend. Nesse cenário, seria desejável "limitar" .stat o arquivo tocando para manter a resposta do site. Você pode fazer isso usando a propriedade /gracePeriod.

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

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

Configurando a Invalidação do Cache Baseado em Tempo - /enableTTL

Se definida, a propriedade /enableTTL avaliará os cabeçalhos de resposta do backend e, se contiverem uma data Cache-Control max-age ou Expires, um arquivo vazio e auxiliar 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 após a hora de modificação, ele é automaticamente solicitado novamente do back-end.

Configurando o balanceamento de carga - /statistics

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

Cada categoria criada define um padrão global. 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 suporta no máximo 8 categorias de estatísticas. Se você definir mais de 8 categorias, somente as primeiras 8 serão usadas.

Renderizar seleção

Sempre que o Dispatcher exigir uma página renderizada, ele usará o seguinte algoritmo para selecionar a renderização:

1. Se a solicitação contiver o nome da renderização em um cookie renderid, o Dispatcher usará essa renderização.

2. Se a solicitação não incluir 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 renderização tem a menor pontuação de resposta para essa categoria e seleciona essa renderização.

3. Se nenhuma renderização ainda estiver selecionada, use a primeira renderização na lista.

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

Definindo Categorias de Estatísticas

Defina uma categoria para cada tipo de documento para o qual você deseja manter estatísticas para a seleção de renderização. 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 está descrito na seção Criando Padrões para Propriedades.

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

Por exemplo, o Dispatcher o arquivo padrão dispatcher.any define uma categoria HTML e outra categoria. A categoria HTML é mais específica e, 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 "*" }
    }
  }

Refletindo a indisponibilidade do servidor nas estatísticas do Dispatcher

A propriedade /unavailablePenalty define a hora (em décimos de segundo) que é aplicada às estatísticas de renderização quando ocorre falha na conexão com a renderização. 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 do host/porta designada não pode ser estabelecida, porque AEM não está sendo executado (e não está 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 de "1" será usado.

/unavailablePenalty "1"

Como identificar uma pasta de conexão aderente - /stickyConnectionsFor

A propriedade /stickyConnectionsFor define uma pasta que contém documentos fixos; isso será acessado 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 consistentes para todos os documentos. Este mecanismo usa o cookie renderid.

O exemplo a seguir define uma conexão aderente com a pasta /products:

/stickyConnectionsFor "/products"

Quando uma página for 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 contém conteúdo de /content/image, /content/video e /var/files/pdfs. A configuração a seguir permite conexões aderentes para todo o conteúdo da página:

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

httpOnly

Quando as conexões aderentes estão ativadas, o módulo do 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.

secure

Quando as conexões aderentes estão ativadas, o módulo do 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 for segura. Se o valor for definido como 1, o sinalizador seguro será adicionado independentemente de a solicitação recebida ser ou não segura.

Tratamento de 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 é marcado quando um código de status 500 ocorre. Se essa página também retornar um código de status 500, a instância será considerada indisponível e uma penalidade de tempo configurável ( /unavailablePenalty) será aplicada à renderização antes de tentar novamente.

/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 as rodadas de tentativas de conexão com as renderizações do farm. Para cada rodada, o número máximo de vezes que o Dispatcher tenta uma conexão com uma renderização é o número de renderizações no farm.

O Dispatcher usa um valor de "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 que o Dispatcher executa com as renderizações. Se o Dispatcher não conseguir se conectar com êxito a uma renderização após esse número de tentativas, o Dispatcher retornará uma resposta com falha.

Para cada rodada, o número máximo de vezes que o Dispatcher tenta uma conexão com uma renderização é 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 renderizações).

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

/numberOfRetries "5"

Usando o Mecanismo de Failover

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

• Quando uma solicitação para uma renderização retorna o status HTTP 503 (INDISPONÍVEL), o Dispatcher envia a solicitação para uma renderização diferente.
• Quando uma solicitação para uma renderização 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 uma renderização diferente.
  • Se a verificação de recuperação retornar o status HTTP 200, o Dispatcher retornará o erro HTTP 500 inicial ao cliente.

Para ativar o failover, adicione a seguinte linha ao farm (ou site):

/failover "1"

Ignorando Erros de Interrupção - /ignoreEINTR

Qualquer chamada de sistema orientada para o sistema de arquivos pode ser interrompida EINTR se o objeto da chamada do sistema estiver localizado em um sistema remoto acessado via NFS. Se essas chamadas do sistema podem expirar ou ser interrompidas, isso se baseia em como o sistema de arquivos subjacente foi montado no computador local.

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

Error while reading response: Interrupted system call

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

while (response not finished) {  
read more data  
}

Essas mensagens podem ser geradas quando EINTR ocorrer na seção " read more data" e são causadas pela recepção de um sinal antes de qualquer dado ser recebido.

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

/ignoreEINTR "1"

Configurar /ignoreEINTR para "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.

Criar padrões para propriedades globais

Várias seções no arquivo de configuração do Dispatcher usam glob propriedades como critérios de seleção para solicitações do cliente. 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 nas quais o Dispatcher atua ou rejeita.

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

Logs

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

• A localização do arquivo de log do Dispatcher.
• O nível do log.

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

Logs girados / Piped do Apache

Se estiver usando um servidor Web Apache, você poderá usar a funcionalidade padrão para registros rotacionados e/ou encanados. Por exemplo, usando registros de tubulação:

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

Isso girará automaticamente:

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

Consulte a documentação do servidor Web Apache em Rotação de log e Logs Piped; por exemplo Apache 2.4.

Registro de rastreamento

Entre outros aprimoramentos para o Dispatcher, a versão 4.2.0 também introduz o Trace Logging.

Este é um nível superior ao do registro de depuração, mostrando informações adicionais nos registros. 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 no servidor da Web.

Abaixo está um exemplo de registros 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 da Web, do Dispatcher e da instância AEM, você pode usar as seguintes etapas:

1. Defina loglevel como 3.

2. Start do servidor Web; isso também start o Dispatcher.

3. Start da instância AEM.

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

   • Dependendo do servidor da Web, você deverá 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 através do servidor da Web. Confirme se o conteúdo está sendo exibido, conforme necessário.
   Por exemplo, em uma instalação local onde AEM é executado na porta 4502 e o servidor Web em 80 acesse o console Sites 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 descarregado corretamente.

8. Se tudo estiver funcionando corretamente, você pode reduzir loglevel para 0.

Usando vários Dispatchers v

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 público alvo foi armazenado em cache, retornado do cache ou não pode ser armazenado 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 que envolvam respostas armazenadas em cache pelo Dispatcher.

Essa funcionalidade não está ativada 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

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

• em cache
  O arquivo de público alvo está contido no cache e o dispatcher determinou que é válido entregá-lo.
• cache
  O arquivo de público alvo 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 estatística é mais
  recenteO arquivo de público alvo está contido no cache, no entanto, ele é invalidado por um arquivo de estatística mais recente. O dispatcher excluirá o arquivo de público alvo, recriará-o da saída e o entregará.
• não pode ser armazenado em cache: nenhuma
  raiz de documentoA configuração do farm não contém uma raiz de documento (elemento de configuração)
  cache.docroot).
• não pode ser armazenado em cache: caminho do arquivo de cache muito longo
  O arquivo de público alvo - a concatenação da raiz e do arquivo URL do documento - excede o nome de arquivo mais longo possível no sistema.
• não pode ser armazenado 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 do arquivo temporário é o nome do arquivo de público alvo com os caracteres _YYYYXXXXXX anexados a ele, onde Y e X serão substituídos para criar um nome exclusivo.
• não pode ser armazenado em cache: o URL de 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 do arquivo, por exemplo: /test.html/a/path.
• não pode ser armazenado em cache: não era um GET ou
  HEADTo método HTTP não é um GET ou um HEAD. O dispatcher supõe que a saída conterá dados dinâmicos que não devem ser armazenados em cache.
• não pode ser armazenado em cache: solicitação continha uma string de query
  A solicitação continha uma string de query. O dispatcher supõe que a saída dependa da string de query fornecida e, portanto, não armazena em cache.
• não pode ser armazenado em cache: gerenciador de sessão não autenticado
  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 contém as informações de autenticação apropriadas.
• não pode ser armazenado em cache: 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 pode ser armazenado em cache: público alvo é um diretório
  O arquivo de público alvo é um diretório. Isso pode apontar para algum erro conceitual, em que um URL e alguns sub-URL contêm saída em cache, por exemplo, se uma solicitação para /test.html/a/file.ext for recebida primeiro e contiver saída em cache, o dispatcher não poderá armazenar a saída de uma solicitação subsequente em /test.html no cache.
• não pode ser armazenado em cache: o URL da solicitação tem uma barra
  O URL da solicitação tem uma barra.
• não pode ser armazenado em cache: URL de solicitação não 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 pode ser armazenado em cache: acesso negado ao verificador de autorização
  O verificador de autorização do farm negou acesso ao arquivo em cache.
• não pode ser armazenado em cache: sessão não
  válidaO cache do farm é regido por um gerenciador de sessão (a configuração contém um sessionmanagement nó) e a sessão do usuário não é ou não é mais válida.
• não pode ser armazenado em cache: a resposta contémno_cache
  o servidor remoto retornou uma
  Dispatcher: no_cache , proibindo o dispatcher de armazenar a saída em cache.
• não pode ser armazenado em cache: comprimento do conteúdo da resposta é
  zeroO comprimento do conteúdo da resposta é zero; o dispatcher não criará um arquivo de comprimento zero.