mirror of
https://github.com/NetherlandsForensicInstitute/hansken-extraction-plugin-sdk-documentation.git
synced 2026-05-07 02:36:38 +00:00
191 lines
12 KiB
HTML
191 lines
12 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" data-content_root="../">
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>Frequently Asked Questions — Hansken Extraction Plugins for plugin developers 0.9.16
|
||
documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d75fae25" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/wider_pages.css?v=32ad70ab" />
|
||
|
||
|
||
<script src="../_static/jquery.js?v=5d32c60e"></script>
|
||
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||
<script src="../_static/documentation_options.js?v=433a2a34"></script>
|
||
<script src="../_static/doctools.js?v=9a2dae69"></script>
|
||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<script src="../_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="Contact" href="../contact.html" />
|
||
<link rel="prev" title="Examples" href="examples.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="../index.html" class="icon icon-home">
|
||
Hansken Extraction Plugins for plugin developers
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="concepts.html">General concepts</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="spec.html">Extraction Plugin specifications</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="java.html">Java</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="python.html">Python</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Frequently Asked Questions</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#how-can-i-access-hansken-developer-community">How can I access Hansken developer community</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#why-use-extraction-plugins">Why use Extraction Plugins?</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#what-programming-languages-are-supported">What programming languages are supported?</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#will-you-support-language-foobar">Will you support language <em>foobar</em>?</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#can-i-reuse-or-modify-the-extraction-plugins-sdk">Can I reuse or modify the Extraction Plugins SDK?</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#can-i-use-a-plugin-that-someone-else-wrote">Can I use a plugin that someone else wrote?</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#what-are-the-legal-implications-of-creating-your-own-extraction-plugin-s">What are the legal implications of creating your own Extraction Plugin(s)?</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#how-safe-are-extraction-plugins">How safe are Extraction Plugins?</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#can-my-extraction-plugin-be-embedded-into-hansken-for-performance-reasons">Can my Extraction Plugin be embedded into Hansken for performance reasons?</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../contact.html">Contact</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../changes.html">Changelog</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../index.html">Hansken Extraction Plugins for plugin developers</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item active">Frequently Asked Questions</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="../_sources/dev/faq.md.txt" rel="nofollow"> View page source</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="frequently-asked-questions">
|
||
<h1>Frequently Asked Questions<a class="headerlink" href="#frequently-asked-questions" title="Link to this heading"></a></h1>
|
||
<section id="how-can-i-access-hansken-developer-community">
|
||
<span id="communityaccess"></span><h2>How can I access Hansken developer community<a class="headerlink" href="#how-can-i-access-hansken-developer-community" title="Link to this heading"></a></h2>
|
||
<p>You will first need git access to the Hansken developer community. Here you can find started guides and examples. If you
|
||
have no access yet, you can get access by following the next steps:</p>
|
||
<ol class="arabic simple">
|
||
<li><p>Sign up at <a class="reference external" href="https://git.eminjenv.nl/">git.eminjenv.nl</a></p></li>
|
||
<li><p>After you have created your account, you should request access to the ”
|
||
Hansken Community” group . Do this by contacting your organisations Hansken business owner. If you don’t know who to
|
||
contact as your business owner, please read the <a class="reference internal" href="../contact.html"><span class="doc">Contact</span></a> page.</p></li>
|
||
</ol>
|
||
</section>
|
||
<section id="why-use-extraction-plugins">
|
||
<h2>Why use Extraction Plugins?<a class="headerlink" href="#why-use-extraction-plugins" title="Link to this heading"></a></h2>
|
||
<p>Extraction plugins enable you to run your own extraction code in Hansken.</p>
|
||
<ul class="simple">
|
||
<li><p>Your plugin runs during extraction</p></li>
|
||
<li><p>Extraction plugins are faster than Hansken.py</p></li>
|
||
<li><p>Multiple programming languages are supported</p></li>
|
||
<li><p>Scalability: Extraction plugins can be scaled flexibly on a kubernetes cluster</p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="what-programming-languages-are-supported">
|
||
<h2>What programming languages are supported?<a class="headerlink" href="#what-programming-languages-are-supported" title="Link to this heading"></a></h2>
|
||
<p>The SDK contains an API and tools to write a Hansken extraction plugin in Java or Python. The Java API can be used to
|
||
develop extraction plugins in JVM-compatible languages, such as Scala and Kotlin.</p>
|
||
</section>
|
||
<section id="will-you-support-language-foobar">
|
||
<h2>Will you support language <em>foobar</em>?<a class="headerlink" href="#will-you-support-language-foobar" title="Link to this heading"></a></h2>
|
||
<p>Probably not. It takes time and effort to create a proper SDK. If you think there is a good use case to support
|
||
language <em>foobar</em>, and there is gRPC support, feel free to contact us. We can discuss the options to add support for
|
||
Hansken extraction plugins with <em>foobar</em>.</p>
|
||
<p>Under the hood, extraction plugins use gRPC to communicate with Hansken. In theory, all programming languages that have
|
||
a gRPC implementation can be used to write Hansken extraction plugins.</p>
|
||
</section>
|
||
<section id="can-i-reuse-or-modify-the-extraction-plugins-sdk">
|
||
<h2>Can I reuse or modify the Extraction Plugins SDK?<a class="headerlink" href="#can-i-reuse-or-modify-the-extraction-plugins-sdk" title="Link to this heading"></a></h2>
|
||
<p>The SDK is distributed under the Apache 2.0 License, see the LICENSE file in the SDK for more details.</p>
|
||
</section>
|
||
<section id="can-i-use-a-plugin-that-someone-else-wrote">
|
||
<h2>Can I use a plugin that someone else wrote?<a class="headerlink" href="#can-i-use-a-plugin-that-someone-else-wrote" title="Link to this heading"></a></h2>
|
||
<p>Yes, at your own risk. The Hansken Team does not take responsibility for code written by third parties in the form of
|
||
Extraction Plugins.</p>
|
||
</section>
|
||
<section id="what-are-the-legal-implications-of-creating-your-own-extraction-plugin-s">
|
||
<h2>What are the legal implications of creating your own Extraction Plugin(s)?<a class="headerlink" href="#what-are-the-legal-implications-of-creating-your-own-extraction-plugin-s" title="Link to this heading"></a></h2>
|
||
<p>All Extraction Plugins not written by the Hansken Team are considered <strong>third party</strong> Extraction Plugins. Please refer
|
||
to <a class="reference internal" href="#"><span class="doc">Can I use a plugin that someone else wrote?</span></a></p>
|
||
</section>
|
||
<section id="how-safe-are-extraction-plugins">
|
||
<h2>How safe are Extraction Plugins?<a class="headerlink" href="#how-safe-are-extraction-plugins" title="Link to this heading"></a></h2>
|
||
<p>We are doing everything to make sure Extraction Plugins are as safe as possible, however note that the Extraction Plugin
|
||
SDK is still in beta. Use it at your own risk. For more information on security see <a class="reference internal" href="concepts/isolation.html"><span class="doc">Isolation</span></a>.</p>
|
||
</section>
|
||
<section id="can-my-extraction-plugin-be-embedded-into-hansken-for-performance-reasons">
|
||
<h2>Can my Extraction Plugin be embedded into Hansken for performance reasons?<a class="headerlink" href="#can-my-extraction-plugin-be-embedded-into-hansken-for-performance-reasons" title="Link to this heading"></a></h2>
|
||
<p>Embedding an Extraction Plugin into Hansken requires access to the Hansken source code. If you have access to the source
|
||
code then please <code class="docutils literal notranslate"><span class="pre">../contact</span></code> us for assistance. Please note that embedded Extraction Plugins are <strong>not officially
|
||
supported</strong>.</p>
|
||
<p>If you do not have access to the Hansken source code, then please contact your own Business Owner, and ask them to
|
||
contact the Hansken Team.</p>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="examples.html" class="btn btn-neutral float-left" title="Examples" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="../contact.html" class="btn btn-neutral float-right" title="Contact" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2020-2026 Netherlands Forensic Institute.</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |