Mindbreeze InSpire SDK Plugins
Mindbreeze Item Transformation und Post Filter Plugins

Einführung

Für die Erstellung und Bereitstellung der Beispiele aus diesem Dokument wird die folgende Software von Drittanbietern benötigt:

• Java SE Development Kit: Version 1.8 oder neuer
• Eclipse IDE für Java-Entwickler

Installation des Mindbreeze Software Development Toolkit

Wenn Sie Microsoft Windows verwenden: Installieren Sie das Mindbreeze SDK, indem Sie MesSDKSetup.exe ausführen.

Wenn Sie Linux oder OSX verwenden: Entpacken Sie die Datei mes-devel-<version>.zip in einen Ordner Ihrer Wahl und fügen Sie den Ordner SDK/bin aus dem Archiv zu Ihrer Path-Variable hinzu.

Ein Mindbreeze-Plugin-Projekt generieren

Das Mindbreeze Software Development Toolkit enthält ein Werkzeug zum Generieren von Mindbreeze-Plugin-Projekten: mesjavaplugin.bat für Microsoft Windows-Installationen und mesjavaplugin.sh für Unix-basierte Systeme. Das Tool kann für die Generierung der folgenden Mindbreeze Erweiterungstypen verwendet werden:

• datasource: Crawler-, Kontext- und Autorisierungs-Plugin für eine bestimmte Datenquelle.
• filter: Filter-Plugin für einen bestimmten Datentyp.
• postfilter: Post-Filter-Transformations-Plugin.
• itemtransformer: Item Transformation Plugin.

Wenn das Werkzeug mesjavaplugin ohne Parameter aufgerufen wird, zeigt es seine Verwendung anhand von Beispielen an:

Der Parameter <name> ist der Name des Plugins. Das Projekt wird in einem Ordner mit dem Namen dieses Parameters in Kleinbuchstaben im aktuellen Pfad erstellt.

Der Parameter <base package> ist das Java-Paket, in dem die Quelldateien erstellt werden.

Beispiel 1: Ein Post Filter Transformation Plugin

Führen Sie die folgenden Schritte aus, um ein Post-Filter-Transformation Plugin zum Bearbeiten oder Hinzufügen benutzerdefinierter Metadaten zu erstellen und bereitzustellen:

1. Erstellen Sie das Plugin-Projekt: mesjavaplugin.sh postfilter MetadataProcessor com.mycompany

1. Navigieren Sie zum Ordner „metadataprocessor“ in Ihrem aktuellen Pfad.

1. Importieren Sie das neu erstellte Projekt in Ihre Eclipse IDE:

1. Nach dem erfolgreichen Import des Projekts finden Sie eine Stub-Implementierung des Plugins in der Datei MetadataProcessorPostFilter.java:

Hinweis: Der Name der Java-Datei ist <name>PostFilter.java, wobei <name> der Name des Plugin-Parameters aus dem vorherigen Schritt ist.

1. Passen Sie den Quellcode an Ihre Bedürfnisse an. Beispielsweise würde die folgende Implementierung ein Metadatum namens “meta” mit dem String-Wert „value” hinzufügen:

private void processRequest(FilterAndIndexRequest.Builder request) {

    // Clone the request

    Metadata.Builder metadataBuilder = request.getContentBuilder().getMetadataBuilder();

    NamedValue.Builder namedValueBuilder = NamedValue.newBuilder();

    namedValueBuilder.setName("meta");

    namedValueBuilder.addValue(ValueHelper.newBuilder("value"));

    metadataBuilder.addMetadatum(namedValueBuilder)

}

1. Erstellen Sie das Plugin-Archiv, indem Sie das Skript build.bat auf Windows-Systemen oder build.sh auf Unix-Systemen im Projektverzeichnis ausführen. Wenn der Vorgang erfolgreich war, sollte ein Archiv mit dem Namen <name>-postfilter.zip erstellt worden sein. Auch hier ist <name> der vorher angegebene Parameter für den Plugin-Namen.

1. Das Plugin kann nun über den Tab “Plugins” im Management Center installiert werden:

1. Nach der erfolgreichen Installation kann das Plugin für jeden Filter-Service aktiviert werden:

Beispiel 2: Ein Item-Transformer Plugin

Führen Sie die folgenden Schritte aus, um ein Item-Transformer-Plugin zum Bearbeiten oder Hinzufügen benutzerdefinierter Metadaten zu erstellen:

1. Erstellen Sie das Plugin-Projekt: mesjavaplugin.sh itemtransformer MetadataProcessor com.mycompany

