io7m.com: com.io7m.looseleaf

looseleaf

The looseleaf package implements an HTTP-accessible key/value database with ACID semantics and fine-grained role-based access control.

Features

ACID semantics.
Atomic reads and updates for arbitrary sets of keys. An unlimited number of keys can be read, updated, and/or deleted in a single operation that is atomic with respect to all other database operations.
Fine-grained role-based access control.
A trivial HTTP interface for easy access from shell scripts.
A strictly defined JSON protocol with a full schema.
Convenient endpoints for use with command-line tools such as curl.
A small, easily auditable codebase with a heavy use of modularity for correctness.
An extensive automated test suite with high coverage.
A small footprint; the server is designed to run in tiny 16-32mb JVM heap configurations.
Platform independence. No platform-dependent code is included in any form, and installations can largely be carried between platforms without changes. The database file format is also platform-independent.
Security-conscious engineering. All requests require authentication, extensive validation is performed on all requests, and careful use is made of the Java type system to enforce invariants throughout the codebase.
Fully instrumented with OpenTelemetry for reliable service monitoring.
Configurable fault injection for testing monitoring.
OSGi-ready
JPMS-ready
ISC license.

Usage

See the documentation.

Releases & Development Snapshots

Releases

You can subscribe to the atom feed to be notified of project releases.

The most recently released version of the package is 3.0.0.

3.0.0 Release (2025-03-29Z)

