Configuring your Quarkus applications

Procedure

1. Review the GreetingResource.java file and make sure it includes the following import statements:

   src/main/java/org/acme/config/GreetingResource.java

   import java.util.Optional;
   import javax.inject.Inject;

   Copy to Clipboard Toggle word wrap

2. Create a file GreetingConfiguration.java in the src/main/java/org/acme/config directory.

3. Add the ConfigProperties and Optional imports to the GreetingConfiguration.java file:

   src/main/java/org/acme/config/GreetingConfiguration.java

   import io.quarkus.arc.config.ConfigProperties;
   import java.util.Optional;
   import javax.inject.Inject;

   Copy to Clipboard Toggle word wrap

4. Create a GreetingConfiguration class for the greeting properties in your GreetingConfiguration.java file:

   src/main/java/org/acme/config/GreetingConfiguration.java

   @ConfigProperties(prefix = "greeting") 

   1

   
   public class GreetingConfiguration {
   
       private String message;
       private String suffix = "!"; 

   2

   
       private Optional<String> name;
   
       public String getMessage() {
           return message;
       }
   
       public void setMessage(String message) {
           this.message = message;
       }
   
       public String getSuffix() {
           return suffix;
       }
   
       public void setSuffix(String suffix) {
           this.suffix = suffix;
       }
   
       public Optional<String> getName() {
           return name;
       }
   
       public void setName(Optional<String> name) {
           this.name = name;
       }
   }

   Copy to Clipboard Toggle word wrap

   1

   prefix is optional. If you do not specify a prefix, it is determined by the name of the class. In this example, the prefix is greeting.

   2

   If greeting.suffix is not set, ! is the default value.

5. Inject the GreetingConfiguration class into the GreetingResource class using the @Inject annotation:

   src/main/java/org/acme/config/GreetingResource.java

   @Path("/greeting")
   public class GreetingResource {
   
       @Inject
       GreetingConfiguration config;
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return config.getMessage() + " " + config.getName().orElse("world") + config.getSuffix();
       }
   }

   Copy to Clipboard Toggle word wrap

6. Compile and start your application in development mode:

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap
   Important

   If you do not provide values for the class properties, the application fails to compile and you receive a javax.enterprise.inject.spi.DeploymentException that indicates a missing value. This does not apply to Optional fields and fields with a default value.

7. Enter the following command in a new terminal window to verify that the endpoint returns the message:

   curl http://localhost:8080/greeting

   Copy to Clipboard Toggle word wrap

8. You receive the following message:

   hello quarkus!

   Copy to Clipboard Toggle word wrap
9. Press CTRL+C to stop the application.

Procedure

1. Review the GreetingConfiguration.java file and make sure it includes the following import statements:

   src/main/java/org/acme/config/GreetingConfiguration.java

   import io.quarkus.arc.config.ConfigProperties;
   import java.util.Optional;
   import java.util.List;

   Copy to Clipboard Toggle word wrap

2. Add the configuration in your GreetingConfiguration.java file using the @ConfigProperties annotation.

   The following example shows the configuration of the GreetingConfiguration class and its properties:

   src/main/java/org/acme/config/GreetingConfiguration.java

   @ConfigProperties(prefix = "greeting")
   public class GreetingConfiguration {
   
       public String message;
       public String suffix = "!";
       public Optional<String> name;
   }

   Copy to Clipboard Toggle word wrap

3. Add a nested class inside the GreetingConfiguration class as shown in the following example:

   src/main/java/org/acme/config/GreetingConfiguration.java

   @ConfigProperties(prefix = "greeting")
   public class GreetingConfiguration {
   
       public String message;
       public String suffix = "!";
       public Optional<String> name;
       public ContentConfig content;
   
       public static class ContentConfig {
           public Integer prizeAmount;
           public List<String> recipients;
       }
   }

   Copy to Clipboard Toggle word wrap

   This example shows a nested class ContentConfig. The name of the field, in this case content, determines the name of the properties bound to the object.

4. Set the greeting.content.prize-amount and greeting.content.recipients configuration properties in your application.properties file.

   The following example shows the values of properties for the GreetingConfiguration and ContentConfig classes:

   src/main/resources/application.properties

   greeting.message = hello
   greeting.name = quarkus
   greeting.content.prize-amount=10
   greeting.content.recipients=Jane,John

   Copy to Clipboard Toggle word wrap

