Connect to Redis Data from a Connection Pool in JBoss

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Redis JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Redis data stores.



Integrate Redis data into Java servlets: Use the Management Console in JBoss to install the Redis JDBC Driver.

CData JDBC drivers can be configured in JBoss by following the standard procedure for connection pooling. This article details how to access Redis data from a connection pool in JBoss applications. This article details how to use the JBoss Management Interface to configure the CData JDBC Driver for Redis. You will then access Redis data from a connection pool.

Create a JDBC Data Source for Redis from the Management Console

Follow the steps below to add the driver JAR and define required connection properties.

  1. In the Runtime menu, select the Domain or Server menu, depending on whether you are deploying to a managed domain or to a stand-alone server, and click "Manage deployments" to open the Deployments page.
  2. Click Add. In the resulting wizard, add the JAR file and license for the driver, located in the lib subfolder of the installation directory. Finish the wizard with the defaults, select the driver, and click Enable.
  3. In the Configuration menu, click Subsystems -> Connector -> Datasources. This opens the JDBC Datasources page.
  4. Click Add and, in the resulting wizard, enter a name for the driver and the JNDI name. For example: java:jboss/root/jdbc/Redis
  5. Select the driver that you added above.
  6. Enter the JDBC URL and the username and password. The syntax of the JDBC URL is jdbc:redis: followed by a semicolon-separated list of connection properties.

    Set the following connection properties to connect to a Redis instance:

    • Server: Set this to the name or address of the server your Redis instance is running on. You can specify the port in Port.
    • Password: Set this to the password used to authenticate with a password-protected Redis instance , using the Redis AUTH command.

    Set UseSSL to negotiate SSL/TLS encryption when you connect.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the Redis JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.redis.jar

    Fill in the connection properties and copy the connection string to the clipboard.

    A typical connection string is below:

    jdbc:redis:Server=127.0.0.1;Port=6379;Password=myPassword;
  7. Test the connection and finish the wizard. Select the Redis data source and click Enable.

More JBoss Integration

The steps above show how to configure the driver in a simple connection pooling scenario. For more information, refer to the Data Source Management chapter in the JBoss EAP documentation.