Nozioni di base su SRP e UGC srp-and-ugc-essentials

Introduzione introduction

Se non conosci il provider di risorse di archiviazione (SRP) e la sua relazione con i contenuti generati dagli utenti (UGC), visita Community Content Storage e Storage Resource Provider Overview.

Questa sezione della documentazione fornisce alcune informazioni essenziali su SRP e UGC.

API StorageResourceProvider storageresourceprovider-api

L’API SocialResourceProvider (API SRP) è un’estensione di varie API Sling Resource Provider. Include il supporto per la paginazione e l'incremento atomico (utile per la conteggio e il punteggio).

Le query sono necessarie per i componenti SCF in quanto è necessario ordinare per data, utilità, numero di voti e così via. Tutte le opzioni SRP dispongono di meccanismi di query flessibili che non si basano sul bucket.

La posizione di archiviazione SRP incorpora il percorso del componente. Utilizza sempre l’API SRP per accedere a UGC, in quanto il percorso principale dipende dall’opzione SRP selezionata, ad esempio ASRP, MSRP o JSRP.

L’API SRP non è una classe astratta, è un’interfaccia. Un’implementazione personalizzata non deve essere intrapresa leggermente, in quanto i vantaggi di miglioramenti futuri alle implementazioni interne verrebbero meno con l’aggiornamento a una nuova versione.

I mezzi per utilizzare l’API SRP sono le utility fornite, come quelle presenti nel pacchetto SocialResourceUtilities.

Durante l’aggiornamento da AEM 6.0 o versioni precedenti, sarà necessario eseguire la migrazione di UGC per tutti gli SRP per i quali è disponibile uno strumento Open Source. Consulta Aggiornamento ad AEM Communities 6.3.

Metodo di utilità per accedere a UGC utility-method-to-access-ugc

Per accedere a UGC, utilizza un metodo del pacchetto SocialResourceUtilities che restituisce un percorso adatto per l’accesso a UGC da SRP e sostituisce il metodo obsoleto trovato nel pacchetto SocialUtils.

Di seguito è riportato un esempio minimo di utilizzo del metodo resourceToUGCStoragePath() in un 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
}

Per altre sostituzioni di SocialUtils, vedi Refactoring di SocialUtils.

Per le linee guida sulla codifica, visita Accesso a UGC con SRP.

Metodo di utilità per accedere alle ACL utility-method-to-access-acls

Alcune implementazioni SRP, come ASRP e MSRP, memorizzano il contenuto della community in database che non forniscono alcuna verifica ACL. I nodi shadow forniscono una posizione nell’archivio locale a cui possono essere applicati gli ACL.

Utilizzando l'API SRP, tutte le opzioni SRP eseguono lo stesso controllo della posizione ombra prima di tutte le operazioni CRUD.

Per verificare gli ACL, utilizza un metodo che restituisca un percorso adatto per la verifica delle autorizzazioni applicate all’UGC della risorsa.

Di seguito è riportato un semplice esempio di utilizzo del metodo resourceToACLPath() in un 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
}

Posizioni di archiviazione relative a UGC ugc-related-storage-locations

Le seguenti descrizioni della posizione di archiviazione possono essere utili per lo sviluppo con JSRP o eventualmente MSRP. Attualmente non è disponibile alcuna interfaccia utente per accedere a contenuti generati dagli utenti archiviati in ASRP, in quanto sono disponibili strumenti JSRP (CRXDE Liti) e MSRP (MongoDB).

Percorso componente

Quando un membro immette contenuti generati dagli utenti (UGC) nell’ambiente di pubblicazione, interagisce con un componente come parte di un sito AEM.

Un esempio di tale componente è il componente comments presente nel sito Guida ai componenti della community. Il percorso del nodo del commento nell’archivio locale è:

Posizione nodo shadow

La creazione di UGC crea anche un nodo shadow a cui vengono applicati gli ACL necessari. Il percorso del nodo shadow corrispondente nell’archivio locale è il risultato dell’anteprima del percorso principale del nodo shadow al percorso del componente:

Posizione UGC

UGC viene creato in nessuna di queste posizioni e dovrebbe essere accessibile solo utilizzando un metodo di utilità che richiama l'API SRP.

Tieni presente, per JSRP il nodo UGC only sarà presente nell'istanza AEM (di authoring o pubblicazione) in cui è stato immesso. Se viene immesso in un'istanza pubblicata, la moderazione non sarà possibile dalla console di moderazione nell'istanza di authoring.

Informazioni correlate related-information