Installation¶

Requirements¶

The SDK targets Java 21. It uses the JDK HTTP client and Jackson for JSON processing.

The source project uses Maven. Build it with:

mvn clean install

The Maven coordinates in this source tree are:

<dependency>
  <groupId>com.newfoundcodes</groupId>
  <artifactId>okatana-java</artifactId>
  <version>1.0.0</version>
</dependency>

The source bundle is Maven-repository-ready, but the documentation does not assume that this artifact has already been published to Maven Central. Use the repository that your organization publishes it to, or install it locally during development.

Runtime dependencies¶

The public runtime dependencies are Jackson Databind and the Jackson Java Time module. HTTP transport uses java.net.http.HttpClient, so an extra HTTP library is not required.

Build outputs¶

mvn package creates the main JAR. The POM also attaches source and Javadoc JARs. mvn verify runs the unit tests and creates a JaCoCo report.

Build the examples¶

After installing the SDK artifact locally:

mvn -f examples/pom.xml clean package

The example project compiles every source under examples/src/main/java.

Build the documentation¶

python -m venv .venv
. .venv/bin/activate
pip install -r requirements.txt
mkdocs build --strict

Material for MkDocs is constrained to major version 9 in requirements.txt.