com.io7m.looseleaf
The looseleaf package implements an HTTP-accessible key/value database with ACID semantics and fine-grained role-based access control.
Features
- Key/value database with 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
Releases
The most recently published version of the software is 2.0.0.
Source code and binaries are available from the repository.
Documentation
Documentation for the 2.0.0 release is available for reading online.
Documentation for current and older releases is archived in the repository.
User documentation
Maven
The following is a complete list of the project's modules expressed as Maven dependencies:
<dependency> <groupId>com.io7m.looseleaf</groupId> <artifactId>com.io7m.looseleaf</artifactId> <version>2.0.0</version> </dependency> <dependency> <groupId>com.io7m.looseleaf</groupId> <artifactId>com.io7m.looseleaf.cmdline</artifactId> <version>2.0.0</version> </dependency> <dependency> <groupId>com.io7m.looseleaf</groupId> <artifactId>com.io7m.looseleaf.database.api</artifactId> <version>2.0.0</version> </dependency> <dependency> <groupId>com.io7m.looseleaf</groupId> <artifactId>com.io7m.looseleaf.database.mvstore</artifactId> <version>2.0.0</version> </dependency> <dependency> <groupId>com.io7m.looseleaf</groupId> <artifactId>com.io7m.looseleaf.documentation</artifactId> <version>2.0.0</version> </dependency> <dependency> <groupId>com.io7m.looseleaf</groupId> <artifactId>com.io7m.looseleaf.oci</artifactId> <version>2.0.0</version> </dependency> <dependency> <groupId>com.io7m.looseleaf</groupId> <artifactId>com.io7m.looseleaf.grafana</artifactId> <version>2.0.0</version> </dependency> <dependency> <groupId>com.io7m.looseleaf</groupId> <artifactId>com.io7m.looseleaf.protocol.v1</artifactId> <version>2.0.0</version> </dependency> <dependency> <groupId>com.io7m.looseleaf</groupId> <artifactId>com.io7m.looseleaf.security</artifactId> <version>2.0.0</version> </dependency> <dependency> <groupId>com.io7m.looseleaf</groupId> <artifactId>com.io7m.looseleaf.server.api</artifactId> <version>2.0.0</version> </dependency> <dependency> <groupId>com.io7m.looseleaf</groupId> <artifactId>com.io7m.looseleaf.server</artifactId> <version>2.0.0</version> </dependency> <dependency> <groupId>com.io7m.looseleaf</groupId> <artifactId>com.io7m.looseleaf.tests</artifactId> <version>2.0.0</version> </dependency>
Each release of the project is made available on Maven Central within ten minutes of the release announcement.
Changes
Subscribe to the releases atom feed.
| 2024-05-16 | Release: com.io7m.looseleaf 2.0.0 |
| 2024-04-19 | Change: Update org.jetbrains.kotlin:kotlin-stdlib:1.9.22 → 1.9.23. |
| 2024-04-19 | Change: Update com.io7m.quarrel.version:1.4.0 → 1.6.0. |
| 2024-04-19 | Change: Update junit.version:5.10.1 → 5.10.2. |
| 2024-04-19 | Change: Update io.opentelemetry:opentelemetry-bom:1.33.0 → 1.37.0. |
| 2024-04-20 | Change: Update logback.version:1.4.14 → 1.5.6. |
| 2024-04-22 | Change: Update net.jqwik:jqwik-api:1.8.2 → 1.8.4. |
| 2024-04-22 | Change: Update org.apache.maven.plugins:maven-failsafe-plugin:3.1.2 → 3.2.5. |
| 2024-04-22 | Change: Update io.opentelemetry:opentelemetry-sdk-logs:1.33.0 → 1.37.0. |
| 2024-04-22 | Change: Update jackson.version:2.16.1 → 2.17.0. |
| 2024-04-23 | Change: Update jetty.version:11.0.19 → 11.0.20. |
| 2024-04-29 | Change: Update com.io7m.jmulticlose:com.io7m.jmulticlose.core:1.1.0 → 1.1.2. |
| 2024-04-29 | Change: Update net.jqwik:jqwik-engine:1.8.2 → 1.8.4. |
| 2024-04-29 | Change: Update org.slf4j:slf4j-api:2.0.10 → 2.0.13. |
| 2024-04-29 | Change: Update org.mockito:mockito-core:5.8.0 → 5.11.0. |
| 2024-04-29 | Change: Update nl.jqno.equalsverifier:equalsverifier:3.15.5 → 3.16.1. |
| 2024-05-05 | Change: Update com.io7m.jdeferthrow:com.io7m.jdeferthrow.core:1.2.0 → 1.3.0. |
| 2024-05-05 | Change: Update com.io7m.jaffirm:com.io7m.jaffirm.core:4.0.0 → 4.0.1. |
| 2024-05-05 | Change: Update jackson.version:2.17.0 → 2.17.1. |
| 2024-05-08 | Change: Update com.io7m.jlexing:com.io7m.jlexing.core:3.1.0 → 3.2.0. |
| 2024-05-08 | Change: Update org.jetbrains.kotlin:kotlin-stdlib:1.9.23 → 1.9.24. |
| 2024-05-08 | Change: Update com.squareup.okio:okio-jvm:3.7.0 → 3.9.0. |
| 2024-05-10 | Change: Update com.io7m.jmulticlose:com.io7m.jmulticlose.core:1.1.2 → 1.1.3. |
| 2024-05-10 | Change: Update com.io7m.jxtrand:com.io7m.jxtrand.vanilla:2.0.0 → 2.1.0. |
| 2024-05-13 | Change: Update com.io7m.repetoir:com.io7m.repetoir.core:1.0.0 → 1.0.1. |
| 2024-05-13 | Change: Update com.io7m.quarrel.version:1.6.0 → 1.6.1. |
| 2024-05-13 | Change: Update com.io7m.jeucreader:com.io7m.jeucreader.core:3.0.0 → 3.0.1. |
| 2024-05-13 | Change: Update io.opentelemetry:opentelemetry-bom:1.37.0 → 1.38.0. |
| 2024-05-13 | Change: Update io.opentelemetry:opentelemetry-sdk-logs:1.37.0 → 1.38.0. |
| 2024-05-15 | Change: Update org.mockito:mockito-core:5.11.0 → 5.12.0. |
| 2024-05-16 | Change: (Backwards incompatible) Require JDK 21. |
| 2024-05-16 | Change: Upgrade Alpine Linux → 3.19.1. |
| 2024-05-16 | Change: Upgrade Temurin → 21.0.3_9-jre-alpine. |
| 2024-05-16 | Change: Update jetty.version:11.0.20 → 11.0.21. |
| 2023-06-11 | Release: com.io7m.looseleaf 1.1.0 |
| 2023-06-11 | Change: Fix a packaging issue that prevented application startup with metrics enabled. |
| 2023-06-11 | Release: com.io7m.looseleaf 1.0.0 |
| 2023-06-11 | Change: Initial major release. |
Sources
This project uses Git to manage source code.
Repository: https://github.com/io7m/primogenitor
$ git clone https://github.com/io7m/primogenitor
License
Copyright © 2024 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.
Bug Tracker
The project uses GitHub Issues to track issues.