Context Navigation

Changeset 8127

Timestamp:

Mar 9, 2023, 2:54:41 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

Reverted the ServiceControllerAction to the original API. Services that need a logger should call ExtensionsLog.createLogger().

Location:

branches/3.19-stable/src

Files:

-                      r8125
+                      r8127
 import net.sf.basedb.util.extensions.ActionFactory;
 import net.sf.basedb.util.extensions.InvokationContext;
-import net.sf.basedb.util.extensions.logging.ExtensionsLogger;
-import net.sf.basedb.util.extensions.logging.LogLevel;
 /**
 …
   @Override
   public void start(final ExtensionsLogger logger)
+  public void start()
+  {
     if (running) return;
 …
         public void run()
+        {
-          logger.log(LogLevel.INFO, "Timeout expired!");
           System.out.println(extensionId + ": " + new Date());
+        }

-                      r8125
+                      r8127
 import net.sf.basedb.util.extensions.Action;
-import net.sf.basedb.util.extensions.logging.ExtensionsLogger;
 /**
 …
     is called on a running service it should do nothing. If the service can't
     be started it may throw an exception.
-    @deprecated In 3.19.8, implement the {@link #start(ExtensionsLogger)}
-      method instead. This method will never be called from the BASE
-      core except for the default implementation of {@link #start(ExtensionsLogger)}.
   */
+  @Deprecated
+  public default void start()
+  {}
+  /**
+    Start the service if it is not already running. If this method
+    is called on a running service it should do nothing. If the service can't
+    be started it may throw an exception.
+    <p>
+    The default implementation of this method simply call the {@link #start()}
+    method.
+    @param logger A logger that the service can use to send log message
+      The system will automatically create "Service started/stopped"
+      messages.
+    @since 3.19.8
+  */
+  public default void start(ExtensionsLogger logger)
+  {
+    start();
+  }
+  public void start();
   /**

-                      r8125
+                      r8127
 import net.sf.basedb.util.extensions.logging.ExtensionsLog;
 import net.sf.basedb.util.extensions.logging.ExtensionsLogger;
-import net.sf.basedb.util.extensions.logging.LogLevel;
 /**
 …
+  {
     log.info("Starting service: " + service);
+    ExtensionsLogger logger = ExtensionsLog.getLogger(ext.getId(), true);
+    service.start(logger);
+    logger.log(LogLevel.INFO, "Service started");
+    service.start();
+    ExtensionsLogger logger = ExtensionsLog.createLogger(ext.getId());
+    if (service.isRunning())
+    {
+      logger.info("Service started");
+    }
+    else
+    {
+      logger.error("Service failed to start");
+    }
     log.info("Starting service done: " + service);
+  }

-                      r8125
+                      r8127
 import net.sf.basedb.util.extensions.logging.ExtensionsLog;
 import net.sf.basedb.util.extensions.logging.ExtensionsLogger;
-import net.sf.basedb.util.extensions.logging.LogLevel;
 import net.sf.basedb.util.extensions.AbstractRenderer;
 …
     service.stop();
     ExtensionsLogger logger = ExtensionsLog.getLogger(ext.getId(), false);
     if (logger != null) logger.log(LogLevel.INFO, "Service stopped");
+    if (logger != null) logger.info("Service stopped");
     log.info("Stopping service done: " + service);
+  }

-                      r8125
+                      r8127
     return log == null ? null : log.createLogger();
+  }
+  /**
+    Create a logger that can add entries to the log for the given extension.
+    If the log doesn't exists yet, it is be created.
+  */
+  public static ExtensionsLogger createLogger(String extensionId)
+  {
+    return getLog(extensionId, true).createLogger();
+  }
   private final String extensionId;
   private final Deque<LogEntry> logEntries;

Note: See TracChangeset for help on using the changeset viewer.