feat(config-api): use orm method to provide persistence metadata (#11509)

pujavs · web-flow · commit dbdc1bd92649 · 2025-05-28T20:05:33.000+03:00
* feat(config-api): use orm method to provide persistence metadata #11459 Signed-off-by: pujavs <pujas.works@gmail.com> * feat(config-api): use orm method to provide persistence metadata #11459 Signed-off-by: pujavs <pujas.works@gmail.com> * feat(config-api): use orm method to provide persistence metadata #11459 Signed-off-by: pujavs <pujas.works@gmail.com> * feat(config-api): use orm method to provide persistence metadata #11459 Signed-off-by: pujavs <pujas.works@gmail.com> * feat(config-api): use orm method to provide persistence metadata #11459 Signed-off-by: pujavs <pujas.works@gmail.com> --------- Signed-off-by: pujavs <pujas.works@gmail.com>
diff --git a/jans-config-api/docs/jans-config-api-swagger.yaml b/jans-config-api/docs/jans-config-api-swagger.yaml
@@ -9336,19 +9336,19 @@ components:
           type: string
         selected:
           type: boolean
-        adminCanView:
-          type: boolean
-        adminCanAccess:
+        whitePagesCanView:
           type: boolean
         adminCanEdit:
           type: boolean
-        userCanAccess:
-          type: boolean
         userCanView:
           type: boolean
         userCanEdit:
           type: boolean
-        whitePagesCanView:
+        adminCanView:
+          type: boolean
+        adminCanAccess:
+          type: boolean
+        userCanAccess:
           type: boolean
         baseDn:
           type: string
@@ -10232,8 +10232,6 @@ components:
           type: boolean
         lockMessageConfig:
           $ref: '#/components/schemas/LockMessageConfig'
-        fapi:
-          type: boolean
         allResponseTypesSupported:
           uniqueItems: true
           type: array
@@ -10243,6 +10241,8 @@ components:
             - code
             - token
             - id_token
+        fapi:
+          type: boolean
     AuthenticationFilter:
       required:
       - baseDn
@@ -10460,8 +10460,24 @@ components:
     PersistenceConfiguration:
       type: object
       properties:
-        persistenceType:
+        databaseName:
+          type: string
+          description: Connection object's current catalog name.
+        schemaName:
+          type: string
+          description: Schema name.
+        productName:
+          type: string
+          description: Name of database product.
+        productVersion:
+          type: string
+          description: Version number of this database product.
+        driverName:
+          type: string
+          description: Name of this JDBC driver.
+        driverVersion:
           type: string
+          description: JDBC driver version number.
     JsonPatch:
       type: object
     CacheConfiguration:
diff --git a/jans-config-api/server/src/main/java/io/jans/configapi/rest/resource/auth/AuthConfigResource.java b/jans-config-api/server/src/main/java/io/jans/configapi/rest/resource/auth/AuthConfigResource.java
@@ -17,7 +17,7 @@
 import io.jans.configapi.util.ApiAccessConstants;
 import io.jans.configapi.util.ApiConstants;
 import io.jans.configapi.core.util.Jackson;
-import io.jans.orm.model.PersistenceMetadata;
+import io.jans.configapi.core.model.PersistenceConfiguration;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.parameters.RequestBody;
@@ -106,7 +106,7 @@ public Response patchAppConfigurationProperty(@NotNull String jsonPatchString)
             "Configuration – Properties" }, security = @SecurityRequirement(name = "oauth2", scopes = {
                     ApiAccessConstants.JANS_AUTH_CONFIG_READ_ACCESS }))
     @ApiResponses(value = {
-            @ApiResponse(responseCode = "200", description = "Jans Authorization Server persistence type", content = @Content(mediaType = MediaType.APPLICATION_JSON, schema = @Schema(implementation = PersistenceMetadata.class), examples = @ExampleObject(name = "Response json example", value = "example/auth/config/auth-config-persistence.json"))),
+            @ApiResponse(responseCode = "200", description = "Jans Authorization Server persistence type", content = @Content(mediaType = MediaType.APPLICATION_JSON, schema = @Schema(implementation = PersistenceConfiguration.class), examples = @ExampleObject(name = "Response json example", value = "example/auth/config/auth-config-persistence.json"))),
             @ApiResponse(responseCode = "401", description = "Unauthorized"),
             @ApiResponse(responseCode = "500", description = "InternalServerError") })
     @GET
@@ -115,9 +115,9 @@ public Response patchAppConfigurationProperty(@NotNull String jsonPatchString)
                     ApiAccessConstants.SUPER_ADMIN_READ_ACCESS })
     @Path(ApiConstants.PERSISTENCE)
     public Response getPersistenceDetails() {
-        PersistenceMetadata persistenceMetadata = configurationService.getPersistenceMetadata();
-        log.debug("AuthConfigResource::getPersistenceDetails() - persistenceMetadata:{}", persistenceMetadata);
-        return Response.ok(persistenceMetadata).build();
+        PersistenceConfiguration persistenceConfiguration = configurationService.getPersistenceMetadata();
+        log.debug("AuthConfigResource::getPersistenceDetails() - persistenceConfiguration:{}", persistenceConfiguration);
+        return Response.ok(persistenceConfiguration).build();
     }
     
     