Update net.jqwik:jqwik-api:1.8.4 → 1.8.5.
Update net.jqwik:jqwik-engine:1.8.4 → 1.8.5.
Update org.xerial:sqlite-jdbc:3.45.3.0 → 3.46.0.0.
Update io.helidon:helidon-bom:4.0.8 → 4.0.9.
Update io.opentelemetry:opentelemetry-bom:1.38.0 → 1.39.0.
Update io.opentelemetry:opentelemetry-sdk-logs:1.38.0 → 1.39.0.
Update io.helidon:helidon-bom:4.0.9 → 4.0.10.
Update org.apache.maven.plugins:maven-failsafe-plugin:3.2.5 → 3.3.0.
Update junit.version:5.10.2 → 5.10.3.
Update net.jqwik:jqwik-api:1.8.5 → 1.9.0.
Update net.jqwik:jqwik-engine:1.8.5 → 1.9.0.
Update jetty.version:11.0.21 → 11.0.22.
Update io.opentelemetry:opentelemetry-sdk-logs:1.39.0 → 1.40.0.
Update jackson.version:2.17.1 → 2.17.2.
Update io.opentelemetry:opentelemetry-bom:1.39.0 → 1.40.0.
Update org.apache.maven.plugins:maven-failsafe-plugin:3.3.0 → 3.3.1.
Update org.jetbrains.kotlin:kotlin-stdlib:1.9.24 → 1.9.25.
Update io.helidon:helidon-bom:4.0.10 → 4.0.11.
Update org.xerial:sqlite-jdbc:3.46.0.0 → 3.46.0.1.
Update org.slf4j:slf4j-api:2.0.13 → 2.0.14.
Update org.slf4j:slf4j-api:2.0.14 → 2.0.15.
Update io.opentelemetry:opentelemetry-bom:1.40.0 → 1.41.0.
Update org.slf4j:slf4j-api:2.0.15 → 2.0.16.
Update io.opentelemetry:opentelemetry-sdk-logs:1.40.0 → 1.41.0.
Update com.h2database:h2-mvstore:2.2.224 → 2.3.232.
Update io.helidon:helidon-bom:4.0.11 → 4.1.0.
Update junit.version:5.10.3 → 5.11.0.
Update logback.version:1.5.6 → 1.5.7.
Update org.xerial:sqlite-jdbc:3.46.0.1 → 3.46.1.0.
Update org.apache.maven.plugins:maven-failsafe-plugin:3.3.1 → 3.4.0.
Update jetty.version:11.0.22 → 11.0.23.
Update nl.jqno.equalsverifier:equalsverifier:3.16.1 → 3.16.2.
Update org.mockito:mockito-core:5.12.0 → 5.13.0.
Update org.apache.maven.plugins:maven-failsafe-plugin:3.4.0 → 3.5.0.
Update io.helidon:helidon-bom:4.1.0 → 4.1.1.
Update jetty.version:11.0.23 → 11.0.24.
Update logback.version:1.5.7 → 1.5.8.
Update io.opentelemetry:opentelemetry-sdk-logs:1.41.0 → 1.42.0.
Update io.opentelemetry:opentelemetry-bom:1.41.0 → 1.42.0.
Update io.opentelemetry:opentelemetry-bom:1.42.0 → 1.42.1.
Update io.opentelemetry:opentelemetry-sdk-logs:1.42.0 → 1.42.1.
Update com.squareup.okio:okio-jvm:3.9.0 → 3.9.1.
Update com.io7m.trasco.version:1.1.0 → 2.0.0.
Update com.io7m.jproperties:com.io7m.jproperties.core:3.2.0 → 4.0.0.
Update com.io7m.dixmont:com.io7m.dixmont.core:1.0.0 → 2.0.0.
Update com.io7m.trasco.version:2.0.0 → 3.0.0.
Update nl.jqno.equalsverifier:equalsverifier:3.16.2 → 3.17.
Update junit.version:5.11.0 → 5.11.1.
Update org.xerial:sqlite-jdbc:3.46.1.0 → 3.46.1.3.
Update jackson.version:2.17.2 → 2.18.0.
Update net.jqwik:jqwik-engine:1.9.0 → 1.9.1.
Update org.mockito:mockito-core:5.13.0 → 5.14.1.
Update net.jqwik:jqwik-api:1.9.0 → 1.9.1.
Update nl.jqno.equalsverifier:equalsverifier:3.17 → 3.17.1.
Update junit.version:5.11.1 → 5.11.2.
Update org.apache.maven.plugins:maven-failsafe-plugin:3.5.0 → 3.5.1.
Update io.helidon:helidon-bom:4.1.1 → 4.1.2.
Update logback.version:1.5.8 → 1.5.9.
Update io.opentelemetry:opentelemetry-sdk-logs:1.42.1 → 1.43.0.
Update io.opentelemetry:opentelemetry-bom:1.42.1 → 1.43.0.
Update logback.version:1.5.9 → 1.5.10.
Update logback.version:1.5.10 → 1.5.11.
Update org.mockito:mockito-core:5.14.1 → 5.14.2.
Update org.xerial:sqlite-jdbc:3.46.1.3 → 3.47.0.0.
Update io.helidon:helidon-bom:4.1.2 → 4.1.3.
Update logback.version:1.5.11 → 1.5.12.
Update jackson.version:2.18.0 → 2.18.1.
Update org.apache.maven.plugins:maven-failsafe-plugin:3.5.1 → 3.5.2.
Update nl.jqno.equalsverifier:equalsverifier:3.17.1 → 3.17.2.
Update nl.jqno.equalsverifier:equalsverifier:3.17.2 → 3.17.3.
Update io.opentelemetry:opentelemetry-bom:1.43.0 → 1.44.1.
Update io.opentelemetry:opentelemetry-sdk-logs:1.43.0 → 1.44.1.
Update io.helidon:helidon-bom:4.1.3 → 4.1.4.
Update org.xerial:sqlite-jdbc:3.47.0.0 → 3.47.1.0.
Update jackson.version:2.18.1 → 2.18.2.
Update nl.jqno.equalsverifier:equalsverifier:3.17.3 → 3.17.4.
Update net.jqwik:jqwik-engine:1.9.1 → 1.9.2.
Update net.jqwik:jqwik-api:1.9.1 → 1.9.2.
Update nl.jqno.equalsverifier:equalsverifier:3.17.4 → 3.17.5.
Update io.opentelemetry:opentelemetry-sdk-logs:1.44.1 → 1.45.0.
Update io.opentelemetry:opentelemetry-bom:1.44.1 → 1.45.0.
Update io.helidon:helidon-bom:4.1.4 → 4.1.5.
Update org.junit:junit-bom:5.11.3 → 5.11.4.
Update logback.version:1.5.12 → 1.5.13.
Update logback.version:1.5.13 → 1.5.14.
Update io.helidon:helidon-bom:4.1.5 → 4.1.6.
Update logback.version:1.5.14 → 1.5.15.
Update nl.jqno.equalsverifier:equalsverifier:3.17.5 → 3.18.
Update org.xerial:sqlite-jdbc:3.47.1.0 → 3.47.2.0.
Update org.mockito:mockito-core:5.14.2 → 5.15.2.
Update logback.version:1.5.15 → 1.5.16.
Update com.squareup.okio:okio-jvm:3.9.1 → 3.10.1.
Update nl.jqno.equalsverifier:equalsverifier:3.18 → 3.18.1.
Update com.squareup.okio:okio-jvm:3.10.1 → 3.10.2.
Update io.opentelemetry:opentelemetry-sdk-logs:1.45.0 → 1.46.0.
Update io.opentelemetry:opentelemetry-bom:1.45.0 → 1.46.0.
Update org.xerial:sqlite-jdbc:3.47.2.0 → 3.48.0.0.
Update codecov/codecov-action:5.1.2 → 5.3.1.
Update nl.jqno.equalsverifier:equalsverifier:3.18.1 → 3.18.2.
Update jackson.version:2.18.2 → 2.18.3.
Update io.opentelemetry:opentelemetry-bom:1.46.0 → 1.47.0.
Update nl.jqno.equalsverifier:equalsverifier:3.18.2 → 3.19.1.
Update io.opentelemetry:opentelemetry-sdk-logs:1.46.0 → 1.47.0.
Switch from mvstore to sqlite as the internal database. (Backwards incompatible)
Update logback.version:1.5.16 → 1.5.17.

