Configurer des connecteurs de source de données personnalisés
Experience Manager Guides vous permet de personnaliser les connecteurs en fonction de vos besoins, puis de les utiliser avec les différentes sources de données. Pour personnaliser un connecteur, vous devez implémenter l’interface du connecteur et ses fonctions importantes, puis configurer l’interface. Vous pouvez également fournir les ressources avec les connecteurs personnalisés.
Personnaliser un connecteur pour Experience Manager Guides customize-connector
Vous pouvez personnaliser ou configurer un connecteur pour une source de données à l’aide des interfaces prédéfinies et des classes abstraites. L’intégralité du code source est disponible à l’adresse https://github.com/adobe/guides-data-source-connectors/tree/main/konnect-definitions.
Reportez-vous à pour les définitions de connexion.
Implémentation de l’interface du connecteur implement-interface
Pour implémenter l’interface et ses fonctions en fonction de vos besoins, procédez comme suit :
- Définissez une méthode normalisée pour l’intégration des connecteurs à un système, permettant l’exécution des requêtes, la validation des connexions et la récupération des métadonnées.
- Simplifiez l’intégration de l’interface utilisateur en fournissant les méthodes par défaut pour configurer des modèles, des logos, des requêtes et d’autres paramètres.
- Assurez-vous que les connecteurs sont correctement validés et qu’ils peuvent gérer les erreurs (
KonnectException) lors de l’interaction avec les sources de données.
L’interface sert de plan directeur pour la mise en œuvre de divers types de connecteurs de données, en veillant à ce que les connecteurs répondent à toutes les exigences d’intégration et d’exploitation spécifiques au sein d’un écosystème logiciel plus vaste.
Fonctions importantes important-functions
Implémentez les fonctions importantes suivantes :
-
Cette méthode renvoie l’URL utilisée comme logo du connecteur.
-
Par défaut, elle renvoie une chaîne vide, indiquant qu’aucune URL de logo n’est fournie, sauf si elle est remplacée.
notes supplémentaires :- Si vous fournissez à la fois une URL de logo et un nom de classe de logo, l’URL de logo est utilisée pour afficher le logo dans l’interface utilisateur.
- Si vous spécifiez l’URL du logo via les paramètres de configuration, elle remplace l’URL définie dans l’implémentation de la méthode .
- Utilisez cette méthode pour vérifier si le connecteur peut établir une connexion à sa source de données.
- Elle prend un objet
ConfigDtoen tant que paramètre, qui contient les paramètres de configuration tels que les informations d’identification de connexion et les URL de point d’entrée. - La méthode renvoie true si la validation (test de connexion) est réussie, indiquant que le connecteur peut se connecter à sa source de données.
- Utilisez cette méthode pour exécuter une seule requête pour le connecteur, en interagissant avec une source de données.
- Les connecteurs prenant en charge cette opération gèrent l’exécution de la requête, analysent la réponse et la convertissent en chaîne JSON si nécessaire.
- Encapsulez la requête à exécuter dans cette méthode dans un objet
QueryInfoDto, qui contient des détails tels que la chaîne de requête et les paramètres. - La méthode renvoie une chaîne JSON qui représente la réponse de l’exécution de la requête.
Remarques Supplémentaires : - Les implémentations de cette méthode varient en fonction du connecteur spécifique et de son interaction avec la source de données.
- Utilisez le
KonnectExceptionpour gérer les exceptions ou les erreurs qui se produisent lors de l’exécution ou de la connexion à la source de données.
- Utilisez cette méthode dans le même but que
execute(), mais avec la fonctionnalité supplémentaire d’appliquer une requête de limitation, généralement pour afficher les aperçus dans les composants de l’interface utilisateur. - Les connecteurs prenant en charge cette opération gèrent l’exécution de la requête, analysent la réponse et la convertissent en chaîne JSON si nécessaire.
- Encapsulez la requête à exécuter dans cette méthode dans un objet
QueryInfoDto, comme pour la méthode précédente.
Remarques Supplémentaires :QueryResultDtoest une classe ou un objet de transfert de données personnalisé qui encapsule le résultat de l’exécution de la requête, y compris les métadonnées sur la requête et son statut d’exécution.
- Cette méthode renvoie un exemple de chaîne de requête qui peut être affiché dans l’interface utilisateur, par exemple dans la boîte de dialogue où les utilisateurs peuvent insérer ou modifier des requêtes.
- Par défaut, elle renvoie une chaîne vide, indiquant qu’aucun exemple de requête n’est fourni, sauf s’il est remplacé.
Remarques Supplémentaires :- Si vous ne définissez pas d’exemple de requête et que la méthode renvoie une chaîne vide, aucun exemple de requête n’est affiché dans la boîte de dialogue d’insertion de requête de l’interface utilisateur.
- Cette méthode renvoie une liste de modèles associés au connecteur.
- Par défaut, il renvoie une liste vide, indiquant qu’aucun modèle n’est fourni, sauf s’il est remplacé.
-
Cette méthode renvoie le nom de la classe comme logo du connecteur. Par défaut, il renvoie une chaîne vide, indiquant qu’aucun nom de classe de logo n’est fourni, sauf s’il est remplacé.
Remarques Supplémentaires :- Si vous fournissez à la fois une URL de logo et un nom de classe de logo, l’URL de logo est utilisée pour afficher le logo dans l’interface utilisateur.
- Si vous spécifiez le nom de classe du logo via les paramètres de configuration, il remplace le nom de classe défini dans l’implémentation de la méthode .
- Cette méthode vérifie si un
connectorest activé. - Par défaut, la méthode renvoie false, ce qui signifie que le connecteur n’est pas activé, sauf s’il est remplacé par une classe implémentant cette méthode.
- Utilisez cette méthode pour renvoyer une chaîne de description qui peut être affichée dans l’interface utilisateur.
- Par défaut, elle renvoie une chaîne vide, indiquant qu’aucune description n’est fournie, sauf si elle est remplacée.
- Cette méthode permet de récupérer le nom de l’auteur qui a créé le connecteur ou qui en est responsable.
- Il permet généralement d’identifier et de reconnaître le créateur ou le responsable du connecteur dans un système ou une structure.
- Cette méthode permet de récupérer le nom unique attribué à un connecteur.
- Le nom renvoyé est essentiel pour identifier le connecteur dans un contexte d’interface utilisateur, en particulier si les paramètres de configuration du connecteur ne spécifient pas explicitement un nom.
- Ce nom est utilisé dans divers composants de l’interface utilisateur pour afficher ou gérer les connecteurs d’une manière conviviale.
- Cette méthode permet de récupérer le nom du groupe associé à un connecteur.
- Les noms de groupe sont généralement utilisés pour organiser ou catégoriser les connecteurs en groupes logiques en fonction de leur fonctionnalité, de leur objectif ou de leur type.
- Cela permet une gestion et une présentation plus faciles des connecteurs dans l’interface utilisateur de configuration.
- Cette méthode renvoie le chemin d’accès par défaut pour les modèles associés à ce connecteur.
- Par défaut, elle renvoie une chaîne vide, indiquant qu’aucun chemin d’accès par défaut n’est défini, sauf s’il est remplacé.
- Utilisez cette méthode pour renvoyer la représentation SVG du logo du connecteur.
- Par défaut, il renvoie une chaîne vide, indiquant qu’aucune donnée SVG n’est fournie, sauf si elle est remplacée.
- Cette méthode renvoie le nombre maximal de lignes interrogées ou affichées dans l’aperçu de l’interface utilisateur.
- Par défaut, elle renvoie la valeur de DEFAULT_LIMIT_PREVIEW, une constante représentant la limite par défaut pour les lignes d’aperçu.
- Cette méthode fournit des informations sur les classes qui implémentent l’interface Config et qui sont prises en charge par ce connecteur.
- Il permet à l’application ou au framework de découvrir et d’utiliser de manière dynamique des configurations compatibles avec le connecteur.
Types d’implémentations du connecteur par défaut default-connectors
La bibliothèque konnect-définitions est fournie avec des implémentations de connecteur abstrait et des fonctions prédéfinies pour exécuter des requêtes. Ces implémentations de connecteur agissent comme des modèles qui peuvent être directement étendus et utilisés en l’état. Si une implémentation personnalisée est requise, ses fonctions peuvent être remplacées.
Outre l’implémentation des connecteurs par défaut, vous pouvez également implémenter l’une des classes abstraites par défaut suivantes :
- Connecteur Rest
- Connecteur de fichiers
- Connecteur GraphQL
- Connecteur SQL
- Connecteur NoSQL
Si un connecteur correspond à l’un de ces types, étendez le connecteur à la classe de base correspondante. Sinon, créez-le à partir de zéro en implémentant l’interface du connecteur.
Interface de configuration config-interface
L’interface Config est conçue pour configurer une source de données avec une méthode d’authentification spécifique, ce qui vous permet de contrôler précisément la création de la connexion.
L’interface Config offre une certaine flexibilité quant à la manière dont les détails d’authentification sont traités et implémentés. Différentes mises en œuvre peuvent offrir différentes manières d’authentifier les sources de données. Un connecteur utilise une instance Config pour exécuter et valider des requêtes sur une source de données, formant un workflow complet.
Un connecteur utilise une instance Config pour exécuter et valider des requêtes sur une source de données, formant ainsi un workflow complet.
Une implémentation de configuration définit la manière dont l’authentification est gérée pour se connecter à une source de données. Cette configuration est ensuite utilisée par une implémentation du connecteur pour interagir avec la source de données, en veillant à ce que les requêtes soient exécutées et validées correctement.
Dans l’ensemble, l’interface Config est une partie essentielle du workflow de connexion aux sources de données, en se concentrant spécifiquement sur la configuration de l’authentification.
Types d’implémentations de configuration par défaut default-config-types
Il existe trois types d’implémentation de configuration abstraite par défaut pour l’authentification :
- RestConfig
- SqlConfig
- NoSqlConfig
Si une configuration s’aligne sur l’un de ces types, elle peut étendre la classe de base correspondante. Sinon, il peut être créé à partir de zéro en implémentant l’interface de configuration.
Implémentations de configuration concrètes concrete-config-implementation
La bibliothèque konnect-definition est fournie avec des implémentations prédéfinies de l’interface Config pour certaines configurations d’authentification couramment utilisées. Vous pouvez utiliser ces configurations directement dans le connecteur ou en définir de nouvelles à l’aide de l’interface de configuration. Ces implémentations incluent :
- Configuration d’authentification de la clé API
- Configuration de base basée sur un jeton d’authentification
- Configuration d’authentification de base
- Configuration du jeton porteur
- Configuration du mot de passe du nom d’utilisateur pour SQL
- Configuration de l’authentification des chaînes de connexion pour NoSQL
Ressources supplémentaires resources
Experience Manager Guides vous permet également de fournir des ressources personnalisées pour les logos et les modèles ainsi que pour la mise en œuvre. Vous pouvez conserver ces ressources dans le dossier resources.
Pour les rendre utilisables par le connecteur, il est obligatoire d’implémenter les fonctions de connecteur suivantes :
-
getLogoSvg- Renvoie le logo SVG sous forme de chaîne. -
getTemplates- Renvoie la liste des modèles au format spécifié.