SRP en UGC Essentials srp-and-ugc-essentials

Inleiding introduction

Als u niet bekend bent met de opslagbronprovider (SRP) en de relatie met door de gebruiker gegenereerde inhoud (UGC), gaat u naar Opslag van communautaire inhoud en Overzicht opslagbronprovider.

Deze sectie van de documentatie verstrekt wat essentiële informatie over SRP en UGC.

StorageResourceProvider API storageresourceprovider-api

De API van SocialResourceProvider (SRP API) is een uitbreiding van diverse API's van Sling Resource Provider. Het omvat steun voor paginering en atoomverhoging (nuttig voor tally en scoring).

Vragen zijn noodzakelijk voor componenten SCF aangezien er de behoefte is om door datum, nuttigheid, aantal stemmen, etc. te sorteren. Alle opties SRP hebben flexibele vraagmechanismen die zich niet op het knippen baseren.

De opslagplaats SRP neemt de componentenweg op. SRP API zou altijd moeten worden gebruikt om tot UGC toegang te hebben aangezien de wortelweg van de geselecteerde optie SRP, zoals ASRP, MSRP, of JSRP afhangt.

SRP API is geen abstracte klasse, het is een interface. Een aangepaste implementatie moet niet lichtvaardig worden uitgevoerd, aangezien de voordelen van toekomstige verbeteringen van interne implementaties niet worden benut bij de upgrade naar een nieuwe release.

De middelen om SRP API te gebruiken zijn door verstrekte nut, zoals die gevonden in het pakket SocialResourceUtilities.

Wanneer het bevorderen van AEM 6.0 of vroeger, zal het noodzakelijk zijn om UGC voor alle SRPs te migreren, waarvoor een Open Bron hulpmiddel beschikbaar is. Zie Upgrade uitvoeren naar AEM Communities 6.3.

Hulpprogrammamethode voor toegang tot UGC utility-method-to-access-ugc

Om tot UGC toegang te hebben, gebruik een methode van het pakket SocialResourceUtilities dat een weg geschikt voor de toegang tot van UGC van SRP terugkeert en de vervangen methode vervangt die in het pakket SocialUtils wordt gevonden.

Hieronder ziet u een minimaal voorbeeld van het gebruik van de methode resourceToUGCStoragePath() in een 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
}

Voor andere vervangingen van SocialUtils, zie SocialUtils Refactoring.

Voor coderingsrichtlijnen gaat u naar Toegang tot UGC met SRP.

De Methode van het nut om tot ACLs toegang te hebben utility-method-to-access-acls

Sommige implementaties SRP, zoals ASRP en MSRP, slaan communautaire inhoud in gegevensbestanden op die geen ACL controle verstrekken. De knopen van de schaduw verstrekken een plaats in de lokale bewaarplaats waarop ACLs kan worden toegepast.

Met de SRP API voeren alle SRP-opties dezelfde controle uit op de schaduwlocatie voorafgaand aan alle CRUD-bewerkingen.

Om ACLs te controleren, gebruik een methode die een weg geschikt voor het controleren van de toestemmingen terugkeert die op UGC van het middel worden toegepast.

Hieronder ziet u een eenvoudig voorbeeld van het gebruik van de methode resourceToACLPath() in een 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
}

UGC-gerelateerde opslaglocaties ugc-related-storage-locations

De volgende beschrijvingen van opslagplaats kunnen van hulp zijn wanneer het ontwikkelen met JSRP of misschien MSRP. Er is momenteel geen UI om tot UGC toegang te hebben die in ASRP wordt opgeslagen, aangezien er voor JSRP is (CRXDE Lite) en MSRP (MongoDB-gereedschappen).

componentlocatie

Wanneer een lid UGC in het publicatiemilieu ingaat, communiceren zij met een component als deel van een AEM plaats.

Een voorbeeld van een dergelijke component is de component component comments die in het Community Components Guide site. Het pad naar het knooppunt met opmerkingen in de lokale opslagplaats is:

locatie van schaduwknooppunten

De oprichting van UGC leidt ook tot een schaduwknooppunt waarop noodzakelijke ACLs wordt toegepast. Het pad naar het corresponderende schaduwknooppunt in de lokale opslagruimte is het resultaat van het voorzetten van het hoofdpad van het schaduwknooppunt naar het componentpad:

UGC-locatie

De UGC wordt gecreeerd in geen van beide plaatsen, en zou slechts moeten worden betreden gebruikend hulpprogrammamethode die de SRP API aanroept.

Wees voorzichtig, voor JSRP, zal de knoop UGC alleen aanwezig zijn op het AEM (auteur of publicatie) waarop het is ingevoerd. Als ingegaan op een publiceer instantie, zal de matiging niet van de moderatieconsole op auteur mogelijk zijn.

Gerelateerde informatie related-information