SRP och UGC Essentials srp-and-ugc-essentials

Introduktion introduction

Om du inte känner till lagringsresursens leverantör (SRP) och dess relation till användargenererat innehåll (UGC) går du till Community-innehåll och Översikt över lagringsresursprovider.

I det här avsnittet av dokumentationen finns viktig information om SRP och UGC.

StorageResourceProvider API storageresourceprovider-api

SocialResourceProvider API (SRP API) är ett tillägg till olika Sling Resource Provider API:er. Den har stöd för sidnumrering och atomisk ökning (användbart för tally och scoring).

Frågor är nödvändiga för SCF-komponenter eftersom det behövs sortering efter datum, hjälpmedel, antal röster och så vidare. Alla SRP-alternativ har flexibla frågemekanismer som inte är beroende av bucketing.

SRP-lagringsplatsen innehåller komponentsökvägen. SRP-API:t ska alltid användas för att komma åt UGC eftersom rotsökvägen beror på vilket SRP-alternativ som har valts, till exempel ASRP, MSRP eller JSRP.

SRP API är inte en abstrakt klass, utan ett gränssnitt. En anpassad implementering bör inte utföras lätt, eftersom fördelarna med framtida förbättringar av interna implementeringar skulle gå förlorade när du uppgraderar till en ny version.

Sättet att använda SRP API är via tillhandahållna verktyg, t.ex. de som finns i paketet SocialResourceUtilities.

När du uppgraderar från AEM 6.0 eller tidigare måste du migrera UGC för alla SRP som har ett verktyg för öppen källkod. Se Uppgradera till AEM Communities 6.3.

Verktygsmetod för åtkomst till UGC utility-method-to-access-ugc

Om du vill få åtkomst till UGC använder du en metod från paketet SocialResourceUtilities som returnerar en sökväg som är lämplig för åtkomst till UGC från SRP och ersätter den borttagna metoden som finns i paketet SocialUtils.

Följande är ett minimalt exempel på hur du använder metoden resourceToUGCStoragePath() i en serverlet:

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
}

Andra SocialUtils-ersättningar finns i Omfaktorisering för SocialUtils.

Riktlinjer för kodning finns på Åtkomst till UGC med SRP.

Verktygsmetod för åtkomst till åtkomstkontrollistor utility-method-to-access-acls

Vissa SRP-implementeringar, som ASRP och MSRP, lagrar communityinnehåll i databaser som inte ger någon ACL-verifiering. Skuggnoder är en plats i den lokala databasen som ACL-listor kan användas på.

Med SRP API utför alla SRP-alternativ samma kontroll av skuggplatsen före alla CRUD-åtgärder.

Om du vill kontrollera åtkomstkontrollistor använder du en metod som returnerar en sökväg som är lämplig för att kontrollera behörigheterna som används i resursens UGC.

Nedan följer ett enkelt exempel på hur du använder metoden resourceToACLPath() i en serverlet:

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-relaterade lagringsplatser ugc-related-storage-locations

Följande beskrivningar av lagringsplats kan vara till hjälp när du utvecklar med JSRP eller kanske MSRP. Det finns för närvarande inget användargränssnitt som kan komma åt UGC som lagras i ASRP, vilket är fallet för JSRP (CRXDE Lite) och MSRP (MongoDB-verktyg).

komponentplacering

När en medlem går in i UGC i publiceringsmiljön interagerar de med en komponent som en del av en AEM.

Ett exempel på en sådan komponent är kommentarkomponent som finns i Community Components Guide webbplats. Sökvägen till kommentarnoden i den lokala databasen är:

skuggnodplats

När UGC skapas skapas också en skuggnod som de nödvändiga åtkomstkontrollistorna tillämpas på. Sökvägen till motsvarande skuggnod i den lokala databasen är resultatet av att skuggnodens rotsökväg har försatts i komponentsökvägen:

UGC-plats

Den användargenererade koden skapas inte på någon av dessa platser och ska bara nås med en utility, metod som anropar SRP API.

Var medveten, för JSRP, kommer UGC-noden att endast finnas på den AEM instansen (antingen författaren eller publiceringen) som den angavs för. Om det anges i en publiceringsinstans går det inte att moderera från modereringskonsolen på författaren.

Relaterad information related-information