| commit | 1906dfb90198b4e43a6ed2ed8ab4e491ff62cf45 | [log] [tgz] |
|---|---|---|
| author | Marc Kupietz <kupietz@ids-mannheim.de> | Sat Mar 26 17:31:07 2022 +0100 |
| committer | Marc Kupietz <kupietz@ids-mannheim.de> | Sat Mar 26 22:40:09 2022 +0100 |
| tree | c82c060192a1a3b46df2176cf0911c4ee4b026d7 | |
| parent | d475d714e8b885307eec6d60fa34050377d48e5d [diff] |
Bump jackson-databind from 2.12.5 to 2.13.2.1 Bumps [jackson-databind](https://github.com/FasterXML/jackson) from 2.12.5 to 2.13.2.1. - [Release notes](https://github.com/FasterXML/jackson/releases) - [Commits](https://github.com/FasterXML/jackson/commits) Change-Id: I937c561619cc393bb9a294483c4024bd3f5de2c5 --- updated-dependencies: - dependency-name: com.fasterxml.jackson.core:jackson-databind dependency-type: direct:production update-type: version-update:semver-minor ... Resolves https://github.com/KorAP/Kalamar-Plugin-Export/security/dependabot/2 Resolves CVE-2020-36518 Change-Id: I4c499bebdf65dcc6b88e8395efbb7164fd219633
Kalamar-Plugin-Export
Description
Kalamar-Plugin-Export is a web service that integrates in the plugin framework of Kalamar, to export matches for the KorAP Corpus Analysis Platform in various formats. Currently supported are RTF, CSV, and JSON.
Kalamar-Plugin-Export is meant to be a basic export plugin and should demonstrate and evaluate the plugin capabilities of Kalamar.
Prerequisites
Java 8 (OpenJDK or Oracle JDK), Git, Maven 3. Further dependencies are resolved using Maven.
Build
To build the latest version of Kalamar-Plugin-Export, do ...
$ git clone https://github.com/KorAP/Kalamar-Plugin-Export $ cd Kalamar-Plugin-Export
... and build the jar file ...
$ mvn clean package
Afterwards the jar file is located in the target/ folder and can be started with ...
$ java -jar KalamarExportPlugin-[VERSION].jar
Per default, this will start a server at http://localhost:7777. It will also create a subfolder files to temporarily store created exports.
Registration of the plugin in Kalamar is not yet officially supported. Registration works by passing the following JSON blob to the plugin registration handler.
{ "name" : "Export", "desc" : "Exports Kalamar results", "embed" : [{ "panel" : "result", "title" : "exports KWICs and snippets", "icon" : "\uf019", "classes" : ["button-icon", "plugin" ], "onClick" : { "action" : "addWidget", "template" : "http://localhost:7777/export", "permissions":["forms","scripts","downloads"] } }] }
The simplest way to do this at the moment is by storing the json blob in a file (the blob needs to be in a list, i.e. surrounded by [...]). The file then can be loaded using the Plugins addon in Kalamar using the Kalamar configuration file.
{ Kalamar => { plugins => ['Plugins'], }, 'Kalamar-Plugins' => { default_plugins => 'plugins.json' } }
For example, with this configuration addition, the content of plugins.json will be registered on every Kalamar page load.
An example demo showcases the embedded plugin.
Customization
The basic configuration file is stored in src/main/resources/exportPlugin.conf. To change the configuration create a new config file and run the jar with the according filename as argument:
$ java -jar KalamarExportPlugin-[VERSION].jar myconf_exportPlugin.conf
Alternatively a file named exportPlugin.conf can be stored in the same directory as the java jar.
License
Copyright (c) 2020-2021, IDS Mannheim, Germany
Kalamar-Plugin-Export is developed as part of the KorAP Corpus Analysis Platform at the Leibniz Institute for the German Language (IDS).
Kalamar-Plugin-Export is published under the BSD-2 License.