Developer Materials

remote-query: Query JDG remotely through Hotrod

What is it?

Hot Rod is a binary TCP client-server protocol used in JBoss Data Grid. The Hot Rod protocol facilitates faster client and server interactions in comparison to other text based protocols and allows clients to make decisions about load balancing, failover and data location operations.

This quickstart demonstrates how to connect remotely to JBoss Data Grid (JDG) to store, retrieve, remove and query data from cache using the Hot Rod protocol. It contains two sample applications. One is a simple address book manager console application (AddressBookManager) that allows you to create, edit and remove Persons, manage a list of phone numbers for each Person, query and print the contents of the data grid, all using the Hot Rod based connector. The second one (SnowForecast) is similar but it focuses on continuous queries and queries with grouping and aggregation.

System requirements

All you need to build this project is Java 6.0 (Java SDK 1.6) or newer, Maven 3.0 or newer.

The application this project produces is designed to be run on JBoss Data Grid 6.6

Configure Maven

If you have not yet done so, you must Configure Maven before testing the quickstarts.

Configure JDG

  1. Obtain JDG server distribution on Red Hat's Customer Portal at https://access.redhat.com/jbossnetwork/restricted/listSoftware.html

  2. Install a JDBC driver into JDG (since JDG includes H2 by default, this step may be skipped for the scope of this example). More information can be found in the DataSource Management chapter of the Administration and Configuration Guide for JBoss Enterprise Application Platform . NOTE: JDG does not support deploying applications so one cannot install it as a deployment.

  3. This Quickstart uses JDBC to store the cache. To permit this, it's necessary to alter JDG configuration file (JDG_HOME/standalone/configuration/standalone.xml) to contain the following definitions:

  • Datasource subsystem definition:

      <subsystem xmlns="urn:jboss:domain:datasources:1.2">
          <!-- Define this Datasource with jndi name  java:jboss/datasources/ExampleDS -->
          <datasources>
              <datasource jndi-name="java:jboss/datasources/ExampleDS" pool-name="ExampleDS" enabled="true" use-java-context="true">
                  <!-- The connection URL uses H2 Database Engine with in-memory database called test -->
                  <connection-url>jdbc:h2:mem:test;DB_CLOSE_DELAY=-1</connection-url>
                  <!-- JDBC driver name -->
                  <driver>h2</driver>
                  <!-- Credentials -->
                  <security>
                      <user-name>sa</user-name>
                      <password>sa</password>
                  </security>
              </datasource>
              <!-- Define the JDBC driver called 'h2' -->
              <drivers>
                  <driver name="h2" module="com.h2database.h2">
                      <xa-datasource-class>org.h2.jdbcx.JdbcDataSource</xa-datasource-class>
                  </driver>
              </drivers>
          </datasources>
      </subsystem>
    
  • Infinispan subsystem definition:

      <subsystem xmlns="urn:infinispan:server:core:6.4" default-cache-container="local">
          <cache-container name="local" default-cache="default" statistics="true">
              <local-cache name="default" start="EAGER">
                  <locking isolation="NONE" acquire-timeout="30000" concurrency-level="1000" striping="false"/>
                  <transaction mode="NONE"/>
              </local-cache>
              <local-cache name="memcachedCache" start="EAGER">
                  <locking isolation="NONE" acquire-timeout="30000" concurrency-level="1000" striping="false"/>
                  <transaction mode="NONE"/>
              </local-cache>
              <local-cache name="namedCache" start="EAGER"/>
                
              <!-- Add a local cache named 'addressbook_indexed' -->
              <local-cache name="addressbook_indexed" start="EAGER">
    
                  <!-- Define the locking isolation of this cache -->
                  <locking
                      acquire-timeout="20000"
                      concurrency-level="500"
                      striping="false" />
                        
                  <!-- Enable indexing using the RAM Lucene directory provider -->
                  <indexing index="ALL">
                      <property name="default.directory_provider">ram</property>
                  </indexing>
                    
                  <!-- Define the JdbcBinaryCacheStores to point to the ExampleDS previously defined -->
                  <string-keyed-jdbc-store datasource="java:jboss/datasources/ExampleDS" passivation="false" preload="false" purge="false">
    
                      <!-- specifies information about database table/column names and data types -->
                      <string-keyed-table prefix="JDG">
                          <id-column name="id" type="VARCHAR"/>
                          <data-column name="datum" type="BINARY"/>
                          <timestamp-column name="version" type="BIGINT"/>
                      </string-keyed-table>
                  </string-keyed-jdbc-store>
              </local-cache>
              <!-- End of 'addressbook_indexed' cache definition -->
    
              <!-- Add a local cache named 'addressbook' which is not indexed -->
              <local-cache name="addressbook" start="EAGER">
    
                  <!-- Define the locking isolation of this cache -->
                  <locking
                      acquire-timeout="20000"
                      concurrency-level="500"
                      striping="false" />
    
                  <!-- Define the JdbcBinaryCacheStores to point to the ExampleDS previously defined -->
                  <string-keyed-jdbc-store datasource="java:jboss/datasources/ExampleDS" passivation="false" preload="false" purge="false">
    
                      <!-- specifies information about database table/column names and data types -->
                      <string-keyed-table prefix="JDG">
                          <id-column name="id" type="VARCHAR"/>
                          <data-column name="datum" type="BINARY"/>
                          <timestamp-column name="version" type="BIGINT"/>
                      </string-keyed-table>
                  </string-keyed-jdbc-store>
              </local-cache>
              <!-- End of 'addressbook' cache definition -->
    
          </cache-container>
          <cache-container name="security"/>
      </subsystem>
    

