Sling propose un Modèle adaptateur permettant de convertir facilement les objets qui implémentent l’interface Adaptable. Cette interface fournit une méthode adaptTo() générique qui convertit les objets dans le type de classe qui est transmis comme argument.
Par exemple, pour convertir un objet Resource en objet Node correspondant, vous pouvez simplement procéder comme suit :
Node node = resource.adaptTo(Node.class);
Il existe plusieurs scénarios d’utilisation :
Obtenir des objets spécifiques à l’implémentation.
Par exemple, une implémentation basée sur JCR de l’interface Resource
permet d’accéder à l’objet Node
JCR sous-jacent.
Création de raccourcis d’objets qui nécessitent la transmission d’objets de contexte internes.
Par exemple, le ResourceResolver
basé sur JCR contient une référence à la JCR Session
de la requête qui, à son tour, est nécessaire pour de nombreux objets qui s’exécuteront sur la base de cette session de requête ; PageManager
ou UserManager
, par exemple.
Raccourci vers les services.
Cas peu fréquent : sling.getService()
s’avère également simple.
adaptTo()
renvoie null.
Il existe plusieurs raisons à cela, notamment :
Il est important que vous gériez le cas « null » de manière élégante. Pour les rendus jsp, il peut être acceptable que le jsp échoue si cela entraîne un élément de contenu vide.
Pour améliorer les performances, les implémentations peuvent mettre en cache l’objet renvoyé par un appel obj.adaptTo()
. Si obj
est identique, l’objet renvoyé l’est également.
Cette mise en cache est exécutée pour tous les scénarios basés sur AdapterFactory
.
Cependant, il n’existe aucune règle générale : l’objet peut être soit une nouvelle instance, soit une instance existante. Cela signifie que vous ne pouvez pas vous fier à aucun des comportements. Par conséquent, il est important, notamment dans l’AdapterFactory
, que les objets soient réutilisables dans ce scénario.
Adaptable.adaptTo()
peut être implémenté de différentes façons :
Par l’objet proprement dit ; implémentation de la méthode et mappage sur certains objets.
Par une AdapterFactory
, qui peut mapper des objets arbitraires.
Les objets doivent cependant implémenter l’interface Adaptable
et étendre SlingAdaptable
(qui transmet l’appel adaptTo
à un gestionnaire d’adaptateur central).
Cela autorise les hooks dans le mécanisme adaptTo
pour les classes existantes, comme Resource
.
Une combinaison des deux.
Pour le premier cas, les documents Java™ peuvent indiquer quelles adaptTo-targets
sont possibles. Cependant, pour des sous-classes spécifiques, telles que la ressource basée sur JCR, cela s’avère souvent impossible. Dans le dernier cas, les implémentations d’AdapterFactory
font généralement partie des classes privées d’un bundle et ne sont donc pas exposées dans une API cliente ni répertoriées dans les documents Java™. En théorie, il serait possible d’accéder à toutes les implémentations AdapterFactory
à partir de l’exécutable de service OSGi et d’observer leurs configurations « adaptables » (sources et cibles), mais pas de les mapper entre elles. En fin de compte, cela dépend de la logique interne, qui doit être documentée. d’où cette référence.
Resource s’adapte à :
Nœud | S’il s’agit d’une ressource basée sur un nœud JCR ou une propriété JCR faisant référence à un nœud. |
Propriété | S’il s’agit d’une ressource basée sur une propriété JCR |
Élément | S’il s’agit d’une ressource basée sur JCR (nœud ou propriété) |
Mappage | Renvoie un mappage des propriétés, s’il s’agit d’une ressource basée sur un nœud JCR (ou une autre ressource prenant en charge les mappages de valeurs) |
ValueMap | Renvoie un mappage simple d’emploi des propriétés, s’il s’agit d’une ressource basée sur un nœud JCR (ou une autre ressource prenant en charge les mappages de valeurs). On peut également obtenir ce résultat (plus simplement) en utilisant ResourceUtil.getValueMap(Resource) (gestion du cas de valeur nulle, etc) |
InheritanceValueMap | Extension de ValueMap, ce qui permet la prise en compte de la hiérarchie de ressources lors de la recherche de propriétés |
ModifiableValueMap | Une extension de la fonction ValueMap, qui permet de modifier les propriétés sur ce noeud. |
InputStream | Renvoie le contenu binaire d’une ressource « fichier » (s’il s’agit d’une ressource basée sur un nœud JCR et que le nœud est de type nt:file ou nt:resource ; s’il s’agit d’une ressource de type lot ; contenu du fichier s’il s’agit d’une ressource de système de fichiers) ou les données d’une ressource de propriété JCR binaire |
URL | Renvoie une URL pointant vers la ressource (URL de référentiel de ce nœud s’il s’agit d’une ressource basée sur un nœud JCR ; URL de lot JAR s’il s’agit d’une ressource de type lot ; URL de fichier s’il s’agit d’une ressource de système de fichiers) |
Fichier | S’il s’agit d’une ressource de système de fichiers |
SlingScript | Si cette ressource est un script (un fichier jsp, par exemple) pour lequel un moteur de script est enregistré auprès de sling |
Servlet | Si cette ressource est un script (un fichier jsp, par exemple) pour lequel un moteur de script est enregistré auprès de sling ou s’il s’agit de ressource de servlet. |
String Boolean Long Double Calendar Value String[] Boolean[] Long[] Calendar[] Value[] |
Renvoie les valeurs s’il s’agit d’une ressource basée sur une propriété JCR (et que la valeur convient). |
LabeledResource | S’il s’agit d’une ressource basée sur un nœud JCR |
Page | S’il s’agit d’une ressource basée sur un nœud JCR et que le nœud est cq:Page (ou cq:PseudoPage ) |
Composant | Si c’est un cq:Component ressource de noeud |
Conception | S’il s’agit d’un nœud de conception (cq:Page ) |
Modèle | Si c’est un cq:Template ressource de noeud |
Plan directeur | Si c’est un cq:Template ressource de noeud |
Asset | S’il s’agit d’une ressource de nœud dam:Asset |
Rendition | S’il s’agit d’un rendu dam:Asset (nt:file dans le dossier de rendu d’un nœud dam:Asset). |
Balise | Si c’est un cq:Tag ressource de noeud |
UserManager | En fonction de la session JCR, s’il s’agit d’une ressource basée sur JCR et que l’utilisateur est autorisé à accéder à UserManager |
Authorizable | Authorizable est la base commune de User et Group |
Utilisateur/Utilisatrice | Utilisateur/Utilisatrice est un objet Authorizable spécial qui peut être authentifié et dont il est possible d’emprunter l’identité |
SimpleSearch | Effectue une recherche sous la ressource (ou utilise setSearchIn()) s’il s’agit d’une ressource basée sur JCR |
WorkflowStatus | Statut du workflow pour le nœud de la payload de la page/du workflow donné |
ReplicationStatus | Statut de réplication de la ressource donnée ou de son sous-nœud jcr:content (vérifié en premier) |
ConnectorResource | Renvoie une ressource de connecteur adaptée pour certains types, s’il s’agit d’une ressource basée sur JCR |
Config | Si c’est un cq:ContentSyncConfig ressource de noeud |
ConfigEntry | Si ceci se trouve sous un cq:ContentSyncConfig ressource de noeud |
ResourceResolver s’adapte à :
Session | Session JCR de la requête, s’il s’agit d’un résolveur de ressources basé sur JCR (par défaut) |
PageManager | |
ComponentManager | |
Designer | |
AssetManager | Basé sur la session JCR, s’il s’agit d’un résolveur de ressources basé sur JCR |
TagManager | Basé sur la session JCR, s’il s’agit d’un résolveur de ressources basé sur JCR |
UserManager | UserManager permet d’accéder aux objets autorisables, c’est-à-dire les utilisateurs et les groupes, et de les gérer. UserManager est lié à une session particulière |
Authorizable | Utilisateur/utilisatrice actuel |
Utilisateur/Utilisatrice |
Utilisateur/utilisatrice actuel |
QueryBuilder | |
Service Externalizer | Pour externaliser des URL absolues, même sans l’objet de requête |
SlingHttpServletRequest s’adapte à :
Pas encore de cible, mais implémente l’interface Adaptable et peut être utilisé comme source dans une AdapterFactory personnalisée.
SlingHttpServletResponse s’adapte à :
ContentHandler (XML) |
S’il s’agit d’une réponse de réécriture sling |
Page s’adapte à :
Ressource |
Ressource de la page |
LabeledResource | Ressource étiquetée (== this) |
Nœud | Nœud de la page |
… | Tous les éléments auxquels la ressource de la page peut être adaptée |
Component s’adapte à :
Resource | Ressource du composant. |
---|---|
LabeledResource | Ressource étiquetée (== this). |
Node | Nœud du composant. |
… | Tous les éléments auxquels la ressource du composant peut être adaptée. |
Template s’adapte à :
Resource |
Ressource du modèle |
LabeledResource | Ressource étiquetée (== this) |
Nœud | Nœud de ce modèle |
… | Tous les éléments auxquels la ressource du modèle peut être adaptée. |
Authorizable, Utilisateur et Groupe** adapter à :
Node | Renvoie le nœud racine utilisateur/groupe. |
---|---|
ReplicationStatus | Renvoie le statut de réplication pour le nœud racine utilisateur/groupe. |
Asset s’adapte à :
Resource | Ressource de l’actif. |
---|---|
Node | Nœud de la ressource. |
… | Tous les éléments auxquels la ressource de l’actif peut être adaptée. |
Tag s’adapte à :
Resource | Ressource de la balise. |
---|---|
Node | Nœud de la balise. |
… | Tous les éléments auxquels la ressource de la balise peut être adaptée. |
Sling/JCR/OCM fournit, en outre, un [AdapterFactory](https://sling.apache.org/site/adapters.html#Adapters-AdapterFactory)
pour les objets OCM (Object Content Mapping) personnalisés.