FISH-9198 Add Microprofile Config TOML Support

[kalinchan]

Description

Resolves #6822

This feature introduces changes to the Admin Console and new AsAdmin Commands.

By default the ordinal for TOML is 95.

The properties will only be updated when first initialised or if the last modified time has been changed.

When the TOML file contains a nested array you can retrieve the value by specifying the index e.g. [1]

Admin Console

(Configurations -> server-config -> Microprofile -> Config -> TOML)

AsAdmin Commands

• get-toml-config-source-configuration: Returns the path to the TOML file and the maximum recursion depth (to prevent potential stackoverflow)
• set-toml-config-source-configuration: path parameter to specify location of toml file, can be relative to current domain. depth parameter to specify the depth of recursion.

Important Info

Blockers

n/a

Testing

New tests

none

Testing Performed

Specified a TOML file with various different tables and arrays and deployed a simple application that prints out all properties, the ordinal and specific values.

Testing Environment

Apache Maven 3.9.8 (36645f6c9b5079805ea5009217e36f2cffd34256)
Maven home: /Users/kalinchan/Library/apache-maven-3.9.8
Java version: 11.0.23, vendor: Azul Systems, Inc., runtime: /Users/kalinchan/.sdkman/candidates/java/11.0.23-zulu/zulu-11.jdk/Contents/Home
Default locale: en_GB, platform encoding: UTF-8
OS name: "mac os x", version: "14.6.1", arch: "aarch64", family: "mac"

Documentation

to come...

Notes for Reviewers

Had to implement the ordinal delegation for configsourceproxy.

Removed default recursion depth as it does not appear in admin console or when running admin command.

[luiseufrasio]

When the file does not exists on Windows it returns:

asadmin set-toml-configuration --path C:\config.tom --depth 10

Picked up JAVA_TOOL_OPTIONS: -Duser.language=en -Duser.country=US -Dfile.encoding=UTF-8
remote failure: java.nio.file.InvalidPathException: Illegal char <:> at index 105: C:\Users\luise\git\Payara\appserver\distributions\payara\target\stage\payara6\glassfish\domains\domain1\C:\config.tom
Illegal char <:> at index 105: C:\Users\luise\git\Payara\appserver\distributions\payara\target\stage\payara6\glassfish\domains\domain1\C:\config.tom
Command set-toml-configuration failed.

[Pandrex247]

I would also question whether the TOML config source should exist under the nucleus package - would it not be better homed alongside the other extensions?

[luiseufrasio]

LGTM!

[poikilotherm]

Potentially stupid question, late to the party. Instead of using TOMLJ and adding another dependency, would it help to use Jackson Dataformat TOML, which is already around as a lib?

[Pandrex247]

Potentially stupid question, late to the party. Instead of using TOMLJ and adding another dependency, would it help to use Jackson Dataformat TOML, which is already around as a lib?

My memory may be failing me, but I don't recall us discussing this library in particular, and it doesn't seem to be indexed highly in Google - it's entirely possible we may have simply overlooked the existence of this library.

Thanks for the suggestion @poikilotherm: we will investigate if it's suitable. We already use Jackson for XML and YAML parsing in the server so yes, all things being equal, it would be the logical library to use over Tomlj.