Added framework support and rest API for creating and deleting connectors.

Author: sebinside

src/main/scala/org/codeoverflow/chatoverflow/connector/ConnectorRegistry.scala

@@ -22,6 +22,32 @@ object ConnectorRegistry extends WithLogger {
     */
   def setTypeRegistry(typeRegistry: TypeRegistry): Unit = this.typeRegistry = Some(typeRegistry)
 
+  /**
+    * Tries to remove the specified connector if it is not running.
+    *
+    * @param sourceIdentifier       the identifier for the source platform
+    * @param qualifiedConnectorName a fully qualified connector type string
+    * @return false, if a major error happened
+    */
+  def removeConnector(sourceIdentifier: String, qualifiedConnectorName: String): Boolean = {
+    logger info s"Trying to remove connector '$sourceIdentifier' of type '$qualifiedConnectorName'."
+    val connectorKey = ConnectorKey(sourceIdentifier, qualifiedConnectorName)
+
+    if (!connectors.contains(connectorKey)) {
+      logger warn "Unable to remove connector. Connector does not exist."
+      false
+    } else {
+      if (connectors(connectorKey).isRunning) {
+        logger warn "Unable to remove connector. Connector is running."
+        false
+      } else {
+        // TODO: Check if this might crash anything
+        connectors -= connectorKey
+        true
+      }
+    }
+  }
+
   /**
     * Adds a new connector to the registry. Before instantiating the state is checked to be correct.
     *

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

@@ -28,4 +28,6 @@ object DTOs {
 
   case class ResultMessage(success: Boolean, message: String = "")
 
+  case class ConnectorRef(sourceIdentifier: String, uniqueTypeString: String)
+
 }

src/main/scala/org/codeoverflow/chatoverflow/ui/web/rest/connector/ConnectorController.scala

@@ -2,7 +2,7 @@ package org.codeoverflow.chatoverflow.ui.web.rest.connector
 
 import org.codeoverflow.chatoverflow.connector.ConnectorRegistry
 import org.codeoverflow.chatoverflow.ui.web.JsonServlet
-import org.codeoverflow.chatoverflow.ui.web.rest.DTOs.ConnectorDetails
+import org.codeoverflow.chatoverflow.ui.web.rest.DTOs.{ConnectorDetails, ConnectorRef, ResultMessage}
 import org.scalatra.swagger.Swagger
 
 class ConnectorController(implicit val swagger: Swagger) extends JsonServlet with ConnectorControllerDefinition {
@@ -22,4 +22,49 @@ class ConnectorController(implicit val swagger: Swagger) extends JsonServlet wit
     }
   }
 
+  post("/", operation(postConnector)) {
+    parsedAs[ConnectorRef] {
+      case ConnectorRef(sourceIdentifier, uniqueTypeString) =>
+        val connector = ConnectorRegistry.getConnector(sourceIdentifier, uniqueTypeString)
+
+        if (connector.isDefined) {
+          ResultMessage(success = false, "Connector already defined.")
+        } else {
+          val connectorClass = chatOverflow.typeRegistry.getConnectorType(uniqueTypeString)
+
+          if (connectorClass.isEmpty) {
+            ResultMessage(success = false, "Connector type not found.")
+
+          } else if (!ConnectorRegistry.addConnector(sourceIdentifier, uniqueTypeString)) {
+            ResultMessage(success = false, "Unable to add connector.")
+
+          } else {
+            chatOverflow.save()
+            ResultMessage(success = true)
+          }
+        }
+    }
+  }
+
+  delete("/:sourceIdentifier/:qualifiedConnectorType", operation(deleteConnector)) {
+    val sourceIdentifier = params("sourceIdentifier")
+    val qualifiedConnectorType = params("qualifiedConnectorType")
+
+    val connector = ConnectorRegistry.getConnector(sourceIdentifier, qualifiedConnectorType)
+
+    if (connector.isEmpty) {
+      ResultMessage(success = false, "Connector does not exist.")
+
+    } else if (connector.get.isRunning) {
+      ResultMessage(success = false, "Connector is running.")
+
+    } else if (!ConnectorRegistry.removeConnector(sourceIdentifier, qualifiedConnectorType)) {
+      ResultMessage(success = false, "Unable to remove connector.")
+
+    } else {
+      chatOverflow.save()
+      ResultMessage(success = true)
+    }
+  }
+
 }

src/main/scala/org/codeoverflow/chatoverflow/ui/web/rest/connector/ConnectorControllerDefinition.scala

@@ -1,7 +1,7 @@
 package org.codeoverflow.chatoverflow.ui.web.rest.connector
 
 import org.codeoverflow.chatoverflow.connector.ConnectorKey
-import org.codeoverflow.chatoverflow.ui.web.rest.DTOs.ConnectorDetails
+import org.codeoverflow.chatoverflow.ui.web.rest.DTOs.{ConnectorDetails, ConnectorRef, ResultMessage}
 import org.scalatra.swagger.SwaggerSupport
 import org.scalatra.swagger.SwaggerSupportSyntax.OperationBuilder
 
@@ -19,6 +19,19 @@ trait ConnectorControllerDefinition extends SwaggerSupport {
       parameter pathParam[String]("sourceIdentifier").description("The (connector unique) identifier of e.g. a account to connect to")
       parameter pathParam[String]("qualifiedConnectorType").description("The fully qualified type of the connector."))
 
+  val postConnector: OperationBuilder =
+    (apiOperation[ResultMessage]("postConnector")
+      summary "Creates a new connector."
+      description "Creates a connector with given sourceIdentifier and connector type."
+      parameter bodyParam[ConnectorRef]("body").description("Requires platform specific source identifier and connector type."))
+
+  val deleteConnector: OperationBuilder =
+    (apiOperation[ResultMessage]("deleteConnector")
+      summary "Deletes a specific connector."
+      description "Deletes the connector specified by identifier and unique type string."
+      parameter pathParam[String]("sourceIdentifier").description("The (connector unique) identifier of e.g. a account to connect to")
+      parameter pathParam[String]("qualifiedConnectorType").description("The fully qualified type of the connector."))
+
   override protected def applicationDescription: String = "Handles platform connectors."