Query RabbitMQ Data in ColdFusion

The CData JDBC driver for RabbitMQ seamlessly integrates connectivity to RabbitMQ data with the rapid development tools in ColdFusion. This article shows how to connect to RabbitMQ data in ColdFusion and query RabbitMQ tables.

Create a JDBC Data Source for RabbitMQ in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

   The JAR and license for the driver are located in the lib subfolder of the installation directory.

   Restart the server after this step.

2. Add the driver as a data source:

   From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

   👁 Adding a JDBC data source to ColdFusion. (Salesforce is shown.)
   

3. Populate the driver properties:

   • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:api: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

     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

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the RabbitMQ 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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     A typical JDBC URL is below:

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

   • Driver Class: Enter the driver class. The driver class is cdata.jdbc.api.APIDriver.
   • Driver Name: Enter a user-defined name for the driver.
   • Username: Enter the username used to authenticate.
   • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData RabbitMQ data source in the Actions column. After reporting a status of OK, the RabbitMQ data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to RabbitMQ. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

Note: To use the cfquery and cfscript, create a .cfm file. Inside the .cfm file, write the code to execute the query (see below). Place the file directly in the root directory of your web server (e.g., wwwroot in Adobe ColdFusion). Restart the service after placing the file for the changes to take effect.

<cfquery name="APIQuery" dataSource="CDataAPI">
 SELECT * FROM AuthAttempts WHERE NodeName = <cfqueryparam value="#NodeName#" cfsqltype="cf_sql_varchar">
</cfquery>
<cfdump var="#APIQuery#">

Below is the equivalent in CFScript:

<cfscript>
result = queryExecute(
 "SELECT * FROM AuthAttempts WHERE NodeName = ?", 
 [
 { value="rabbit@hostname", cfsqltype="cf_sql_varchar" }
 ],
 { datasource="CDataAPI" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following:

http://MyServer:8500/query.cfm?NodeName=rabbit@hostname