Fix #1191 - refactor CredentialsProvider return type

gabriel-farache · gabriel-farache · commit 377e0346e055 · 2025-06-12T16:35:42.000+02:00
diff --git a/client/integration-tests/auth-provider/src/main/java/io/quarkiverse/openapi/generator/it/auth/provider/CustomCredentialsProvider.java b/client/integration-tests/auth-provider/src/main/java/io/quarkiverse/openapi/generator/it/auth/provider/CustomCredentialsProvider.java
@@ -1,5 +1,7 @@
 package io.quarkiverse.openapi.generator.it.auth.provider;
 
+import java.util.Optional;
+
 import jakarta.annotation.Priority;
 import jakarta.enterprise.context.Dependent;
 import jakarta.enterprise.inject.Alternative;
@@ -11,18 +13,18 @@
 @Dependent
 @Alternative
 @Specializes
-@Priority(200)
+@Priority(201)
 public class CustomCredentialsProvider extends ConfigCredentialsProvider {
     public CustomCredentialsProvider() {
     }
 
     @Override
-    public String getBearerToken(CredentialsContext input) {
-        return super.getBearerToken(input) + "_TEST";
+    public Optional<String> getBearerToken(CredentialsContext input) {
+        return Optional.of(super.getBearerToken(input).get() + "_TEST");
     }
 
     @Override
-    public String getOauth2BearerToken(CredentialsContext input) {
-        return super.getOauth2BearerToken(input) + "_TEST";
+    public Optional<String> getOauth2BearerToken(CredentialsContext input) {
+        return Optional.of("KEYCLOAK_ACCESS_TOKEN" + "_TEST");
     }
 }
diff --git a/client/integration-tests/override-credential-provider/src/main/java/io/quarkiverse/openapi/generator/it/creds/CustomCredentialsProvider.java b/client/integration-tests/override-credential-provider/src/main/java/io/quarkiverse/openapi/generator/it/creds/CustomCredentialsProvider.java
@@ -1,5 +1,7 @@
 package io.quarkiverse.openapi.generator.it.creds;
 
+import java.util.Optional;
+
 import jakarta.annotation.Priority;
 import jakarta.enterprise.context.Dependent;
 import jakarta.enterprise.inject.Alternative;
@@ -19,8 +21,8 @@ public class CustomCredentialsProvider extends ConfigCredentialsProvider {
     public static String TOKEN = "FIXED_TEST_TOKEN";
 
     @Override
-    public String getBearerToken(CredentialsContext input) {
+    public Optional<String> getBearerToken(CredentialsContext input) {
         LOGGER.info("========> getBearerToken from CustomCredentialsProvider");
-        return TOKEN;
+        return Optional.of(TOKEN);
     }
-}
+}
diff --git a/client/oidc/src/main/java/io/quarkiverse/openapi/generator/oidc/providers/OAuth2AuthenticationProvider.java b/client/oidc/src/main/java/io/quarkiverse/openapi/generator/oidc/providers/OAuth2AuthenticationProvider.java
@@ -4,6 +4,7 @@
 
 import java.io.IOException;
 import java.util.List;
+import java.util.Optional;
 
 import jakarta.ws.rs.client.ClientRequestContext;
 
@@ -32,17 +33,22 @@ public OAuth2AuthenticationProvider(String name,
 
     @Override
     public void filter(ClientRequestContext requestContext) throws IOException {
-        String bearerToken;
+        String bearerToken = "";
 
         if (this.isTokenPropagation()) {
             bearerToken = this.getTokenForPropagation(requestContext.getHeaders());
         } else {
-            delegate.filter(requestContext);
-            bearerToken = this.getCredentialsProvider().getOauth2BearerToken(CredentialsContext.builder()
-                    .requestContext(requestContext)
-                    .openApiSpecId(getOpenApiSpecId())
-                    .authName(getName())
-                    .build());
+            Optional<String> optionalBearerToken = this.getCredentialsProvider()
+                    .getOauth2BearerToken(CredentialsContext.builder()
+                            .requestContext(requestContext)
+                            .openApiSpecId(getOpenApiSpecId())
+                            .authName(getName())
+                            .build());
+            if (optionalBearerToken.isPresent()) {
+                bearerToken = optionalBearerToken.get();
+            } else {
+                delegate.filter(requestContext);
+            }
         }
 
         if (!isEmptyOrBlank(bearerToken)) {
diff --git a/client/runtime/src/main/java/io/quarkiverse/openapi/generator/providers/ApiKeyAuthenticationProvider.java b/client/runtime/src/main/java/io/quarkiverse/openapi/generator/providers/ApiKeyAuthenticationProvider.java
@@ -58,7 +58,7 @@ private String getApiKey(ClientRequestContext requestContext) {
                 .requestContext(requestContext)
                 .openApiSpecId(getOpenApiSpecId())
                 .authName(getName())
-                .build());
+                .build()).orElseThrow();
     }
 
     private boolean isUseAuthorizationHeaderValue() {
diff --git a/client/runtime/src/main/java/io/quarkiverse/openapi/generator/providers/BasicAuthenticationProvider.java b/client/runtime/src/main/java/io/quarkiverse/openapi/generator/providers/BasicAuthenticationProvider.java
@@ -29,15 +29,15 @@ private String getUsername(ClientRequestContext requestContext) {
                 .requestContext(requestContext)
                 .openApiSpecId(getOpenApiSpecId())
                 .authName(getName())
-                .build());
+                .build()).orElseThrow();
     }
 
     private String getPassword(ClientRequestContext requestContext) {
         return credentialsProvider.getBasicPassword(CredentialsContext.builder()
                 .requestContext(requestContext)
                 .openApiSpecId(getOpenApiSpecId())
                 .authName(getName())
-                .build());
+                .build()).orElseThrow();
     }
 
     @Override
diff --git a/client/runtime/src/main/java/io/quarkiverse/openapi/generator/providers/BearerAuthenticationProvider.java b/client/runtime/src/main/java/io/quarkiverse/openapi/generator/providers/BearerAuthenticationProvider.java
@@ -51,6 +51,6 @@ private String getBearerToken(ClientRequestContext requestContext) {
                 .requestContext(requestContext)
                 .openApiSpecId(getOpenApiSpecId())
                 .authName(getName())
-                .build());
+                .build()).orElseThrow();
     }
 }
diff --git a/client/runtime/src/main/java/io/quarkiverse/openapi/generator/providers/ConfigCredentialsProvider.java b/client/runtime/src/main/java/io/quarkiverse/openapi/generator/providers/ConfigCredentialsProvider.java
@@ -1,9 +1,10 @@
 package io.quarkiverse.openapi.generator.providers;
 
+import java.util.Optional;
+
 import jakarta.annotation.Priority;
 import jakarta.enterprise.context.Dependent;
 import jakarta.enterprise.inject.Alternative;
-import jakarta.ws.rs.core.HttpHeaders;
 
 import org.eclipse.microprofile.config.ConfigProvider;
 import org.slf4j.Logger;
@@ -26,7 +27,7 @@ public ConfigCredentialsProvider() {
     }
 
     @Override
-    public String getApiKey(CredentialsContext input) {
+    public Optional<String> getApiKey(CredentialsContext input) {
         final String key = ConfigProvider.getConfig()
                 .getOptionalValue(
                         AbstractAuthProvider.getCanonicalAuthConfigPropertyName(API_KEY, input.getOpenApiSpecId(),
@@ -38,41 +39,41 @@ public String getApiKey(CredentialsContext input) {
                     AbstractAuthProvider.getCanonicalAuthConfigPropertyName(API_KEY, input.getOpenApiSpecId(),
                             input.getAuthName()));
         }
-        return key;
+        return Optional.of(key);
     }
 
     @Override
-    public String getBasicUsername(CredentialsContext input) {
-        return ConfigProvider.getConfig()
+    public Optional<String> getBasicUsername(CredentialsContext input) {
+        return Optional.of(ConfigProvider.getConfig()
                 .getOptionalValue(
                         AbstractAuthProvider.getCanonicalAuthConfigPropertyName(USER_NAME, input.getOpenApiSpecId(),
                                 input.getAuthName()),
                         String.class)
-                .orElse("");
+                .orElse(""));
     }
 
     @Override
-    public String getBasicPassword(CredentialsContext input) {
-        return ConfigProvider.getConfig()
+    public Optional<String> getBasicPassword(CredentialsContext input) {
+        return Optional.of(ConfigProvider.getConfig()
                 .getOptionalValue(
                         AbstractAuthProvider.getCanonicalAuthConfigPropertyName(PASSWORD, input.getOpenApiSpecId(),
                                 input.getAuthName()),
                         String.class)
-                .orElse("");
+                .orElse(""));
     }
 
     @Override
-    public String getBearerToken(CredentialsContext input) {
-        return ConfigProvider.getConfig()
+    public Optional<String> getBearerToken(CredentialsContext input) {
+        return Optional.of(ConfigProvider.getConfig()
                 .getOptionalValue(
                         AbstractAuthProvider.getCanonicalAuthConfigPropertyName(BEARER_TOKEN, input.getOpenApiSpecId(),
                                 input.getAuthName()),
                         String.class)
-                .orElse("");
+                .orElse(""));
     }
 
     @Override
-    public String getOauth2BearerToken(CredentialsContext input) {
-        return input.getRequestContext().getHeaderString(HttpHeaders.AUTHORIZATION);
+    public Optional<String> getOauth2BearerToken(CredentialsContext input) {
+        return Optional.empty();
     }
 }
diff --git a/client/runtime/src/main/java/io/quarkiverse/openapi/generator/providers/CredentialsProvider.java b/client/runtime/src/main/java/io/quarkiverse/openapi/generator/providers/CredentialsProvider.java
@@ -1,5 +1,7 @@
 package io.quarkiverse.openapi.generator.providers;
 
+import java.util.Optional;
+
 /**
  * Provider for security credentials. Clients can implement this interface to control how to provide security credentials in
  * runtime.
@@ -13,37 +15,37 @@ public interface CredentialsProvider {
      * @param input the input data available to the method
      * @return the API Key to use when filtering the request
      */
-    String getApiKey(CredentialsContext input);
+    Optional<String> getApiKey(CredentialsContext input);
 
     /**
      * Gets the username given the OpenAPI definition and security schema
      *
      * @param input the input data available to the method
      * @return the username to use when filtering the request
      */
-    String getBasicUsername(CredentialsContext input);
+    Optional<String> getBasicUsername(CredentialsContext input);
 
     /**
      * Gets the password given the OpenAPI definition and security schema
      *
      * @param input the input data available to the method
      * @return the password to use when filtering the request
      */
-    String getBasicPassword(CredentialsContext input);
+    Optional<String> getBasicPassword(CredentialsContext input);
 
     /**
      * Gets the Bearer Token given the OpenAPI definition and security schema
      *
      * @param input the input data available to the method
      * @return the Bearer Token to use when filtering the request
      */
-    String getBearerToken(CredentialsContext input);
+    Optional<String> getBearerToken(CredentialsContext input);
 
     /**
      * Gets the OAuth2 Bearer Token given the OpenAPI definition and security schema
      *
      * @param input the input data available to the method
      * @return the Bearer Token to use when filtering the request
      */
-    String getOauth2BearerToken(CredentialsContext input);
+    Optional<String> getOauth2BearerToken(CredentialsContext input);
 }

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ private String getApiKey(ClientRequestContext requestContext) {`
`58`	`58`	`.requestContext(requestContext)`
`59`	`59`	`.openApiSpecId(getOpenApiSpecId())`
`60`	`60`	`.authName(getName())`
`61`		`- .build());`
	`61`	`+ .build()).orElseThrow();`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`private boolean isUseAuthorizationHeaderValue() {`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,6 @@ private String getBearerToken(ClientRequestContext requestContext) {`
`51`	`51`	`.requestContext(requestContext)`
`52`	`52`	`.openApiSpecId(getOpenApiSpecId())`
`53`	`53`	`.authName(getName())`
`54`		`- .build());`
	`54`	`+ .build()).orElseThrow();`
`55`	`55`	`}`
`56`	`56`	`}`