Hocon Configuration Format

The Hocon Configuration Format extends the Vert.x Configuration Retriever and provides the support for the HOCON(https://github.com/typesafehub/config/blob/master/HOCON.md) format.

It supports includes, json, properties, macros…​

Using the Hocon Configuration Format

To use the Hocon Configuration Format, add the following dependency to the dependencies section of your build descriptor:

  • Maven (in your pom.xml):

<dependency>
  <groupId>io.vertx</groupId>
  <artifactId>vertx-config-hocon-scala_2.12</artifactId>
  <version>3.5.0.Beta1</version>
</dependency>
<dependency>
  <groupId>io.vertx</groupId>
  <artifactId>vertx-config</artifactId>
  <version>3.5.0.Beta1</version>
</dependency>
  • Gradle (in your build.gradle file):

compile 'io.vertx:vertx-config:3.5.0.Beta1'
compile 'io.vertx:vertx-config-hocon-scala_2.12:3.5.0.Beta1'

Configuring the store to use HOCON

Once added to your classpath or dependencies, you need to configure the ConfigRetriever to use this format:

var store = ConfigStoreOptions()
  .setType("file")
  .setFormat("hocon")
  .setConfig(new io.vertx.core.json.JsonObject().put("path", "my-config.conf"))


var retriever = ConfigRetriever.create(vertx, ConfigRetrieverOptions()
  .setStores(Set(store))
)

You just need to set format to hocon.