Changeset 8116

Timestamp:

Feb 21, 2023, 2:53:35 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 ServiceLogger class and modified the ServiceControllerAction so that we can supply a logger from the BASE core. The logger currently only write to stdout and it deosn't know which extension it belongs to. This need to be fixed.

Location:

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

Files:

• DummyService.java (modified) (3 diffs)
• ServiceControllerAction.java (modified) (1 diff)
• ServiceLogger.java (added)
• StartServiceRenderer.java (modified) (2 diffs)
• StopServiceRenderer.java (modified) (2 diffs)

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

@@ -25 +25 @@
 import java.util.TimerTask;
 
+import net.sf.basedb.clients.web.extensions.service.ServiceLogger.LogLevel;
 import net.sf.basedb.core.Application;
 import net.sf.basedb.util.Values;
@@ -85 +86 @@
   }
 
+  @SuppressWarnings("deprecation")
   @Override
   public void start()
+  {}
+  
+  @Override
+  public void start(final ServiceLogger logger)
   {
     if (running) return;
@@ -97 +103 @@
         public void run()
         {
+          logger.log(LogLevel.INFO, "Timeout expired!");
           System.out.println(extensionId + ": " + new Date());
         }

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

@@ -50 +50 @@
     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(ServiceLogger)}
+      method instead. This method will never be called from the BASE 
+      core except for the default implementation of {@link #start(ServiceLogger)}.
   */
+  @Deprecated
   public 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(ServiceLogger logger)
+  {
+    start();
+  }
   
   /**

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

@@ -22 +22 @@
 package net.sf.basedb.clients.web.extensions.service;
 
+import net.sf.basedb.clients.web.extensions.service.ServiceLogger.LogLevel;
 import net.sf.basedb.util.extensions.Renderer;
 
@@ -48 +49 @@
   {
     log.info("Starting service: " + service);
-    service.start();
+    ServiceLogger logger = new ServiceLogger(); // TODO -- we need information about the extension!
+    service.start(logger);
+    logger.log(LogLevel.INFO, "Service started");
     log.info("Starting service done: " + service);
   }

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

@@ -22 +22 @@
 package net.sf.basedb.clients.web.extensions.service;
 
+import net.sf.basedb.clients.web.extensions.service.ServiceLogger.LogLevel;
 import net.sf.basedb.util.extensions.Renderer;
 
@@ -50 +51 @@
     log.info("Stopping service: " + service);
     service.stop();
+    ServiceLogger logger = new ServiceLogger(); // TODO -- we need information about the extension!
+    logger.log(LogLevel.INFO, "Service stopped");
     log.info("Stopping service done: " + service);
   }