Ready to get started?

Download a free trial of the Elasticsearch Driver to get started:

 Download Now

Learn more:

Elasticsearch Icon Elasticsearch JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Elasticsearch.

Connect to Elasticsearch Data from a Connection Pool in JBoss



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

CData JDBC drivers can be configured in JBoss by following the standard procedure for connection pooling. This article details how to access Elasticsearch 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 Elasticsearch. You will then access Elasticsearch data from a connection pool.

Create a JDBC Data Source for Elasticsearch 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/Elasticsearch
  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:elasticsearch: followed by a semicolon-separated list of connection properties.

    Set the Server and Port connection properties to connect. To authenticate, set the User and Password properties, PKI (public key infrastructure) properties, or both. To use PKI, set the SSLClientCert, SSLClientCertType, SSLClientCertSubject, and SSLClientCertPassword properties.

    The data provider uses X-Pack Security for TLS/SSL and authentication. To connect over TLS/SSL, prefix the Server value with 'https://'. Note: TLS/SSL and client authentication must be enabled on X-Pack to use PKI.

    Once the data provider is connected, X-Pack will then perform user authentication and grant role permissions based on the realms you have configured.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.elasticsearch.jar

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

    A typical connection string is below:

    jdbc:elasticsearch:Server=127.0.0.1;Port=9200;User=admin;Password=123456;
  7. Test the connection and finish the wizard. Select the Elasticsearch 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.