SRP e UGC Essentials

Introdução

Se não estiver familiarizado com o SRP (armazenamento Resource Provider [provedor de recursos do ]) e sua relação com o UGC (User-Gered Content Provider [conteúdo gerado pelo usuário]), visite Armazenamento de conteúdo da comunidade e Visão Geral do Provedor de Recursos do Armazenamento.

Esta seção da documentação fornece algumas informações essenciais sobre o SRP e o UGC.

API StorageResourceProvider

A API SocialResourceProvider (API SRP) é uma extensão de várias APIs do Provedor de recursos Sling. Inclui suporte para paginação e incremento atômico (útil para tally e pontuação).

Os query são necessários para os componentes do quadro SEPA para os cartões, uma vez que é necessário classificar por data, utilidade, número de votos, etc. Todas as opções de SRP têm mecanismos flexíveis de query que não dependem da definição de baldes.

A localização do armazenamento SRP incorpora o caminho do componente. A API SRP deve ser sempre usada para acessar o UGC, já que o caminho raiz depende da opção SRP selecionada, como ASRP, MSRP ou JSRP.

A API SRP não é uma classe abstrata, é uma interface. Uma implementação personalizada não deve ser realizada com ligeireza, já que os benefícios de futuras melhorias nas implementações internas seriam desperdiçados ao atualizar para uma nova versão.

Os meios para usar a API SRP são utilitários fornecidos, como os encontrados no pacote SocialResourceUtilities.

Ao atualizar do AEM 6.0 ou anterior, será necessário migrar o UGC para todos os SRPs, para os quais uma ferramenta Open Source está disponível. Consulte Atualizando para o AEM Communities 6.3.

Observação

Historicamente, os utilitários para acessar o UGC foram encontrados no pacote SocialUtils, que não existe mais.

Para obter utilitários de substituição, consulte Refatoração SocialUtils.

Método do utilitário para acessar UGC

Para acessar o UGC, use um método do pacote SocialResourceUtilities que retorna um caminho adequado para acessar o UGC do SRP e substitui o método obsoleto encontrado no pacote SocialUtils.

Veja a seguir um exemplo mínimo de como usar o método resourceToUGCStoragePath() em um servlet:

import com.adobe.cq.social.srp.utilities.api.SocialResourceUtilities;

@Reference
private SocialResourceUtilities socialResourceUtilities;

@Override
protected void doGet(final SlingHttpServletRequest request, final SlingHttpServletResponse response) throws ServletException, IOException {
  String ugcPath = socialResourceUtilities.resourceToUGCStoragePath(request.getResource());
  // rest of servlet
}

Para outras substituições do SocialUtils, consulte Refatoração do SocialUtils.

Para obter diretrizes de codificação, visite Acessar UGC com SRP.

CUIDADO

O caminho que o resourceToUGCStoragePath() retorna é not adequado para verificação ACL.

Método do utilitário para acessar ACLs

Algumas implementações SRP, como ASRP e MSRP, armazenam conteúdo da comunidade em bancos de dados que não fornecem verificação de ACL. Os nós de sombra fornecem um local no repositório local ao qual as ACLs podem ser aplicadas.

Usando a API SRP, todas as opções SRP executam a mesma verificação do local da sombra antes de todas as operações CRUD.

Para verificar ACLs, use um método que retorne um caminho adequado para verificar as permissões aplicadas ao UGC do recurso.

Veja a seguir um exemplo simples de como usar o método resourceToACLPath() em um servlet:

import com.adobe.cq.social.srp.utilities.api.SocialResourceUtilities;

@Reference
private SocialResourceUtilities socialResourceUtilities;

@Override
protected void doGet(final SlingHttpServletRequest request, final SlingHttpServletResponse response) throws ServletException, IOException {
  String aclPath = socialResourceUtilities.resourceToACLPath(request.getResource());
  // rest of servlet
}
CUIDADO

O caminho retornado por resourceToACLPath() é not adequado para acessar o próprio UGC.

As seguintes descrições da localização do armazenamento podem ser úteis ao desenvolver com JSRP ou talvez MSRP. No momento, não há interface do usuário para acessar o UGC armazenado no ASRP, como há para JSRP (CRXDE Lite) e MSRP (ferramentas MongoDB).

Localização do componente

Quando um membro entra no UGC no ambiente de publicação, ele interage com um componente como parte de um site AEM.

Um exemplo desse componente é o componente comments que existe no site Guia de componentes da comunidade. O caminho para o nó de comentário no repositório local é:

  • Caminho do componente = /content/community-components/en/comments/jcr:content/content/includable/comments

Localização do nó sombra

A criação do UGC também cria um nó de sombra ao qual as ACLs necessárias são aplicadas. O caminho para o nó de sombra correspondente no repositório local é o resultado do prefixo do caminho raiz do nó de sombra para o caminho do componente:

  • Caminho raiz = /content/usergenerated
  • Nó sombra de comentários = /content/usergenerated/content/community-components/en/comments/jcr:content/content/includable/comments

Local UGC

O UGC é criado em nenhum desses locais e só deve ser acessado usando um método de utilitário que chama a API SRP.

  • Caminho raiz = /content/usergenerated/asi/srp-choice
  • Nó UGC para JSRP = /content/usergenerated/asi/jcr/content/community-components/en/comments/jcr:content/content/includable/comments/srzd-let_it_be_

Esteja ciente de que, para o JSRP, o nó UGC ** só estará presente na instância AEM (autor ou publicação) na qual foi inserido. Se inserido em uma instância de publicação, a moderação não será possível no console de moderação do autor.

Nesta página