5. Inject the GreetingConfiguration class into the GreetingResource class using the @Inject annotation, and update the message string that the /greeting endpoint returns to have the message show the values that you set for the new greeting.content.prize-amount and greeting.content.recipients properties that you added:

   src/main/java/org/acme/config/GreetingResource.java

   @Path("/greeting")
   public class GreetingResource {
   
       @Inject
       GreetingConfiguration config;
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return config.message + " " + config.name.orElse("world") + config.suffix + "\n" + config.content.recipients + " receive total of candies: " + config.content.prizeAmount;
       }
   }

   Copy to Clipboard Toggle word wrap

6. Compile and start your application in development mode:

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap
   Important

   If you do not provide values for the class properties, the application fails to compile and you receive a javax.enterprise.inject.spi.DeploymentException that indicates a missing value. This does not apply to Optional fields and fields with a default value.

7. Enter the following command in a new terminal window to verify that the endpoint returns the message:

   curl http://localhost:8080/greeting

   Copy to Clipboard Toggle word wrap

8. You receive the message that contains the greeting on the first line and the recipients of the prize and the prize amount on the second line:

   hello quarkus!
   Jane,John receive total of candies: 10

   Copy to Clipboard Toggle word wrap
9. Press CTRL+C to stop the application.

Procedure

1. Review the GreetingConfiguration.java file and make sure it includes the following import statements:

   src/main/java/org/acme/config/GreetingConfiguration.java

   import io.quarkus.arc.config.ConfigProperties;
   import org.eclipse.microprofile.config.inject.ConfigProperty;
   import java.util.Optional;

   Copy to Clipboard Toggle word wrap

2. Add a GreetingConfiguration class as an interface to your GreetingConfiguration.java file:

   src/main/java/org/acme/config/GreetingConfiguration.java

   @ConfigProperties(prefix = "greeting")
   public interface GreetingConfiguration {
   
       @ConfigProperty(name = "message") 

   1

   
       String message();
   
       @ConfigProperty(defaultValue = "!")
       String getSuffix(); 

   2

   
   
       Optional<String> getName(); 

   3

   
   }

   Copy to Clipboard Toggle word wrap

   1

   You must set the @ConfigProperty annotation because the name of the configuration property does not follow the getter method naming conventions.

   2

   In this example, name was not set so the corresponding property will be greeting.suffix.

   3

   You do not need to specify the @ConfigProperty annotation because the method name follows the getter method naming conventions (greeting.name being the corresponding property) and no default value is needed.

3. Inject the GreetingConfiguration class into the GreetingResource class using the @Inject annotation:

   src/main/java/org/acme/config/GreetingResource.java

   @Path("/greeting")
   public class GreetingResource {
   
       @Inject
       GreetingConfiguration config;
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return config.message() + " " + config.getName().orElse("world") + config.getSuffix();
       }
   }

   Copy to Clipboard Toggle word wrap

4. Compile and start your application in development mode:

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap
   Important

   If you do not provide values for the class properties, the application fails to compile and you receive a javax.enterprise.inject.spi.DeploymentException that indicates a missing value. This does not apply to Optional fields and fields with a default value.

5. Enter the following command in a new terminal window to verify that the endpoint returns the message:

   curl http://localhost:8080/greeting

   Copy to Clipboard Toggle word wrap

6. You receive the following message:

   hello quarkus!

   Copy to Clipboard Toggle word wrap
7. Press CTRL+C to stop the application.

Procedure

1. To set a custom profile, create a configuration property with the profile name in the application.properties file, where <key> is the name of the property, <value> is the property value, and <profile> is the name of a profile:

    %<profile>.<key>=<value>

   Copy to Clipboard Toggle word wrap

   In the following example configuration, the value of quarkus.http.port is 9090 by default, and becomes 8181 when the dev profile is activated:

   quarkus.http.port=9090
   %dev.quarkus.http.port=8181

   Copy to Clipboard Toggle word wrap

