Build RabbitMQ-Connected Web Apps in Servoy

Servoy is a rapid application development and deployment platform. When paired with the CData API Driver for JDBC, users can build RabbitMQ-connected apps that work with live RabbitMQ data. This article describes how to connect to RabbitMQ from Servoy and build a simple web app to display and search RabbitMQ data.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live RabbitMQ data. When you issue complex SQL queries to RabbitMQ, the driver pushes supported SQL operations, like filters and aggregations, directly to RabbitMQ and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying lets you work with RabbitMQ data using native data types.

Connect to RabbitMQ in Servoy Developer

To build RabbitMQ-connected apps, you need to first create a data provider in Servoy Developer using the CData API Driver for JDBC.

1. Install the JDBC Driver.
2. Copy the JDBC Driver JAR file. (cdata.jdbc.api.jar) to the /application_server/drivers/ directory in the installation directory for Servoy.
3. Open Servoy Developer.
4. In the Solution Explorer, right-click Database Server (under Resources) and choose "Connect to existing database" -> "empty."
   1. Name the server.
   2. Click to show the advanced server settings.

      • Set the URL, for example: jdbc:api:Profile=C:\profiles\\RabbitMQ.apip;AuthScheme=Basic;URL=http://localhost:15672;User=guest;Password=guest;

        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.

        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
        
      • Select the Driver class you just copied, for example, cdata.jdbc.api.APIDriver
   

Build a RabbitMQ-Connected Web App

Once you have configured the connection to RabbitMQ in the Servoy Developer resources, you are ready to build apps with access to live RabbitMQ data.

Create a New Solution

1. In the Server Explorer, right-click "All solutions" and select "Create new solution."
2. Name the solution.
3. Select the checkbox to include the "search" module.
4. Click "Finish."

Create a New Form

Right-click "Forms" and select "Create new form."

1. Name the form.
2. Select a Datasource.
3. Set the type (e.g., Simple) and click "Finish."

Add a Data Grid to the Form

1. Drag a Data Grid component (from Servoy NG-Grids) onto the form.

2. Drag a column component onto the Data Grid and set the "dataprovider" property for each column component to a column from the RabbitMQ "table" (e.g., from the AuthAttempts table).

   Continue adding columns as desired.

Add Searching to the App

Note that the "svySearch" extension is required to add search functionality (included by default when you create a new solution). If you did not add the extension when you created the solution or you are modifying an existing solution, you can add the search module by right-clicking Modules (in the solution) and selecting "Add Module." Select "svySearch" and click "OK."

1. Drag a Text Field component onto the Form.
2. Right-click the Form and select "Open in Script Editor."
3. Create a new variable (JavaScript) to hold the search value:

   var searchText = '';
   

4. Back on the Form, in the Text Field properties:
   1. Set the "dataprovider" property to the Form variable you just created.
   2. Double-click to add a method for the onAction event.
   3. Click to create the method in "Form," name the method (e.g., onEnter), and click "Create private."
   4. Click "OK & Show."
5. Add the following JavaScript to the JavaScript file to use the Servoy framework to implement searching bound data based on the text in the Text Field:

   var search = scopes.svySearch.createSimpleSearch(foundset).setSearchText(searchText);
   search.setSearchAllColumns();
   search.loadRecords(foundset);
   

Save and Launch the App

Save the form and JavaScript file, then click Run -> Launch NGClient to start the web app.

Download a free, 30-day trial of the CData API Driver for JDBC and start building RabbitMQ-connected apps with Servoy. Reach out to our Support Team if you have any questions.