Added PluginLogMessages to the api, encapsulating a message and logging timestamp. Updated framework and rest interface.

Author: sebinside

src/main/scala/org/codeoverflow/chatoverflow/framework/manager/PluginManagerImpl.scala

@@ -3,7 +3,7 @@ package org.codeoverflow.chatoverflow.framework.manager
 import java.util
 
 import org.codeoverflow.chatoverflow.WithLogger
-import org.codeoverflow.chatoverflow.api.plugin.PluginManager
+import org.codeoverflow.chatoverflow.api.plugin.{PluginLogMessage, PluginManager}
 
 import scala.collection.JavaConverters._
 import scala.collection.mutable.ListBuffer
@@ -15,15 +15,15 @@ import scala.collection.mutable.ListBuffer
   */
 class PluginManagerImpl(pluginInstanceName: String, logOutputOnConsole: Boolean) extends PluginManager with WithLogger {
 
-  private val logMessages = new ListBuffer[String]
+  private val logMessages = new ListBuffer[PluginLogMessage]
 
   /**
     * Prints a log message on the console and saves the message for later inspection.
     *
     * @param message the message to show
     */
   override def log(message: String): Unit = {
-    logMessages += message
+    logMessages += new PluginLogMessage(message)
 
     if (logOutputOnConsole) {
       logger info s"[$pluginInstanceName] $message"
@@ -35,5 +35,5 @@ class PluginManagerImpl(pluginInstanceName: String, logOutputOnConsole: Boolean)
     *
     * @return a list of log messages
     */
-  override def getLogMessages: util.List[String] = logMessages.toList.asJava
+  override def getLogMessages: util.List[PluginLogMessage] = logMessages.toList.asJava
 }

src/main/scala/org/codeoverflow/chatoverflow/framework/manager/PluginManagerStub.scala

@@ -2,7 +2,7 @@ package org.codeoverflow.chatoverflow.framework.manager
 
 import java.util
 
-import org.codeoverflow.chatoverflow.api.plugin.PluginManager
+import org.codeoverflow.chatoverflow.api.plugin.{PluginLogMessage, PluginManager}
 
 /**
   * This plugin manager stub does not provide any useful functionality and should only be used for
@@ -23,7 +23,7 @@ class PluginManagerStub extends PluginManager {
     *
     * @return a list of log messages
     */
-  override def getLogMessages: util.List[String] = {
-    new util.ArrayList[String]()
+  override def getLogMessages: util.List[PluginLogMessage] = {
+    new util.ArrayList[PluginLogMessage]()
   }
 }

src/main/scala/org/codeoverflow/chatoverflow/ui/web/rest/DTOs.scala

@@ -43,4 +43,6 @@ object DTOs {
 
   case class Password(password: String)
 
+  case class PluginLogMessageDTO(message: String, timestamp: String)
+
 }

src/main/scala/org/codeoverflow/chatoverflow/ui/web/rest/plugin/PluginInstanceController.scala

@@ -201,6 +201,7 @@ class PluginInstanceController(implicit val swagger: Swagger) extends JsonServle
       val startIndex = if (params.isDefinedAt("startIndex")) Some(params("startIndex")) else None
       val pluginInstance = chatOverflow.pluginInstanceRegistry.getPluginInstance(instanceName)
       val logMessages = pluginInstance.get.getPluginManager.getLogMessages
+        .asScala.map(logMessage => PluginLogMessageDTO(logMessage.getMessage, logMessage.getTimestamp.toString))
 
       val index = startIndex.getOrElse("0")
       val msg = logMessages.toArray.drop(Integer.parseInt(index))

src/main/scala/org/codeoverflow/chatoverflow/ui/web/rest/plugin/PluginInstanceControllerDefinition.scala

@@ -53,7 +53,7 @@ trait PluginInstanceControllerDefinition extends SwaggerSupport with TagSupport
       parameter pathParam[String]("instanceName").description("The name of the plugin instance.")
       parameter pathParam[String]("requirementID").description("The unique id of the requirement."))
   val getLog: OperationBuilder =
-    (apiOperation[List[String]]("getLog")
+    (apiOperation[List[PluginLogMessageDTO]]("getLog")
       summary "Shows the log of a plugin instance."
       description "Shows all (or the newest) log messages of a specified plugin instance."
       tags controllerTag