.. _safeddsgen_install_linux:

Installation
============

This section provides the instructions for installing *Safe DDS Gen* in a Linux environment from sources.
*Safe DDS Gen* is a Java application that generates source code using the data types defined in an IDL file.
Please refer to :ref:`typesupport_safeddsgen_intro` for more information.

Requirements
------------

*Safe DDS Gen* is built using Gradle.
Gradle is an open-source build automation tool which requires a Java version to be executed (see `Gradle-Java compatibility matrix <https://docs.gradle.org/current/userguide/compatibility.html>`_).

.. note::

    *Safe DDS Gen* does not support Gradle 8.

.. _java_sl:

Java JDK
^^^^^^^^

The JDK is a development environment for building applications and components using the Java language.
There are several versions of Java available.
For instance, to install Java 11 JDK, run the following command:

.. code-block:: bash

    sudo apt install openjdk-11-jdk

.. note::

    *Safe DDS Gen* supports Java versions from 11 to 19.

Compiling Safe DDS Gen
----------------------

In order to compile *Safe DDS Gen*, an executable script is included in the repository which will download Gradle temporarily for the compilation step.
Please, follow the steps below to build *Safe DDS Gen*:

.. code-block:: bash

    cd code-gen
    ./gradlew assemble

.. note::

    In case that a supported Gradle version is already installed in the system, *Safe DDS Gen* can also be built running directly:

    .. code-block:: bash

        gradle assemble