Start JDG

  1. Open a command line and navigate to the root of the JDG directory.
  2. The following shows the command line to start the server with the web profile:

     For Linux:   $JDG_HOME/bin/standalone.sh
     For Windows: %JDG_HOME%\bin\standalone.bat
    

Build and Run the Quickstart

NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See Build and Deploy the Quickstarts for complete instructions and additional options.

  1. Make sure you have started the JDG as described above.
  2. Open a command line and navigate to the root directory of this quickstart.
  3. Type this command to build and deploy the archive:

     mvn clean package 
    
  4. This will create a file at target/jboss-remote-query-quickstart.jar

  5. Run the example application in its directory:

     mvn exec:java
    

This will execute the AddressBookManager application by default. To run the SnowForecast application you will need to activate the SnowForecast profile.

    mvn exec:java -PSnowForecast

Using the application

Basic usage scenarios can look like this (keyboard actions will be shown to you upon start):

Available actions:
0. Display available actions
1. Add person
2. Remove person
3. Add phone to person
4. Remove phone from person
5. Query persons by name
6. Query persons by phone
7. Add memo
8. Query memo by author
9. Display all cache entries
10. Clear cache
11. Quit    

Type 11 to exit the application.

Run application with different classpath

It's possible to run this quickstart with different classpath (other than default created by mvn exec:java). To do this, compile quickstart with:

    mvn clean package -Pcustom-classpath -Dclasspath=/custom/classpath/directory

This will create a file at target/jboss-remote-query-quickstart.jar. Then you can run it with:

    java -jar target/jboss-remote-query-quickstart.jar

Debug the Application

If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.

mvn dependency:sources
mvn dependency:resolve -Dclassifier=javadoc

Build and Run the C++ Quickstart

Install the C++ HotRod client from source or one of the pre-built packages.

Compile and run the quickstart:

$ cd src/main/cpp
$ mkdir build_linux
$ cd build_linux
$ cmake ..
$ cmake --build .
$ ./quickstart [<host>] [<port>]

A menu similar to the Java quickstart will be displayed.

Recent Changelog

  • Jan 7, 2016(Martin Gencur):Fix readme to allow for smooth start of the server
  • Dec 3, 2015(Adrian Nistor):Add aggregations and continuous query demo
  • Dec 3, 2015(Jiri Holusa):BZ1288098 JBQA 12055 Migrate quickstarts to uberjars
  • Nov 3, 2015(Martin Gencur):Change links in readme file to use absolute path
  • Apr 17, 2015(Sebastian Laskawiec):existing hyperlink appended make link broken fixed url
  • Oct 9, 2014(Adrian Nistor):BZ1159879 Quickstarts Remote query not working
  • Nov 3, 2014(Jiri Holusa):Updated subsystem versions in README files
  • Sep 22, 2014(Jiri Holusa):ISPN 4747 Update README files in quickstarts
  • Aug 1, 2014(Martin Gencur):Further cleanup of readme files
  • Jul 31, 2014(Martin Gencur):BZ919423 Remove eviction configuration from Carmart quickstart
Avg:
Your Rating:
×