docfix/added comments for the InternalConnector

OpenBankProject · Oct 29, 2024 · 7dcbbf3 · 7dcbbf3
1 parent a15b185
commit 7dcbbf3
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/obp-api/src/main/scala/code/bankconnectors/Connector.scala b/obp-api/src/main/scala/code/bankconnectors/Connector.scala
@@ -71,6 +71,7 @@ object Connector extends SimpleInjector {
     "rabbitmq_vOct2024" -> RabbitMQConnector_vOct2024,
     // this proxy connector only for unit test, can set connector=proxy in test.default.props, but never set it in default.props
     "proxy" -> ConnectorUtils.proxyConnector,
+    // internal is the dynamic connector, the developers can upload the source code and override connector method themselves.
     "internal" -> InternalConnector.instance
   )
 

diff --git a/obp-api/src/main/scala/code/bankconnectors/InternalConnector.scala b/obp-api/src/main/scala/code/bankconnectors/InternalConnector.scala
@@ -19,7 +19,10 @@ import com.openbankproject.commons.util.ReflectUtils
 
 import scala.reflect.runtime.universe.{MethodSymbol, TermSymbol, typeOf}
 
-
+/**
+ * InternalConnector is actually the dynamic connector, if set method to `internal`. this allows the developer to use `Create Connector Method`
+ * endpoint to upload the scala/Js/Java source code to redesign the logic for the connector method
+ */
 object InternalConnector {
 
   lazy val instance: Connector = {