Verwenden von Sling-Adaptern

Mit Sling wird ein Adaptermuster zum bequemen Übersetzen von Objekten bereitgestellt, die zum Implementieren der Adaptable-Schnittstelle verwendet werden. Diese Schnittstelle stellt eine generische adaptTo()-Methode bereit, mit der das Objekt in den Klassentyp übersetzt wird, der als Argument übergeben wird.

Sie können beispielsweise einfach wie folgt vorgehen, um ein Ressourcenobjekt in das entsprechende Knotenbjekt zu übersetzen:

Node node = resource.adaptTo(Node.class);

Nutzungsszenarien

Es gibt die folgenden Nutzungsszenarien:

• Rufen Sie spezifische Objekte für die Implementierung ab.

  Eine JCR-basierte Implementierung der generischen Resource-Schnittstelle ermöglicht beispielsweise Zugriff auf das zugrunde liegende JCR-Node-Element.

• Erstellung von direkten Verknüpfungen für Objekte, für die interne Kontextobjekte übergeben werden müssen.

  Der JCR-basierte ResourceResolver enthält beispielsweise einen Verweis auf die JCR Session der Anforderung, die wiederum für viele Objekte benötigt wird, deren Ausführung von dieser Anforderungssitzung abhängig ist, z. B. PageManager oder UserManager.

• Direkte Verknüpfung mit Diensten.

  Dies ist ein seltener Fall, da sling.getService() bereits eine einfache Möglichkeit darstellt.

NULL-Rückgabewert

adaptTo() kann NULL zurückgeben.

Hierfür gibt es verschiedene Gründe, z. B.:

• Die Implementierung unterstützt den Zieltyp nicht.
• Eine Adapter-Factory zur Verarbeitung dieses Falls ist nicht aktiv (z. B. aufgrund von fehlenden Dienstverweisen)
• Fehler für interne Bedingung
• Dienst ist nicht verfügbar

Es ist wichtig, dass Sie den NULL-Fall ordnungsgemäß verarbeiten. Für das JSP-Rendering kann es zulässig sein, dass für JSP ein Fehler auftritt, wenn dies zu einem leeren Inhaltselement führt.

Caching

Zur Verbesserung der Leistung dürfen Implementierungen das Objekt zwischenspeichern, das über einen obj.adaptTo()-Aufruf zurückgegeben wird. Wenn das obj gleich ist, ist auch das zurückgegebene Objekt dasselbe.

Diese Zwischenspeicherung wird für alle auf AdapterFactory basierenden Fälle durchgeführt.

Es gibt aber keine allgemeine Regel. Bei dem Objekt kann es sich entweder um eine neue oder eine vorhandene Instanz handeln. Dies bedeutet, dass Sie sich nicht auf eines der Verhalten verlassen können. Es ist also – vor allem innerhalb von AdapterFactory – wichtig, dass Objekte bei diesem Szenario wiederverwendet werden können.

Funktionsweise

Es gibt verschiedene Möglichkeiten, Adaptable.adaptTo() zu implementieren:

• Über das Objekt selbst. Die eigentliche Methode wird implementiert. Anschließend erfolgt die Zuordnung zu bestimmten Objekten.

• Durch ein AdapterFactory", das beliebige Objekte zuordnen kann.

  Die Objekte müssen trotzdem noch die Adaptable-Schnittstelle implementieren und SlingAdaptable (übergibt den adaptTo-Aufruf an einen zentralen Adapter-Manager) erweitern.

  Dies ermöglicht die Verwendung von Hooks für den adaptTo-Mechanismus für vorhandene Klassen, z. B. Resource.

• Eine Kombination beider Vorgehensweisen.

Im ersten Fall kann über javadocs angegeben werden, welche adaptTo-targets möglich sind. Für bestimmte Unterklassen, z. B. die JCR-basierte Resource-Klasse, ist dies häufig nicht möglich. Da Implementierungen von AdapterFactory im letzteren Fall normalerweise Teil der privaten Klassen eines Pakets sind, werden sie nicht per Client-API verfügbar gemacht und auch nicht in javadocs aufgeführt. Theoretisch wäre es möglich, auf alle AdapterFactory-Implementierungen über die OSGi-Dienstlaufzeit zuzugreifen und sich die Konfigurationen der „adaptierbaren Elemente“ (Quellen und Ziele) anzusehen, diese aber nicht einander zuzuordnen. Dies hängt letztendlich von der internen Logik ab, die dokumentiert werden muss. Dies ist der Grund für diesen Verweis.

Verweis

Sling

Adaptierung von Resource für:

Adaption von ResourceResolver für:

Adaptierung von SlingHttpServletRequest für:

Es sind noch keine Ziele vorhanden, aber „Adaptable“ wird implementiert und kann als Quelle in einer benutzerdefinierten „AdapterFactory“ verwendet werden.

Adaptierung von SlingHttpServletResponse für:

WCM

Adaption von Page für:

Adaption von Component für:

Adaption von Template für:

Sicherheit

Autorisierbare, ​ Benutzer- und ​ Gruppenanpassung an:

DAM

Adaption von Asset für:

Tagging

Adaption von Tag für:

Andere

Über Sling/JCR/OCM wird außerdem eine [AdapterFactory](https://sling.apache.org/site/adapters.html#Adapters-AdapterFactory) für benutzerdefinierte OCM-Objekte (Object Content Mapping) bereitgestellt.