Serverseitige Anpassung

⇐ Essentials Clientseitige Anpassung ⇒
SCF-Handlebars Helpers ⇒

Java-APIs

Hinweis

Der Speicherort des Pakets von Communities-APIs kann sich ändern, wenn von einer Hauptversion zur nächsten aktualisiert wird.

SocialComponent-Schnittstelle

SocialComponents sind POJOs, die eine Ressource für eine AEM Communities-Funktion darstellen. Idealerweise stellt jede SocialComponent einen bestimmten resourceType mit offen gelegten GETters dar, die dem Client Daten bereitstellen, damit die Ressource korrekt dargestellt wird. Die gesamte Geschäftslogik und die Logik der Ansicht sind in der SocialComponent eingeschlossen, einschließlich der Sitzungsinformationen des Site-Besuchers, sofern erforderlich.

Die Schnittstelle definiert einen grundlegenden Satz von GETters, die zur Darstellung einer Ressource erforderlich sind. Wichtig ist, dass in der Schnittstelle die Methoden Map<String, Object> getAsMap() und String toJSONString() festgelegt sind, die zum Rendern von Handlebars-Vorlagen und zum Bereitstellen von GET JSON-Endpunkten für Ressourcen erforderlich sind.

Alle SocialComponent-Klassen müssen die Schnittstelle implementieren com.adobe.cq.social.scf.SocialComponent

SocialCollectionComponent-Schnittstelle

Die SocialCollectionComponent-Schnittstelle erweitert die SocialComponent-Schnittstelle, um Ressourcen besser darzustellen, die Sammlungen anderer Ressourcen sind.

Alle SocialCollectionComponent-Klassen müssen die Schnittstelle com.adobe.cq.social.scf.SocialCollectionComponent implementieren

SocialComponentFactory-Schnittstelle

Eine SocialComponentFactory (Factory) registriert eine SocialComponent mit dem Framework. Die Factory bietet eine Möglichkeit, das Framework darüber zu informieren, welche SocialComponents für einen bestimmten resourceType verfügbar sind und welche Priorität ranking&ast; wenn mehrere SocialComponents identifiziert werden.

Eine SocialComponentFactory ist für das Erstellen einer Instanz der ausgewählten SocialComponent zuständig, sodass alle Abhängigkeiten, die von der SocialComponent benötigt werden, mithilfe von DI-Verfahren aus der Factory eingefügt werden können.

Eine SocialComponentFactory ist ein OSGi-Dienst und hat Zugriff auf andere OSGi-Dienste, die über einen Konstruktor an die SocialComponent übergeben werden können.

Alle SocialComponentFactory-Klassen müssen die Schnittstelle implementieren com.adobe.cq.social.scf.SocialComponentFactory

Eine Implementierung der Methode SocialComponentFactory.getPriority() sollte den höchsten Wert zurückgeben, damit die Factory für den angegebenen resourceType verwendet wird, wie von getResourceType() zurückgegeben.

SocialComponentFactoryManager-Schnittstelle

Der SocialComponentFactoryManager (Manager) verwaltet alle im Framework registrierten SocialComponents und ist für die Auswahl der SocialComponentFactory für eine bestimmte Ressource (resourceType) zuständig. Wenn keine Fabriken für einen bestimmten resourceType registriert sind, gibt der Manager eine Factory mit dem nächsten Supertyp für die jeweilige Ressource zurück.

Ein SocialComponentFactoryManager ist ein OSGi-Dienst und hat Zugriff auf andere OSGi-Dienste, die über einen Konstruktor an die SocialComponent übergeben werden können.

Ein Handle für den OSGi-Dienst wird durch Aufrufen von com.adobe.cq.social.scf.SocialComponentFactoryManager

HTTP-API - POST-Anfragen

PostOperation-Klasse

Die HTTP-API-POST-Endpunkte sind PostOperation-Klassen, die durch Implementierung der SlingPostOperationSchnittstelle (package org.apache.sling.servlets.post) definiert werden.

Die Implementierung PostOperationdes Endpunkts setzt sling.post.operationauf einen Wert, auf den der Vorgang reagiert. Alle POST-Anfragen mit einem:operation-Parameter, der auf diesen Wert gesetzt ist, werden dieser Implementierungsklasse übertragen.

Die PostOperationruft die SocialOperationauf, die die für den Vorgang erforderlichen Aktionen ausführt.

Das Ergebnis PostOperationwird vom Client empfangen SocialOperationund die entsprechende Antwort an den Client zurückgegeben.