The compiled artifacts for the release (and all previous releases) are available on Maven Central.

Maven Modules

<dependency> <group>com.io7m.looseleaf</group> <artifactId>com.io7m.looseleaf.cmdline</artifactId> <version>3.0.0</version> </dependency><dependency> <group>com.io7m.looseleaf</group> <artifactId>com.io7m.looseleaf.database.api</artifactId> <version>3.0.0</version> </dependency><dependency> <group>com.io7m.looseleaf</group> <artifactId>com.io7m.looseleaf.database.mvstore</artifactId> <version>3.0.0</version> </dependency><dependency> <group>com.io7m.looseleaf</group> <artifactId>com.io7m.looseleaf.database.sqlite</artifactId> <version>3.0.0</version> </dependency><dependency> <group>com.io7m.looseleaf</group> <artifactId>com.io7m.looseleaf.documentation</artifactId> <version>3.0.0</version> </dependency><dependency> <group>com.io7m.looseleaf</group> <artifactId>com.io7m.looseleaf.grafana</artifactId> <version>3.0.0</version> </dependency><dependency> <group>com.io7m.looseleaf</group> <artifactId>com.io7m.looseleaf.oci</artifactId> <version>3.0.0</version> </dependency><dependency> <group>com.io7m.looseleaf</group> <artifactId>com.io7m.looseleaf.protocol.v1</artifactId> <version>3.0.0</version> </dependency><dependency> <group>com.io7m.looseleaf</group> <artifactId>com.io7m.looseleaf.security</artifactId> <version>3.0.0</version> </dependency><dependency> <group>com.io7m.looseleaf</group> <artifactId>com.io7m.looseleaf.server.api</artifactId> <version>3.0.0</version> </dependency><dependency> <group>com.io7m.looseleaf</group> <artifactId>com.io7m.looseleaf.server</artifactId> <version>3.0.0</version> </dependency><dependency> <group>com.io7m.looseleaf</group> <artifactId>com.io7m.looseleaf.tests</artifactId> <version>3.0.0</version> </dependency>

