feat(jans-config-api): dashboard with monthly active users

docs/janssen-server/developer/customization/customize-web-pages.md

@@ -81,7 +81,7 @@ Listing of custom asset types that each Janssen Server module accepts:
 
 | Path | Asset Type |
 |----------------|-------------|
-| /opt/jans/jetty/jans-lock/custom-libs	| *.jar
+| /opt/jans/jetty/jans-lock/custom/libs	| *.jar
 
 
 ### KeyCloak-link
@@ -96,7 +96,7 @@ Listing of custom asset types that each Janssen Server module accepts:
 
 | Path | Asset Type |
 |----------------|-------------|
-| /opt/jans/jetty/jans-link/custom-libs	| *.jar
+| /opt/jans/jetty/jans-link/custom/libs	| *.jar
 | /var/jans/link-snapshots/	| *.txt
 
 

jans-config-api/docs/jans-config-api-swagger.yaml

@@ -9337,20 +9337,20 @@ components:
           type: string
         selected:
           type: boolean
-        userCanAccess:
-          type: boolean
-        adminCanAccess:
-          type: boolean
         whitePagesCanView:
           type: boolean
-        adminCanView:
+        adminCanEdit:
           type: boolean
         userCanEdit:
           type: boolean
-        adminCanEdit:
+        adminCanView:
           type: boolean
         userCanView:
           type: boolean
+        adminCanAccess:
+          type: boolean
+        userCanAccess:
+          type: boolean
         baseDn:
           type: string
     PatchRequest:
@@ -10211,8 +10211,6 @@ components:
           type: boolean
         lockMessageConfig:
           $ref: '#/components/schemas/LockMessageConfig'
-        fapi:
-          type: boolean
         allResponseTypesSupported:
           uniqueItems: true
           type: array
@@ -10222,6 +10220,8 @@ components:
             - code
             - token
             - id_token
+        fapi:
+          type: boolean
     AuthenticationFilter:
       required:
       - baseDn
@@ -10351,8 +10351,10 @@ components:
           type: string
         finishedFlowPage:
           type: string
-        bridgeScriptPage:
-          type: string
+        startEndUrlMapping:
+          type: object
+          additionalProperties:
+            type: string
         serializeRules:
           type: object
           additionalProperties:

jans-config-api/plugins/docs/lock-plugin-swagger.yaml

@@ -469,7 +469,7 @@ paths:
       security:
       - oauth2:
         - https://jans.io/oauth/lock-config.write
-  /lock/stat:
+  /lock/lockStat:
     get:
       tags:
       - Statistics
@@ -488,12 +488,12 @@ paths:
           is mandatory if start_month and end_month parameters are not present.
         schema:
           type: string
-      - name: start_month
+      - name: start-month
         in: query
         description: Start-Month for which the stat report is to be fetched
         schema:
           type: string
-      - name: end_month
+      - name: end-month
         in: query
         description: End-Month for which the stat report is to be fetched
         schema:
@@ -671,9 +671,6 @@ components:
         tokenUrl:
           type: string
           description: Jans URL of the OpenID Connect Provider's OAuth 2.0 Token Endpoint
-        groupScopeEnabled:
-          type: boolean
-          description: Group scope enabled
         endpointGroups:
           type: object
           additionalProperties:
@@ -707,9 +704,6 @@ components:
         externalLoggerConfiguration:
           type: string
           description: The path to the external log4j2 logging configuration
-        metricChannel:
-          type: string
-          description: Channel for metric reports
         metricReporterInterval:
           type: integer
           description: The interval for metric reporter in seconds
@@ -725,11 +719,6 @@ components:
           type: integer
           description: Time interval for the Clean Service in seconds
           format: int32
-        opaConfiguration:
-          $ref: '#/components/schemas/OpaConfiguration'
-        pdpType:
-          type: string
-          description: PDP type
         policiesJsonUrisAuthorizationToken:
           type: string
           description: Authorization token to access Json Uris
@@ -748,18 +737,14 @@ components:
           items:
             type: string
             description: List of Zip Uris with policies
-        errorReasonEnabled:
-          type: boolean
-    OpaConfiguration:
-      type: object
-      properties:
-        baseUrl:
+        messageConsumerType:
           type: string
