Connect to Sentry Data from a Connection Pool in JBoss

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Integrate Sentry data into Java servlets: Use the Management Console in JBoss to install the Sentry JDBC Driver.

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

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

    Using API Key Authentication

    Sentry uses token-based authentication. To obtain an Auth Token:

    1. Log in to your Sentry account at https://sentry.io
    2. Navigate to Settings > Auth Tokens
    3. Click "Create New Token"
    4. Select the required scopes and click "Create Token"
    5. Copy the generated token (it will only be shown once)

    After obtaining your Auth Token, set the following connection properties:

    • AuthScheme: Set this to APIKey.
    Set the following in the ProfileSettings connection property:
    • APIKey: Set this to your Sentry Auth Token.
    • OrganizationId: Set this to your Sentry organization slug or ID.

    Example Connection String

    Profile=C:\profiles\Sentry.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_auth_token;OrganizationId=your_org_slug";
    

    Connecting to Sentry

    Once the authentication is configured, you can connect to Sentry and query data from any of the available tables such as Organizations, Projects, Issues, and Events.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.api.jar
    

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

    A typical connection string is below:

    jdbc:api:Profile=C:\profiles\Sentry.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_auth_token;OrganizationId=your_org_slug";
    
  7. Test the connection and finish the wizard. Select the Sentry 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.

Ready to get started?

Connect to live data from Sentry with the API Driver

Connect to Sentry