Red Hat

Developer Materials

hotrod-endpoint: Use 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, and remove data from cache using the Hot Rod protocol. It is a simple Football Manager console application allows you to add and remove teams, add players to or remove players from teams, or print a list of the current teams and players using the Hot Rod based connector.

System requirements

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

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

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 on the Customer Portal at https://access.redhat.com/site/documentation/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.1">
          <!-- 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.0" default-cache-container="local">
          <cache-container name="local" default-cache="default">
              <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 called 'teams' -->
               
              <local-cache 
                  name="teams"
                  start="EAGER"
                  batching="false">
                    
                  <!-- Define the locking isolation of this cache -->
                  <locking
                      isolation="READ_COMMITTED"
                      acquire-timeout="20000"
                      concurrency-level="500"
                      striping="false" />
                        
                  <!-- Disable transactions for this cache -->
                  <transaction mode="NONE" />
                    
                  <!-- 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 local cache called 'teams' definition -->
    
          </cache-container>
      </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-hotrod-endpoint-quickstart.jar

  5. Run the example application in its directory:

     mvn exec:java
    

Using the application

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

    at  -  add a team
    ap  -  add a player to a team
    rt  -  remove a team
    rp  -  remove a player from a team
    p   -  print all teams and players
    q   -  quit

Type q one more time 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), for instance with ${infinispan-server}/client/hotrod/java classpath. To do this, compile quickstart with:

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

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

    java -jar target/jboss-hotrod-endpoint-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

Recent Changelog

  • Dec 20, 2013(Adrian Nistor):Fix generated jar name
  • Nov 5, 2013(Jiri Holusa):Added profile for custom classpath run
  • Oct 30, 2013(Martin Gencur):ISPN 3553 Remove references to AS 7.1 in the JDG quickstarts
  • Oct 8, 2013(Jiri Holusa):Added quickstart tests
  • Sep 18, 2013(Martin Gencur):Upgrade quickstarts to ISPN 6.0.0.CR1
  • Jul 11, 2013(Rafael Benevides):JDF 412 get jdf repo modifications
  • Jul 3, 2013(knakayam):Use correct namespace for Infinispan in readme files
  • Jan 21, 2013(Tristan Tarrant):BZ894081 Various micro fixes
  • Sep 6, 2012(Rafael Benevides):Put JDG Quickstart on JDF format
Avg:
Your Rating:
×