...
Tip |
---|
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.
Anchor | ||||
---|---|---|---|---|
|
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
Click Inbound Endpoint on the Developer Studio Dashboard. Alternatively, you can right-click on the ESB
ConfigSolution project and then click New > Inbound Endpoint.
Tip title 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.
- Give
Enter a unique name for the inbound endpoint, and select
the protocol type and click Finish. - The created inbound endpoint opens in the Graphical Editor as shown below:
- Drag and drop a sequence and an
onError
sequence from the tool palette as shown below: - If you want to browse a sequence from the registry, right-click on the sequence and click Show Properties View.
- Point to an existing sequence in the registry in the Static Reference Key property.
- Right-click on
an Inbound Endpoint Creation Type from the list shown below.
Tip 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
opengo to the Property
window.- Update the parameters as preferred and the changes will be saved in the inbound endpoint configuration.
...
Follow the steps below to import an existing inbound endpoint from an XML file such as a Synapse configuration file, into an ESB Config project.
- 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 Config project and then click New > Inbound Endpoint.
- Select Import Inbound Endpoint and click Next.
- Specify the inbound endpoint file by typing its full path name or clicking Browse and navigating to the file.
- In the Save Inbound Endpoint Infield, specify an existing ESB Config project in your workspace where you want to save the inbound endpoint, or click Create new ESB Project to create a new ESB Config project and save the endpoint there.
- Click Finish. The inbound endpoint you selected is created in the
inbound-endpoints
folder under the ESB Config project you specified, and the inbound endpoint opens in the editor.tab. You can update the parameters relevant to the type of inbound endpoint.
Tip 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.
Tip 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.
Note | ||
---|---|---|
| ||
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 (
Note that this setting may be required in Windows environments as the process of closing a port can sometimes take longer than 10 seconds. |
Anchor | ||||
---|---|---|---|---|
|
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.
...