diff --git a/jans-config-api/server/src/main/java/io/jans/configapi/service/auth/ConfigurationService.java b/jans-config-api/server/src/main/java/io/jans/configapi/service/auth/ConfigurationService.java
@@ -11,6 +11,7 @@
 import io.jans.as.model.configuration.AppConfiguration;
 import io.jans.config.GluuConfiguration;
 import io.jans.configapi.configuration.ConfigurationFactory;
+import io.jans.configapi.core.model.PersistenceConfiguration;
 import io.jans.configapi.model.status.StatsData;
 import io.jans.orm.PersistenceEntryManager;
 import io.jans.service.document.store.conf.DocumentStoreConfiguration;
@@ -126,7 +127,22 @@ public String getRevokeUrl() {
         return configurationFactory.getApiAppConfiguration().getAuthOpenidRevokeUrl();
     }
     
-    public PersistenceMetadata getPersistenceMetadata() {
-        return persistenceManager.getPersistenceMetadata("o=jans");
+    public PersistenceConfiguration getPersistenceMetadata() {
+         PersistenceMetadata persistenceMetadata  = persistenceManager.getPersistenceMetadata("o=jans");
+         return getPersistenceConfiguration(persistenceMetadata);
+    }
+    
+    private PersistenceConfiguration getPersistenceConfiguration(PersistenceMetadata persistenceMetadata) {
+        PersistenceConfiguration persistenceConfiguration = new PersistenceConfiguration();
+        if(persistenceMetadata == null) {
+            persistenceConfiguration.setDatabaseName(persistenceMetadata.getDatabaseName());
+            persistenceConfiguration.setSchemaName(persistenceMetadata.getSchemaName());
+            persistenceConfiguration.setProductName(persistenceMetadata.getProductName());
+            persistenceConfiguration.setProductVersion(persistenceMetadata.getProductVersion());
+            persistenceConfiguration.setDriverName(persistenceMetadata.getDriverName());
+            persistenceConfiguration.setDriverVersion(persistenceMetadata.getDriverVersion());
+        }
+        
+        return persistenceConfiguration;
     }
 }
diff --git a/jans-config-api/shared/src/main/java/io/jans/configapi/core/model/PersistenceConfiguration.java b/jans-config-api/shared/src/main/java/io/jans/configapi/core/model/PersistenceConfiguration.java
@@ -2,22 +2,84 @@
 
 import java.io.Serializable;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+
 public class PersistenceConfiguration implements Serializable {
     
     private static final long serialVersionUID = -1214215449005176251L;
     
-    private String persistenceType;
+    @Schema(description = "Connection object's current catalog name.")
+    private String databaseName; 
+    
+    @Schema(description = "Schema name.")
+    private String schemaName; 
+    
+    @Schema(description = "Name of database product.")
+    private String productName; 
+    
+    @Schema(description = "Version number of this database product.")
+    private String productVersion;
+    
+    @Schema(description = "Name of this JDBC driver.")
+    private String driverName; 
+    
+    @Schema(description = "JDBC driver version number.")
+    private String driverVersion;
+
+    public String getDatabaseName() {
+        return databaseName;
+    }
+
+    public void setDatabaseName(String databaseName) {
+        this.databaseName = databaseName;
+    }
+
+    public String getSchemaName() {
+        return schemaName;
+    }
+
+    public void setSchemaName(String schemaName) {
+        this.schemaName = schemaName;
+    }
 
-    public String getPersistenceType() {
-        return persistenceType;
+    public String getProductName() {
+        return productName;
     }
 
-    public void setPersistenceType(String persistenceType) {
-        this.persistenceType = persistenceType;
+    public void setProductName(String productName) {
+        this.productName = productName;
+    }
+
+    public String getProductVersion() {
+        return productVersion;
+    }
+
+    public void setProductVersion(String productVersion) {
+        this.productVersion = productVersion;
+    }
+
+    public String getDriverName() {
+        return driverName;
+    }
+
+    public void setDriverName(String driverName) {
+        this.driverName = driverName;
+    }
+
+    public String getDriverVersion() {
+        return driverVersion;
+    }
+
+    public void setDriverVersion(String driverVersion) {
+        this.driverVersion = driverVersion;
     }
 
     @Override
     public String toString() {
-        return "PersistenceConfiguration [persistenceType=" + persistenceType + "]";
+        return "PersistenceConfiguration [databaseName=" + databaseName + ", schemaName=" + schemaName
+                + ", productName=" + productName + ", productVersion=" + productVersion + ", driverName=" + driverName
+                + ", driverVersion=" + driverVersion + "]";
     }
+
+ 
 }
