Mercurial > hg > orthanc-book

comparison Sphinx/source/plugins/java.rst @ 999:3b62529bfe91

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added java plugin
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 19 Dec 2023 13:36:11 +0100
parents
children a3436ae3709c
comparison
equal deleted inserted replaced
998:bd7fbe3042f7 999:3b62529bfe91
1 .. _java-plugin:
2
3
4 Java plugin for Orthanc
5 =======================
6
7 .. contents::
8
9
10 Overview
11 --------
12
13 This plugin can be used to write :ref:`Orthanc plugins
14 <creating-plugins>` using the `Java programming language
15 <https://en.wikipedia.org/wiki/Java_(programming_language)>`__ instead
16 of the more complex C/C++ programming languages.
17
18 Java plugins have access to more features and a more consistent SDK
19 than :ref:`Lua scripts <lua>`. The largest part of the Java API is
20 automatically generated from the `Orthanc plugin SDK in C
21 <https://orthanc.uclouvain.be/hg/orthanc/file/Orthanc-1.12.2/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__
22 using the `Clang <https://en.wikipedia.org/wiki/Clang>`__ compiler
23 front-end.
24
25 As of release 1.0 of the plugin, the coverage of the C SDK is about
26 76% (122 functions are automatically wrapped in Java out of a total of
27 160 functions from the Orthanc SDK 1.10.0).
28
29
30 Source code
31 -----------
32
33 * Link to the `official releases of this plugin
34 <https://orthanc.uclouvain.be/downloads/sources/orthanc-java/index.html>`__.
35
36 * Link to the `code repository
37 <https://orthanc.uclouvain.be/hg/orthanc-java/>`__.
38
39
40 Licensing
41 ---------
42
43 This plugin is licensed under the terms of the `GPLv3+ license
44 <https://en.wikipedia.org/wiki/GNU_Affero_General_Public_License>`__,
45 which is the same as the core of Orthanc.
46
47 This has an important consequence: If you distribute Orthanc to
48 clients together with one Java plugin, you **must** disclose the
49 source code of your Java script to the Orthanc community under the
50 terms of the GPL or AGPL licenses.
51
52 We suggest you to put the source code of your Java scripts on the
53 dedicated `"OrthancContributed" repository on GitHub
54 <https://github.com/jodogne/OrthancContributed/tree/master/Plugins>`__,
55 and/or to send it to the `Orthanc Users discussion forum
56 <https://discourse.orthanc-server.org>`__.
57
58 Check out the :ref:`FAQ about licensing <licensing>` for more context.
59
60
61 Usage
62 -----
63
64
65 FHIR server
66 -----------
67