1. Navigieren Sie zum Ordner metadataprocessor in Ihrem aktuellen Pfad.

1. Importieren Sie das neu erstellte Projekt in ihrer Eclipse IDE (wie im vorherigen Beispiel).

1. Nach dem erfolgreichen Import des Projekts finden Sie eine Stub-Implementierung des Plugins in der Datei MetadataProcessorItemTransformerService.java:

1. Erweitern Sie den Code entsprechend Ihren Anforderungen. Dieses Beispiel fügt erneut ein Metadatum namens „meta“ mit dem Wert „value“ hinzu:

    private void processItem(Item.Builder itemBuilder) {

    itemBuilder.addProperty(

    NamedValue.newBuilder()

    .setName("meta")

    .addValue(ValueHelper.newBuilder("value"))

    );

}

1. Erstellen Sie das Plugin-Archiv, indem Sie das Skript build.bat auf Windows-Systemen oder build.sh auf Unix-Systemen im Projektverzeichnis ausführen. Wenn der Vorgang erfolgreich war, sollte ein Archiv mit dem Namen <name>-postfilter.zip erstellt worden sein. Auch hier ist <name> der vorher angegebene Parameter für den Plugin-Namen.

1. Das Plugin kann nun über den Tab “Plugins” im Management Center installiert werden:

1. Nach der erfolgreichen Installation steht das Plugin für alle Index Services zur Verfügung.

Plugin-Konfiguration

Wie Sie in beiden Beispielen sehen konnten, ist es möglich, Eigenschaften für die installierten Plugins über die Konfigurationsschnittstelle zu definieren, indem benutzerdefinierte Plugin-Eigenschaften hinzugefügt werden.

Diese Konfigurationseigenschaften sind im Quellcode des Plugins über die Properties-Map zugänglich:

Map<String, List<String>> properties = null;

Die Init-Methode, die die Konfigurationseigenschaften abruft, wird automatisch aufgerufen, wenn das Plugin die Schnittstelle com.mindbreeze.enterprisesearch.mesapi.Initializable implementiert.

Das vorherige Beispiel eines Item Transformer Plugins, das nun einen Metadatenwert auf einen Konfigurationsparameter namens „meta“ setzt, sieht wie folgt aus:

    private void processItem(Item.Builder itemBuilder) {

    if (properties != null && properties.containsKey("meta")) {

    List<String> values = properties.get("meta");

    if (values != null && !values.isEmpty()) {

    String value = values.get(0);

    if (value != null) {

    itemBuilder.addProperty(

            NamedValue.newBuilder()

            .setName("meta")

            .addValue(ValueHelper.newBuilder(value))

            );

    }

    }

    }

    }

Abschnitt zur Konfiguration der Plugin-Beschreibung

Die Plugin-Beschreibung „plugins.xml“ beschreibt die im Archiv verfügbaren Plugins. Die Gliederung ist wie folgt:

version

plugins

Plugin

id

kind

extension

code

wenn “kind” CODE ist

properties

für vordefinierte Eigenschaften, die an das Plugin übergeben werden

config_options

• Das Element config_options selbst ist eine Sprache zur Beschreibung von Elementen der Konfigurationsbenutzeroberfläche und ermöglicht es dem Plugin-Entwickler daher, die Mindbreeze InSpire-Konfigurationsschnittstelle zu erweitern. Als Beispiel erweitert die folgende Konfiguration die Konfigurationsbenutzeroberfläche um die Eigenschaft „meta“.  Zum Zeitpunkt der Erstellung dieser Dokumentation unterstützt die Konfigurationsschnittstelle nur englische Übersetzungen. Unterstützte Eingabetypen sind TEXT, NUMBER, BOOLEAN, TEXTAREA, SELECT, PASSWORD, CREDENTIAL. Standardwerte können über default_string oder default_numeric hinzugefügt werden. Auswahloptionen können mit dem Element select_option definiert werden.

      <config_option>

        <Group>

          <label>

            <LangString>

              <lang>en</lang>

              <value>Base Configuration</value>

            </LangString>

          </label>

          <level>DEFAULT_LEVEL</level>

          <option>

            <Option>

              <name>meta</name>

              <input>TEXT</input>

              <hint>The value that is added as the meta property.</hint>

              <label>

                <LangString>

                  <lang>en</lang>

                  <value>meta property value</value>

                </LangString>

              </label>

              <option />

            </Option>            

          </option>

        </Group>

      </config_option>