Set Up your Dev Environment

This section describes what needs to be done to set up your environment to develop Rumi applications.

You will need the following to build and run Rumi applications

• A JDK

• Maven

• An IDE

Install JDK

Ensure you have one of the following JDKs installed on your machine.

• JDK 8

• JDK 11

• JDK 17

• JDK 21

You can download and install the JDK from here

Install Maven

Rumi modules implemements several plugins for code generation and preparation of deployment artifacts that integrate into the build cycle. Currently, all these plugins are built for Maven. Therefore, Maven is the preferred tool to build Rumi applications.

You can download and install Maven from here.

Free Maven installation tutorials can be found at:

• Windows

• OSX

Please make sure you install Maven v3.0.4 or later.

Using Other Build Tools: The functionality of each Maven plugin implemented by the Rumi is also available as a CLI tool implemented by the core Rumi runtime. In fact, the plugins and the CLI tools are each implemented using a common underlying API implemented by the Rumi runtime. These CLI tools are intended for use with build tools other than Maven such as Gradle and Ivy

Set JAVA_HOME

Set the following in your environment

JAVA_HOME=<Home directory of the JDK which you would like to use to build Rumi applications>

This setting is used by Maven to determine the JDK to use to build your Rumi project.

Building Using Java 11 or Beyond

To run Rumi code generation plugins and build the generated core, you would need to include the following additional dependencies in your Maven project. This is due to the removal of these packages from the JDK after JDK8

<dependencies>
    <dependency>
        <groupId>javax.annotation</groupId>
        <artifactId>javax.annotation-api</artifactId>
        <version>1.3.2</version>
    </dependency>

    <dependency>
        <groupId>jakarta.xml.bind</groupId>
        <artifactId>jakarta.xml.bind-api</artifactId>
        <version>2.3.3</version>
    </dependency>

    <dependency>
        <groupId>org.glassfish.jaxb</groupId>
        <artifactId>jaxb-runtime</artifactId>
        <version>2.3.8</version>
    </dependency>
</dependencies>
 

Versions: The versions above are the versions against which the Rumi has been tested.

Rumi Licensing

Rumi is free to use and no license is required to build and run Rumi applications.

Setup your IDE

Rumi applications can be developed using any IDE that supports developing of Java applications.