Previous Releases

The changelogs for the most recent previous releases are as follows:

2.0.0 Release (2024-05-16Z)

Update org.jetbrains.kotlin:kotlin-stdlib:1.9.22 → 1.9.23.
Update com.io7m.quarrel.version:1.4.0 → 1.6.0.
Update junit.version:5.10.1 → 5.10.2.
Update io.opentelemetry:opentelemetry-bom:1.33.0 → 1.37.0.
Update logback.version:1.4.14 → 1.5.6.
Update net.jqwik:jqwik-api:1.8.2 → 1.8.4.
Update org.apache.maven.plugins:maven-failsafe-plugin:3.1.2 → 3.2.5.
Update io.opentelemetry:opentelemetry-sdk-logs:1.33.0 → 1.37.0.
Update jackson.version:2.16.1 → 2.17.0.
Update jetty.version:11.0.19 → 11.0.20.
Update com.io7m.jmulticlose:com.io7m.jmulticlose.core:1.1.0 → 1.1.2.
Update net.jqwik:jqwik-engine:1.8.2 → 1.8.4.
Update org.slf4j:slf4j-api:2.0.10 → 2.0.13.
Update org.mockito:mockito-core:5.8.0 → 5.11.0.
Update nl.jqno.equalsverifier:equalsverifier:3.15.5 → 3.16.1.
Update com.io7m.jdeferthrow:com.io7m.jdeferthrow.core:1.2.0 → 1.3.0.
Update com.io7m.jaffirm:com.io7m.jaffirm.core:4.0.0 → 4.0.1.
Update jackson.version:2.17.0 → 2.17.1.
Update com.io7m.jlexing:com.io7m.jlexing.core:3.1.0 → 3.2.0.
Update org.jetbrains.kotlin:kotlin-stdlib:1.9.23 → 1.9.24.
Update com.squareup.okio:okio-jvm:3.7.0 → 3.9.0.
Update com.io7m.jmulticlose:com.io7m.jmulticlose.core:1.1.2 → 1.1.3.
Update com.io7m.jxtrand:com.io7m.jxtrand.vanilla:2.0.0 → 2.1.0.
Update com.io7m.repetoir:com.io7m.repetoir.core:1.0.0 → 1.0.1.
Update com.io7m.quarrel.version:1.6.0 → 1.6.1.
Update com.io7m.jeucreader:com.io7m.jeucreader.core:3.0.0 → 3.0.1.
Update io.opentelemetry:opentelemetry-bom:1.37.0 → 1.38.0.
Update io.opentelemetry:opentelemetry-sdk-logs:1.37.0 → 1.38.0.
Update org.mockito:mockito-core:5.11.0 → 5.12.0.
Require JDK 21. (Backwards incompatible)
Upgrade Alpine Linux → 3.19.1.
Upgrade Temurin → 21.0.3_9-jre-alpine.
Update jetty.version:11.0.20 → 11.0.21.

1.1.0 Release (2023-06-11Z)

Fix a packaging issue that prevented application startup with metrics enabled.

1.0.0 Release (2023-06-11Z)

Initial major release.

Development Snapshots

At the time of writing, the current unstable development version of the package is 3.1.0-SNAPSHOT.

Development snapshots may be available in the Central Portal Snapshots repository. Snapshots are published to this repository every time the project is built by the project's continuous integration system, but snapshots do expire after around ninety days and so may or may not be available depending on when a build of the package was last triggered.

Manual

User Manual

Sources

This project uses Git to manage source code.

Repository: https://www.github.com/io7m-com/looseleaf

$ git clone --recursive https://www.github.com/io7m-com/looseleaf

Issues

This project uses GitHub Issues to track issues.

License

Copyright © 2023 Mark Raynsford <code@io7m.com> https://www.io7m.com Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.