Connect to RabbitMQ Data from a Connection Pool in Jetty

The CData JDBC driver for RabbitMQ is easy to integrate with Java Web applications. This article shows how to efficiently connect to RabbitMQ data in Jetty by configuring the driver for connection pooling. You will configure a JNDI resource for RabbitMQ in Jetty.

Configure the JDBC Driver for Salesforce as a JNDI Data Source

Follow the steps below to connect to Salesforce from Jetty.

1. Enable the JNDI module for your Jetty base. The following command enables JNDI from the command-line:

   java -jar ../start.jar --add-to-startd=jndi
   

2. Add the CData and license file, located in the lib subfolder of the installation directory, into the lib subfolder of the context path.

3. Declare the resource and its scope. Enter the required connection properties in the resource declaration. This example declares the RabbitMQ data source at the level of the Web app, in WEB-INF\jetty-env.xml.

   <Configure id='rabbitmqdemo' class="org.eclipse.jetty.webapp.WebAppContext">
    <New id="rabbitmqdemo" class="org.eclipse.jetty.plus.jndi.Resource">
    <Arg><Ref refid="rabbitmqdemo"/></Arg>
    <Arg>jdbc/rabbitmqdb</Arg>
    <Arg>
    <New class="cdata.jdbc.api.APIDriver">
    <Set name="url">jdbc:api:</Set>
    <Set name="Profile">C:\profiles\\RabbitMQ.apip</Set>
    <Set name="AuthScheme">Basic</Set>
    <Set name="URL">http://localhost:15672</Set>
    <Set name="User">guest</Set>
    <Set name="Password">guest</Set>
    </New>
    </Arg>
    </New>
   </Configure>
   

   About RabbitMQ Management HTTP API

   RabbitMQ is an open-source message broker that supports multiple messaging protocols. The RabbitMQ Management HTTP API provides HTTP-based access to management and monitoring data for a RabbitMQ server. The API exposes information about virtual hosts, exchanges, queues, bindings, connections, channels, consumers, users, permissions, policies, and cluster-wide statistics.

   The Management plugin must be enabled on the RabbitMQ server for the HTTP API to be available. By default, the management interface listens on port 15672.

   Using Basic Authentication

   RabbitMQ Management HTTP API uses HTTP Basic authentication. You must supply the username and password of a RabbitMQ management user.

   To enable access to the management API:

   1. Ensure the RabbitMQ Management plugin is enabled on your server (rabbitmq-plugins enable rabbitmq_management).
   2. Use an existing management user or create one with the appropriate management tag (management, policymaker, monitoring, or administrator).
   3. Note the full base URL of your RabbitMQ Management HTTP API (e.g., http://localhost:15672).

   After configuring your RabbitMQ server, set the following connection properties to connect:

   • AuthScheme: Set this to Basic.
   • URL: Set this to the base URL of your RabbitMQ Management HTTP API (e.g., http://localhost:15672).
   • User: Set this to your RabbitMQ management username (e.g., guest).
   • Password: Set this to your RabbitMQ management password.

   Example connection string:

   Profile=C:\profiles\RabbitMQ.apip;AuthScheme=Basic;URL=http://localhost:15672;User=guest;Password=guest;
   

   Available Tables

   The RabbitMQ profile provides access to the following tables:

   • Overview - Cluster-wide statistics and information about the RabbitMQ node
   • Nodes - Information about individual nodes in the RabbitMQ cluster
   • NodeMemory - Detailed memory usage breakdown for a specific cluster node
   • Connections - List of all open AMQP connections to the broker
   • Channels - List of all open AMQP channels across all connections
   • Consumers - List of all consumers registered across all queues
   • Exchanges - List of exchanges declared across all virtual hosts
   • Queues - List of queues declared across all virtual hosts
   • Bindings - List of all bindings between exchanges and queues
   • VirtualHosts - List of virtual hosts configured on the broker
   • VhostPermissions - User permissions within a specific virtual host
   • Users - List of all RabbitMQ users
   • Permissions - Permission records for all users across all virtual hosts
   • TopicPermissions - Topic-level permission records for all users
   • Policies - List of policies applied to queues and exchanges in virtual hosts
   • OperatorPolicies - List of operator policies applied to queues in virtual hosts
   • Parameters - List of component parameters (e.g., federation, shovel) per virtual host
   • GlobalParameters - List of global parameters that apply across all virtual hosts
   • VhostLimits - Resource limits configured for specific virtual hosts
   • UserLimits - Resource limits configured for specific users
   • FeatureFlags - List of feature flags and their enabled/disabled state on the node
   • DeprecatedFeatures - List of deprecated features and their usage state
   • AuthAttempts - Authentication attempt statistics for the node
   • ClusterName - The name of the RabbitMQ cluster
   • WhoAmI - Information about the currently authenticated management user
   • ExchangeBindingsSource - Bindings for which a specific exchange is the source
   • ExchangeBindingsDestination - Bindings for which a specific exchange is the destination
   • QueueBindings - Bindings for a specific queue within a virtual host

4. Configure the resource in the Web.xml:

    jdbc/rabbitmqdb
    javax.sql.DataSource
    Container
   
   

5. You can then access RabbitMQ with a lookup to java:comp/env/jdbc/rabbitmqdb:

   InitialContext ctx = new InitialContext();
   DataSource myrabbitmq = (DataSource)ctx.lookup("java:comp/env/jdbc/rabbitmqdb");
   

More Jetty Integration

The steps above show how to configure the driver in a simple connection pooling scenario. For more use cases and information, see the Working with Jetty JNDI chapter in the Jetty documentation.