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 com.adobe.cq.social.scf.SocialComponent implementieren

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, dem Framework mitzuteilen, welche SocialComponents für einen bestimmten resourceType verfügbar sind und welche Priorität sie haben, 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 com.adobe.cq.social.scf.SocialComponentFactory implementieren

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 abgerufen

HTTP-API - POST-Anfragen

PostOperation-Klasse

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

Die PostOperation-Endimplementierung setzt sling.post.operation auf einen Wert, auf den der Vorgang reagieren soll. Alle POST-Anfragen mit einem:operation-Parameter, der auf diesen Wert gesetzt ist, werden dieser Implementierungsklasse übertragen.

Das PostOperation ruft das SocialOperation auf, das die für den Vorgang erforderlichen Aktionen ausführt.

PostOperation empfängt das Ergebnis von SocialOperation und gibt die entsprechende Antwort an den Client zurück.

SocialOperation-Klasse

Jeder SocialOperation-Endpunkt erweitert die AbstractSocialOperation-Klasse und überschreibt die Methode performOperation(). Diese Methode führt alle erforderlichen Aktionen aus, um den Vorgang abzuschließen und ein SocialOperationResult zurückzugeben oder stattdessen ein OperationException auszugeben. 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 von AbstractSocialOperation ermöglicht die Wiederverwendung von SocialComponents zum Senden von JSON-Antworten.

SocialOperationResult-Klasse

Die SocialOperationResult-Klasse wird als Ergebnis von SocialOperation zurückgegeben und besteht aus einer SocialComponent-, HTTP-Statuscode- und HTTP-Statusmeldung.

Das SocialComponent stellt die Ressource dar, die von dem Vorgang betroffen war.

Bei einem Create-Vorgang stellt das SocialComponent, das in SocialOperationResult enthalten ist, die soeben erstellte Ressource und bei einem Update-Vorgang die Ressource dar, die durch den Vorgang geändert wurde. Für einen Löschvorgang wird kein SocialComponent zurückgegeben.

Folgende HTTP-Statuscodes werden verwendet:

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

OperationException-Klasse

Bei Ausführung eines Vorgangs kann ein OperationExcepton ausgegeben werden, wenn die Anforderung ungültig ist oder ein anderer Fehler auftritt, z. B. interne Fehler, ungültige Parameterwerte, falsche Berechtigungen usw. Ein OperationException besteht aus einem HTTP-Statuscode und einer Fehlermeldung, die als Antwort auf PostOperatoin an den Client 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 Klasse SocialOperation implementiert, sondern stattdessen an einen OSGi-Dienst delegiert wird. Die Verwendung eines OSGi-Dienstes für Geschäftslogik ermöglicht die Integration eines SocialComponent-Endpunkts mit einem SocialOperation-Endpunkt und einer unterschiedlichen Geschäftslogik.

Alle OperationService-Klassen erweitern AbstractOperationService, wodurch zusätzliche Erweiterungen möglich sind, die mit dem ausgeführten Vorgang verknüpft werden können. Jeder Vorgang im Dienst wird durch eine SocialOperation-Klasse dargestellt. Die OperationExtensions-Klasse 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

OperationExtension Klassen 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.