This is an automated email from the ASF dual-hosted git repository.
zehnder pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/streampipes.git
The following commit(s) were added to refs/heads/dev by this push:
new beada3a0b4 refactor: Add javadoc to class FunctionRegistrationHandler
(#3277)
beada3a0b4 is described below
commit beada3a0b4a45aa5328b586429c15f47296ccfcd
Author: Philipp Zehnder <[email protected]>
AuthorDate: Wed Oct 2 12:38:52 2024 +0200
refactor: Add javadoc to class FunctionRegistrationHandler (#3277)
---
.../extensions/function/FunctionRegistrationHandler.java | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git
a/streampipes-service-extensions/src/main/java/org/apache/streampipes/service/extensions/function/FunctionRegistrationHandler.java
b/streampipes-service-extensions/src/main/java/org/apache/streampipes/service/extensions/function/FunctionRegistrationHandler.java
index 04f1f370c4..8e17da40dd 100644
---
a/streampipes-service-extensions/src/main/java/org/apache/streampipes/service/extensions/function/FunctionRegistrationHandler.java
+++
b/streampipes-service-extensions/src/main/java/org/apache/streampipes/service/extensions/function/FunctionRegistrationHandler.java
@@ -26,6 +26,16 @@ import org.slf4j.LoggerFactory;
import java.util.List;
+/**
+ * The {@code FunctionRegistrationHandler} class is responsible for registering
+ * a list of functions with the StreamPipes backend system.
+ *
+ * <p>Note: This class only handles the registration of the functions in the
backend.
+ * The actual execution of the registered functions occurs in the extension
service.
+ *
+ * <p>Once the registration is successful, a log entry is created to indicate
+ * the completion of the process.
+ */
public class FunctionRegistrationHandler extends RegistrationHandler {
private static final Logger LOG =
LoggerFactory.getLogger(FunctionRegistrationHandler.class);
@@ -36,7 +46,8 @@ public class FunctionRegistrationHandler extends
RegistrationHandler {
@Override
protected void performRequest(StreamPipesClient client) {
- client.adminApi().registerFunctions(functions);
+ client.adminApi()
+ .registerFunctions(functions);
}
@Override
