Configuring RESTEasy Applications

Since WildFly 20, you can configure RESTEasy through the MicroProfile Config project (https://github.com/eclipse/microprofile-config). The use of MicroProfile Config offers to REST developers a plenty of flexibility in controlling runtime configuration.

If you want to read more details about MicroProfile Config API, we recommend checking this tutorial: Configuring Microservices with MicroProfile Configuration

In a nutshell, the MicroProfile Config, defines a ConfigSource as Map<String, String> of property names to values. In turn, the ConfigSource represents a sequence of ConfigSources, ordered by priority. The priority of a ConfigSource is given by an ordinal (represented by an int), with a higher value indicating a higher priority. Here is the ordered list (Top-Down Ranking) ConfigSources:

• a ConfigSource based on System.getProperties() (ordinal = 400).
• a ConfigSource based on System.getenv() (ordinal = 300)
• a ConfigSource for each META-INF/microprofile-config.properties file on the ClassPath, separately configurable via a config_ordinal property inside each file (default ordinal = 100)

Using MicroProfile Config with REST Easy

Before WildFly 20, configuration properties were added at application level through the standard web.xml descriptor. For example, to set the resteasy.role.based.security property:

<web-app>
...
   <context-param>
      <param-name>resteasy.role.based.security</param-name>
      <param-value>true</param-value>
   </context-param>
</web-app>

Now, you can define this property with any of the ConfigSources, for example through the META-INF/microprofile-config.properties file:

resteasy.role.based.security=true

You can check an example application which uses RESTEasy Role Base Security here: Securing JAX-RS Services in WildFly applications

The full list of Properties you can set for your REST Easy Application is listed in this Table: