[CXF-9175] added test, renamed attribute, fixed PMDM issues

gpitteloud · gpitteloud · commit f0cffd69409c · 2025-11-14T15:00:45.000+01:00
diff --git a/rt/rs/description-swagger-ui/src/main/java/org/apache/cxf/jaxrs/swagger/ui/SwaggerUiConfig.java b/rt/rs/description-swagger-ui/src/main/java/org/apache/cxf/jaxrs/swagger/ui/SwaggerUiConfig.java
@@ -68,7 +68,7 @@ public class SwaggerUiConfig {
     private Boolean queryConfigEnabled;
     // Controls the OAuth config. If present, the SwaggerUIBundle initialization will contain a call to initOAuth
     // with the parameters contained here
-    private SwaggerUiOAuth2Config oAuthConfig;
+    private SwaggerUiOAuth2Config oAuth2Config;
     
     public String getConfigUrl() {
         return configUrl;
@@ -340,16 +340,16 @@ public void setTryItOutEnabled(Boolean tryItOutEnabled) {
         setQueryConfigEnabledIfNeeded();
     }
 
-    public SwaggerUiOAuth2Config getOAuthConfig() {
-        return oAuthConfig;
+    public SwaggerUiOAuth2Config getOAuth2Config() {
+        return oAuth2Config;
     }
 
-    public void setOAuthConfig(SwaggerUiOAuth2Config oAuthConfig) {
-        this.oAuthConfig = oAuthConfig;
+    public void setOAuth2Config(SwaggerUiOAuth2Config oauth) {
+        this.oAuth2Config = oauth;
     }
 
-    public SwaggerUiConfig oAuthConfig(SwaggerUiOAuth2Config oAuthConfig) {
-        setOAuthConfig(oAuthConfig);
+    public SwaggerUiConfig oAuth2Config(SwaggerUiOAuth2Config oauth) {
+        setOAuth2Config(oauth);
         return this;
     }
 }
diff --git a/rt/rs/description-swagger-ui/src/main/java/org/apache/cxf/jaxrs/swagger/ui/SwaggerUiOAuth2Config.java b/rt/rs/description-swagger-ui/src/main/java/org/apache/cxf/jaxrs/swagger/ui/SwaggerUiOAuth2Config.java
@@ -1,3 +1,22 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
 package org.apache.cxf.jaxrs.swagger.ui;
 
 import java.util.List;
@@ -28,8 +47,8 @@ public void setClientId(String clientId) {
         this.clientId = clientId;
     }
 
-    public SwaggerUiOAuth2Config clientId(String clientId) {
-        setClientId(clientId);
+    public SwaggerUiOAuth2Config clientId(String cid) {
+        setClientId(cid);
         return this;
     }
 
@@ -41,8 +60,8 @@ public void setClientSecret(String clientSecret) {
         this.clientSecret = clientSecret;
     }
 
-    public SwaggerUiOAuth2Config clientSecret(String clientSecret) {
-        setClientSecret(clientSecret);
+    public SwaggerUiOAuth2Config clientSecret(String secret) {
+        setClientSecret(secret);
         return this;
     }
 
@@ -54,8 +73,8 @@ public void setRealm(String realm) {
         this.realm = realm;
     }
 
-    public SwaggerUiOAuth2Config realm(String realm) {
-        setRealm(realm);
+    public SwaggerUiOAuth2Config realm(String re) {
+        setRealm(re);
         return this;
     }
 
@@ -67,8 +86,8 @@ public void setAppName(String appName) {
         this.appName = appName;
     }
 
-    public SwaggerUiOAuth2Config appName(String appName) {
-        setAppName(appName);
+    public SwaggerUiOAuth2Config appName(String name) {
+        setAppName(name);
         return this;
     }
 
@@ -80,8 +99,8 @@ public void setScopes(List<String> scopes) {
         this.scopes = scopes;
     }
 
-    public SwaggerUiOAuth2Config scopes(List<String> scopes) {
-        setScopes(scopes);
+    public SwaggerUiOAuth2Config scopes(List<String> scopesList) {
+        setScopes(scopesList);
         return this;
     }
 
@@ -93,8 +112,8 @@ public void setAdditionalQueryStringParams(Map<String, String> additionalQuerySt
         this.additionalQueryStringParams = additionalQueryStringParams;
     }
 
-    public SwaggerUiOAuth2Config additionalQueryStringParams(Map<String, String> additionalQueryStringParams) {
-        setAdditionalQueryStringParams(additionalQueryStringParams);
+    public SwaggerUiOAuth2Config additionalQueryStringParams(Map<String, String> additionalParams) {
+        setAdditionalQueryStringParams(additionalParams);
         return this;
     }
 
@@ -106,8 +125,8 @@ public void setUseBasicAuthenticationWithAccessCodeGrant(Boolean useBasicAuthent
         this.useBasicAuthenticationWithAccessCodeGrant = useBasicAuthenticationWithAccessCodeGrant;
     }
 
-    public SwaggerUiOAuth2Config useBasicAuthenticationWithAccessCodeGrant(Boolean useBasicAuthenticationWithAccessCodeGrant) {
-        setUseBasicAuthenticationWithAccessCodeGrant(useBasicAuthenticationWithAccessCodeGrant);
+    public SwaggerUiOAuth2Config useBasicAuthenticationWithAccessCodeGrant(Boolean basicAuth) {
+        setUseBasicAuthenticationWithAccessCodeGrant(basicAuth);
         return this;
     }
 
@@ -119,8 +138,8 @@ public void setUsePkceWithAuthorizationCodeGrant(Boolean usePkceWithAuthorizatio
         this.usePkceWithAuthorizationCodeGrant = usePkceWithAuthorizationCodeGrant;
     }
 
-    public SwaggerUiOAuth2Config usePkceWithAuthorizationCodeGrant(Boolean usePkceWithAuthorizationCodeGrant) {
-        setUsePkceWithAuthorizationCodeGrant(usePkceWithAuthorizationCodeGrant);
+    public SwaggerUiOAuth2Config usePkceWithAuthorizationCodeGrant(Boolean pkce) {
+        setUsePkceWithAuthorizationCodeGrant(pkce);
         return this;
     }
 
@@ -143,18 +162,18 @@ public String toJsonString() {
         if (json.toString().endsWith(",")) {
             json.delete(json.length() - 1, json.length());
         }
-        return json.append("}").toString();
+        return json.append('}').toString();
     }
 
     private void addStringField(StringBuilder json, String name, String value) {
         if (value != null) {
-            json.append(quote(name)).append(':').append(quote(value)).append(",");
+            json.append(quote(name)).append(':').append(quote(value)).append(',');
         }
     }
 
     private void addBooleanField(StringBuilder json, String name, Boolean value) {
         if (value != null) {
-            json.append(quote(name)).append(':').append(quote(value.toString())).append(",");
+            json.append(quote(name)).append(':').append(value).append(',');
         }
     }
 
@@ -163,7 +182,7 @@ private void addListField(StringBuilder json, String name, List<String> value) {
             json.append(quote(name)).append(':').append(
                     value.stream().map(this::quote)
                             .collect(Collectors.joining(",", "[", "]"))
-            ).append(",");
+            ).append(',');
         }
     }
 
@@ -172,7 +191,7 @@ private void addMapField(StringBuilder json, String name, Map<String, String> va
             json.append(quote(name)).append(':').append(
                     value.entrySet().stream().map(this::entryToString)
                             .collect(Collectors.joining(",", "{", "}"))
-            ).append(",");
+            ).append(',');
         }
     }
 
diff --git a/rt/rs/description-swagger-ui/src/main/java/org/apache/cxf/jaxrs/swagger/ui/SwaggerUiService.java b/rt/rs/description-swagger-ui/src/main/java/org/apache/cxf/jaxrs/swagger/ui/SwaggerUiService.java
@@ -129,7 +129,7 @@ public Response getResource(@Context UriInfo uriInfo, @PathParam("resource") Str
                     // Since Swagger UI 4.1.3, passing the default URL as query parameter,
                     // e.g. `?url=swagger.json` is disabled by default due to security concerns.
                     final String url = config.getUrl();
-                    final SwaggerUiOAuth2Config oAuthConfig = config.getOAuthConfig();
+                    final SwaggerUiOAuth2Config oAuthConfig = config.getOAuth2Config();
                     if (!StringUtils.isEmpty(url) || oAuthConfig != null) {
                         try (InputStream in = resourceURL.openStream()) {
                             String resource = IOUtils.readStringFromStream(in);
diff --git a/systests/jaxrs/src/test/java/org/apache/cxf/systest/jaxrs/description/openapi/SwaggerUiConfigurationTest.java b/systests/jaxrs/src/test/java/org/apache/cxf/systest/jaxrs/description/openapi/SwaggerUiConfigurationTest.java
@@ -19,7 +19,11 @@
 package org.apache.cxf.systest.jaxrs.description.openapi;
 
 import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.databind.json.JsonMapper;
 import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
 
 import jakarta.ws.rs.core.MediaType;
@@ -31,12 +35,14 @@
 import org.apache.cxf.jaxrs.model.AbstractResourceInfo;
 import org.apache.cxf.jaxrs.openapi.OpenApiFeature;
 import org.apache.cxf.jaxrs.swagger.ui.SwaggerUiConfig;
+import org.apache.cxf.jaxrs.swagger.ui.SwaggerUiOAuth2Config;
 import org.apache.cxf.testutil.common.AbstractClientServerTestBase;
 import org.apache.cxf.testutil.common.AbstractServerTestServerBase;
 
 import org.junit.BeforeClass;
 import org.junit.Test;
 
+import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY;
 import static org.hamcrest.CoreMatchers.containsString;
 import static org.hamcrest.CoreMatchers.equalTo;
 import static org.hamcrest.MatcherAssert.assertThat;
@@ -45,7 +51,12 @@
 
 public class SwaggerUiConfigurationTest extends AbstractClientServerTestBase {
     private static final String PORT = allocatePort(SwaggerUiConfigurationTest.class);
-
+    private static final SwaggerUiOAuth2Config OAUTH2_CONFIG = new SwaggerUiOAuth2Config()
+            .usePkceWithAuthorizationCodeGrant(true)
+            .appName("CXF Test App")
+            .additionalQueryStringParams(Map.of("key1", "value1", "key2", "value2"))
+            .scopes(List.of("scope1", "scope2"));
+    
     public static class Server extends AbstractServerTestServerBase {
 
         @Override
@@ -57,7 +68,10 @@ protected org.apache.cxf.endpoint.Server createServer(Bus bus) throws Exception
             sf.setProvider(new JacksonJsonProvider());
             final OpenApiFeature feature = new OpenApiFeature();
             feature.setRunAsFilter(false);
-            feature.setSwaggerUiConfig(new SwaggerUiConfig().url("/openapi.json").queryConfigEnabled(false));
+            feature.setSwaggerUiConfig(new SwaggerUiConfig()
+                    .url("/openapi.json")
+                    .queryConfigEnabled(false)
+                    .oAuth2Config(OAUTH2_CONFIG));
             sf.setFeatures(Arrays.asList(feature));
             sf.setAddress("http://localhost:" + PORT + "/");
             return sf.create();
@@ -109,7 +123,7 @@ public void testUiRootResource() {
 
     @Test
     public void testUiRootResourcePicksUrlFromConfigurationOnly() {
-        // Test that Swagger UI URL is picked from configuration only and 
+        // Test that Swagger UI URL is picked from configuration only and
         // never from the query string (when query config is disabled).
         WebClient uiClient = WebClient
             .create("http://localhost:" + getPort() + "/api-docs")
@@ -130,7 +144,7 @@ public void testUiRootResourceReplacesUrlAsConfigured() {
         WebClient uiClient = WebClient
                 .create("http://localhost:" + getPort() + "/api-docs")
                 .path("/swagger-initializer.js")
-                .query("another-openapi.json")
+                .query("url", "another-openapi.json")
                 .accept("*/*");
 
         try (Response response = uiClient.get()) {
@@ -139,7 +153,26 @@ public void testUiRootResourceReplacesUrlAsConfigured() {
             assertFalse(jsCode.contains("another-openapi.json"));
         }
     }
-
+    
+    @Test
+    public void testUiRootResourceAddsOAuth2ConfigAsConfigured() throws Exception {
+        // With query config disabled or unset, we replace the url value in the Swagger resource with the one
+        // configured in SwaggerUiConfig, and ignore the one in query parameter.
+        WebClient uiClient = WebClient
+                .create("http://localhost:" + getPort() + "/api-docs")
+                .path("/swagger-initializer.js")
+                .accept("*/*");
+        
+        try (Response response = uiClient.get()) {
+            String jsCode = response.readEntity(String.class);
+            final JsonMapper mapper = JsonMapper.builder()
+                    .defaultPropertyInclusion(JsonInclude.Value.construct(NON_EMPTY, NON_EMPTY))
+                    .build();
+            final String expectedConfigAsJson = mapper.writeValueAsString(OAUTH2_CONFIG);
+            assertThat(jsCode, containsString("ui.initOAuth(" + expectedConfigAsJson + ")"));
+        }
+    }
+    
     public static String getPort() {
         return PORT;
     }

Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ public class SwaggerUiConfig {`
`68`	`68`	`private Boolean queryConfigEnabled;`
`69`	`69`	`// Controls the OAuth config. If present, the SwaggerUIBundle initialization will contain a call to initOAuth`
`70`	`70`	`// with the parameters contained here`
`71`		`- private SwaggerUiOAuth2Config oAuthConfig;`
	`71`	`+ private SwaggerUiOAuth2Config oAuth2Config;`
`72`	`72`
`73`	`73`	`public String getConfigUrl() {`
`74`	`74`	`return configUrl;`
`@@ -340,16 +340,16 @@ public void setTryItOutEnabled(Boolean tryItOutEnabled) {`
`340`	`340`	`setQueryConfigEnabledIfNeeded();`
`341`	`341`	`}`
`342`	`342`
`343`		`- public SwaggerUiOAuth2Config getOAuthConfig() {`
`344`		`- return oAuthConfig;`
	`343`	`+ public SwaggerUiOAuth2Config getOAuth2Config() {`
	`344`	`+ return oAuth2Config;`
`345`	`345`	`}`
`346`	`346`
`347`		`- public void setOAuthConfig(SwaggerUiOAuth2Config oAuthConfig) {`
`348`		`- this.oAuthConfig = oAuthConfig;`
	`347`	`+ public void setOAuth2Config(SwaggerUiOAuth2Config oauth) {`
	`348`	`+ this.oAuth2Config = oauth;`
`349`	`349`	`}`
`350`	`350`
`351`		`- public SwaggerUiConfig oAuthConfig(SwaggerUiOAuth2Config oAuthConfig) {`
`352`		`- setOAuthConfig(oAuthConfig);`
	`351`	`+ public SwaggerUiConfig oAuth2Config(SwaggerUiOAuth2Config oauth) {`
	`352`	`+ setOAuth2Config(oauth);`
`353`	`353`	`return this;`
`354`	`354`	`}`
`355`	`355`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,22 @@`
	`1`	`+/**`
	`2`	`+ * Licensed to the Apache Software Foundation (ASF) under one`
	`3`	`+ * or more contributor license agreements. See the NOTICE file`
	`4`	`+ * distributed with this work for additional information`
	`5`	`+ * regarding copyright ownership. The ASF licenses this file`
	`6`	`+ * to you under the Apache License, Version 2.0 (the`
	`7`	`+ * "License"); you may not use this file except in compliance`
	`8`	`+ * with the License. You may obtain a copy of the License at`
	`9`	`+ *`
	`10`	`+ * http://www.apache.org/licenses/LICENSE-2.0`
	`11`	`+ *`
	`12`	`+ * Unless required by applicable law or agreed to in writing,`
	`13`	`+ * software distributed under the License is distributed on an`
	`14`	`+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY`
	`15`	`+ * KIND, either express or implied. See the License for the`
	`16`	`+ * specific language governing permissions and limitations`
	`17`	`+ * under the License.`
	`18`	`+ */`
	`19`	`+`
`1`	`20`	`package org.apache.cxf.jaxrs.swagger.ui;`
`2`	`21`
`3`	`22`	`import java.util.List;`
`@@ -28,8 +47,8 @@ public void setClientId(String clientId) {`
`28`	`47`	`this.clientId = clientId;`
`29`	`48`	`}`
`30`	`49`
`31`		`- public SwaggerUiOAuth2Config clientId(String clientId) {`
`32`		`- setClientId(clientId);`
	`50`	`+ public SwaggerUiOAuth2Config clientId(String cid) {`
	`51`	`+ setClientId(cid);`
`33`	`52`	`return this;`
`34`	`53`	`}`
`35`	`54`
`@@ -41,8 +60,8 @@ public void setClientSecret(String clientSecret) {`
`41`	`60`	`this.clientSecret = clientSecret;`
`42`	`61`	`}`
`43`	`62`
`44`		`- public SwaggerUiOAuth2Config clientSecret(String clientSecret) {`
`45`		`- setClientSecret(clientSecret);`
	`63`	`+ public SwaggerUiOAuth2Config clientSecret(String secret) {`
	`64`	`+ setClientSecret(secret);`
`46`	`65`	`return this;`
`47`	`66`	`}`
`48`	`67`
`@@ -54,8 +73,8 @@ public void setRealm(String realm) {`
`54`	`73`	`this.realm = realm;`
`55`	`74`	`}`
`56`	`75`
`57`		`- public SwaggerUiOAuth2Config realm(String realm) {`
`58`		`- setRealm(realm);`
	`76`	`+ public SwaggerUiOAuth2Config realm(String re) {`
	`77`	`+ setRealm(re);`
`59`	`78`	`return this;`
`60`	`79`	`}`
`61`	`80`
`@@ -67,8 +86,8 @@ public void setAppName(String appName) {`
`67`	`86`	`this.appName = appName;`
`68`	`87`	`}`
`69`	`88`
`70`		`- public SwaggerUiOAuth2Config appName(String appName) {`
`71`		`- setAppName(appName);`
	`89`	`+ public SwaggerUiOAuth2Config appName(String name) {`
	`90`	`+ setAppName(name);`
`72`	`91`	`return this;`
`73`	`92`	`}`
`74`	`93`
`@@ -80,8 +99,8 @@ public void setScopes(List<String> scopes) {`
`80`	`99`	`this.scopes = scopes;`
`81`	`100`	`}`
`82`	`101`
`83`		`- public SwaggerUiOAuth2Config scopes(List<String> scopes) {`
`84`		`- setScopes(scopes);`
	`102`	`+ public SwaggerUiOAuth2Config scopes(List<String> scopesList) {`
	`103`	`+ setScopes(scopesList);`
`85`	`104`	`return this;`
`86`	`105`	`}`
`87`	`106`
`@@ -93,8 +112,8 @@ public void setAdditionalQueryStringParams(Map<String, String> additionalQuerySt`
`93`	`112`	`this.additionalQueryStringParams = additionalQueryStringParams;`
`94`	`113`	`}`
`95`	`114`
`96`		`- public SwaggerUiOAuth2Config additionalQueryStringParams(Map<String, String> additionalQueryStringParams) {`
`97`		`- setAdditionalQueryStringParams(additionalQueryStringParams);`
	`115`	`+ public SwaggerUiOAuth2Config additionalQueryStringParams(Map<String, String> additionalParams) {`
	`116`	`+ setAdditionalQueryStringParams(additionalParams);`
`98`	`117`	`return this;`
`99`	`118`	`}`
`100`	`119`
`@@ -106,8 +125,8 @@ public void setUseBasicAuthenticationWithAccessCodeGrant(Boolean useBasicAuthent`
`106`	`125`	`this.useBasicAuthenticationWithAccessCodeGrant = useBasicAuthenticationWithAccessCodeGrant;`
`107`	`126`	`}`
`108`	`127`
`109`		`- public SwaggerUiOAuth2Config useBasicAuthenticationWithAccessCodeGrant(Boolean useBasicAuthenticationWithAccessCodeGrant) {`
`110`		`- setUseBasicAuthenticationWithAccessCodeGrant(useBasicAuthenticationWithAccessCodeGrant);`
	`128`	`+ public SwaggerUiOAuth2Config useBasicAuthenticationWithAccessCodeGrant(Boolean basicAuth) {`
	`129`	`+ setUseBasicAuthenticationWithAccessCodeGrant(basicAuth);`
`111`	`130`	`return this;`
`112`	`131`	`}`
`113`	`132`
`@@ -119,8 +138,8 @@ public void setUsePkceWithAuthorizationCodeGrant(Boolean usePkceWithAuthorizatio`
`119`	`138`	`this.usePkceWithAuthorizationCodeGrant = usePkceWithAuthorizationCodeGrant;`
`120`	`139`	`}`
`121`	`140`
`122`		`- public SwaggerUiOAuth2Config usePkceWithAuthorizationCodeGrant(Boolean usePkceWithAuthorizationCodeGrant) {`
`123`		`- setUsePkceWithAuthorizationCodeGrant(usePkceWithAuthorizationCodeGrant);`
	`141`	`+ public SwaggerUiOAuth2Config usePkceWithAuthorizationCodeGrant(Boolean pkce) {`
	`142`	`+ setUsePkceWithAuthorizationCodeGrant(pkce);`
`124`	`143`	`return this;`
`125`	`144`	`}`
`126`	`145`
`@@ -143,18 +162,18 @@ public String toJsonString() {`
`143`	`162`	`if (json.toString().endsWith(",")) {`
`144`	`163`	`json.delete(json.length() - 1, json.length());`
`145`	`164`	`}`
`146`		`- return json.append("}").toString();`
	`165`	`+ return json.append('}').toString();`
`147`	`166`	`}`
`148`	`167`
`149`	`168`	`private void addStringField(StringBuilder json, String name, String value) {`
`150`	`169`	`if (value != null) {`
`151`		`- json.append(quote(name)).append(':').append(quote(value)).append(",");`
	`170`	`+ json.append(quote(name)).append(':').append(quote(value)).append(',');`
`152`	`171`	`}`
`153`	`172`	`}`
`154`	`173`
`155`	`174`	`private void addBooleanField(StringBuilder json, String name, Boolean value) {`
`156`	`175`	`if (value != null) {`
`157`		`- json.append(quote(name)).append(':').append(quote(value.toString())).append(",");`
	`176`	`+ json.append(quote(name)).append(':').append(value).append(',');`
`158`	`177`	`}`
`159`	`178`	`}`
`160`	`179`
`@@ -163,7 +182,7 @@ private void addListField(StringBuilder json, String name, List<String> value) {`
`163`	`182`	`json.append(quote(name)).append(':').append(`
`164`	`183`	`value.stream().map(this::quote)`
`165`	`184`	`.collect(Collectors.joining(",", "[", "]"))`
`166`		`- ).append(",");`
	`185`	`+ ).append(',');`
`167`	`186`	`}`
`168`	`187`	`}`
`169`	`188`
`@@ -172,7 +191,7 @@ private void addMapField(StringBuilder json, String name, Map<String, String> va`
`172`	`191`	`json.append(quote(name)).append(':').append(`
`173`	`192`	`value.entrySet().stream().map(this::entryToString)`
`174`	`193`	`.collect(Collectors.joining(",", "{", "}"))`
`175`		`- ).append(",");`
	`194`	`+ ).append(',');`
`176`	`195`	`}`
`177`	`196`	`}`
`178`	`197`