LockFactoryServer

Project information

Current Build

Introduction

A synchronization primitives server with various connection interfaces (like gRPC, Java RMI, REST), developed in Java and ready to use.

• Lock: a simple, mutex exclusive lock
• Semaphore: with permits it can acquire or release, in any quantity, from/to requesters
• Countdownlatch: with an initial count and requesters that wait until the count is zero
• Holders: requesters wait until some data is stored into memory or is cancelled
• Rate limiter: limits the rate of requests/usages/etc. by time or by tokens from bucket (coming soon, in rateLimiter branch !)

So various processes/applications/threads can access the same primitive by using any connection method (the connections share the primitives caches ). A synchronization primitive will be automatically erased from the cache unless it is in use (particular for every type).

You can activate or deactivate each type of primitive and also each type of connection. But once something is activated, is available to be used/accessed by every other active type (no fine grained control)

In advanced beta for now !

See the wiki for more documentation

Structure

The project has 4 sub-modules

• core: it has the main proto and interface files. It also servers as documentation for the service and their methods and operations. All other modules depend on this one
• server: This is the server implementation, with the RMI, REST and gRPC connections that offer the core-defined services.
  The server can run standalone or be embedded into other services or applications.
• client: A Java client implementation for each service and connection type; it offers a simplified way to use the services and a simple coding example
• integration: this module depends on the server and client, and obviously the core. It has no production code, but only test code.
  It executes integration tests, where a local server is started and local clients execute complex operations against it. It servers to ensure the good performance and correctness of the system.
  There are more than 55 integration tests to ensure the correctness of the project.

There are more than 300 unit tests to ensure a working project.

How to build

This project uses JDK11 and Gradle (provided gradlew 7.5.1)

If you need a integration test for REST connection, you can use curl or postman

Rationale

I made this project because I wanted to have a 100% Java implementation of a server which provides synchronization primitives as services.
I know you can do this with mongo, redis (as see here) or other servers; but I wanted a stand-alone, slimmed, only-for-this-purpose, do-one-thing-and-do-it-well implementation.
This is why I don't want to provide with memory-related apis, nor messaging or other utilites; as redis, rabbitmq and other are fully available out there.

It uses arteam embedded http server to facilitate the usage of internal SUN http server.