Add support for file store configuration into Quarkus

Closes #16821

quarkus/config-api/src/main/java/org/keycloak/config/StorageOptions.java

@@ -17,6 +17,8 @@
 
 package org.keycloak.config;
 
+import static java.util.function.Predicate.not;
+
 import org.keycloak.models.map.storage.hotRod.common.AutogeneratedHotRodDescriptors;
 import org.keycloak.models.map.storage.hotRod.common.HotRodEntityDescriptor;
 
@@ -32,7 +34,8 @@ public class StorageOptions {
 
         jpa("jpa"),
         chm("concurrenthashmap"),
-        hotrod("hotrod");
+        hotrod("hotrod"),
+        file("file");
 
         private final String provider;
 
@@ -263,6 +266,7 @@ public class StorageOptions {
             .category(OptionCategory.STORAGE)
             .description(descriptionForStorageAreas("single use objects"))
             .buildTime(true)
+            .expectedValues(Stream.of(StorageType.values()).filter(not(StorageType.file::equals)).toArray(StorageType[]::new))
             .build();
 
     public static final Option<String> STORAGE_PUBLIC_KEY_STORAGE_STORE = new OptionBuilder<>("storage-public-key-storage", String.class)
@@ -324,6 +328,11 @@ public class StorageOptions {
             .hidden()
             .build();
 
+    public static final Option<String> STORAGE_FILE_DIR= new OptionBuilder<>("storage-file-dir", String.class)
+            .category(OptionCategory.STORAGE)
+            .description("Root directory for file map store.")
+            .build();
+
     private static String descriptionForStorageAreas(String areaAsText) {
         return "Sets a storage mechanism for " + areaAsText + ".";
     }

quarkus/runtime/pom.xml

@@ -528,6 +528,16 @@
                 </exclusion>
             </exclusions>
         </dependency>
+        <dependency>
+            <groupId>org.snakeyaml</groupId>
+            <artifactId>snakeyaml-engine</artifactId>
+            <exclusions>
+                <exclusion>
+                    <groupId>*</groupId>
+                    <artifactId>*</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
         <dependency>
             <groupId>com.google.zxing</groupId>
             <artifactId>core</artifactId>

quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/StoragePropertyMappers.java

@@ -230,7 +230,7 @@ final class StoragePropertyMappers {
                 fromOption(StorageOptions.STORAGE_SINGLE_USE_OBJECT_STORE)
                         .to("kc.spi-single-use-object-map-storage-provider")
                         .mapFrom("storage")
-                        .transformer(StoragePropertyMappers::resolveMapStorageProvider)
+                        .transformer(StoragePropertyMappers::resolveMapStorageProviderSingleUseObjects)
                         .paramLabel("type")
                         .build(),
                 fromOption(StorageOptions.STORAGE_PUBLIC_KEY_STORAGE_STORE)
@@ -298,6 +298,11 @@ final class StoragePropertyMappers {
                 fromOption(StorageOptions.STORAGE_HOTROD_CACHE_REINDEX)
                         .to("kc.spi-connections-hot-rod-default-reindex-caches")
                         .paramLabel("[cache1,cache2,...]|all")
+                        .build(),
+                fromOption(StorageOptions.STORAGE_FILE_DIR)
+                        .to("kc.spi-map-storage-file-dir")
+                        .mapFrom("storage")
+                        .paramLabel("dir")
                         .build()
         };
     }
@@ -366,6 +371,21 @@ final class StoragePropertyMappers {
         return value;
     }
 
+    private static Optional<String> resolveMapStorageProviderSingleUseObjects(Optional<String> value, ConfigSourceInterceptorContext context) {
+        try {
+            if (value.isPresent()) {
+                return of(value.map(StorageType::valueOf)
+                        .filter(not(StorageType.file::equals))
+                        .map(StorageType::getProvider)
+                        .orElse(StorageType.chm.getProvider()));
+            }
+        } catch (IllegalArgumentException iae) {
+            throw new IllegalArgumentException("Invalid storage provider: " + value.orElse(null), iae);
+        }
+
+        return value;
+    }
+
     private static Optional<String> resolveMapStorageProviderPublicKeyStorage(Optional<String> value, ConfigSourceInterceptorContext context) {
         try {
             if (value.isPresent()) {

quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelpAll.unix.approved.txt

@@ -31,52 +31,54 @@ Cache:
 Storage (Experimental):
 
 --storage <type>     Experimental: Sets the default storage mechanism for all areas. Possible
-                       values are: jpa, chm, hotrod.
+                       values are: jpa, chm, hotrod, file.
 --storage-area-auth-session <type>
                      Experimental: Sets a storage mechanism for authentication sessions. Possible
-                       values are: jpa, chm, hotrod.
+                       values are: jpa, chm, hotrod, file.
 --storage-area-authorization <type>
                      Experimental: Sets a storage mechanism for authorizations. Possible values
-                       are: jpa, chm, hotrod.
+                       are: jpa, chm, hotrod, file.
 --storage-area-client <type>
                      Experimental: Sets a storage mechanism for clients. Possible values are: jpa,
-                       chm, hotrod.
+                       chm, hotrod, file.
 --storage-area-client-scope <type>
                      Experimental: Sets a storage mechanism for client scopes. Possible values are:
-                       jpa, chm, hotrod.
+                       jpa, chm, hotrod, file.
 --storage-area-event-admin <type>
                      Experimental: Sets a storage mechanism for admin events. Possible values are:
-                       jpa, chm, hotrod.
+                       jpa, chm, hotrod, file.
 --storage-area-event-auth <type>
                      Experimental: Sets a storage mechanism for authentication and authorization
-                       events. Possible values are: jpa, chm, hotrod.
+                       events. Possible values are: jpa, chm, hotrod, file.
 --storage-area-group <type>
                      Experimental: Sets a storage mechanism for groups. Possible values are: jpa,
-                       chm, hotrod.
+                       chm, hotrod, file.
 --storage-area-login-failure <type>
                      Experimental: Sets a storage mechanism for login failures. Possible values
-                       are: jpa, chm, hotrod.
+                       are: jpa, chm, hotrod, file.
 --storage-area-realm <type>
                      Experimental: Sets a storage mechanism for realms. Possible values are: jpa,
-                       chm, hotrod.
+                       chm, hotrod, file.
 --storage-area-role <type>
                      Experimental: Sets a storage mechanism for roles. Possible values are: jpa,
-                       chm, hotrod.
+                       chm, hotrod, file.
 --storage-area-single-use-object <type>
                      Experimental: Sets a storage mechanism for single use objects. Possible values
                        are: jpa, chm, hotrod.
 --storage-area-user <type>
                      Experimental: Sets a storage mechanism for users. Possible values are: jpa,
-                       chm, hotrod.
+                       chm, hotrod, file.
 --storage-area-user-session <type>
                      Experimental: Sets a storage mechanism for user and client sessions. Possible
-                       values are: jpa, chm, hotrod.
+                       values are: jpa, chm, hotrod, file.
 --storage-deployment-state-version-seed <type>
                      Experimental: Secret that serves as a seed to mask the version number of
                        Keycloak in URLs. Need to be identical across all servers in the cluster.
                        Will default to a random number generated when starting the server which is
                        secure but will lead to problems when a loadbalancer without sticky sessions
                        is used or nodes are restarted.
+--storage-file-dir <dir>
+                     Experimental: Root directory for file map store.
 --storage-hotrod-host <host>
                      Experimental: Sets the host of the Infinispan server.
 --storage-hotrod-password <password>

quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelpAll.unix.approved.txt

@@ -37,52 +37,54 @@ Cache:
 Storage (Experimental):
 
 --storage <type>     Experimental: Sets the default storage mechanism for all areas. Possible
-                       values are: jpa, chm, hotrod.
+                       values are: jpa, chm, hotrod, file.
 --storage-area-auth-session <type>
                      Experimental: Sets a storage mechanism for authentication sessions. Possible
-                       values are: jpa, chm, hotrod.
+                       values are: jpa, chm, hotrod, file.
 --storage-area-authorization <type>
                      Experimental: Sets a storage mechanism for authorizations. Possible values
-                       are: jpa, chm, hotrod.
+                       are: jpa, chm, hotrod, file.
 --storage-area-client <type>
                      Experimental: Sets a storage mechanism for clients. Possible values are: jpa,
-                       chm, hotrod.
+                       chm, hotrod, file.
 --storage-area-client-scope <type>
                      Experimental: Sets a storage mechanism for client scopes. Possible values are:
-                       jpa, chm, hotrod.
+                       jpa, chm, hotrod, file.
 --storage-area-event-admin <type>
                      Experimental: Sets a storage mechanism for admin events. Possible values are:
-                       jpa, chm, hotrod.
+                       jpa, chm, hotrod, file.
 --storage-area-event-auth <type>
                      Experimental: Sets a storage mechanism for authentication and authorization
-                       events. Possible values are: jpa, chm, hotrod.
+                       events. Possible values are: jpa, chm, hotrod, file.
 --storage-area-group <type>
                      Experimental: Sets a storage mechanism for groups. Possible values are: jpa,
-                       chm, hotrod.
+                       chm, hotrod, file.
 --storage-area-login-failure <type>
                      Experimental: Sets a storage mechanism for login failures. Possible values
-                       are: jpa, chm, hotrod.
+                       are: jpa, chm, hotrod, file.
 --storage-area-realm <type>
                      Experimental: Sets a storage mechanism for realms. Possible values are: jpa,
-                       chm, hotrod.
+                       chm, hotrod, file.
 --storage-area-role <type>
                      Experimental: Sets a storage mechanism for roles. Possible values are: jpa,
-                       chm, hotrod.
+                       chm, hotrod, file.
 --storage-area-single-use-object <type>
                      Experimental: Sets a storage mechanism for single use objects. Possible values
                        are: jpa, chm, hotrod.
 --storage-area-user <type>
                      Experimental: Sets a storage mechanism for users. Possible values are: jpa,
-                       chm, hotrod.
+                       chm, hotrod, file.
 --storage-area-user-session <type>
                      Experimental: Sets a storage mechanism for user and client sessions. Possible
-                       values are: jpa, chm, hotrod.
+                       values are: jpa, chm, hotrod, file.
 --storage-deployment-state-version-seed <type>
                      Experimental: Secret that serves as a seed to mask the version number of
                        Keycloak in URLs. Need to be identical across all servers in the cluster.
                        Will default to a random number generated when starting the server which is
                        secure but will lead to problems when a loadbalancer without sticky sessions
                        is used or nodes are restarted.
+--storage-file-dir <dir>
+                     Experimental: Root directory for file map store.
 --storage-hotrod-host <host>
                      Experimental: Sets the host of the Infinispan server.
 --storage-hotrod-password <password>

quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelpAll.unix.approved.txt

@@ -28,6 +28,8 @@ Storage (Experimental):
                        Will default to a random number generated when starting the server which is
                        secure but will lead to problems when a loadbalancer without sticky sessions
                        is used or nodes are restarted.
+--storage-file-dir <dir>
+                     Experimental: Root directory for file map store.
 --storage-hotrod-host <host>
                      Experimental: Sets the host of the Infinispan server.
 --storage-hotrod-password <password>