Setting up Oracle (V1)

Setting up the database and users

Follow the steps below to set up a Oracle database.

1. Create a new database by using the Oracle database configuration assistant (dbca) or manually.

2. Make the necessary changes in the Oracle tnsnames.ora and listner.ora files in order to define addresses of the databases for establishing connections to the newly created database.

3. After configuring the .ora files, start the Oracle instance using the following command:

   $ sudo /etc/init.d/oracle-xe restart

4. Connect to Oracle using SQL*Plus as SYSDBA as follows:

   $ ./$<ORACLE_HOME>/config/scripts/sqlplus.sh sysadm/password as SYSDBA

5. Connect to the instance with the username and password using the following command:

   $ connect

6. As SYSDBA, create a database user and grant privileges to the user as shown below:

   Create user <USER_NAME> identified by password account unlock;
   grant connect to <USER_NAME>;
   grant create session, create table, create sequence, create trigger to <USER_NAME>;
   alter user <USER_NAME> quota <SPACE_QUOTA_SIZE_IN_MEGABYTES> on '<TABLE_SPACE_NAME>';
   commit;

7. Exit from the SQL*Plus session by executing the quit command.

Setting up the JDBC driver

1. Copy the Oracle JDBC libraries (for example, <ORACLE_HOME/jdbc/lib/ojdbc14.jar) to the <PRODUCT_HOME>/repository/components/lib/ directory.
2. Remove the old database driver from the <PRODUCT_HOME>/repository/components/dropins/ directory.

Setting up datasource configurations

A datasource is used to establish the connection to a database. By default, WSO2_CARBON_DB datasource is used to connect to the default  H2 database, which stores registry and user management data. After setting up the Oracle database to replace the default H2 database, either change the default configurations of the WSO2_CARBON_DB datasource, or configure a new datasource to point it to the new database as explained below.

Changing the default WSO2_CARBON_DB datasource

Follow the steps below to change the type of the default WSO2_CARBON_DB datasource.

1. Edit the default datasource configuration in the <PRODUCT_HOME>/repository/conf/datasources/m aster-datasources.xml file as shown below.

   <datasource>
        <name>WSO2_CARBON_DB</name>
        <description>The datasource used for registry and user manager</description>
        <jndiConfig>
              <name>jdbc/WSO2CarbonDB</name>
        </jndiConfig>
        <definition type="RDBMS">
              <configuration>
                  <url>jdbc:oracle:thin:@SERVER_NAME:PORT/DB_NAME</url>
                  <username>regadmin</username>
                  <password>regadmin</password>
                  <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName>
                  <maxActive>80</maxActive>
                  <maxWait>60000</maxWait>
                  <minIdle>5</minIdle>
                  <testOnBorrow>true</testOnBorrow>
                  <validationQuery>SELECT 1 FROM DUAL</validationQuery>
                  <validationInterval>30000</validationInterval>
   			   <defaultAutoCommit>false</defaultAutoCommit>
              </configuration>
        </definition>
   </datasource>

   The elements in the above configuration are described below:

   Element	Description
   url	The URL of the database. The default port for a DB2 instance is 50000.
   username and password	The name and password of the database user
   driverClassName	The class name of the database driver
   maxActive	The maximum number of active connections that can be allocated  at the same time from this pool. Enter any negative value to denote an unlimited number of active connections.
   maxWait	The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception. You can enter zero or a negative value to wait indefinitely.
   minIdle	The minimum number of active connections that can remain idle in the pool without extra ones being created, or enter zero to create none.
   testOnBorrow	The indication of whether objects will be validated before being borrowed from the pool. If the object fails to validate, it will be dropped from the pool, and another attempt will be made to borrow another.
   validationQuery	The SQL query that will be used to validate connections from this pool before returning them to the caller.
   validationInterval	The indication to avoid excess validation, and only run validation at the most, at this frequency (time in milliseconds). If a connection is due for validation, but has been validated previously within this interval, it will not be validated again.
   defaultAutoCommit	This property is not applicable to the Carbon database in WSO2 products because auto committing is usually handled at the code level, i.e., the default auto commit configuration specified for the RDBMS driver will be effective instead of this property element. Typically, auto committing is enabled for an RDBMS drivers by default. When auto committing is enabled, each SQL statement will be committed to the database as an individual transaction, as opposed to committing multiple statements as a single transaction.

   The default port for Oracle is 1521.

   For more information on other parameters that can be defined in the <PRODUCT_HOME>/repository/conf/datasources/ master-datasources.xml file, see Tomcat JDBC Connection Pool.

Configuring new  datasources to manage registry or user management data

Follow the steps below to configure new datasources to point to the new  databases you create to manage registry and/or user management data separately.

1. Add a new datasource with similar configurations as the WSO2_CARBON_DB datasource above to the <PRODUCT_HOME>/repository/conf/datasources/ master-datasources.xml file. Change its elements with your custom values. For instructions, see Setting up datasource configurations.

2. If you are setting up a separate database to store registry-related data, update the following configurations in the <PRODUCT_HOME>/repository/conf/ registry.xml file.

   <dbConfig name="wso2registry">
   	<dataSource>jdbc/MY_DATASOURCE_NAME</dataSource>
   </dbConfig>

3. If you are setting up a separate database to store user management data, update the following configurations in the <PRODUCT_HOME>/repository/conf/ user-mgt.xml file.

   <Configuration>
   	<Property name="dataSource">jdbc/MY_DATASOURCE_NAME</Property>
   </Configuration>

Creating the database tables

To create the database tables, connect to the database that you created earlier and run the following scripts in SQL*Plus:

1. To create tables in the registry and user manager database (WSO2CARBON_DB), use the below script:

   SQL> @$<PRODUCT_HOME>/dbscripts/oracle.sql

2. Restart the server.

   You can create database tables automatically when starting the product for the first time by using the -Dsetup parameter as follows:

   • For Windows: <PRODUCT_HOME>/bin/wso2server.bat -Dsetup

   • For Linux: <PRODUCT_HOME>/bin/wso2server.sh -Dsetup