Creating an Inbound Endpoint

You can create a new inbound endpoint or import an existing inbound endpoint from an XML file, such as a Synapse configuration file using WSO2 EI tooling.

Using WSO2 EI Tooling

You need to have WSO2 EI tooling installed to create a new inbound endpoint or to import an existing inbound endpoint via tooling. For instructions on installing WSO2 EI tooling, see Installing Enterprise Integrator Tooling.

Step 1: Creating an ESB Solution project

First, create an ESB Solution Project in ESB tooling. We will use this project to store the Inbound Endpoint artifacts.

Open the Developer Studio Dashboard (click Developer Studio > Open Dashboard) and click ESB Solution Project.
Enter a name for the project and click Next.
Enter the Maven information about the project and click Finish.
The new project will be listed in the project explorer.

Step 2: Creating a new inbound endpoint

Follow the steps below to create a new inbound endpoint.

In Eclipse, click the Developer Studio menu and then click Open Dashboard. This opens the Developer Studio Dashboard.
Click Inbound Endpoint on the Developer Studio Dashboard. Alternatively, you can right-click on the ESB Solution project and then click New > Inbound Endpoint.
Importing an Inbound Endpoint?

If you already have an inbound endpoint artifact created, you have the option of importing the XML configuration. Select Import Inbound Endpoint and follow the instructions on the UI. To create a new inbound endpoint from scratch, continue with the following steps.
Select Create a New Inbound Endpoint and click Next.
Enter a unique name for the inbound endpoint, and select an Inbound Endpoint Creation Type from the list shown below.

Go to WSO2 EI Inbound Endpoints to learn more about how each of the protocol types work.
For certain protocols ( HL7, KAFKA, Custom, MQTT, RabbitMq, WSO2_MB, WS, and WSS) the main sequence and error sequence are mandatory fields. You can select sequences that already exists in the workspace and add them to the Sequence and Error sequence fields (shown below). If you don't have any sequences in the workspace, click Generate Sequence and Error Sequence to generate new sequences for the inbound endpoint.
In the Save Inbound Endpoint field, specify the ESB Solution project where the inbound endpoint should be saved.
Click Finish to generate the inbound endpoint. The artifact will now be saved in the ESB Solution project.
Select the inbound endpoint from the project explorer and go to the Design View.
Right-click the inbound endpoint and click Show Properties View to go to the Property tab. You can update the parameters relevant to the type of inbound endpoint.

Go to WSO2 EI Inbound Endpoints for details of the parameters available for each inbound endpoint type.
Add sequences to the main sequence and error sequence of the inbound endpoint. This can be done using the Sequence mediator in the Mediators pallet. Open the Property tab (right-click and click Show Properties View) of the Sequence mediator and update the relevant parameters.

See the parameters available for the Sequence Mediator.

Step 3: Deploying the inbound endpoint in the ESB server

Once you have created your inbound endpoint as explained in the previous topics, you need to create a Composite Application project with a CAR file. You can then deploy the CAR file in the ESB server:

Right-click the Project Explorer and click New > Project.
From the window that opens, click Composite Application Project.
Give a name to the Composite Application project and select the projects that you need to group into your C-App from the list of available projects. You need to select the ESB project, which contains the proxy service and security policy file respectively.
Next, deploy the CAR file in the ESB server.

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, be sure to add the following system property in the product startup script (integrator.sh for Linux/MacOS/CentOs and integrator.bat for Windows), which is stored in the <EI_HOME>/bin/ directory and restart the server before redeploying the artifacts.

-Dsynapse.transport.portCloseVerifyTimeout=20

Note that this setting may be required in Windows environments as the process of closing a port can sometimes take longer than 10 seconds.

Using the management console

You can add, edit and delete inbound endpoints via WSO2 EI Management Console. You can also enable/disable statistics as well as enable/disable tracing for inbound endpoints via the Management console.

Adding an inbound endpoint

Follow the steps given below to add an inbound endpoint.

Click the Main tab on the Management Console and then go to Manage -> Service Bus and click Inbound Endpoints to open the Inbound Endpoints page.
On the Inbound Endpoints page, click Add Inbound Endpoint to open the New Inbound Endpoint page.
Specify a name for the inbound endpoint, select the inbound protocol type for the new inbound endpoint , and click Next. This displays all the parameters applicable to the new inbound endpoint depending on the protocol type you selected.
Specify values for all the required parameters. Following are the available inbound protocol types. Click on a required protocol type for information on the parameters you need to specify as well as to view a sample configuration for an inbound endpoint of the relevant protocol type.
Click Show Advanced Options if you want to configure advanced settings for the inbound endpoint. The parameters displayed under advanced options also depend on the protocol type you selected for the inbound endpoint.
Click Save. You will see the new inbound endpoint you added displayed under Available Defined Inbound Endpoints on the Inbound Endpoints page.

Editing an inbound endpoint

Follow the steps given below to edit an inbound endpoint.

Click the Main tab on the Management Console and then go to Manage -> Service Bus and click Inbound Endpoints to open the Inbound Endpoints page.
On the Inbound Endpoints page, you will see all the inbound endpoints that you have added under Available Defined Inbound Endpoints.
Click Edit to make necessary changes to a required inbound endpoint.
Change the existing parameter values based on your requirement and click Update. The changes will be applied to the inbound endpoint.

Deleting an inbound endpoint

Follow the steps below to delete an inbound endpoint.

Click the Main tab on the Management Console and then go to Manage -> Service Bus and click Inbound Endpoints to open the Inbound Endpoints page.
On the Inbound Endpoints page, you will see all the inbound endpoints that you have added under Available Defined Inbound Endpoints.
Click Delete to discard an inbound endpoint that you no longer need. A message appears to confirm that you want to proceed with deleting the inbound endpoint.
Click Yes. The inbound endpoint will be deleted and will no longer appear under Available Defined Inbound Endpoints on the Inbound Endpoints page.

Enabling/disabling statistics

Follow the steps below to enable or disable statistics for inbound endpoints.

Click the Main tab on the Management Console and then go to Manage -> Service Bus and click Inbound Endpoints to open the Inbound Endpoints page.
On the Inbound Endpoints page, you will see all the inbound endpoints that you have added under Available Defined Inbound Endpoints. You will see the Enable Statistics link displayed for inbound endpoints that have statistics currently disabled, and the Disable Statistics link displayed for inbound endpoints that have statistics currently enabled.
If you want to enable statistics for an inbound endpoint, click Enable Statistics for the particular inbound endpoint.
If you want to disable statistics for an inbound endpoint, click Disable Statistics for the particular inbound endpoint.

Enabling/disabling tracing

Follow the steps below to enable or disable tracing for inbound endpoints.

Click the Main tab on the Management Console and then go to Manage -> Service Bus and click Inbound Endpoints to open the Inbound Endpoints page.
On the Inbound Endpoints page, you will see all the inbound endpoints that you have added under Available Defined Inbound Endpoints. You will see the Enable Tracing link displayed for inbound endpoints that have tracing disabled, and the Disable Tracing link displayed for inbound endpoints that have tracing enabled.
If you want to enable tracing for an inbound endpoint, click Enable Tracing for the particular inbound endpoint.
If you want to disable tracing for an inbound endpoint, click Disable Tracing for the particular inbound endpoint.