SocialOperation-Klasse

Jeder SocialOperationEndpunkt erweitert die AbstractSocialOperation-Klasse und überschreibt die Methode performOperation().Diese Methode führt alle erforderlichen Aktionen aus, um den Vorgang abzuschließen und eine SocialOperationResultoder andere Ausgabe eines OperationExceptionauszuführen. In diesem Fall wird anstelle des normalen JSON-Antwort- oder Erfolgs-HTTP-Statuscodes ein HTTP-Fehlerstatus mit einer Meldung zurückgegeben, sofern verfügbar.

Die Erweiterung AbstractSocialOperationermöglicht die Wiederverwendung von SocialComponentszum Senden von JSON-Antworten.

SocialOperationResult-Klasse

Die SocialOperationResultKlasse wird als Ergebnis der zurückgegeben SocialOperationund setzt sich aus einem SocialComponentHTTP-Statuscode und einer HTTP-Statusmeldung zusammen.

Die Ressource SocialComponentstellt die Ressource dar, die von dem Vorgang betroffen war.

Bei einem Create-Vorgang stellt der SocialComponentim SocialOperationResultAbschnitt enthaltene Wert die soeben erstellte Ressource und bei einem Update-Vorgang die Ressource dar, die durch den Vorgang geändert wurde. Für einen Löschvorgang SocialComponentwird kein Fehler zurückgegeben.

Die verwendeten Erfolgs-HTTP-Statuscodes sind

  • 201 für Create-Vorgänge
  • 200 für Aktualisierungsvorgänge
  • 204 für Löschvorgänge

OperationException-Klasse

Beim Ausführen eines Vorgangs OperationExceptonkann eine Fehlermeldung ausgegeben werden, wenn die Anforderung ungültig ist oder ein anderer Fehler auftritt, z. B. interne Fehler, ungültige Parameterwerte, falsche Berechtigungen usw. Eine OperationExceptionbesteht aus einem HTTP-Statuscode und einer Fehlermeldung, die an den Client als Antwort auf die PostOperatoinNachricht zurückgegeben werden.

OperationService-Klasse

Das Framework für soziale Komponenten empfiehlt, dass die Geschäftslogik, die für die Ausführung des Vorgangs verantwortlich ist, nicht innerhalb der SocialOperationKlasse implementiert, sondern stattdessen an einen OSGi-Dienst delegiert wird. Durch die Verwendung eines OSGi-Dienstes für Geschäftslogik kann ein SocialComponentvon einem SocialOperationEndpunkt verwendeter Endpunkt in anderen Code integriert werden und eine andere Geschäftslogik angewendet werden.

Alle OperationServiceKlassen erweitern AbstractOperationServiceund ermöglichen zusätzliche Erweiterungen, die an die auszuführende Operation angeschlossen werden können. Jeder Vorgang im Dienst wird durch eine SocialOperationKlasse dargestellt. Die OperationExtensionsKlasse kann während der Ausführung des Vorgangs aufgerufen werden, indem die Methoden

  • performBeforeActions()
    Ermöglicht die Vorab-/Vorverarbeitung und Überprüfung
  • performAfterActions()
    Ermöglicht eine weitere Änderung der Ressourcen oder das Aufrufen benutzerdefinierter Ereignis, Workflows usw.

OperationExtension-Klasse

OperationExtensionKlassen sind benutzerdefinierte Codeabschnitte, die in einen Vorgang eingefügt werden können, der eine Anpassung der Vorgänge an die geschäftlichen Anforderungen ermöglicht. Die Benutzer der Komponente können der Komponente dynamisch und inkrementell Funktionen hinzufügen. Das Erweiterungs-/Hakenmuster ermöglicht es Entwicklern, sich ausschließlich auf die Erweiterungen selbst zu konzentrieren und entfernt die Notwendigkeit, ganze Vorgänge und Komponenten zu kopieren und zu überschreiben.

Beispielcode

Beispielcode ist im Adobe Marketing Cloud GitHub Repository verfügbar. Suchen Sie nach Projekten mit dem Präfix aem-communities oder aem-scf.

Best Practices

Ansicht der Coding-Richtlinien für verschiedene Codierungsrichtlinien und Best Practices für AEM Communities-Entwickler.

Informationen zum Zugriff auf benutzergenerierte Inhalte finden Sie unter auch Datenspeicherung Resource Provider (SRP) für UGC .

⇐ Essentials Clientseitige Anpassung ⇒
SCF-Handlebars Helpers ⇒

Auf dieser Seite