Added requirements accessor for write access in framework code.

Author: sebinside

src/main/scala/org/codeoverflow/chatoverflow/configuration/ConfigurationService.scala

@@ -4,7 +4,7 @@ import java.io.{File, PrintWriter}
 
 import org.codeoverflow.chatoverflow.WithLogger
 import org.codeoverflow.chatoverflow.api.io
-import org.codeoverflow.chatoverflow.api.plugin.configuration.{Requirement, Requirements}
+import org.codeoverflow.chatoverflow.api.plugin.configuration.Requirements
 import org.codeoverflow.chatoverflow.connector.ConnectorRegistry
 import org.codeoverflow.chatoverflow.framework.PluginFramework
 import org.codeoverflow.chatoverflow.instance.PluginInstanceRegistry
@@ -197,7 +197,7 @@ class ConfigurationService(val configFilePath: String) extends WithLogger {
     * Creates the xml for all requirements of a plugin.
     */
   private def createRequirementXML(requirements: Requirements): Array[Elem] = {
-    val requirementMap = requirements.getRequirementMap
+    val requirementMap = requirements.getAccess.getRequirementMap
     val keys = requirementMap.keySet().toArray
 
     for {
@@ -264,7 +264,7 @@ object ConfigurationService extends WithLogger {
       false
     } else {
       val requirements = instance.get.getRequirements
-      val requirement = requirements.getRequirementById(requirementId)
+      val requirement = requirements.getAccess.getRequirementById(requirementId)
 
       if (!requirement.isPresent) {
         logger error s"Unable to find requirement with the given id '$requirementId'."
@@ -289,7 +289,7 @@ object ConfigurationService extends WithLogger {
 
             try {
               val reqContent = loadedRequirementType.get.newInstance().asInstanceOf[io.Serializable]
-              requirement.get.asInstanceOf[Requirement[io.Serializable]].set(reqContent)
+              requirements.getAccess.setRequirementContent(requirementId, reqContent)
               reqContent.deserialize(content)
 
               logger info s"Created requirement content for '$requirementId' and deserialized its content."

src/main/scala/org/codeoverflow/chatoverflow/instance/PluginInstance.scala

@@ -92,9 +92,9 @@ class PluginInstance(val instanceName: String, pluginType: PluginType) extends W
       } else {
 
         // Next, check for complete requirements
-        if (!getRequirements.isComplete) {
+        if (!getRequirements.getAccess.isComplete) {
           logger error s"At least one non-optional requirement of plugin '$instanceName' has not been set. Unable to start!"
-          logger debug s"Not set requirements: ${getRequirements.getMissingRequirements.toArray.mkString(", ")}."
+          logger debug s"Not set requirements: ${getRequirements.getAccess.getMissingRequirements.toArray.mkString(", ")}."
           false
 
         } else {
@@ -103,7 +103,7 @@ class PluginInstance(val instanceName: String, pluginType: PluginType) extends W
           var allConnectorsReady = true
 
           // Initialize all inputs & outputs
-          val inputRequirements = getRequirements.getInputRequirements.toArray
+          val inputRequirements = getRequirements.getAccess.getInputRequirements.toArray
           for (requirement <- inputRequirements) {
             try {
               val input = requirement.asInstanceOf[Requirement[Input]]
@@ -118,7 +118,7 @@ class PluginInstance(val instanceName: String, pluginType: PluginType) extends W
                 logger warn s"Unable to initialize input '$requirement'. Exception: ${e.getMessage}"
             }
           }
-          val outputRequirements = getRequirements.getOutputRequirements.toArray
+          val outputRequirements = getRequirements.getAccess.getOutputRequirements.toArray
           for (requirement <- outputRequirements) {
             try {
               val output = requirement.asInstanceOf[Requirement[Output]]
@@ -177,12 +177,12 @@ class PluginInstance(val instanceName: String, pluginType: PluginType) extends W
                 } finally {
 
                   // If the plugin ended or crashed, try to shut down the connectors
-                  val inputRequirements = getRequirements.getInputRequirements.toArray
+                  val inputRequirements = getRequirements.getAccess.getInputRequirements.toArray
                   inputRequirements.filter(_.asInstanceOf[Requirement[_]].isSet).foreach(requirement => {
                     requirement.asInstanceOf[Requirement[Input]].get().shutdown()
                   })
 
-                  val outputRequirements = getRequirements.getOutputRequirements.toArray
+                  val outputRequirements = getRequirements.getAccess.getOutputRequirements.toArray
                   outputRequirements.filter(_.asInstanceOf[Requirement[_]].isSet).foreach(requirement => {
                     requirement.asInstanceOf[Requirement[Output]].get().shutdown()
                   })

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

@@ -43,7 +43,7 @@ class PluginInstanceController(implicit val swagger: Swagger) extends JsonServle
             } else if (pluginInstance.get.isRunning) {
               ResultMessage(success = false, "Plugin instance already running.")
 
-            } else if (!pluginInstance.get.getRequirements.isComplete) {
+            } else if (!pluginInstance.get.getRequirements.getAccess.isComplete) {
               ResultMessage(success = false, "Not all required requirements have been set.")
 
             } else if (!pluginInstance.get.start()) {
@@ -93,7 +93,7 @@ class PluginInstanceController(implicit val swagger: Swagger) extends JsonServle
         returnSeq
 
       } else {
-        val requirements = pluginInstance.get.getRequirements.getRequirementMap
+        val requirements = pluginInstance.get.getRequirements.getAccess.getRequirementMap
 
         requirements.forEach((uniqueRequirementID, requirement) =>
           returnSeq += createRequirement(uniqueRequirementID, requirement))
@@ -113,7 +113,7 @@ class PluginInstanceController(implicit val swagger: Swagger) extends JsonServle
       if (pluginInstance.isEmpty) {
         Requirement("", "", isOptional = false, isSet = false, "", "")
       } else {
-        val requirement = pluginInstance.get.getRequirements.getRequirementById(requirementID)
+        val requirement = pluginInstance.get.getRequirements.getAccess.getRequirementById(requirementID)
 
         if (!requirement.isPresent) {
           Requirement("", "", isOptional = false, isSet = false, "", "")
@@ -143,7 +143,7 @@ class PluginInstanceController(implicit val swagger: Swagger) extends JsonServle
             } else if (pluginInstance.get.isRunning) {
               ResultMessage(success = false, "Plugin is running.")
 
-            } else if (!pluginInstance.get.getRequirements.getRequirementById(requirementID).isPresent) {
+            } else if (!pluginInstance.get.getRequirements.getAccess.getRequirementById(requirementID).isPresent) {
               ResultMessage(success = false, "Requirement not found.")
             } else {
 
@@ -178,11 +178,11 @@ class PluginInstanceController(implicit val swagger: Swagger) extends JsonServle
         } else if (pluginInstance.get.isRunning) {
           ResultMessage(success = false, "Plugin is running.")
 
-        } else if (!pluginInstance.get.getRequirements.getRequirementById(requirementID).isPresent) {
+        } else if (!pluginInstance.get.getRequirements.getAccess.getRequirementById(requirementID).isPresent) {
           ResultMessage(success = false, "Requirement not found.")
         } else {
 
-          if (!pluginInstance.get.getRequirements.unsetRequirementById(requirementID)) {
+          if (!pluginInstance.get.getRequirements.getAccess.unsetRequirementById(requirementID)) {
 
             ResultMessage(success = false, "Unable to remove the requirement. Already removed.")
           } else {
@@ -273,7 +273,7 @@ class PluginInstanceController(implicit val swagger: Swagger) extends JsonServle
   = {
     PluginInstance(pluginInstance.instanceName, pluginInstance.getPluginTypeName,
       pluginInstance.getPluginTypeAuthor, pluginInstance.isRunning,
-      pluginInstance.getRequirements.getRequirementMap.keySet().asScala.toList,
+      pluginInstance.getRequirements.getAccess.getRequirementMap.keySet().asScala.toList,
       pluginInstance.getPluginManager.getLogMessages
         .asScala.map(logMessage => PluginLogMessageDTO(logMessage.getMessage, logMessage.getTimestamp.toString)))
   }