This documentation is for WSO2 Identity Server 5.0.0. View documentation for the latest release.
Setting up Informix - Identity Server 5.0.0 - WSO2 Documentation
||
Skip to end of metadata
Go to start of metadata

The following sections describe how to replace the default H2 databases with IBM Informix:

Prerequisites

Download the latest version of IBM Informix and install it on your computer.

Creating the database

Create the database and users in Informix. For instructions on creating the database and users, see Informix product documentation.

Do the following changes to the default database when creating the Informix database.

  • Use page size as 4K or higher when creating the dbspace as shown in the following command (i.e. denoted by -k 4) : onspaces -c -S testspace4 -k 4 -p /usr/informix/logdir/data5.dat -o 100 -s 3000000
  • Add the following system environment variables.

    export DB_LOCALE=en_US.UTF-8
    export CLIENT_LOCALE=en_US.UTF-8
  • Create a sbspace other than the dbspace by executing the following command: onspaces -c -S testspace4 -k 4 -p /usr/informix/logdir/data5.dat -o 100 -s 3000000
  • Add the following entry to the <INFORMIX_HOME>/etc/onconfig file, andreplace the given example sbspace name (i.e. testspace4) with your sbspace name: SBSPACENAME testspace4

Setting up Informix JDBC drivers

Download the Informix JDBC drivers and copy them to your WSO2 product's <PRODUCT_HOME>/repository/components/lib/directory.

Use Informix JDBC driver version 3.70.JC8, 4.10.JC2 or higher.

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 IBM Informix 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>WSO2AM_DB</name>
                <description>The datasource used for API Manager database</description>
                <jndiConfig>
                    <name>jdbc/WSO2AM_DB</name>
                </jndiConfig>
                <definition type="RDBMS">
                    <configuration>
                        <!-- IP ADDRESS AND PORT OF DB SERVER -->
                        <url>jdbc:informix-sqli://localhost:1533/AM_DB;CLIENT_LOCALE=en_US.utf8;DB_LOCALE=en_us.utf8;IFX_USE_STRENC=true;</url>
                        <username>wso2carbon</username>
                        <password>wso2carbon</password>
                        <driverClassName>com.informix.jdbc.IfxDriver</driverClassName>
                        <maxActive>80</maxActive>
                        <maxWait>60000</maxWait>
                        <testOnBorrow>true</testOnBorrow>
                        <validationQuery>SELECT 1</validationQuery>
                        <validationInterval>30000</validationInterval>
    					<defaultAutoCommit>false</defaultAutoCommit>
                    </configuration>
                </definition>
            </datasource>

    The elements in the above configuration are described below:

    ElementDescription
    url

    The URL of the database. The default port for a DB2 instance is 50000.

    You need to add the following configuration when specifying the connection URL as shown in the example above:

    Add the following configuration to the connection URL when specifying it as shown in the example above: CLIENT_LOCALE=en_US.utf8;DB_LOCALE=en_us.utf8;IFX_USE_STRENC=true;

    username and passwordThe name and password of the database user
    driverClassNameThe class name of the database driver
    maxActiveThe 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.
    maxWaitThe 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.
    minIdleThe 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.
    validationQueryThe SQL query that will be used to validate connections from this pool before returning them to the caller.
    validationIntervalThe 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.


    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 database tables

To create the database tables, connect to the database that you created earlier and run the following scripts.

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

    <PRODUCT_HOME>/dbscripts/informix.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

Changing the database for identity-related data

The topics above show how to change the WSO2_CARBON_DB, which is used to store registry and user manager information. However, If you set up a separate database for identity-related data, the instructions are the same. In summary:

  • Add the new datasource configuration to the master-datasources.xml file. Change its elements with your custom values as shown above.

    Create the database tables using the following scripts.

    For the identity data Use <PRODUCT_HOME>/dbscripts/identity/informix.sql
    For data related to identity management (like service provider and identity provider data)Use <PRODUCT_HOME>/dbscripts/identity/application-mgt/informix.sql
  • No labels