Red Hat JBoss Enterprise Application Platform Administration I

Java Database Connectivity (JDBC) is a Java API to communicate with relational databases. A JDBC driver is a component that implements the JDBC API. Java applications use the JDBC driver to perform database operations. A JDBC driver is packaged in a Java Archive (JAR) file, and contains a class file with the driver definition. JDBC drivers are available from database vendors, such as from MariaDB or PostgreSQL. To use a JDBC driver in Red Hat JBoss Enterprise Application Platform (JBoss EAP), you first need install the driver as a module on the server.

You can add the JDBC driver module manually or with the management CLI. The module add management CLI command requires the user to provide:

The syntax for the module add command is:

[disconnected /] module add \
--name=<module_name> \
--resources=<JDBC_Driver> \
--dependencies=<library1>,<library2>,...

For example, the following command in the management CLI creates the JDBC PostreSQL module by using the file postgresql-42.x.y.jar that the database vendor provides:

[disconnected /] module add \
--name=com.postgresql \
--resources=/path/to/postgresql-42.x.y.jar \
--dependencies=javaee.api,sun.jdk,ibm.jdk,javax.api,javax.transaction.api

This command creates the /opt/jboss-eap-7.4/modules/com/postgresql/main directory with the JDBC JAR file and a module.xml with the dependencies you specify in the command.

The following module.xml file defines a module for the PostgreSQL JDBC driver:

<?xml version="1.0" ?>
<module xmlns="urn:jboss:module:1.1" name="com.postgresql">
  <resources>
    <resource-root path="postgresql-42.x.y.jar"/>
  </resources>
  <dependencies>
    <module name="javaee.api"/>
    <module name="sun.jdk"/>
    <module name="ibm.jdk"/>
    <module name="javax.api"/>
    <module name="javax.transaction.api"/>
  </dependencies>
</module>

[disconnected /] module remove --name=<module_name>

After adding the driver as a module, the next step is to create a <driver> definition in the <drivers> section of the data source subsystem in the JBoss EAP configuration file.

You can use the following management CLI operation to add the <driver> definition on a standalone server:

/subsystem=datasources/jdbc-driver=<driver_name>:add\
(driver-module-name=<module_name>,driver-name=<unique_driver_name>)

In the driver definition command, the following fields are required:

For the managed domain mode, the syntax is as follows:

/profile=<profile_name>/subsystem=datasources/jdbc-driver=<
driver_name>:add\
(driver-module-name=<module_name>,driver-name=<unique_driver_name>)

For example, in a managed domain, use the following management CLI command to define the PostgresSQL driver in the default profile:

[domain@172.25.250.254 /] /profile=default/subsystem=datasources/jdbc-driver=mysql:add(\
           driver-module-name=com.postgresql,\
           driver-name=postgresql\
)

<drivers>
    <driver name="postgresql" module="com.postgresql"/>
</drivers>

After defining the <driver> in the <drivers> section of the data source subsystem, the driver is referenced by its name attribute and users can create data sources that use the driver.