Package com.jk.web.monitoring

Class JKMonitorService

java.lang.Object
com.jk.web.monitoring.JKMonitorService
Direct Known Subclasses:
JKLogServicePublisher, JKWebStackMonitor
public class JKMonitorService extends Object
This class is a service class for monitoring and logging exceptions in a web application.
Version:
1.0
Author:
Dr. Jalal H. Kiswani

  • Constructor Summary

    Constructors
    Constructor
    Description
    JKMonitorService()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.keycloak.representations.IDToken
    getIdToken(jakarta.servlet.http.HttpServletRequest request)
    This method retrieves the ID Token associated with the authenticated user from the provided HttpServletRequest object.
    static JKMonitorService
    getInstance()
    This method retrieves the single instance of JKMonitorService.
    String
    getUserName(jakarta.servlet.http.HttpServletRequest request)
    This method retrieves the user name of the authenticated user from the provided HttpServletRequest object.
    void
    publish(jakarta.servlet.http.HttpServletRequest request, Throwable exception)
    This method logs an error or exception.
    static void
    setInstance(JKMonitorService instance)
    This method sets the instance of JKMonitorService to the provided one.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • JKMonitorService

      public JKMonitorService()

  • Method Details

    • getUserName

      public String getUserName(jakarta.servlet.http.HttpServletRequest request)
      This method retrieves the user name of the authenticated user from the provided HttpServletRequest object.
      Parameters:
      request - Specifies the HttpServletRequest object representing the current HTTP request.
      Returns:
      the user name of the authenticated user from the provided HttpServletRequest object.

    • getIdToken

      public org.keycloak.representations.IDToken getIdToken(jakarta.servlet.http.HttpServletRequest request)
      This method retrieves the ID Token associated with the authenticated user from the provided HttpServletRequest object.
      Parameters:
      request - Specifies the HttpServletRequest object representing the current HTTP request.
      Returns:
      the ID Token of the authenticated user.

    • getInstance

      public static JKMonitorService getInstance()
      This method retrieves the single instance of JKMonitorService.
      Returns:
      the single instance of JKMonitorService.

    • setInstance

      public static void setInstance(JKMonitorService instance)
      This method sets the instance of JKMonitorService to the provided one.
      Parameters:
      instance - Specifies the new instance of JKMonitorService.

    • publish

      public void publish(jakarta.servlet.http.HttpServletRequest request, Throwable exception)
      This method logs an error or exception.
      Parameters:
      request - Specifies the HttpServletRequest object representing the current HTTP request.
      exception - Specifies the Throwable exception that needs to be logged.