Project icon

com.io7m.looseleaf

Build status Maven Central Codecov

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

Contents

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.
  • OSGi-ready
  • JPMS-ready
  • ISC license

Releases

The most recently published version of the software is 0.0.2.

Source code and binaries are available from the repository.

Documentation

Documentation for the 0.0.2 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>0.0.2</version>
</dependency>

<dependency>
  <groupId>com.io7m.looseleaf</groupId>
  <artifactId>com.io7m.looseleaf.cmdline</artifactId>
  <version>0.0.2</version>
</dependency>

<dependency>
  <groupId>com.io7m.looseleaf</groupId>
  <artifactId>com.io7m.looseleaf.database.api</artifactId>
  <version>0.0.2</version>
</dependency>

<dependency>
  <groupId>com.io7m.looseleaf</groupId>
  <artifactId>com.io7m.looseleaf.database.mvstore</artifactId>
  <version>0.0.2</version>
</dependency>

<dependency>
  <groupId>com.io7m.looseleaf</groupId>
  <artifactId>com.io7m.looseleaf.documentation</artifactId>
  <version>0.0.2</version>
</dependency>

<dependency>
  <groupId>com.io7m.looseleaf</groupId>
  <artifactId>com.io7m.looseleaf.oci</artifactId>
  <version>0.0.2</version>
</dependency>

<dependency>
  <groupId>com.io7m.looseleaf</groupId>
  <artifactId>com.io7m.looseleaf.protocol.v1</artifactId>
  <version>0.0.2</version>
</dependency>

<dependency>
  <groupId>com.io7m.looseleaf</groupId>
  <artifactId>com.io7m.looseleaf.security</artifactId>
  <version>0.0.2</version>
</dependency>

<dependency>
  <groupId>com.io7m.looseleaf</groupId>
  <artifactId>com.io7m.looseleaf.server.api</artifactId>
  <version>0.0.2</version>
</dependency>

<dependency>
  <groupId>com.io7m.looseleaf</groupId>
  <artifactId>com.io7m.looseleaf.server</artifactId>
  <version>0.0.2</version>
</dependency>

<dependency>
  <groupId>com.io7m.looseleaf</groupId>
  <artifactId>com.io7m.looseleaf.tests</artifactId>
  <version>0.0.2</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.

No formal releases have been made.

Sources

This project uses Git to manage source code.

Repository: https://github.com/io7m/primogenitor

$ git clone https://github.com/io7m/primogenitor

License

Copyright © 2022 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.