Mercurial > hg > orthanc-book
annotate Sphinx/source/plugins/java.rst @ 1055:ebe3214f3ab0
added citation instructions
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Sat, 06 Apr 2024 18:00:13 +0200 |
parents | a3436ae3709c |
children | d2be251975d1 |
rev | line source |
---|---|
999 | 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 | |
1021 | 21 <https://orthanc.uclouvain.be/hg/orthanc/file/Orthanc-1.12.3/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h>`__ |
999 | 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 | |
1055
ebe3214f3ab0
added citation instructions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1021
diff
changeset
|
29 **For researchers**: `Please cite this paper |
ebe3214f3ab0
added citation instructions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1021
diff
changeset
|
30 <https://doi.org/10.5220/0012384600003657>`__. |
ebe3214f3ab0
added citation instructions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1021
diff
changeset
|
31 |
999 | 32 |
33 Source code | |
34 ----------- | |
35 | |
36 * Link to the `official releases of this plugin | |
37 <https://orthanc.uclouvain.be/downloads/sources/orthanc-java/index.html>`__. | |
38 | |
39 * Link to the `code repository | |
40 <https://orthanc.uclouvain.be/hg/orthanc-java/>`__. | |
41 | |
42 | |
43 Licensing | |
44 --------- | |
45 | |
46 This plugin is licensed under the terms of the `GPLv3+ license | |
47 <https://en.wikipedia.org/wiki/GNU_Affero_General_Public_License>`__, | |
48 which is the same as the core of Orthanc. | |
49 | |
50 This has an important consequence: If you distribute Orthanc to | |
51 clients together with one Java plugin, you **must** disclose the | |
52 source code of your Java script to the Orthanc community under the | |
53 terms of the GPL or AGPL licenses. | |
54 | |
55 We suggest you to put the source code of your Java scripts on the | |
56 dedicated `"OrthancContributed" repository on GitHub | |
57 <https://github.com/jodogne/OrthancContributed/tree/master/Plugins>`__, | |
58 and/or to send it to the `Orthanc Users discussion forum | |
59 <https://discourse.orthanc-server.org>`__. | |
60 | |
61 Check out the :ref:`FAQ about licensing <licensing>` for more context. | |
62 | |
63 | |
64 Usage | |
65 ----- | |
66 | |
67 | |
68 FHIR server | |
69 ----------- | |
70 |