From 83574c4a9df8f6173a7a711b4c1e9d707102da33 Mon Sep 17 00:00:00 2001 From: DinithiDiaz Date: Wed, 11 Dec 2024 14:14:56 +0530 Subject: [PATCH 1/5] Update `Create an Inbound Endpoint` page --- .../creating-an-inbound-endpoint.md | 136 +++++++++--------- en/mkdocs.yml | 2 +- 2 files changed, 70 insertions(+), 68 deletions(-) diff --git a/en/docs/develop/creating-artifacts/creating-an-inbound-endpoint.md b/en/docs/develop/creating-artifacts/creating-an-inbound-endpoint.md index e99b33a7b..fba1c957b 100644 --- a/en/docs/develop/creating-artifacts/creating-an-inbound-endpoint.md +++ b/en/docs/develop/creating-artifacts/creating-an-inbound-endpoint.md @@ -1,105 +1,107 @@ -# Creating an Inbound Endpoint +# Create an Inbound Endpoint -Follow the instructions given below to create a new [Inbound Endpoint]({{base_path}}/reference/synapse-properties/inbound-endpoints/about-inbound-endpoints) artifact in WSO2 Integration Studio. +Follow these instructions to create an [Inbound Endpoint]({{base_path}}/reference/synapse-properties/inbound-endpoints/about-inbound-endpoints) artifact in the Micro Integrator for Visual Studio Code extension (MI for VS Code). -## Instructions +### Create an inbound endpoint artifact -### Creating the Inbound Endpoint artifact +{!includes/creating-project.md!} -1. If you have already created an [ESB Config project]({{base_path}}/develop/create-integration-project/#esb-config-project), right-click the project and go to **New → Inbound Endpoint** to open the **New Inbound Endpoint Artifact**. + Hereafter, this project will be referred to as ``. - +3. To add a new inbound endpoint, go to **Micro Integrator Project Explorer** > **Inbound Endpoints**. -2. Select **Create a New Inbound Endpoint** and click **Next**. +4. Hover over **Inbound Endpoints** and click the **+** icon that appears to open the **Inbound EP Form**. - + Create inbound endpoint -3. Enter a unique name for the inbound endpoint, and select an **Inbound Endpoint Creation Type** from the list. +5. Select the inbound endpoint type. - +6. Provide details for the inbound endpoint artifact. -4. Specify values for the required parameter for the selected inbound endpoint type. + !!! note + **Injecting Sequence Name** and **Error Sequence Name** are mandatory fields. + If you don't have any sequences created in the integration project, tick the checkbox to **Automatically generate sequences**, to generate new sequences for the inbound endpoint. Otherwise, you can select sequences that already exist in the project to the **Injecting Sequence Name** and **Error Sequence Name** fields from the dropdown. - !!! Note - For certain protocols (HL7, KAFKA, Custom, MQTT, RabbitMq, WSO2_MB, WS, and  WSS) the **main sequence** and **error sequence** are mandatory fields. - +7. Once you complete the **Inbound EP Form**, click **Create**. +
- You can select sequences that already exist in the workspace and add them to the **Sequence** and **Error sequence** fields. If you don't have any sequences in the workspace, click **Generate Sequence and Error Sequence** to generate new sequences for the inbound endpoint. +The created inbound endpoint will be available in the **MI Overview** under **Inbound Endpoints**. +If you checked the option to **Automatically generate sequences** in the previous step, the automatically generated inbound sequence and error sequence will also be available in the **MI Overview** under **Sequences**. -5. Do one of the following: - - To save the endpoint in an existing ESB Config project in your workspace, click **Browse** and select that project. - - To save the endpoint in a new ESB Config project, click **Create new Project** and create the new project. -6. Click **Finish**.  +!!! info + You can switch to the default Visual Studio Code **Explorer** to view the folder structure. + + The newly-created inbound endpoint will be stored in the `/src/main/wso2mi/artifacts/inbound-endpoints` folder of your integration project. -The inbound endpoint is created in the `src/main/synapse-config/inbound-endpoint` folder under the ESB Config project you specified. + If you checked the option to **Automatically generate sequences** in the previous step, the inbound sequence and error sequence will also be created and stored in the `/src/main/wso2mi/artifacts/sequences` folder of your integration project. -### Designing the integration +### Design the integration -When you open the inbound endpoint from the **Config** project in the project explorer, you will see the default **Design** view. +The integration flow for an inbound endpoint is defined within [named sequences]({{base_path}}/reference/mediation-sequences/#named-sequences). - +1. To design the integration, go to **MI Project Explorer** > **Inbound Endpoints**. -The integration flow for an inbound endpoint is defined within [named sequences]({{base_path}}/reference/mediation-sequences/#named-sequences). You can drag and drop **sequences** from the **Palette** to the canvas as shown below. +2. Select the inbound endpoint. - +Alternatively, to open this view, go to **MI Overview** and select the inbound sequence you want to design under **Sequences**. -Double-click the **Sequence** artifact to open the canvas for the sequence. You can now drag and drop the mediation artifacts from the palette and design the integration flow. +This will open the design view of the inbound endpoint. You can design the inbound sequence now. - +Follow the below steps to design the error sequence: -### Updating the properties +1. Go to **MI Overview**. -To update properties from the **Design** view: +2. Select the inbound error sequence you want to design under **Sequences**. -1. Double-click the **Inbound Endpoint** icon to open the Properties tab. +You can now add the mediation artifacts from the palette and design the integration flow. - +### Update the configurations -2. See the following links for the list of parameters for each inbound endpoint type: +1. Go to **MI Project Explorer** > **Inbound Endpoints**. - - [HTTP Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/listening-inbound-endpoints/http-inbound-endpoint-properties) - - [CXF WS RM Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/listening-inbound-endpoints/cxf-ws-rm-inbound-endpoint-properties) - - [HL7 Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/listening-inbound-endpoints/hl7-inbound-endpoint-properties) - - [WebSocket Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/listening-inbound-endpoints/websocket-inbound-endpoint-properties) - - [File Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/polling-inbound-endpoints/file-inbound-endpoint-properties) - - [JMS Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/polling-inbound-endpoints/jms-inbound-endpoint-properties) - - [Kafka Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/polling-inbound-endpoints/kafka-inbound-endpoint-properties) - - [RabbitMQ Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/event-based-inbound-endpoints/rabbitmq-inbound-endpoint-properties) - - [MQTT Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/event-based-inbound-endpoints/mqtt-inbound-endpoint-properties) +2. Select the inbound endpoint you want to edit. -!!! Note - **Redeployment of listening inbound endpoints fail?** +2. On the inbound endpoint view, click the edit (pen) icon next to the inbound endpoint name to edit the inbound endpoint. - A **listening inbound endpoint** opens the port for itself during deployment. Therefore, if you are **redeploying** a listening inbound endpoint artifact, the redeployment will not be successful until the port that was previously opened for the inbound endpoint is closed. + Edit inbound endpoint - By default, the system will wait for 10 seconds for the previously opened port to close down. If you want to increase this waiting time beyond 10 seconds, be sure to add the following system property in the `deployment.toml` file, which is stored in the `MI_HOME/conf/` directory and restart the server before redeploying the artifacts. + This will open the **Edit Listener** interface. - ```toml - [system.parameter] - 'synapse.transport.portCloseVerifyTimeout' = 20 - ``` - Note that `synapse.transport.portCloseVerifyTimeout` should be wrapped by single quotes since it contain dots. The TOML format detects the dot as an object separator. - Also note that this setting may be required in Windows environments as the process of closing a port can sometimes take longer than 10 seconds. +4. Once you update the details, click **Update**. -### Using the Source View +See the following links for the list of parameters for each inbound endpoint type: -Click the **Source** tab to view the XML-based synapse configuration (source code) of the inbound endpoint. You can update the service using this view. +- [HTTP Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/listening-inbound-endpoints/http-inbound-endpoint-properties) +- [CXF WS RM Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/listening-inbound-endpoints/cxf-ws-rm-inbound-endpoint-properties) +- [HL7 Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/listening-inbound-endpoints/hl7-inbound-endpoint-properties) +- [WebSocket Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/listening-inbound-endpoints/websocket-inbound-endpoint-properties) +- [File Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/polling-inbound-endpoints/file-inbound-endpoint-properties) +- [JMS Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/polling-inbound-endpoints/jms-inbound-endpoint-properties) +- [Kafka Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/polling-inbound-endpoints/kafka-inbound-endpoint-properties) +- [RabbitMQ Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/event-based-inbound-endpoints/rabbitmq-inbound-endpoint-properties) +- [MQTT Inbound Parameters]({{base_path}}/reference/synapse-properties/inbound-endpoints/event-based-inbound-endpoints/mqtt-inbound-endpoint-properties) - +### Source View -## Examples +Click the **Show Source** (``) icon located in the top right corner of the VS Code to view the XML-based synapse configuration (source code) of the inbound endpoint. You can update the inbound endpoint using this view. -- [JMS Inbound Endpoint example]({{base_path}}/learn/examples/inbound-endpoint-examples/inbound-endpoint-jms-protocol) -- [File Inbound Endpoint example]({{base_path}}/learn/examples/inbound-endpoint-examples/file-inbound-endpoint) -- [HTTP Inbound Endpoint example]({{base_path}}/learn/examples/inbound-endpoint-examples/inbound-endpoint-http-protocol) -- [HTTPS Inbound Endpoint example]({{base_path}}/learn/examples/inbound-endpoint-examples/inbound-endpoint-https-protocol) -- [HL7 Inbound Endpoint example]({{base_path}}/learn/examples/inbound-endpoint-examples/inbound-endpoint-hl7-protocol-auto-ack) -- [MQTT Inbound Endpoint example]({{base_path}}/learn/examples/inbound-endpoint-examples/inbound-endpoint-mqtt-protocol) -- [RabbitMQ Inbound Endpoint example]({{base_path}}/learn/examples/inbound-endpoint-examples/inbound-endpoint-rabbitmq-protocol) -- [Kafka Inbound Endpoint example]({{base_path}}/learn/examples/inbound-endpoint-examples/inbound-endpoint-kafka) -- [WebSocket Inbound Endpoint example]({{base_path}}/learn/examples/inbound-endpoint-examples/inbound-endpoint-secured-websocket) -- [Using Inbound Endpoints with Registry]({{base_path}}/learn/examples/inbound-endpoint-examples/inbound-endpoint-with-registry) +Edit inbound endpoint -## Tutorial +!!! abstract "Learn more about inbound endpoints" -- See the tutorial on [using inbound endpoints]({{base_path}}/learn/integration-tutorials/using-inbound-endpoints) + Follow our examples on inbound endpoints: + + - [JMS Inbound Endpoint example]({{base_path}}/learn/examples/inbound-endpoint-examples/inbound-endpoint-jms-protocol) + - [File Inbound Endpoint example]({{base_path}}/learn/examples/inbound-endpoint-examples/file-inbound-endpoint) + - [HTTP Inbound Endpoint example]({{base_path}}/learn/examples/inbound-endpoint-examples/inbound-endpoint-http-protocol) + - [HTTPS Inbound Endpoint example]({{base_path}}/learn/examples/inbound-endpoint-examples/inbound-endpoint-https-protocol) + - [HL7 Inbound Endpoint example]({{base_path}}/learn/examples/inbound-endpoint-examples/inbound-endpoint-hl7-protocol-auto-ack) + - [MQTT Inbound Endpoint example]({{base_path}}/learn/examples/inbound-endpoint-examples/inbound-endpoint-mqtt-protocol) + - [RabbitMQ Inbound Endpoint example]({{base_path}}/learn/examples/inbound-endpoint-examples/inbound-endpoint-rabbitmq-protocol) + - [Kafka Inbound Endpoint example]({{base_path}}/learn/examples/inbound-endpoint-examples/inbound-endpoint-kafka) + - [WebSocket Inbound Endpoint example]({{base_path}}/learn/examples/inbound-endpoint-examples/inbound-endpoint-secured-websocket) + - [Using Inbound Endpoints with Registry]({{base_path}}/learn/examples/inbound-endpoint-examples/inbound-endpoint-with-registry) + + Follow our tutorial on inbound endpoints: + + - See the tutorial on [using inbound endpoints]({{base_path}}/learn/integration-tutorials/using-inbound-endpoints) diff --git a/en/mkdocs.yml b/en/mkdocs.yml index 4be091d0a..a4620552f 100644 --- a/en/mkdocs.yml +++ b/en/mkdocs.yml @@ -351,7 +351,7 @@ nav: - Create Artifacts: - Create a REST API: develop/creating-artifacts/creating-an-api.md - Create a Proxy Service: develop/creating-artifacts/creating-a-proxy-service.md - #- Create an Inbound Endpoint: develop/creating-artifacts/creating-an-inbound-endpoint.md + - Create an Inbound Endpoint: develop/creating-artifacts/creating-an-inbound-endpoint.md - Create Scheduled Tasks: develop/creating-artifacts/creating-scheduled-task.md - Create a Message Store: develop/creating-artifacts/creating-a-message-store.md - Create a Message Processor: develop/creating-artifacts/creating-a-message-processor.md From 5a52429715c35a1de81e6980fde8863001667812 Mon Sep 17 00:00:00 2001 From: DinithiDiaz Date: Wed, 11 Dec 2024 14:17:43 +0530 Subject: [PATCH 2/5] Remove redirect for inbound endpoint --- en/mkdocs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/en/mkdocs.yml b/en/mkdocs.yml index a4620552f..7c7cad0d5 100644 --- a/en/mkdocs.yml +++ b/en/mkdocs.yml @@ -1007,7 +1007,6 @@ plugins: 'reference/connectors/amazonsqs-connector/amazonsqs-connector-example/' : 'https://mi.docs.wso2.com/en/4.3.0/reference/connectors/amazonsqs-connector/2.x/amazonsqs-connector-2.x-example/' 'reference/connectors/develop-connectors.md': 'https://mi.docs.wso2.com/en/4.3.0/develop/customizations/creating-new-connector/' 'reference/mediators/data-mapper-json-schema-specification.md' : 'https://mi.docs.wso2.com/en/4.3.0/reference/mediators/data-mapper-mediator' - 'develop/creating-artifacts/creating-an-inbound-endpoint.md' : 'https://mi.docs.wso2.com/en/4.3.0/develop/intro-integration-development/' 'reference/connectors/microsoft-azure-storage-connector/1.x/microsoft-azure-storage-connector-example.md' : 'https://mi.docs.wso2.com/en/4.3.0/reference/connectors/microsoft-azure-storage-connector/1.x/microsoft-azure-storage-reference/' 'observe-and-manage/working-with-monitoring-dashboard.md' : 'https://mi.docs.wso2.com/en/4.3.0/observe-and-manage/working-with-integration-control-plane/' 'develop/creating-artifacts/data-services/creating-input-validators.md' : 'https://mi.docs.wso2.com/en/4.3.0/learn/learn-overview/' From a5a15c253d20d6ee856b8f59fc633ad86b2236c9 Mon Sep 17 00:00:00 2001 From: DinithiDiaz Date: Wed, 11 Dec 2024 14:20:39 +0530 Subject: [PATCH 3/5] Update `Create a Proxy Service` page --- .../creating-a-proxy-service.md | 37 +++++++++---------- 1 file changed, 18 insertions(+), 19 deletions(-) diff --git a/en/docs/develop/creating-artifacts/creating-a-proxy-service.md b/en/docs/develop/creating-artifacts/creating-a-proxy-service.md index e3d5eb5a9..e8796c893 100644 --- a/en/docs/develop/creating-artifacts/creating-a-proxy-service.md +++ b/en/docs/develop/creating-artifacts/creating-a-proxy-service.md @@ -1,28 +1,29 @@ # Create a Proxy Service -Follow the instructions below to create a new [Proxy Service]({{base_path}}/reference/synapse-properties/proxy-service-properties) artifact in the Micro Integrator for Visual Studio Code extension (MI for VS Code). +Follow these instructions to create a [Proxy Service]({{base_path}}/reference/synapse-properties/proxy-service-properties) artifact in the Micro Integrator for Visual Studio Code extension (MI for VS Code). -## Instructions - -### Create the proxy service artifact +## Create a new proxy service artifact {!includes/creating-project.md!} + Hereafter, this project will be referred to as ``. + 3. Go to **MI Project Explorer** > **Proxy Services**. - Create proxy service - 4. Hover over **Proxy Services** and click the **+** icon that appears to open the **Proxy Service Form** below. + proxy service + 5. Enter a unique name for the proxy service. - proxy service +6. Once you complete the **Proxy Service Form**, click **Create**. -6. Click **Create**. +!!! info + You can switch to the default Visual Studio Code **Explorer** to view the folder structure. -The proxy service is created in the `src/main/wso2mi/artifacts/proxy-services` folder under the project you created. + The newly-created proxy service will be stored in the `/src/main/wso2mi/artifacts/proxy-services` folder of your integration project. -### Design the integration +## Design the integration 1. Go to the **MI Overview** interface. @@ -36,23 +37,21 @@ The proxy service is created in the `src/main/wso2mi/artifacts/proxy-services` f 3. Add the required mediators and connectors and design the integration flow. - source view - -### Update the properties +## Update the configurations -#### To update from the Form View: +1. Go to **MI Overview**. -1. In the MI Overview, select the proxy service to go to its **Resource View**. +2. Under **Proxy Services**, select the proxy service you want to edit to go to its **Resource View**. -2. Click the **Edit** icon to edit the proxy service. +3. Click the **Edit** icon to edit the proxy service. Edit proxy service -3. Add the required parameters. +4. Add the required parameters. Edit proxy view -4. Click **Update**. +5. Click **Update**. See the following links for the list of transport parameters you can use: @@ -65,7 +64,7 @@ The proxy service is created in the `src/main/wso2mi/artifacts/proxy-services` f See the complete list of [service-level properties and parameters]({{base_path}}/reference/synapse-properties/proxy-service-properties) that you can configure. -#### To update from the Source View: +## Source View Click the **Show Source** (``) icon located in the top right corner of the VS Code to view the XML-based synapse configuration (source code) of the proxy service. From dd3d0c9e07e0e9aff74534f8f2bed512969502ed Mon Sep 17 00:00:00 2001 From: DinithiDiaz Date: Wed, 11 Dec 2024 14:21:47 +0530 Subject: [PATCH 4/5] Update `Create a Scheduled Task` page --- .../creating-scheduled-task.md | 48 ++++++++++++------- en/mkdocs.yml | 2 +- 2 files changed, 31 insertions(+), 19 deletions(-) diff --git a/en/docs/develop/creating-artifacts/creating-scheduled-task.md b/en/docs/develop/creating-artifacts/creating-scheduled-task.md index 486684708..a6197dea3 100644 --- a/en/docs/develop/creating-artifacts/creating-scheduled-task.md +++ b/en/docs/develop/creating-artifacts/creating-scheduled-task.md @@ -1,46 +1,58 @@ -# Create Scheduled Tasks +# Create a Scheduled Task -Follow the instructions below to create a Scheduled Task in the Micro Integrator for Visual Studio Code extension (MI for VS Code). +Follow the instructions below to create a Scheduled Task in the Micro Integrator for Visual Studio Code (MI for VS Code) extension. -## Instructions - -### Create the scheduled task artifact +## Create a scheduled task artifact {!includes/creating-project.md!} -3. Go to **Micro Integrator Project Explorer** > **Tasks**. + Hereafter, this project will be referred to as ``. - create tasks +3. Go to **Micro Integrator Project Explorer** > **Tasks**. 4. Hover over **Tasks** and click the **+** icon that appears. - Add Task - This will open the below **Task Form**. 5. Specify values for the [required parameters]({{base_path}}/reference/synapse-properties/scheduled-task-properties) for the scheduled task. create new scheduled task - The scheduled task is created in the `src/main/wso2mi/artifacts/tasks` folder under the project you created. +The created scheduled task will be available in the **MI Overview** under Tasks. + +!!! info + You can switch to the default Visual Studio Code Explorer to view the folder structure. + + The newly-created task will be stored in the `/src/main/wso2mi/artifacts/tasks` folder of your integration project. -### Update properties +## Update configurations -You can later update the task properties to specify the incoming message that should trigger the task and the destination where the message should be injected. +You can later update the task configurations to specify the incoming message that should trigger the task and the destination where the message should be injected. -Open the above-created task artifact from the **MI Project Explorer**. You can use the **Form view** or the **Source view** to update task properties. +1. Go to **MI Overview**. + +2. Under **Tasks**, select the task you want to edit. + +3. This will open the **Task View**. + +4. Click the pen icon next to the task name. + + create new scheduled task + +5. Update task configurations. + +6. Click **Update**. !!! info - Refer to the [Scheduled Tasks Property Catalog]({{base_path}}/reference/synapse-properties/scheduled-task-properties/) documentation for a list of all available properties for tasks. + See the [Scheduled Tasks Property Catalog]({{base_path}}/reference/synapse-properties/scheduled-task-properties/) documentation for a list of all available configurations for tasks. !!! abstract "Learn more about scheduled tasks" Follow our examples on scheduled tasks: - [Task Scheduling using a Simple Trigger]({{base_path}}/learn/examples/scheduled-tasks/task-scheduling-simple-trigger) - - [Injecting Messages to a RESTful Endpoint]({{base_path}}/learn/examples/scheduled-tasks/injecting-messages-to-rest-endpoint) - - Follow our tutorials on scheduled tasks: + - [Inject Messages to a RESTful Endpoint]({{base_path}}/learn/examples/scheduled-tasks/injecting-messages-to-rest-endpoint) - - See the tutorial on [periodically executing an integration process]({{base_path}}/learn/integration-tutorials/using-scheduled-tasks) using a scheduled task + Follow our tutorial on scheduled tasks: + - [Periodically execute an integration process]({{base_path}}/learn/integration-tutorials/using-scheduled-tasks) using a scheduled task diff --git a/en/mkdocs.yml b/en/mkdocs.yml index 7c7cad0d5..1b4a3a284 100644 --- a/en/mkdocs.yml +++ b/en/mkdocs.yml @@ -352,7 +352,7 @@ nav: - Create a REST API: develop/creating-artifacts/creating-an-api.md - Create a Proxy Service: develop/creating-artifacts/creating-a-proxy-service.md - Create an Inbound Endpoint: develop/creating-artifacts/creating-an-inbound-endpoint.md - - Create Scheduled Tasks: develop/creating-artifacts/creating-scheduled-task.md + - Create a Scheduled Task: develop/creating-artifacts/creating-scheduled-task.md - Create a Message Store: develop/creating-artifacts/creating-a-message-store.md - Create a Message Processor: develop/creating-artifacts/creating-a-message-processor.md - Create an Endpoint: develop/creating-artifacts/creating-endpoints.md From 549e5010422306fab996206e5ab0c2bfa5c29d50 Mon Sep 17 00:00:00 2001 From: DinithiDiaz Date: Wed, 11 Dec 2024 14:26:54 +0530 Subject: [PATCH 5/5] Move the note from `Creating an Inbound Endpoint` page --- .../inbound-endpoints/about-inbound-endpoints.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/en/docs/reference/synapse-properties/inbound-endpoints/about-inbound-endpoints.md b/en/docs/reference/synapse-properties/inbound-endpoints/about-inbound-endpoints.md index 56c52480f..74b114b52 100644 --- a/en/docs/reference/synapse-properties/inbound-endpoints/about-inbound-endpoints.md +++ b/en/docs/reference/synapse-properties/inbound-endpoints/about-inbound-endpoints.md @@ -11,6 +11,20 @@ A listening inbound endpoint listens on a given port for requests that are comin - CXF WS-RM Inbound Protocol - WebSocket Inbound Protocol +!!! Note "Redeployment of listening inbound endpoints fail?" + + A listening inbound endpoint opens the port for itself during deployment. Therefore, if you are redeploying a listening inbound endpoint artifact, the redeployment will not be successful until the port that was previously opened for the inbound endpoint is closed. + + By default, the system will wait for 10 seconds for the previously opened port to close down. If you want to increase this waiting time beyond 10 seconds, add the following system property in the `deployment.toml` file, which is stored in the `/conf/` directory and restart the server before redeploying the artifacts. + + ```toml + [system.parameter] + 'synapse.transport.portCloseVerifyTimeout' = 20 + ``` + + The `synapse.transport.portCloseVerifyTimeout` property should be wrapped by single quotes (`'` `'`) since it contains dots (`.`) as shown above as the TOML format detects the dot as an object separator. + Also note that this setting may be required in Windows environments as the process of closing a port can sometimes take longer than 10 seconds. +