Configuring JBoss Web Server

This section describes how to configure JBoss Web Server to use the Delinea JDBC Proxy Driver with DataSource connections.

This documentation covers both XA and Non-XA DataSource configuration. Direct connections are not supported on JBoss; only DataSource connections are supported.

Available Connection Types

JBoss Server integration supports the following DataSource configurations:

  • Non-XA DataSource — For standard single database transactions (most common use case). Uses non-JTA data sources.
  • XA DataSource — For distributed transactions across multiple databases, JMS, or other resources requiring two-phase commit. Uses JTA data sources.

Key Differences Between Non-XA and XA DataSource

Aspect Non-XA DataSource XA DataSource
Transaction Type Single database (local) Distributed (2-phase commit)
DataSource Element <datasource> <xa-datasource>
Application Config Tag <non-jta-data-source> <jta-data-source>
Properties Element <connection-property> <xa-datasource-property>
XA DataSource Class Not applicable com.delinea.jdbc.DelineaXADataSource
Use Case Most applications Multiple databases/JMS resources

The server manages connection pooling for DataSource connections, which provides better performance compared to direct connections.

Before You Begin

Ensure you have completed the following:

  • Prerequisites met — Your environment meets all system requirements.
  • Delinea Platform or Secret Server configured — Service accounts or application accounts have been created.
  • Setup completed — The Setup Utility has been run successfully (see Setup). When prompted for the deployed application lib folder path, provide JBOSS_HOME/modules/com/delinea/main.
  • JBOSS_HOME environment variable — Create a JBOSS_HOME system variable in the environment variables in Windows and set the value to the path of the JBoss installation folder (e.g., C:\Users\my-user\EAP-7.2.0).

Configuration Process

Regardless of which DataSource type you choose, follow these steps:

  1. Step 1: Set up JDBC drivers as modules — Configure both native and Delinea driver modules.
  2. Step 2: Define a DataSource — Configure a Non-XA or XA DataSource in standalone.xml.
  3. Step 3: Configure the application — Update your application configuration file to reference the JNDI names.
  4. Restart JBoss Server and verify the integration.

Step 1: Set Up JDBC Drivers as Modules

Before configuring DataSources, set up the JDBC drivers as JBoss modules.

Setting Up the Native JDBC Driver Module

  1. Create folder structure for the native JDBC driver (e.g., for MySQL):

    JBOSS_HOME/modules/com/mysql/main

    JBOSS_HOME refers to the path of the JBoss installation folder on your machine.

  2. Add the native JDBC driver JAR (e.g., mysql-connector-java-8.0.28.jar) to the main directory.

  3. Create a module.xml file in the main directory:

    Copy 
    <?xml version="1.0" encoding="UTF-8"?>
                            <module xmlns="urn:jboss:module:1.1" name="com.mysql">
                            <resources>
                            <resource-root path="mysql-connector-java-8.0.28.jar"/>
                            </resources>
                            <dependencies>
                            <module name="javax.api"/>
                            <module name="javax.transaction.api"/>
                            </dependencies>
                        </module>

    The name attribute value must match the directory structure (e.g., com.mysql for com/mysql).

Creating a Module for the Delinea JDBC Driver

  1. Create the folder structure:

    JBOSS_HOME/modules/com/delinea/main

  2. Verify the Delinea driver files are present:

    The Setup Utility should have already copied Delinea-Jdbc-Proxy.jar and DelineaDriver.properties to this location when you provided the path JBOSS_HOME/modules/com/delinea/main during setup. If these files are not present, run the Setup Utility again with this path.

  3. Create a module.xml file in the main folder:

    Copy 
    <?xml version="1.0" encoding="UTF-8"?>
                            <module xmlns="urn:jboss:module:1.1" name="com.delinea">
                            <resources>
                            <resource-root path="Delinea-Jdbc-Proxy.jar"/>
                            </resources>
                            <dependencies>
                            <module name="com.mysql"/>
                            <module name="javax.api"/>
                            </dependencies>
                        </module>

    Add the native driver module (e.g., com.mysql) to the <dependencies> section so the Delinea JDBC driver module can access the native driver. In the example above, the native driver module is added for MySQL.

Step 2: Define a DataSource

Create a DataSource configuration in the standalone.xml file, located at JBOSS_HOME/standalone/configuration/standalone.xml.

Both the DataSource definitions and the driver definitions are placed inside the <datasources> section of standalone.xml.

Choose the appropriate configuration based on your transaction requirements:

Verification and Troubleshooting

For details on how to verify that the integration is functioning correctly, as well as troubleshooting information, refer to JBoss Server Integration Verification.