Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

M #-: Improve java bindings documentation #2933

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+33 −2
Open

M #-: Improve java bindings documentation #2933

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 33 additions & 2 deletions source/integration_and_development/system_interfaces/java.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,45 @@ This page contains the OpenNebula Cloud API Specification for Java. It has been
Download
================================================================================

You can download the ``.jar`` file compiled using Java 1.8, the required libraries, and the javadoc packaged in a tar.gz file `following this link <http://downloads.opennebula.io/packages>`__ in the OpenNebula version you have installed.
You can download the ``.jar`` file compiled using Java 11, the required libraries, and the javadoc packaged in a tar.gz file `following this link <http://downloads.opennebula.io/packages>`__ in the OpenNebula version you have installed.

You can also consult the `javadoc online </doc/6.4/oca/java/>`__.

Compilation
================================================================================

If you need to compile the Java bindings, please follow these steps

- Download the source code of opennebula (available on `OpenNebula code repository <https://www.github.com/OpenNebula/one>`__)

``git clone https://www.github.com/OpenNebula/one``

- On the source code, change to the directory ``src/oca/java``

``cd one/src/oca/java``

- Download the apache xmlrpc library (note that the URL may change in your case)

``curl -OL https://archive.apache.org/dist/ws/xmlrpc/binaries/xmlrpc-3.1.1-bin.tar.gz``

- Uncompress it and move the ``/lib`` directory to the source code dir

``tar xzvf xmlrpc-3.1.1-bin.tar.gz; mv xmlrpc-3.1.1/lib .``

- Modify the build script adding to the libraries the xmlrpc library

``sed -i 's@^LIB_DIR="/usr/share/java"$@LIB_DIR="/usr/share/java:./lib"@g' build.sh``

- Build the library

``build.sh``

The jar file with the bindings will be the ``jar/org.opennebula.client.jar`` file

Usage
================================================================================

To use the OpenNebula Cloud API for Java in your Java project, you have to add to the classpath the org.opennebula.client.jar file and the XML-RPC libraries located in the lib directory.
To use the OpenNebula Cloud API for Java in your Java project, you have to add to the classpath the ``org.opennebula.client.jar`` file and the XML-RPC libraries located in the lib directory.

Code Sample
================================================================================
Expand Down
Loading