Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Follow the instructions below to set up an embedded Derby database.

...

Table of Contents
maxLevel3
minLevel3

...

styleborder:1
locationtop
typeflat
separatorpipe

...

Preparing the Derby Database

...

Setup Configuration Files

1. Edit the registry Edit the default database configuration defined in the master-datasources.xml file  file located in the at $GREG_HOME/repository/conf directory /datasources directory of the deployed registry instance as shown below.Image Removedbelow. Both the database configurations in registry.xml and user-mgt.xml refer this data source. 

Image Added

Info
titleNote

The configurations should be replaced with your own database name, username, and password.

Code Block
 <currentDBConfig>derby-db</currentDBConfig>       <datasource>
            <name>WSO2_CARBON_DB</name>
            <description>The datasource used for registry and user manager</description>
            <jndiConfig>
                <name>jdbc/WSO2CarbonDB</name>
            </jndiConfig>
            <dbConfig<definition nametype="derby-dbRDBMS">
                <configuration>
                    <url>jdbc:derby:repository//database/WSO2CARBON_DBlocalhost:1527/db;create=true</url>
                    <userName>regadmin</userName>
                    <password>regadmin</password>
           <driverName>org         <driverClassName>org.apache.derby.jdbc.EmbeddedDriver</driverName>driverClassName>
                    <maxActive>80</maxActive>
                    <maxWait>60000</maxWait>
                    <minIdle>5</minIdle>
                    <testOnBorrow>true</testOnBorrow>
                    <validationQuery>SELECT 1</validationQuery>
                    <validationInterval>30000</validationInterval>
    </dbConfig>            </configuration>
            </definition>
        </datasource>
The database configuration options
  • url - The URL of the database.
  • userName - The name of the database user.
  • password - The password of the database user.
  • driverName driverClassName - The class name of the database driver.
  • maxActive - The maximum number of active connections that can be allocated from this pool at the same time or negative for no limit.
  • 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 or <= 0 to wait indefinitely.
  • minIdle - The minimum number of active connections that can remain idle in the pool, without extra ones being created, or 0 to create none.
Info
titleNote

In contrast to the remote registry, in embedded registry you will set the database driver name ( the driverName element) to the value org.apache.derby.jdbc.EmbeddedDriver and the database URL (the url element) to the database directory location relative to the registry installation. In the above sample configuration, it is inside the database/WSO2CARBON_DB directory.

2. Edit the user-mgt.xml file located in the $GREG_HOME/repository/conf directory of the deployed instance as below.

Image Removed

Info
titleNote

You have to replace these settings with your custom values.

Code Block

<Configuration>
        ...
        <Property name="url">jdbc:derby:repository/database/WSO2CARBON_DB;create=true</Property>
        <Property name="userName">regadmin</Property>
        <Property name="password">regadmin</Property>
        <Property name="driverName">org.apache.derby.jdbc.EmbeddedDriver</Property>
        <Property name="maxActive">50</Property>
        <Property name="maxWait">60000</Property>
        <Property name="minIdle">5</Property>
    </Configuration>

 

...

Setup Drivers

Place derby.jar, derbyclient.jar and derbynet.jar in the $GREG_HOME/repository/components/extensions directory (to the class path of the WSO2 Governance Registry web application).

...

1. The first time you start the registry, run with the -Dsetup option so it will create the Derby database.

  • For Linux:
Code Block

wso2server.sh -Dsetup

Image RemovedImage Added

  • For Windows:
Code Block

wso2server.bat -Dsetup

2. The WSO2 Governance Registry is configured to run using an embedded Apache Derby database.

...

6. Restart the WSO2 Registry instance. Now WSO2 Governance Registry is running using a remote Apache Derby database.

Excerpt
hiddentrue

Instructions on how to set up Governance Registry with embedded Derby database.