Updating the tutorial on how to create Java Plugin using JNA Binding #2800

dmoisej · 2019-06-19T18:13:45Z

Basics

Check relevant points but please do not remove entries.
Do not describe the purpose of this PR in the PR description but:

Short descriptions should be in the release notes (added as entry in
doc/news/_preparation_next_release.md which contains _(my name)_)
Please always add something to the the release notes.
Longer descriptions should be in documentation or in design decisions.
Describe details of how you changed the code in commit messages
(first line should have module: short statement syntax)
References to issues, e.g. close #X, should be in the commit messages.

Checklist

Check relevant points but please do not remove entries.
For docu fixes, spell checking, and similar none of these points below
need to be checked.

I added unit tests
I ran all tests locally and everything went fine
affected documentation is fixed
I added code comments, logging, and assertions (see Coding Guidelines)
meta data is updated (e.g. README.md of plugins and METADATA.ini)

Review

Reviewers will usually check the following:

Code is conforming to our Coding Guidelines
APIs are conforming to our Design Guidelines
Code is consistent to our Design Decisions
Documentation is concise and good to read
Examples are well chosen and understandable

Labels

Add the "work in progress" label if you do not want the PR to be reviewed yet.
Add the "ready to merge" label if the build server is happy and also you
say that everything is ready to be merged.

dmoisej · 2019-06-19T18:22:07Z

@markus2330 please review my PR

markus2330 · 2019-06-19T19:22:07Z

Something went wrong with reformatting, see: https://github.com/ElektraInitiative/libelektra/pull/2800/files

Please use reformat-markdown to solve this problem.

dmoisej · 2019-06-19T19:46:28Z

@markus2330 where can I find the constraints on markdowns while writing guides?

dmoisej · 2019-06-19T19:51:45Z

@markus2330 fixed formatting.

markus2330

Formatting (line endings?) still broken.

markus2330 · 2019-06-19T20:56:51Z

doc/API.md

@@ -1,208 +1,209 @@
-## Elektra Initiative Overview


Format still broken, you somehow change every line of this file. (Maybe different line endings?)

The PR just changes the line endings from CRLF to LF, which should be fine in my opinion.

Ok, we should unify the line endings, see #2801.

markus2330 · 2019-06-19T20:59:17Z

doc/tutorials/java-plugins.md

+
+### Writing a Plugin
+
+Under the path: `/path/to/libelektra/src/bindings/jna/libelektra4j/src/main/java/org/libelektra` you can find the examples of already existing plugins and you can look into libelektra Java library, which is used for communication with the configuration database.


Make proper markdown links here (and also separately for examples, tests, plugins,...)

what do you mean here? It is just the path to the files. It is not a specific file

Yes, you could link to the specific files so that they are easier accessible from this tutorial.

markus2330 · 2019-06-19T21:01:16Z

@markus2330 where can I find the constraints on markdowns while writing guides?

doc/CODING.md

dmoisej · 2019-06-20T06:32:34Z

@markus2330 fixed the markdowns.

markus2330 · 2019-06-20T07:58:57Z

Thank you!

sanssecours · 2019-06-20T07:45:24Z

doc/tutorials/java-kdb.md

+
+## Introduction
+
+When programming in Java it is possible to access the kdb database, changing values of existing keys or adding new ones and a few other things. It is also possible to write plugins for Elektra in Java but we will focus on using the Java


Since “KDB” is already the abbreviation for “Key DataBase” adding the word database after KDB is kind of redundant.

Suggested change

When programming in Java it is possible to access the kdb database, changing values of existing keys or adding new ones and a few other things. It is also possible to write plugins for Elektra in Java but we will focus on using the Java

When programming in Java it is possible to access the key database, changing values of existing keys or adding new ones and a few other things. It is also possible to write plugins for Elektra in Java but we will focus on using the Java

sanssecours · 2019-06-20T07:45:54Z

doc/tutorials/java-kdb.md

+
+## First Steps
+
+In order to use `kdb` you will need include the dependency in your project. [Here](../../src/bindings/jna/README.md) you can find a detailed tutorial on how to do that.


Suggested change

In order to use `kdb` you will need include the dependency in your project. [Here](../../src/bindings/jna/README.md) you can find a detailed tutorial on how to do that.

