Chapter 10. Using custom configuration converters as configuration values

Procedure

1. Include the fully qualified class name of the converter in your META-INF/services/org.eclipse.microprofile.config.spi.Converter service file as shown in the following example:

   org.acme.config.MicroProfileCustomValueConverter
   org.acme.config.SomeOtherConverter
   org.acme.config.YetAnotherConverter

2. Implement the converter class to override the convert method:

   package org.acme.config;
   
   import org.eclipse.microprofile.config.spi.Converter;
   
   public class MicroProfileCustomValueConverter implements Converter<MicroProfileCustomValue> {
   
       @Override
       public MicroProfileCustomValue convert(String value) {
           return new MicroProfileCustomValue(Integer.valueOf(value));
       }
   }

   Note

   Your custom converter class must be public and must have a public no-argument constructor. Your custom converter class cannot be abstract.

3. Use your custom type as a configuration value:

   @ConfigProperty(name = "configuration.value.name")
   MicroProfileCustomValue value;