ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-20 21:43:14 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
dbfea9015d
corda/common/configuration-parsing
History
Stefano Franz b23af5f0d2
add timeouts to all tests (#5875)
2020-02-11 10:14:05 +00:00
..
src add timeouts to all tests (#5875) 2020-02-11 10:14:05 +00:00
build.gradle CORDA-2893 Upgrade Corda to use Gradle 5.4.1 (Take 2) (#5137) 2019-05-20 14:26:42 +01:00
README.md [CORDA-1778, CORDA-1835]: Decoupled configuration parsing mechanism (#4093) 2018-10-25 16:45:14 +01:00

README.md

configuration-parsing

This module provides types and functions to facilitate using Typesafe configuration objects.

Features

  1. A multi-step, structured validation framework for Typesafe configurations, allowing to merge Typesafe and application-level rules.
  2. A parsing framework, allowing to extract domain types from raw configuration objects in a versioned, type-safe fashion.
  3. A configuration description framework, allowing to print the expected schema of a configuration object.
  4. A configuration serialization framework, allowing to output the structure and values of a configuration object, potentially obfuscating sensitive data.

Concepts

The main idea is to create a Configuration.Specification to model the expected structure of a Typesafe configuration. The specification is then able to parse, validate, describe and serialize a raw Typesafe configuration.

By using VersionedConfigurationParser, it is possible to map specific versions to Configuration.Specifications and to parse and validate a raw configuration object based on a version header.

Refer to the following tests to gain an understanding of how the library works:

  • net.corda.common.configuration.parsing.internal.versioned.VersionedParsingExampleTest
  • net.corda.common.configuration.parsing.internal.SpecificationTest
  • net.corda.common.configuration.parsing.internal.SchemaTest