Changeset 8121

Timestamp:

Mar 7, 2023, 3:34:02 PM (7 months ago)

Author:

Nicklas Nordborg

Message:

References #2295: Add API for services to send log messages that can be displayed by the web client

Added some more methods to the logging API to make it easier to use. It also possible to forward log messages to a SLF4J Logger implementation.

Location:

branches/3.19-stable/src/clients/web/net/sf/basedb/clients/web/extensions/service

Files:

• ServiceLog.java (modified) (3 diffs)
• ServiceLogger.java (modified) (2 diffs)

branches/3.19-stable/src/clients/web/net/sf/basedb/clients/web/extensions/service/ServiceLog.java

@@ -33 +33 @@
 
 import org.apache.commons.collections4.iterators.UnmodifiableIterator;
+import org.slf4j.Logger;
 
 /**
@@ -226 +227 @@
   public enum LogLevel
   {
-    INFO("info.png"),
-    WARNING("warning.png"),
-    ERROR("error.png"),
-    DEBUG("bug.png");
+    INFO("info.png") 
+    {
+      @Override
+      void logTo(Logger logger, String msg, Throwable t) 
+      {
+        logger.info(msg, t);
+      }
+    },
+    WARNING("warning.png") 
+    {
+      @Override
+      void logTo(Logger logger, String msg, Throwable t) 
+      {
+        logger.warn(msg, t);
+      }
+    },
+    ERROR("error.png") 
+    {
+      @Override
+      void logTo(Logger logger, String msg, Throwable t) 
+      {
+        logger.error(msg, t);
+      }
+    },
+    DEBUG("bug.png") 
+    {
+      @Override
+      void logTo(Logger logger, String msg, Throwable t) 
+      {
+        logger.debug(msg, t);
+      }
+    };
     
     private final String icon;
@@ -245 +274 @@
       return icon;
     }
+    
+    abstract void logTo(org.slf4j.Logger logger, String msg, Throwable t);
   }
   

branches/3.19-stable/src/clients/web/net/sf/basedb/clients/web/extensions/service/ServiceLogger.java

@@ -23 +23 @@
 {
   private final ServiceLog log;
+  private final org.slf4j.Logger otherLogger;
   
   ServiceLogger(ServiceLog log)
   {
-    this.log = log;
+    this(log, null);
   }
   
+  ServiceLogger(ServiceLog log, org.slf4j.Logger otherLogger)
+  {
+    this.log = log;
+    this.otherLogger = otherLogger;
+  }
+  
+  /**
+    Wrap a generic SLF4J logger with this logger. Messages
+    that are submitted to the logger created by this method are
+    also forwarded to the SLF4J logger.
+  */
+  public ServiceLogger wrap(org.slf4j.Logger otherLogger)
+  {
+    return new ServiceLogger(this.log, otherLogger);
+  }
+  
+  /**
+    Check if debug logging has been enabled or not.
+  */
   public boolean isDebugEnabled()
   {
@@ -34 +54 @@
   }
   
+  /**
+    Log a message at the specified level.
+  */
   public void log(LogLevel level, String msg)
   {
     log.add(new LogEntry(level, msg, null));
+    if (otherLogger != null) level.logTo(otherLogger, msg, null);
   }
   
-  public void log(LogLevel level, String msg, Throwable t)
+  /**
+    Log a message at the specified level with an optional stacktrace.
+  */
+  public void log(LogLevel level, String msg, Throwable stacktrace)
   {
-    log.add(new LogEntry(level, msg, t));
+    log.add(new LogEntry(level, msg, stacktrace));
+    if (otherLogger != null) level.logTo(otherLogger, msg, stacktrace);
+  }
+  
+  /**
+    Log an INFO message.
+  */
+  public void info(String msg)
+  {
+    log(LogLevel.INFO, msg);
+  }
+  /**
+    Log an INFO message with an optional stacktrace.
+  */
+  public void info(String msg, Throwable stacktrace)
+  {
+    log(LogLevel.INFO, msg, stacktrace);
+  }
+  
+  /**
+    Log a WARNING message.
+  */
+  public void warning(String msg)
+  {
+    log(LogLevel.WARNING, msg);
+  }
+  /**
+    Log a WARNING message with an optional stacktrace.
+  */
+  public void warning(String msg, Throwable t)
+  {
+    log(LogLevel.WARNING, msg, t);
+  }
+  
+  /**
+    Log an ERROR message.
+  */
+  public void error(String msg)
+  {
+    log(LogLevel.ERROR, msg);
+  }
+  /**
+    Log an ERROR message with an optional stacktrace.
+  */
+  public void error(String msg, Throwable t)
+  {
+    log(LogLevel.ERROR, msg, t);
+  }
+  
+  /**
+    Log a DEBUG message.
+  */
+  public void debug(String msg)
+  {
+    log(LogLevel.DEBUG, msg);
+  }
+  /**
+    Log a DEBUG message with an optional stacktrace.
+  */
+  public void debug(String msg, Throwable t)
+  {
+    log(LogLevel.DEBUG, msg, t);
+  }
+  
+  /**
+    Check if TRACE-level logging has been enabled in the 
+    related SLF4J logger. If no SLF4J logger is related 
+    (see {@link #wrap(org.slf4j.Logger)}) all TRACE messages
+    will be ignored.
+  */
+  public boolean isTraceEnabled()
+  {
+    return otherLogger != null && otherLogger.isTraceEnabled();
+  }
+  /**
+    Log a TRACE message with the related SLF4J logger. 
+    If no SLF4J logger is related 
+    (see {@link #wrap(org.slf4j.Logger)}) all TRACE messages
+    will be ignored.
+  */
+  public void trace(String msg)
+  {
+    if (otherLogger != null) otherLogger.trace(msg);
+  }
+  /**
+    Log a TRACE message with an optional stacktrace.
+    If no SLF4J logger is related 
+    (see {@link #wrap(org.slf4j.Logger)}) all TRACE messages
+    will be ignored.
+  */
+  public void trace(String msg, Throwable t)
+  {
+    if (otherLogger != null) otherLogger.trace(msg, t);
   }