2. Use one of the following methods to enable a profile:

   • Set the quarkus.profile system property.

     • To enable a profile using the quarkus.profile system property, enter the following command:

       mvn -Dquarkus.profile=<value> quarkus:dev

       Copy to Clipboard Toggle word wrap

   • Set the QUARKUS_PROFILE environment variable.

     • To enable profile using an environment variable, enter the following command:

       export QUARKUS_PROFILE=<profile>

       Copy to Clipboard Toggle word wrap
       Note

       The system property value takes precedence over the environment variable value.

3. To repackage the application and change the profile, enter the following command:

   ./mvnw package -Dquarkus.profile=<profile>
    java -jar target/myapp-runner.jar

   Copy to Clipboard Toggle word wrap

   The following example shows a command that activates the prod-aws profile:

   ./mvnw package -Dquarkus.profile=prod-aws
    java -jar target/myapp-runner.jar

   Copy to Clipboard Toggle word wrap

Procedure

1. Add the following import statements to your service file:

   package org.acme.config;
   
   import javax.annotation.Priority;
   import org.eclipse.microprofile.config.spi.Converter;

   Copy to Clipboard Toggle word wrap

2. Set a priority for your custom converter by annotating the class with the @Priority annotation and passing it a priority value:

   @Priority(150)
   public class MyCustomConverter implements Converter<MicroProfileCustomValue> {
   
       @Override
       public MicroProfileCustomValue convert(String value) {
   
           final int secretNumber;
           if (value.startsFrom("OBF:")) {
               secretNumber = Integer.valueOf(SecretDecoder.decode(value));
           } else {
               secretNumber = Integer.valueOf(value);
           }
   
           return new MicroProfileCustomValue(secretNumber);
       }
   }

   Copy to Clipboard Toggle word wrap
   Note

   If you add a new converter, you must list it in the META-INF/services/org.eclipse.microprofile.config.spi.Converter service file.

Procedure

1. Open the src/main/resources/application.yaml configuration file.

2. Add the nested class configuration properties to your application.yaml file as shown in the example:

   src/main/resources/application.yaml

   # Properties that configure the JDBC data source driver of your PostgreSQL data source
   quarkus:
     datasource:
       url: jdbc:postgresql://localhost:5432/some-database
       driver: org.postgresql.Driver
       username: quarkus
       password: quarkus
   
   # Property that configures the URL of the endpoint to which the rest client sends requests
   org:
     acme:
       restclient:
         CountriesService/mp-rest/url: https://restcountries.eu/rest
   
   # Property that configures the log message level for your application
   quarkus:
     log:
       category:
         # Do not use spaces in names of configuration properties that you place inside quotation marks
         "io.quarkus.category":
           level: INFO

   Copy to Clipboard Toggle word wrap

   Note, that you can use comments to describe your configuration properties in a similar way as you use them in application.properties.

   Note

   Always use spaces to indent the properties in your YAML configuration file. YAML does not allow using tabs for indentation.

Procedure

1. Open the src/main/resources/application.yaml configuration file.

2. To set a profile dependent configuration, add the profile name before defining the key-value pairs using the "%<profile_name>" syntax. Ensure that you place the profile name inside quotation marks. In YAML, all strings that begin with a special character must be placed inside quotation marks.

   In the following example the PostgreSQL database is configured to be available at the jdbc:postgresql://localhost:5432/some-database URL when you start your Quarkus application in development mode:

   src/main/resources/application.yaml

   "%dev":
     # Properties that configure the JDBC data source driver of your PostgreSQL data source
     quarkus:
       datasource:
         url: jdbc:postgresql://localhost:5432/some-database
         driver: org.postgresql.Driver
         username: quarkus
         password: quarkus

   Copy to Clipboard Toggle word wrap

Procedure

1. Open your YAML configuration file.

2. To define a YAML property as a prefix of another property, add a tilde (~) in the scope of the property as shown in the following example:

   quarkus:
     http:
       cors:
         ~: true
         methods: GET,PUT,POST

   Copy to Clipboard Toggle word wrap

3. To compile your Quarkus application in development mode, enter the following command from the project directory:

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap
   Note

   You can use YAML keys for conflicting configuration keys at any level because they are not included in the assembly of configuration property name.