Configuração do uso de cookies

O AEM fornece um serviço que permite configurar e controlar como os cookies são usados com suas páginas da Web:

  • Um serviço configurável do lado do servidor mantém uma lista de cookies que podem ser usados.
  • Uma API de javascript permite que o código javascript verifique se um cookie pode ser usado.

Use este recurso para garantir que suas páginas estejam em conformidade com o consentimento dos usuários em relação ao uso de cookies.

Configuração de cookies permitidos

Configure o Serviço de recusa do Adobe Granite para especificar como os cookies são usados em suas páginas da Web. A tabela a seguir descreve as propriedades que você pode configurar.

Para configurar o serviço, você pode usar o Console da Web ou adicionar uma configuração OSGi ao repositório. A tabela a seguir descreve as propriedades necessárias para qualquer método. Para uma configuração OSGi, o PID do serviço é com.adobe.granite.optout.

Nome da propriedade (console da Web) Nome da propriedade OSGi Descrição
Cookies de recusa optout.cookies Os nomes dos cookies que indicam, quando presentes no dispositivo do usuário, que ele não consentiu em usar cookies.
Cabeçalhos HTTP de recusa optout.headers Os nomes dos cabeçalhos HTTP que indicam, quando presentes, que o usuário não consentiu em usar cookies.
Cookies da lista de permissões optout.whitelist.cookies Uma lista de cookies essenciais para o funcionamento do site, e que podem ser usados sem o consentimento do usuário.

Use o javascript do lado do cliente para chamar o Serviço de recusa do Adobe Granite para verificar se você pode usar um cookie. Use o objeto javascript Granite.OptOutUtil para executar qualquer uma das seguintes tarefas:

  • Obtenha uma lista de nomes de cookies que indicam que esse usuário não consente em usar cookies para fins de rastreamento.
  • Obtenha uma lista de cookies que podem ser usados.
  • Determine se o navegador da Web contém um cookie que indica que o usuário não consente com o uso de cookies para rastreamento.
  • Determine se um cookie específico pode ser usado.

O granite.utils pasta da biblioteca do cliente fornece o objeto Granite.OptOutUtil. Adicione o seguinte código à JSP do cabeçalho da página para incluir um link à biblioteca javascript:

<ui:includeClientLib categories="granite.utils" />

Por exemplo, a seguinte função javascript determina se o cookie COOKIE_NAME pode ser usado antes de gravar nele:

function writeCookie(value){
   if (!Granite.OptOutUtil.maySetCookie("COOKIE_NAME"))
      return;
   if (value) {
      value = encodeURIComponent(value);
      document.cookie = "COOKIE_NAME=" + value;
   }
}

O objeto Javascript Granite.OptOutUtil

Granite.OptOutUtil permite determinar se o uso de cookies é permitido.

função getCookieNames()

Retorna os nomes dos cookies que, quando presentes, indicam que o usuário não consentiu com o uso de cookies.

Parâmetros

Nenhum.

Devoluções

Uma matriz de nomes de cookies.

função getWhitelistCookieNames()

Retorna os nomes dos cookies que podem ser usados independentemente do consentimento do usuário.

Parâmetros

Nenhum.

Devoluções

Uma matriz de nomes de cookies.

função isOptedOut()

Determina se o navegador do usuário contém cookies que indicam que não foi dado consentimento para o uso de cookies.

Parâmetros

Nenhum.

Devoluções

Um valor booleano de true se for encontrado um cookie que indique ausência de consentimento e um valor de false se nenhum cookie indicar não consentimento.

função maySetCookie(cookieName)

Determina se um cookie específico pode ser usado no navegador do usuário. Esta função é equivalente a usar a variável isOptedOut juntamente com a determinação de se o cookie fornecido está incluído na lista que o getWhitelistCookieNames A função retorna.

Parâmetros

  • cookieName: cadeia de caracteres. O nome do cookie.

Devoluções

Um valor booleano de true se cookieName pode ser usado, ou um valor de false se cookieName não pode ser usado.

Nesta página