mirror of
https://github.com/NetherlandsForensicInstitute/hansken-extraction-plugin-sdk-documentation.git
synced 2026-05-08 11:16:33 +00:00
171 lines
9.7 KiB
HTML
171 lines
9.7 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>Prerequisites — 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="Packaging" href="packaging.html" />
|
|
<link rel="prev" title="Java API Changelog" href="api_changelog.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 current"><a class="reference internal" href="../java.html">Java</a><ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="api_changelog.html">Java API Changelog</a></li>
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">Prerequisites</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="packaging.html">Packaging</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="snippets.html">Java code snippets</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="testing.html">Using the Test Framework in Java</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="debugging.html">How to debug an Extraction Plugin</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="javadoc.html">Javadoc</a></li>
|
|
</ul>
|
|
</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"><a class="reference internal" href="../faq.html">Frequently Asked Questions</a></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"><a href="../java.html">Java</a></li>
|
|
<li class="breadcrumb-item active">Prerequisites</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="../../_sources/dev/java/prerequisites.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="prerequisites">
|
|
<h1>Prerequisites<a class="headerlink" href="#prerequisites" title="Link to this heading"></a></h1>
|
|
<p>Required software:</p>
|
|
<ul class="simple">
|
|
<li><p>Java 11 or higher</p></li>
|
|
<li><p>Docker for <a class="reference internal" href="packaging.html"><span class="doc">packaging</span></a> and publishing plugins
|
|
(or use a Docker alternative such as <code class="docutils literal notranslate"><span class="pre">podman</span></code>)</p></li>
|
|
<li><p>Maven (recommended, build automation tool)</p></li>
|
|
</ul>
|
|
<p>Required dependencies:</p>
|
|
<ul>
|
|
<li><p>All required project dependencies to build extraction plugins are published on the public Maven Central, under <code class="docutils literal notranslate"><span class="pre">org.hansken.plugin.extraction:plugin-super-pom</span></code>.
|
|
For maven based extraction plugins, the following <code class="docutils literal notranslate"><span class="pre">pom.xml</span></code> snippet can be used as basis of a plugin:</p>
|
|
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp"><?xml version="1.0" encoding="UTF-8"?></span>
|
|
<span class="nt"><project</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">"http://maven.apache.org/POM/4.0.0"</span>
|
|
<span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span>
|
|
<span class="w"> </span><span class="na">xsi:schemaLocation=</span><span class="s">"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"</span><span class="nt">></span>
|
|
<span class="w"> </span><span class="nt"><modelVersion></span>4.0.0<span class="nt"></modelVersion></span>
|
|
|
|
<span class="w"> </span><span class="nt"><parent></span>
|
|
<span class="w"> </span><span class="nt"><groupId></span>org.hansken.plugin.extraction<span class="nt"></groupId></span>
|
|
<span class="w"> </span><span class="nt"><artifactId></span>plugin-super-pom<span class="nt"></artifactId></span>
|
|
<span class="w"> </span><span class="nt"><version></span>SET_THE_SDK_VERSION_HERE<span class="nt"></version></span>
|
|
<span class="w"> </span><span class="nt"></parent></span>
|
|
|
|
<span class="w"> </span><span class="nt"><artifactId></span>CHOOSE_YOUR_ARTIFACTID_HERE<span class="nt"></artifactId></span>
|
|
<span class="w"> </span><span class="nt"><version></span>SET_THE_PLUGIN_VERSION_HERE<span class="nt"></version></span>
|
|
|
|
<span class="w"> </span><span class="nt"><licenses></span>
|
|
<span class="w"> </span><span class="nt"><license></span>
|
|
<span class="w"> </span><span class="nt"><name></span>The<span class="w"> </span>Apache<span class="w"> </span>Software<span class="w"> </span>License,<span class="w"> </span>Version<span class="w"> </span>2.0<span class="nt"></name></span>
|
|
<span class="w"> </span><span class="nt"><url></span>http://www.apache.org/licenses/LICENSE-2.0.txt<span class="nt"></url></span>
|
|
<span class="w"> </span><span class="nt"><distribution></span>repo<span class="nt"></distribution></span>
|
|
<span class="w"> </span><span class="nt"></license></span>
|
|
<span class="w"> </span><span class="nt"></licenses></span>
|
|
|
|
<span class="w"> </span><span class="nt"><properties></span>
|
|
<span class="w"> </span><span class="nt"><mainClass></span>SET_THE_PLUGIN_MAIN_CLASS_HERE<span class="nt"></mainClass></span>
|
|
<span class="w"> </span><span class="nt"></properties></span>
|
|
<span class="nt"></project></span>
|
|
</pre></div>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="api_changelog.html" class="btn btn-neutral float-left" title="Java API Changelog" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
<a href="packaging.html" class="btn btn-neutral float-right" title="Packaging" 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> |