Requirements

• JDK 11+
• JDK 8 (optional)
• A modern Linux, OSX, or Windows host

Building the sources

You can build and verify the sources as follows:

./mvnw verify

verify goal runs validation and test steps next to building (i.e., compiling) the sources. To speed up the build, you can skip verification:

./mvnw -DskipTests package

If you want to install generated artifacts to your local Maven repository, replace above verify and/or package goals with install.

DNS lookups in tests

Note that if your /etc/hosts file does not include an entry for your computer's hostname, then many unit tests may execute slow due to DNS lookups to translate your hostname to an IP address in InetAddress.getLocalHost(). To remedy this, you can execute the following:

printf '127.0.0.1 %s\n::1 %s\n' `hostname` `hostname` | sudo tee -a /etc/hosts

Java 8 tests

To test the library against the target JRE (JRE 8), you need to configure a JDK 8 toolchains as explained below and run Maven with the java8-tests profile:

./mvnw verify -Pjava8-tests

Configuring Maven Toolchains

Maven Toolchains is used to employ additional JDKs required for tests. You either need to have a user-level configuration in ~/.m2/toolchains.xml or explicitly provide one to the Maven: ./mvnw --global-toolchains /path/to/toolchains.xml.

<?xml version="1.0" encoding="UTF8"?>
<toolchains>
  <toolchain>
    <type>jdk</type>
    <provides>
      <version>1.8.0_372</version>
    </provides>
    <configuration>
      <jdkHome>/usr/lib/jvm/java-8-openjdk-amd64</jdkHome>
    </configuration>
  </toolchain>
</toolchains>

Building the website and manual

You can build the website and manual as follows:

./mvnw site

And view it using a simple HTTP server, e.g., the one comes with the Python:

python3 -m http.server -d target/site