Apache Geronimo Config
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
impl
.gitignore
LICENSE
NOTICE
README.adoc
pom.xml

README.adoc

Configuration for Java SE and EE

Status

Implementation of the MicroProfile Config Specification.

Rationale

Many project artifacts (e.g. WAR, EAR) should only be created once and then get installed at different customers, stages, etc They need to target those different execution environments without necessity of any repackaging. In other words: depending on the situation they need different configuration.

This is easily achievable by having a set of default configuration values inside the project artifact. But be able to overwrite those default values from external.

History

This very configuration approach has it’s roots in the Apache OpenWebBeans internal SPI configuration. In 2010 it got moved over to the Apache MyFaces CODI project and enhanced to also fit the need of customer projects by Gerhard Petracek and Mark Struberg. In 2011 we further enhanced it while moving CODI to the Apache DeltaSpike project. Romain Manni-Bucau (Apache/Tomitribe), Ron Smeral (JBoss) and Anatole Tresch also gave appreciated input in the last years.

How it works

A 'Configuration' consists of the information collected from the registered ConfigSource s. These `ConfigSource`s get sorted according to their ordinal. That way it is possible to overwrite configuration with lower importance from outside.

By default there are 3 default ConfigSources:

  • System.getenv() (ordinal=400)

  • System.getProperties() (ordinal=300)

  • all META-INF/microprofile-config.properties files on the ClassPath. (ordinal=100, separately configurable via a config_ordinal property inside each file)

That means that I can put my default configuration in a META-INF/microprofile-config.properties anywhere on the classpath. And I can later simply e.g set a system property to change this default configuration.

Custom ConfigSources

It is possible to write and register custom `ConfigSource`s. An example would be a ConfigSource which gets the configured values from a shared database table in a cluster.

Building

Against Apache OpenWebBeans 1.7.x: $> mvn clean install

Against Apache OpenWebBeans 2.0.x: $> mvn clean install -POWB2

Against JBoss Weld 3.0.x: $> mvn clean install -PWeld3

Adding to your project

To add Geronimo Config to your project, just add the following dependency.

<dependency>
    <groupId>org.apache.geronimo.config</groupId>
    <artifactId>geronimo-config-impl</artifactId>
    <version>1.0</version>
</dependency>

Config API

Geronimo Config implements The MicroProfile Config API v1.1 and further information can be found at

The API is also available as Maven Artifact, which you could use if provided by your container

<dependency>
    <groupId>org.eclipse.microprofile.config</groupId>
    <artifactId>microprofile-config-api</artifactId>
    <version>1.1</version>
    <scope>provided</scope>
</dependency>