From ae5d20ebc32de5b2b58c61f790851b4e28379e9c Mon Sep 17 00:00:00 2001 From: Marco Del Tufo <marco.deltufo@exact-lab.it> Date: Tue, 1 Aug 2023 14:50:54 +0000 Subject: [PATCH] Update as-api-listener.md --- .../server-side-extensions/as-api-listener.md | 20 ++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/docs/software-developer-documentation/server-side-extensions/as-api-listener.md b/docs/software-developer-documentation/server-side-extensions/as-api-listener.md index 0ff335af18a..d3066059451 100644 --- a/docs/software-developer-documentation/server-side-extensions/as-api-listener.md +++ b/docs/software-developer-documentation/server-side-extensions/as-api-listener.md @@ -58,11 +58,25 @@ is provided with the V3 API jar and provides 3 methods: session token used for the operation, the operation result and any exception that happened during the operation. +```{warning} +Implicit Requirements -| :red_circle: Implicit Requirements | -|:---------------------------| -| **Requirement 1: Â The Listener should be Thread Safe Code**<br /><br />A single instance of the Listener is created during the server startup.<br /><br />Since a single instance is used to serve all requests thread safe code is a requirement.<br /><br />We strongly suggest to not to keep any state.<br /><br />**Requirement 2: The Listener should not throw Exceptions**<br /><br />If the listener throw an exception it will make the API call fail.<br /><br />**Requirement 3: The Listener should use IOperation and IOperationResult as indicated below**<br /><br />All API Operations go through every listener so the method signatures should use IOperation and IOperationResult.<br /><br />Please use instanceof for safe casting. | +**Requirement 1: Â The Listener should be Thread Safe Code** +A single instance of the Listener is created during the server startup. + +Since a single instance is used to serve all requests thread safe code is a requirement. + +We strongly suggest to not to keep any state. + +**Requirement 2: The Listener should not throw Exceptions** + +If the listener throw an exception it will make the API call fail. + +**Requirement 3: The Listener should use IOperation and IOperationResult as indicated below** + +All API Operations go through every listener so the method signatures should use IOperation and IOperationResult.<br /><br />Please use instanceof for safe casting. +``` **IOperationListener** -- GitLab