-          description: Base OPA URL
-        accessToken:
+          description: PubSub consumer service
+        policyConsumerType:
           type: string
-          description: OPA access token
-      description: Opa Configuration
+          description: Policy consumer service
+        errorReasonEnabled:
+          type: boolean
     JsonPatch:
       type: object
     JsonNode:

jans-config-api/plugins/kc-saml-plugin/src/main/java/io/jans/configapi/plugin/saml/service/SamlIdpService.java

@@ -6,7 +6,6 @@
 
 package io.jans.configapi.plugin.saml.service;
 
-import io.jans.service.document.store.service.DocumentStoreService;
 import io.jans.service.document.store.conf.DocumentStoreType;
 import io.jans.service.document.store.service.LocalDocumentStoreService;
 import io.jans.util.exception.InvalidConfigurationException;
@@ -38,8 +37,6 @@ public class SamlIdpService {
 
     @Inject
     Logger logger;
-    @Inject
-    private DocumentStoreService documentStoreService;
 
     @Inject
     private LocalDocumentStoreService localDocumentStoreService;
@@ -58,7 +55,7 @@ public void create() {
     }
 
     public boolean isLocalDocumentStoreType() {
-        return documentStoreService.getProviderType() == DocumentStoreType.LOCAL;
+        return localDocumentStoreService.getProviderType() == DocumentStoreType.LOCAL;
     }
 
     public String saveMetadataFile(String metadataDir, String metadataFileName, String documentStoreModuleName,
@@ -83,14 +80,13 @@ public String saveMetadataFile(String metadataDir, String metadataFileName, Stri
         }
 
         String metadataFile = metadataDir + File.separator + metadataFileName;
-        logger.info("documentStoreService:{}, metadataFile:{}, localDocumentStoreService:{} ", documentStoreService,
-                metadataFile, localDocumentStoreService);
+        logger.info("metadataFile:{}, localDocumentStoreService:{} ", metadataFile, localDocumentStoreService);
         try {
-            String result = documentStoreService.saveDocumentStream(metadataFile, null,
-                    stream, documentStoreModuleName);
+            String result = localDocumentStoreService.saveDocumentStream(metadataFile, null, stream,
+                    documentStoreModuleName);
             logger.info("SAML file saving result:{}", result);
 
-            InputStream newFile = documentStoreService.readDocumentAsStream(metadataFile);
+            InputStream newFile = localDocumentStoreService.readDocumentAsStream(metadataFile);
             logger.info("SAML file read newFile:{}", newFile);
 
             if (result != null) {
@@ -114,16 +110,16 @@ public GluuErrorHandler validateMetadata(String metadataPath)
             return new GluuErrorHandler(false, true, validationLog);
         }
 
-        try (InputStream stream = documentStoreService.readDocumentAsStream(metadataPath)) {
+        try (InputStream stream = localDocumentStoreService.readDocumentAsStream(metadataPath)) {
             return XMLValidator.validateMetadata(stream, samlSchema);
         }
     }
 
     public boolean renameMetadata(String metadataPath, String destinationMetadataPath) {
         logger.debug("Rename metadata file documentStoreService:{},metadataPath:{}, destinationMetadataPath:{}",
-                documentStoreService, metadataPath, destinationMetadataPath);
+                localDocumentStoreService, metadataPath, destinationMetadataPath);
         try {
-            return documentStoreService.renameDocument(metadataPath, destinationMetadataPath) != null;
+            return localDocumentStoreService.renameDocument(metadataPath, destinationMetadataPath) != null;
         } catch (Exception ex) {
             logger.error("Failed to rename metadata '{}' to '{}'", metadataPath, destinationMetadataPath, ex);
         }
@@ -133,24 +129,24 @@ public boolean renameMetadata(String metadataPath, String destinationMetadataPat
 
     public InputStream getFileFromDocumentStore(String path) {
 
-        logger.debug("Get file from DocumentStore. Path: {}",path);
+        logger.debug("Get file from DocumentStore. Path: {}", path);
         try {
-            return documentStoreService.readDocumentAsStream(path);
-        }catch(Exception e) {
-            logger.error("Failed to get file '{}' from DocumentStore",path);
+            return localDocumentStoreService.readDocumentAsStream(path);
+        } catch (Exception e) {
+            logger.error("Failed to get file '{}' from DocumentStore", path);
             return null;
         }
     }
 
-    private String getTempMetadataFilename(String metadataFolder, String fileName) {
-        logger.info("documentStoreService:{}, localDocumentStoreService:{}, metadataFolder:{}, fileName:{}",
-                documentStoreService, localDocumentStoreService, metadataFolder, fileName);
+    public String getTempMetadataFilename(String metadataFolder, String fileName) {
+        logger.info("localDocumentStoreService:{}, metadataFolder:{}, fileName:{}", localDocumentStoreService,
+                metadataFolder, fileName);
         synchronized (SamlIdpService.class) {
             String possibleTemp;
             do {
                 possibleTemp = fileName + INumGenerator.generate(2);
                 logger.debug("possibleTemp:{}", possibleTemp);
-            } while (documentStoreService.hasDocument(metadataFolder + possibleTemp));
+            } while (localDocumentStoreService.hasDocument(metadataFolder + possibleTemp));
             return possibleTemp;
         }
     }

jans-config-api/plugins/lock-plugin/src/main/java/io/jans/configapi/plugin/lock/rest/ApiApplication.java

@@ -48,6 +48,7 @@ public Set<Class<?>> getClasses() {
 
         classes.add(LockConfigResource.class);
         classes.add(AuditResource.class);
+        classes.add(LockStatResource.class);
 
         return classes;
     }

jans-config-api/plugins/lock-plugin/src/main/java/io/jans/configapi/plugin/lock/rest/LockStatResource.java

@@ -6,11 +6,10 @@
 
 package io.jans.configapi.plugin.lock.rest;
 
-
-
 import com.fasterxml.jackson.databind.JsonNode;
 
 import static io.jans.as.model.util.Util.escapeLog;
+import io.jans.configapi.core.model.exception.ApiApplicationException;
 import io.jans.configapi.core.rest.BaseResource;
 import io.jans.configapi.core.rest.ProtectedApi;
 import io.jans.configapi.plugin.lock.service.LockService;
@@ -66,8 +65,8 @@ public class LockStatResource extends BaseResource {
     public Response getStatistics(
             @Parameter(description = "Authorization code") @HeaderParam("Authorization") String authorization,
             @Parameter(description = "Month for which the stat report is to be fetched. The parameter is mandatory if start_month and end_month parameters are not present.") @QueryParam(value = "month") String month,
-            @Parameter(description = "Start-Month for which the stat report is to be fetched") @QueryParam(value = "start_month") String startMonth,
-            @Parameter(description = "End-Month for which the stat report is to be fetched") @QueryParam(value = "end_month") String endMonth,
+            @Parameter(description = "Start-Month for which the stat report is to be fetched") @QueryParam(value = "start-month") String startMonth,
+            @Parameter(description = "End-Month for which the stat report is to be fetched") @QueryParam(value = "end-month") String endMonth,
             @Parameter(description = "Report format") @QueryParam(value = "format") String format) {
         if (StringUtils.isBlank(format)) {
             format = "";
@@ -77,13 +76,17 @@ public Response getStatistics(
             if (logger.isInfoEnabled()) {
                 logger.info(
                         "LockStatResource::getStatistics() - authorization:{}, month:{},  startMonth:{}, endMonth:{}, format:{}",
-                        escapeLog(authorization), escapeLog(month), escapeLog(startMonth), escapeLog(endMonth), escapeLog(format));
+                        escapeLog(authorization), escapeLog(month), escapeLog(startMonth), escapeLog(endMonth),
+                        escapeLog(format));
             }
             String url = getIssuer() + STAT_URL;
             jsonNode = this.lockService.getStat(url, authorization, month, startMonth, endMonth, format);
             logger.info("StatResource::getUserStatistics() - jsonNode:{} ", jsonNode);
+        } catch (ApiApplicationException aex) {
+            logger.error(" ApiApplicationException while fetching lock stat is", aex);
+            throwInternalServerException("Stat Error", aex);
         } catch (Exception ex) {
-            logger.error(" Error while fetching lock stat is", ex);
+            logger.error(" Exception while fetching lock stat is", ex);
             throwBadRequestException(ex);
         }
         return Response.ok(jsonNode).build();