Author: Adrian Nistor Level: Intermediate Technologies: Infinispan, Hot Rod, Remote Query Summary: Demonstrates how to query Infinispan remotely using the Hot Rod client. Target Product: Infinispan Product Versions: Infinispan 7.x Source: https://github.com/infinispan/jdg-quickstart
Hot Rod is a binary TCP client-server protocol used by Infinispan server. 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 Infinispan server to store, retrieve, remove and query data from cache using the Hot Rod protocol. It is a simple address book manager console application 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.
All you need to build this project is Java 7.0 (Java SDK 1.7) or newer, Maven 3.0 or newer.
The application this project produces is designed to be run on Infinispan 7.x
If you have not yet done so, you must Configure Maven before testing the quickstarts.
-
Obtain Infinispan server distribution from the Infinispan community website at http://infinispan.org/download/
-
Install a JDBC driver into Infinispan server (since Infinispan 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 Infinispan Server Guide. NOTE: Infinispan server does not support deploying applications so one cannot install it as a deployment.
-
This Quickstart uses JDBC to store the cache. To permit this, it's necessary to alter Infinispan server configuration file (
JBOSS_HOME/standalone/configuration/standalone.xml) to contain the following definitions:
-
Datasource subsystem definition:
<subsystem xmlns="urn:jboss:domain:datasources:2.0"> <!-- 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:7.0" default-cache-container="local"> <cache-container name="local" default-cache="default" statistics="true"> <local-cache name="default" start="EAGER"> <locking acquire-timeout="30000" concurrency-level="1000" striping="false"/> <transaction mode="NONE"/> </local-cache> <local-cache name="memcachedCache" start="EAGER"> <locking 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="Infinispan"> <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="Infinispan"> <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> </subsystem>
-
Open a command line and navigate to the root of the Infinispan Server directory.
-
The following shows the command line to start the server with the web profile:
For Linux: $JBOSS_HOME/bin/standalone.sh For Windows: %JBOSS_HOME%\bin\standalone.bat
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.
-
Make sure you have started the Infinispan Server as described above.
-
Open a command line and navigate to the root directory of this quickstart.
-
Type this command to build and deploy the archive:
mvn clean package -
This will create a file at
target/jboss-remote-query-quickstart.jar -
Run the example application in its directory:
mvn exec:java
Basic usage scenarios can look like this (keyboard shortcuts 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. Display all persons
6. Query persons by name
7. Query persons by phone
8. Quit
Type 8 to exit the application.
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
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
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.