Personalização do lado do servidor server-side-customization

APIs Java java-apis

Interface do SocialComponent socialcomponent-interface

Os componentes sociais são POJOs que representam um recurso para um recurso do AEM Communities. Idealmente, cada SocialComponent representa um resourceType específico com GETters expostos que fornecem dados ao cliente para que o recurso seja representado com precisão. Toda lógica de negócios e lógica de visualização é encapsulada no SocialComponent, incluindo as informações de sessão do visitante do site, se necessário.

A interface define um conjunto básico de GETters que são necessários para representar um recurso. Importante: a interface estipula o Mapa<string object=""> os métodos getAsMap() e String toJSONString() necessários para renderizar modelos Handlebars e expor os endpoints JSON do GET para os recursos.

Todas as classes SocialComponent devem implementar a interface com.adobe.cq.social.scf.SocialComponent

Interface do SocialCollectionComponent socialcollectioncomponent-interface

A interface SocialCollectionComponent estende a interface SocialComponent para representar melhor os recursos que são coleções de outros recursos.

Todas as classes SocialCollectionComponent devem implementar a interface com.adobe.cq.social.scf.SocialCollectionComponent

Interface do SocialComponentFactory socialcomponentfactory-interface

Um SocialComponentFactory (fábrica) registra um SocialComponent com a estrutura. A fábrica fornece um meio de informar a estrutura sobre quais componentes sociais estão disponíveis para um determinado tipo de recurso e sua classificação e classificação de prioridade; quando vários SocialComponents são identificados.

Um SocialComponentFactory é responsável pela criação de uma instância do SocialComponent selecionado, permitindo inserir todas as dependências necessárias para o SocialComponent da fábrica usando práticas de ID.

Um SocialComponentFactory é um serviço OSGi e tem acesso a outros serviços OSGi que podem ser passados para o SocialComponent por meio de um construtor.

Todas as classes SocialComponentFactory devem implementar a interface com.adobe.cq.social.scf.SocialComponentFactory

Uma implementação do método SocialComponentFactory.getPriority() deve retornar o valor mais alto para que a fábrica seja usada para o resourceType fornecido, conforme retornado por getResourceType().

Interface do SocialComponentFactoryManager socialcomponentfactorymanager-interface

O SocialComponentFactoryManager (gerente) gerencia todos os SocialComponents registrados com a estrutura e é responsável por selecionar o SocialComponentFactory a ser usado para um determinado recurso (resourceType). Se não houver fábricas registradas para um resourceType específico, o gerente retornará uma fábrica com o supertipo mais próximo para o recurso em questão.

Um SocialComponentFactoryManager é um serviço OSGi e tem acesso a outros serviços OSGi que podem ser passados para o SocialComponent por meio de um construtor.

Um identificador para o serviço OSGi é obtido chamando com.adobe.cq.social.scf.SocialComponentFactoryManager

API HTTP - Solicitações do POST http-api-post-requests

Classe PostOperation postoperation-class

Os pontos de extremidade POST da API HTTP são classes PostOperation definidas pela implementação do SlingPostOperationinterface (pacote) org.apache.sling.servlets.post).

O PostOperationconjuntos de implementação de endpont sling.post.operationa um valor ao qual a operação responderá. Todas as solicitações de POST com um parâmetro:operation definido para esse valor serão delegadas a essa classe de implementação.

O PostOperationchama o SocialOperationque executa as ações necessárias para a operação.

O PostOperationrecebe o resultado do SocialOperatione retorna a resposta apropriada ao cliente.

Classe SocialOperation socialoperation-class

Cada SocialOperationendpoint estende a classe AbstractSocialOperation e substitui o método performOperation().Este método executa todas as ações necessárias para concluir a operação e retornar um SocialOperationResultou, caso contrário, coloque uma OperationException, nesse caso, um status de erro HTTP com uma mensagem, se disponível, é retornado no lugar da resposta JSON normal ou do código de status HTTP bem-sucedido.

Extensão AbstractSocialOperationpermite a reutilização de SocialComponentspara enviar respostas JSON.

Classe SocialOperationResult socialoperationresult-class

O SocialOperationResultA classe é retornada como resultado da SocialOperatione é composto por um SocialComponent, código do status HTTP e mensagem de status HTTP.

O SocialComponentrepresenta o recurso que foi afetado pela operação.

Para uma operação Criar , a variável SocialComponentincluídos na SocialOperationResultrepresenta o recurso recém-criado e, para uma operação Update , representa o recurso que foi alterado pela operação. Não SocialComponenté retornado para uma operação Delete .

Os códigos de status HTTP bem-sucedidos usados são

Classe OperationException operationexception-class

Um OperationExceptonpode ser lançado ao executar uma operação se a solicitação não for válida ou se algum outro erro ocorrer, como erros internos, valores de parâmetros incorretos, permissões inadequadas etc. Um OperationExceptioné composto de um código de status HTTP e uma mensagem de erro, que são retornados ao cliente como a resposta ao PostOperatoin.

Classe OperationService operationservice-class

A estrutura do componente social recomenda que a lógica de negócios responsável pela execução da operação não seja implementada no SocialOperation, mas delegadas a um serviço OSGi. Usar um serviço OSGi para lógica de negócios permite SocialComponent, que tenha sido SocialOperationendpoint, para ser integrado a outro código e ter uma lógica comercial diferente aplicada.

Todos OperationServiceextensões de classes AbstractOperationService, permitindo extensões adicionais que podem ser conectadas à operação que está sendo executada. Cada operação no serviço é representada por um SocialOperationclasse . O OperationExtensionsA classe pode ser invocada durante a execução da operação chamando os métodos

Classe OperationExtension operationextension-class

OperationExtensionclasses são partes de código personalizadas que podem ser inseridas em uma operação que permite a personalização de operações para atender às necessidades dos negócios. Os consumidores do componente podem adicionar funcionalidade de forma dinâmica e incremental ao componente. O padrão de extensão/gancho permite que os desenvolvedores se concentrem exclusivamente nas próprias extensões e remove a necessidade de copiar e substituir operações e componentes inteiros.

Código de exemplo sample-code

O código de amostra está disponível na seção Adobe Marketing Cloud GitHub repositório. Procure projetos com o prefixo ou aem-communities ou aem-scf.

Práticas recomendadas best-practices

Visualize o Diretrizes de codificação para obter várias diretrizes de codificação e práticas recomendadas para desenvolvedores do AEM Communities.

Consulte também Provedor de recursos de armazenamento (SRP) para UGC para saber mais sobre como acessar conteúdo gerado pelo usuário.