Implementieren der Connector-Schnittstelle
Führen Sie die folgenden Schritte aus, um die Schnittstelle und ihre Funktionen gemäß Ihren Anforderungen zu implementieren:
- Definieren Sie eine standardisierte Methode für die Integration der Connectoren mit einem System, sodass Abfragen ausgeführt, Verbindungen validiert und Metadaten abgerufen werden können.
- Erleichterung der UI-Integration durch Bereitstellung der Standardmethoden zum Konfigurieren von Vorlagen, Logos, Abfragen und anderen Einstellungen.
- Stellen Sie sicher, dass die Connectoren ordnungsgemäß validiert sind und Fehler (
KonnectException
) bei der Interaktion mit Datenquellen verarbeiten können.
Die Schnittstelle dient als Blueprint für die Implementierung verschiedener Arten von Daten-Connectoren und stellt sicher, dass die Connectoren alle spezifischen Integrations- und Betriebsanforderungen in einem größeren Software-Ökosystem erfüllen.
Wichtige Funktionen
Implementieren Sie die folgenden wichtigen Funktionen:
-
Diese Methode gibt die URL zurück, die als Logo des Connectors verwendet wird.
-
Standardmäßig wird eine leere Zeichenfolge zurückgegeben, was darauf hinweist, dass keine Logo-URL bereitgestellt wird, es sei denn, sie wird überschrieben.
zusätzliche Hinweise:- Wenn Sie sowohl eine Logo-URL als auch einen Logo-Klassennamen angeben, wird die Logo-URL verwendet, um das Logo in der Benutzeroberfläche anzuzeigen.
- Wenn Sie die Logo-URL über die Konfigurationseinstellungen angeben, überschreibt sie die in der Methodenimplementierung festgelegte URL.
- Verwenden Sie diese Methode, um zu überprüfen, ob der Connector eine Verbindung zu seiner Datenquelle herstellen kann.
- Dazu wird ein
ConfigDto
-Objekt als Parameter benötigt, das die Konfigurationseinstellungen wie Verbindungsanmeldeinformationen und Endpunkt-URLs enthält. - Die Methode gibt „true“ zurück, wenn die Validierung (Verbindungstest) erfolgreich war. Dies bedeutet, dass der Connector eine Verbindung zu seiner Datenquelle herstellen kann.
- Verwenden Sie diese Methode, um eine einzelne Abfrage für den Connector auszuführen und mit einer Datenquelle zu interagieren.
- Die Connectoren, die diesen Vorgang unterstützen, handhaben die Ausführung der Abfrage, parsen die Antwort und konvertieren sie bei Bedarf in eine JSON-Zeichenfolge.
- Kapseln Sie die in dieser Methode auszuführende Abfrage in einem
QueryInfoDto
-Objekt, das Details wie die Abfragezeichenfolge und Parameter enthält. - Die Methode gibt eine JSON-Zeichenfolge zurück, die die Antwort aus der Ausführung der Abfrage darstellt.
zusätzliche Hinweise: - Implementierungen dieser Methode variieren je nach dem spezifischen Connector und seiner Interaktion mit der Datenquelle.
- Verwenden Sie die
KonnectException
, um alle Ausnahmen oder Fehler zu behandeln, die während der Ausführung oder Verbindung mit der Datenquelle auftreten.
- Verwenden Sie diese Methode für denselben Zweck wie
execute()
, jedoch mit der zusätzlichen Funktion, eine einschränkende Abfrage anzuwenden, normalerweise zum Anzeigen der Vorschauen in Benutzeroberflächenkomponenten. - Connectoren, die diesen Vorgang unterstützen, handhaben die Ausführung der Abfrage, parsen die Antwort und konvertieren sie bei Bedarf in eine JSON-Zeichenfolge.
- Kapseln Sie die in dieser Methode auszuführende Abfrage in einem
QueryInfoDto
Objekt, ähnlich der vorherigen Methode.
zusätzliche Hinweise:QueryResultDto
ist eine benutzerdefinierte Klasse oder ein Datenübertragungsobjekt, das das Ergebnis der Abfrageausführung einschließlich Metadaten zur Abfrage und deren Ausführungsstatus enthält.
- Diese Methode gibt eine Beispiel-Abfragezeichenfolge zurück, die in der Benutzeroberfläche angezeigt werden kann, z. B. im Dialogfeld, in dem Benutzer Abfragen einfügen oder bearbeiten können.
- Standardmäßig wird eine leere Zeichenfolge zurückgegeben, was darauf hinweist, dass keine Beispielabfrage bereitgestellt wird, es sei denn, sie wird überschrieben.
zusätzliche Hinweise:- Wenn Sie keine Beispielabfrage definieren und die Methode eine leere Zeichenfolge zurückgibt, wird im Dialogfeld zum Einfügen der Abfrage in der Benutzeroberfläche keine Beispielabfrage angezeigt.
- Diese Methode gibt eine Liste von Vorlagen zurück, die mit dem Connector verknüpft sind.
- Standardmäßig wird eine leere Liste zurückgegeben, was bedeutet, dass keine Vorlagen bereitgestellt werden, es sei denn, sie werden überschrieben.
-
Diese Methode gibt den Klassennamen als Logo des Connectors zurück. Standardmäßig wird eine leere Zeichenfolge zurückgegeben, was darauf hinweist, dass kein Logo-Klassenname bereitgestellt wird, es sei denn, er wird überschrieben.
zusätzliche Hinweise:- Wenn Sie sowohl eine Logo-URL als auch einen Logo-Klassennamen angeben, wird die Logo-URL verwendet, um das Logo in der Benutzeroberfläche anzuzeigen.
- Wenn Sie den Namen der Logoklasse über die Konfigurationseinstellungen angeben, überschreibt er den in der Methodenimplementierung festgelegten Klassennamen.
- Diese Methode prüft, ob ein
connector
aktiviert ist. - Standardmäßig gibt die Methode false zurück. Das bedeutet, dass der Connector nur aktiviert wird, wenn er von einer Klasse überschrieben wird, die diese Methode implementiert.
- Verwenden Sie diese Methode, um eine Beschreibungszeichenfolge zurückzugeben, die in der Benutzeroberfläche angezeigt werden kann.
- Standardmäßig wird eine leere Zeichenfolge zurückgegeben, was bedeutet, dass keine Beschreibung bereitgestellt wird, es sei denn, sie wird überschrieben.
- Diese Methode bietet eine Möglichkeit, den Namen des Autors abzurufen, der den Connector erstellt hat oder für ihn verantwortlich ist.
- Dies hilft in der Regel dabei, den Ersteller oder Betreuer des Connectors innerhalb eines Systems oder Frameworks zu identifizieren und zu bestätigen.
- Diese Methode bietet eine Möglichkeit, den eindeutigen Namen abzurufen, der einem Connector zugewiesen ist.
- Der zurückgegebene Name ist wichtig, um den Connector in einem Benutzeroberflächen-Kontext zu identifizieren, insbesondere wenn in den Konfigurationseinstellungen des Connectors kein expliziter Name angegeben ist.
- Dieser Name wird in verschiedenen UI-Komponenten verwendet, um Connectoren benutzerfreundlich anzuzeigen oder zu verwalten.
- Diese Methode bietet eine Möglichkeit, den mit einem Connector verknüpften Gruppennamen abzurufen.
- Gruppennamen werden normalerweise verwendet, um Connectoren basierend auf ihrer Funktionalität, ihrem Zweck oder ihrem Typ in logische Gruppen zu organisieren oder zu kategorisieren.
- Dies ermöglicht eine einfachere Verwaltung und Darstellung von Connectoren in der Konfigurationsoberfläche.
- Diese Methode gibt den Standardpfad für die mit diesem Connector verknüpften Vorlagen zurück.
- Standardmäßig wird eine leere Zeichenfolge zurückgegeben. Dies bedeutet, dass kein Standardpfad festgelegt wird, es sei denn, er wird überschrieben.
- Mit dieser Methode geben Sie die SVG-Darstellung des Connector-Logos zurück.
- Standardmäßig wird eine leere Zeichenfolge zurückgegeben, was darauf hinweist, dass keine SVG-Daten bereitgestellt werden, es sei denn, sie werden überschrieben.
- Diese Methode gibt die maximale Anzahl von Zeilen zurück, die in der Vorschau der Benutzeroberfläche abgefragt oder angezeigt werden.
- Standardmäßig wird der Wert von DEFAULT_LIMIT_PREVIEW zurückgegeben, eine Konstante, die das standardmäßige Limit für Vorschauzeilen darstellt.
- Diese Methode stellt Informationen über die Klassen bereit, die die Config-Schnittstelle implementieren und von diesem Connector unterstützt werden.
- Dadurch kann das Programm oder Framework mit Konfigurationen, die mit dem Connector kompatibel sind, dynamisch suchen und arbeiten.