diff --git a/en/docs/integrate/develop/customizations/creating-synapse-handlers.md b/en/docs/integrate/develop/customizations/creating-synapse-handlers.md index ee53b2b0b8..dff418fca4 100644 --- a/en/docs/integrate/develop/customizations/creating-synapse-handlers.md +++ b/en/docs/integrate/develop/customizations/creating-synapse-handlers.md @@ -90,8 +90,16 @@ To deploy your custom synapse handler in WSO2 Micro Integrator, bundle the artif To engage the deployed Synapse handler, you need to add the following configuration to the `deployment.toml` file. -```toml -[[synapse_handlers]] -name = "" -class = "." -``` +=== "Format" + ```toml + [synapse_handlers.] + enabled = true + class = "." + ``` +=== "Example" + ```toml + [synapse_handlers.custom_handler] + enabled=true + class="org.wso2.carbon.apimgt.gateway.handlers.custom.customer_handler" + ``` + diff --git a/en/docs/reference/config-catalog.md b/en/docs/reference/config-catalog.md index c5df734efa..30cbaf94a0 100644 --- a/en/docs/reference/config-catalog.md +++ b/en/docs/reference/config-catalog.md @@ -14076,7 +14076,7 @@ key_password = "wso2carbon"
[http_access_log]
-useLogger = true
+enabled = true
@@ -14608,3 +14608,80 @@ excludeResponseHeaders = ""
+ + +## Global handler configurations + + +
+
+
+
+ + + +
+
+
[synapse_handlers.custom_handler_name]
+enabled=true
+class="org.wso2.carbon.apimgt.gateway.handlers.custom.customer_handler"
+
+
+
+
+
+
+ [synapse_handlers.custom_handler_name] + +

+ configuration used to define or enable disable global handler. +

+
+
+
+
+ enabled +
+
+
+

+ boolean + +

+
+ Default: +
+ +
+
+

Enable or disable a defined global handler.

+
+
+
+
+ class +
+
+
+

+ string + Required +

+
+ Default: +
+ +
+
+

Fully qualified class name of the global handler.

+
+
+
+
+
+
+
+
+
+
+ diff --git a/en/tools/config-catalog-generator/data/configs.json b/en/tools/config-catalog-generator/data/configs.json index 425c3d529e..e72c32e50d 100755 --- a/en/tools/config-catalog-generator/data/configs.json +++ b/en/tools/config-catalog-generator/data/configs.json @@ -5412,6 +5412,36 @@ } ], "exampleFile": "transport-headers.toml" + }, + + { + "title": "Global handler configurations", + "options": [ + { + "name": "synapse_handlers.custom_handler_name", + "required": false, + "description": "configuration used to define or enable disable global handler.", + "params": [ + { + "name": "enabled", + "type": "boolean", + "required": false, + "default": "", + "possible": "", + "description": "Enable or disable a defined global handler." + }, + { + "name": "class", + "type": "string", + "required": true, + "default": "", + "possible": "", + "description": "Fully qualified class name of the global handler." + } + ] + } + ], + "exampleFile": "synapse_handlers.toml" } ] }