This documentation is work in progress and will be released with the next WSO2 EI version.
Exposing Data as an OData Service - WSO2 Enterprise Integrator 6.x.x - WSO2 Documentation

All docs This doc
||
Skip to end of metadata
Go to start of metadata

In this tutorial, we will run through the process of exposing and RDBMS as an OData service. When OData is enabled for a datasource, you do not need to manually define CRUD operations. They are automatically created.

Note that the OData feature can only be used for RDBMS, Cassandra, and MonghoDB datasources.


Setting up an RDBMS

Follow the steps given below to set up a MySQL database for this tutorial.

  1. Download the product installer from here, and run the installer.
    Let's call the installation location of your product the <EI_HOME> directory. This is located in a place specific to your OS as shown below:
    OSHome directory
    Mac OS/Library/WSO2/EnterpriseIntegrator/6.5.0
    WindowsC:\Program Files\WSO2\EnterpriseIntegrator\6.5.0\
    Ubuntu/usr/lib/wso2/EnterpriseIntegrator/6.5.0
    CentOS/usr/lib64/EnterpriseIntegrator/6.5.0

  2. Install the MySQL server.
  3. Download the JDBC driver for MySQL from here and copy it to your <EI_HOME>/lib directory.
  4. Create a MySQL database named CompanyAccounts.

    CREATE DATABASE CompanyAccounts;
  5. Create a table in the CompanyAccounts database as follows.

    CREATE TABLE ACCOUNT(AccountID int NOT NULL,Branch varchar(255) NOT NULL, AccountNumber varchar(255),AccountType ENUM('CURRENT', 'SAVINGS') NOT NULL,
    Balance FLOAT,ModifiedDate DATE,PRIMARY KEY (AccountID)); 
  6. Enter the following data into the table:

    INSERT INTO ACCOUNT VALUES (1,"AOB","A00012","CURRENT",231221,'2014-12-02');

Expose the RDBMS as an OData service

Follow the steps given below.

  1. Start the WSO2 ESB profile.

    Open a terminal and execute the following command:

    wso2ei-6.4.0-integrator
    Go to Start Menu -> Programs -> WSO2 -> Enterprise Integrator 6.4.0 Integrator. This will open a terminal and start the ESB profile.
  2. Open the ESB profile's Management Console using https://localhost:9443/carbon, and log in using admin as the username and the password.
  3. Click Add New Datasource and enter details for the new datasource as follows.

    Datasource IDDatasource
    Datasource TypeRDBMS
    Datasource Type (Default/External)Leave Default selected.
    Database EngineMySQL
    Driver Classcom.mysql.jdbc.Driver
    URLjdbc:mysql://localhost:3306/Company
    User NameEnter your MySQL server's username. Example: root
    PasswordEnter your MySQL server's password. 
    If you have not assigned a password, keep this field empty. 
    Enable ODataSelect this check box.

Access the data service using CRUD operations

Open a command prompt execute the following CURL commands using CRUD operations:

Note that you should have privileges to perform CRUD operations on the database. If not, the OData service will not work properly.

  • To get the service document:

    curl -X GET -H 'Accept: application/json' http://localhost:8280/odata/ExposeDatabaseService/Datasource
  • To get the metadata of the service:

    curl -X GET -H 'Accept: application/xml' http://localhost:8280/odata/ExposeDatabaseService/Datasource/$metadata
  • To read details from the ACCOUNT table:

    curl -X GET -H 'Accept: application/xml' http://localhost:8280/odata/ExposeDatabaseService/Datasource/ACCOUNT
  • No labels