In order to use `kdb` you need to include the dependency in your project. [Here](../../src/bindings/jna/README.md) you can find a detailed tutorial on how to do that.

sanssecours · 2019-06-20T07:46:12Z

doc/tutorials/java-kdb.md

+
+In order to use `kdb` you will need include the dependency in your project. [Here](../../src/bindings/jna/README.md) you can find a detailed tutorial on how to do that.
+
+After that you can start loading an `KDB` object as follows:


Suggested change

After that you can start loading an `KDB` object as follows:

After that you can start loading a `KDB` object as follows:

sanssecours · 2019-06-20T07:46:38Z

doc/tutorials/java-kdb.md

+}
+```
+
+Note that KDB implements `AutoClosable` which allows [try-with-resouces](https://docs.oracle.com/javase/tutorial/essential/exceptions/tryResourceClose.html).


Suggested change

Note that KDB implements `AutoClosable` which allows [try-with-resouces](https://docs.oracle.com/javase/tutorial/essential/exceptions/tryResourceClose.html).

Note that `KDB` implements `AutoClosable` which allows [try-with-resouces](https://docs.oracle.com/javase/tutorial/essential/exceptions/tryResourceClose.html).

sanssecours · 2019-06-20T07:47:06Z

doc/tutorials/java-kdb.md

+
+Note that KDB implements `AutoClosable` which allows [try-with-resouces](https://docs.oracle.com/javase/tutorial/essential/exceptions/tryResourceClose.html).
+
+You can also pass a `Key` object with an empty string on the first line. The passed key (`user/kdbsession/javabinding` in this case) is being used for the session and stores warnings and error informations.


Suggested change

You can also pass a `Key` object with an empty string on the first line. The passed key (`user/kdbsession/javabinding` in this case) is being used for the session and stores warnings and error informations.

You can also pass a `Key` object with an empty string on the first line. The passed key (`user/kdbsession/javabinding` in this case) is being used for the session and stores warnings and error information.

sanssecours · 2019-06-20T08:32:30Z

doc/tutorials/java-plugins.md

+
+- `/path/to/SDK/include`
+
+or you can reinstall Java 1.8 SDK.


Suggested change

or you can reinstall Java 1.8 SDK.

or you can reinstall the Java SDK.

sanssecours · 2019-06-20T08:33:59Z

doc/tutorials/java-plugins.md

+
+### JNA Binding
+
+Java Native Access is Java technology (library), which like JNI allows a developer to run native code using only Java by providing access to native shared libraries. In order to use JNA binding, it should be firstly installed. More information you can find on the the GitHub [page](https://github.com/java-native-access/jna).


Suggested change

Java Native Access is Java technology (library), which like JNI allows a developer to run native code using only Java by providing access to native shared libraries. In order to use JNA binding, it should be firstly installed. More information you can find on the the GitHub [page](https://github.com/java-native-access/jna).

Java Native Access is Java technology (library), which like JNI allows a developer to run native code using only Java by providing access to native shared libraries. In order to use the JNA binding, it should be installed first. You can find more information on [JNA’s GitHub page](https://github.com/java-native-access/jna).

sanssecours · 2019-06-20T08:34:43Z

doc/tutorials/java-plugins.md

+
+Java Native Access is Java technology (library), which like JNI allows a developer to run native code using only Java by providing access to native shared libraries. In order to use JNA binding, it should be firstly installed. More information you can find on the the GitHub [page](https://github.com/java-native-access/jna).
+
+Generally speaking, `JNI` and `JNA` are both different java technologies that could be used to bind Java code and code written in C and C++. Even though, `JNI` gives the ability for developers to integrate Java code into C, what is not possible with `JNA`.


Suggested change

Generally speaking, `JNI` and `JNA` are both different java technologies that could be used to bind Java code and code written in C and C++. Even though, `JNI` gives the ability for developers to integrate Java code into C, what is not possible with `JNA`.

Generally speaking, `JNI` and `JNA` are both different java technologies that could be used to bind Java code and code written in C and C++. Even though, `JNI` gives developers the ability for to integrate Java code into C. That is not possible with `JNA`.

sanssecours · 2019-06-20T08:35:55Z

doc/tutorials/java-plugins.md

+
+Under the the following [path](/src/bindings/jna/libelektra4j/src/main/java/org/libelektra) you can find the examples of already existing plugins and you can look into libelektra Java library, which is used for communication with the configuration database.
+
+In order to write a new Java Plugin, the new class has to be created under the `plugin` folder. It has also to extend the `Plugin.java` interface, which contains all required methods to communicate with Elektra database. You can leave some of the methods not implemented, if there is no need in them.


Suggested change

In order to write a new Java Plugin, the new class has to be created under the `plugin` folder. It has also to extend the `Plugin.java` interface, which contains all required methods to communicate with Elektra database. You can leave some of the methods not implemented, if there is no need in them.

In order to write a new Java Plugin, the new class has to be created under the `plugin` folder. It has also to extend the `Plugin.java` interface, which contains all required methods to communicate with Elektra’s database. You can leave some of the methods unimplemented, if there is no need for them.

sanssecours · 2019-06-20T08:37:05Z

doc/tutorials/java-plugins.md

+
+### Usage of Plugin
+
+To use the bindings in a java project, we have to include the jar file `libelektra-version.jar` in the project. The version number is the same one as used for Elektra. This jar is created upon build, if you enable the jna bindings. You can also use maven to take care about the dependencies. After that you can take your implemented class out of `libelektra` folder and integrate it into your project.


Suggested change

To use the bindings in a java project, we have to include the jar file `libelektra-version.jar` in the project. The version number is the same one as used for Elektra. This jar is created upon build, if you enable the jna bindings. You can also use maven to take care about the dependencies. After that you can take your implemented class out of `libelektra` folder and integrate it into your project.

To use the bindings in a java project, we have to include the jar file `libelektra-version.jar` in the project. The version number is the same one as used for Elektra. This jar is created upon build, if you enable the JNA binding. You can also use Maven to take care of the dependencies. After that you can take your implemented class out of the `libelektra` folder and integrate it into your project.

markus2330 · 2019-06-20T09:52:42Z

@sanssecours Sorry, I did not see your fixes! Can you push them to master please?

Moiseiuk added 3 commits June 19, 2019 20:17

Start completing tutorial

0fb4545

Add additional text for the Java tutorial

747d8d1

Change unix line endings

a492696

dmoisej force-pushed the docu/java--plugin-guide branch from 58f0824 to a492696 Compare June 19, 2019 18:18

markus2330 requested a review from sanssecours June 19, 2019 19:22

Fix formatting

d00c496

dmoisej added 2 commits June 19, 2019 22:24

Fix styling issues

bccd0c1

Fix spelling

4944569

markus2330 requested changes Jun 19, 2019

View reviewed changes

dmoisej added 2 commits June 19, 2019 23:34

Fix spelling error

05c7e6e

Add the link to java files

2a9972a

markus2330 merged commit 260398c into ElektraInitiative:master Jun 20, 2019

sanssecours reviewed Jun 20, 2019

View reviewed changes

markus2330 mentioned this pull request Jun 20, 2019

JNI: Write Tutorial for Java Plugin Development #2552

Closed

9 tasks

sanssecours added this to the 0.8.27 milestone Jun 20, 2019

sanssecours added cm2019s enhancement lang/java labels Jun 20, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updating the tutorial on how to create Java Plugin using JNA Binding #2800

Updating the tutorial on how to create Java Plugin using JNA Binding #2800

dmoisej commented Jun 19, 2019 •

edited

dmoisej commented Jun 19, 2019

markus2330 commented Jun 19, 2019

dmoisej commented Jun 19, 2019

dmoisej commented Jun 19, 2019

markus2330 left a comment

markus2330 Jun 19, 2019

sanssecours Jun 20, 2019

markus2330 Jun 20, 2019

markus2330 Jun 19, 2019

dmoisej Jun 19, 2019

markus2330 Jun 19, 2019

markus2330 commented Jun 19, 2019

dmoisej commented Jun 20, 2019

markus2330 commented Jun 20, 2019

sanssecours Jun 20, 2019

sanssecours Jun 20, 2019

sanssecours Jun 20, 2019

sanssecours Jun 20, 2019

sanssecours Jun 20, 2019

sanssecours Jun 20, 2019

sanssecours Jun 20, 2019

sanssecours Jun 20, 2019

sanssecours Jun 20, 2019

sanssecours Jun 20, 2019

markus2330 commented Jun 20, 2019


		### Writing a Plugin

		Under the path: `/path/to/libelektra/src/bindings/jna/libelektra4j/src/main/java/org/libelektra` you can find the examples of already existing plugins and you can look into libelektra Java library, which is used for communication with the configuration database.


		## Introduction

		When programming in Java it is possible to access the kdb database, changing values of existing keys or adding new ones and a few other things. It is also possible to write plugins for Elektra in Java but we will focus on using the Java


		## First Steps

		In order to use `kdb` you will need include the dependency in your project. [Here](../../src/bindings/jna/README.md) you can find a detailed tutorial on how to do that.

	In order to use `kdb` you will need include the dependency in your project. [Here](../../src/bindings/jna/README.md) you can find a detailed tutorial on how to do that.
	In order to use `kdb` you need to include the dependency in your project. [Here](../../src/bindings/jna/README.md) you can find a detailed tutorial on how to do that.


		In order to use `kdb` you will need include the dependency in your project. [Here](../../src/bindings/jna/README.md) you can find a detailed tutorial on how to do that.

		After that you can start loading an `KDB` object as follows:

	After that you can start loading an `KDB` object as follows:
	After that you can start loading a `KDB` object as follows:

	Note that KDB implements `AutoClosable` which allows [try-with-resouces](https://docs.oracle.com/javase/tutorial/essential/exceptions/tryResourceClose.html).
	Note that `KDB` implements `AutoClosable` which allows [try-with-resouces](https://docs.oracle.com/javase/tutorial/essential/exceptions/tryResourceClose.html).


		Note that KDB implements `AutoClosable` which allows [try-with-resouces](https://docs.oracle.com/javase/tutorial/essential/exceptions/tryResourceClose.html).

		You can also pass a `Key` object with an empty string on the first line. The passed key (`user/kdbsession/javabinding` in this case) is being used for the session and stores warnings and error informations.

	or you can reinstall Java 1.8 SDK.
	or you can reinstall the Java SDK.


		### JNA Binding

		Java Native Access is Java technology (library), which like JNI allows a developer to run native code using only Java by providing access to native shared libraries. In order to use JNA binding, it should be firstly installed. More information you can find on the the GitHub [page](https://github.com/java-native-access/jna).


		Java Native Access is Java technology (library), which like JNI allows a developer to run native code using only Java by providing access to native shared libraries. In order to use JNA binding, it should be firstly installed. More information you can find on the the GitHub [page](https://github.com/java-native-access/jna).

		Generally speaking, `JNI` and `JNA` are both different java technologies that could be used to bind Java code and code written in C and C++. Even though, `JNI` gives the ability for developers to integrate Java code into C, what is not possible with `JNA`.


		Under the the following [path](/src/bindings/jna/libelektra4j/src/main/java/org/libelektra) you can find the examples of already existing plugins and you can look into libelektra Java library, which is used for communication with the configuration database.

		In order to write a new Java Plugin, the new class has to be created under the `plugin` folder. It has also to extend the `Plugin.java` interface, which contains all required methods to communicate with Elektra database. You can leave some of the methods not implemented, if there is no need in them.


		### Usage of Plugin

		To use the bindings in a java project, we have to include the jar file `libelektra-version.jar` in the project. The version number is the same one as used for Elektra. This jar is created upon build, if you enable the jna bindings. You can also use maven to take care about the dependencies. After that you can take your implemented class out of `libelektra` folder and integrate it into your project.

Updating the tutorial on how to create Java Plugin using JNA Binding #2800

Updating the tutorial on how to create Java Plugin using JNA Binding #2800

Conversation

dmoisej commented Jun 19, 2019 • edited

Basics

Checklist

Review

Labels

dmoisej commented Jun 19, 2019

markus2330 commented Jun 19, 2019

dmoisej commented Jun 19, 2019

dmoisej commented Jun 19, 2019

markus2330 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

markus2330 commented Jun 19, 2019

dmoisej commented Jun 20, 2019

markus2330 commented Jun 20, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

markus2330 commented Jun 20, 2019

dmoisej commented Jun 19, 2019 •

edited