Copyright (C) 2024 The Open Library Foundation
This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.
mod-record-specifications is a module for managing and validating records against predefined specifications.
To compile mod-record-specifications, use the command:
mvn clean installIt is possible to define specific tenant parameters during module's initialization for particular tenant.
| Tenant parameter | Default value | Description |
|---|---|---|
| syncSpecifications | true | Sync Specifications as module is enabled for the new tenant |
Below are the environment variables used by this module:
| Variable Name | Default Value | Description |
|---|---|---|
| DB_HOST | localhost | Postgres hostname |
| DB_PORT | 5432 | Postgres port |
| DB_USERNAME | folio_admin | Postgres username |
| DB_PASSWORD | folio_admin | Postgres username password |
| DB_DATABASE | okapi_modules | Postgres database name |
| DB_MAXPOOLSIZE | 10 | Max pool size allowed, including both idle and in-use connections |
| DB_MINIMUM_IDLE | 10 | Min number of idle connections that HikariCP tries to maintain in the pool |
| DB_CONNECTION_TIMEOUT | 30000 | Max number of milliseconds that a client will wait for a connection from the pool |
| DB_IDLE_TIMEOUT | 600000 | Max amount of time that a connection is allowed to sit idle in the pool, applicable when DB_MINIMUM_IDLE < DB_MAXPOOLSIZE |
| DB_KEEPALIVE_TIME | 0 | Frequency of connection keep alive attempts by HikariCP to prevent time-out by database/network. 0 means disabled |
| DB_MAX_LIFETIME | 1800000 | Max lifetime of a connection in the pool |
| DB_VALIDATION_TIMEOUT | 5000 | Max amount of time a connection is tested for aliveness. Must be less than DB_CONNECTION_TIMEOUT |
| DB_INITIALIZATION_FAIL_TIMEOUT | 30000 | Defines whether the pool will 'fail fast' if it can't be seeded with an initial connection |
| DB_LEAK_DETECTION_THRESHOLD | 30000 | Time a connection can be out of the pool before a message is logged for a possible connection leak. 0 means disabled |
| KAFKA_HOST | kafka | Kafka broker hostname |
| KAFKA_PORT | 9092 | Kafka broker port |
| KAFKA_SECURITY_PROTOCOL | PLAINTEXT | Kafka security protocol used to communicate with brokers (SSL or PLAINTEXT) |
| KAFKA_SSL_KEYSTORE_LOCATION | - | The location of the Kafka key store file. This is optional for client and can be used for two-way authentication for client. |
| KAFKA_SSL_KEYSTORE_PASSWORD | - | The store password for the Kafka key store file. This is optional for client and only needed if 'ssl.keystore.location' is configured. |
| KAFKA_SSL_TRUSTSTORE_LOCATION | - | The location of the Kafka trust store file. |
| KAFKA_SSL_TRUSTSTORE_PASSWORD | - | The password for the Kafka trust store file. If a password is not set, trust store file configured will still be used, but integrity checking is disabled. |
Change these variables as per your requirements.
Run the module locally on the default listening port (8081) with the prescribed command:
DB_HOST=localhost DB_PORT=5432 DB_DATABASE=okapi_modules DB_USERNAME=folio_admin DB_PASSWORD=folio_admin \
java -Dserver.port=8081 -jar mod-record-specifications-server/target/mod-record-specifications-fat.jarTo run the module in a Docker container, first build the Docker image:
docker build -t dev.folio/mod-record-specifications .Prepare infrastructure needed for the module: PostgreSQL database. Alternatively, you can use Docker Compose to manage the application's infrastructure.
docker compose upThen run the container:
docker run -t -i -p 8081:8081 dev.folio/mod-record-specificationsSee the built target/ModuleDescriptor.json file for the interfaces, permissions, and additional modules required and provided by this one.
Additional development documentation exists in the development.md
If you find any issues or bugs, please report at project MRSPECS at the FOLIO issue tracker.
This module's API documentation.
The built artifacts for this module are available. See configuration for repository access, and the Docker image