Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Getting Started Guide

Red Hat JBoss Data Grid 6.4

For use with Red Hat JBoss Data Grid 6.4.1

Misha Husnain Ali

Red Hat Engineering Content Services

Gemma Sheldon

Red Hat Engineering Content Services

Rakesh Ghatvisave

Red Hat Engineering Content Services

Abstract

This guide outlines introductory concepts and operations within Red Hat JBoss Data Grid 6.4.1

Part I. Introducing Red Hat JBoss Data Grid
Copy link

Chapter 1. Red Hat JBoss Data Grid
Copy link

Red Hat JBoss Data Grid is a distributed in-memory data grid, which provides the following capabilities:
  • Schemaless key-value store – JBoss Data Grid is a NoSQL database that provides the flexibility to store different objects without a fixed data model.
  • Grid-based data storage – JBoss Data Grid is designed to easily replicate data across multiple nodes.
  • Elastic scaling – Adding and removing nodes is simple and non-disruptive.
  • Multiple access protocols – It is easy to access the data grid using REST, Memcached, Hot Rod, or simple map-like API.
Report a bug

1.1. Supported Configurations
Copy link

The set of supported features, configurations, and integrations for Red Hat JBoss Data Grid (current and past versions) are available at the Supported Configurations page at https://access.redhat.com/articles/115883.
Report a bug

1.2. Components and Versions
Copy link

Red Hat JBoss Data Grid includes many components for Library and Remote Client-Server modes. A comprehensive (and up to date) list of components included in each of these usage modes and their versions is available in the Red Hat JBoss Data Grid Component Details page at https://access.redhat.com/articles/488833
Report a bug

1.3. Red Hat JBoss Data Grid Usage Modes
Copy link

Red Hat JBoss Data Grid offers two usage modes:
  • Remote Client-Server mode
  • Library mode
Report a bug

1.3.1. Remote Client-Server Mode
Copy link

Remote Client-Server mode provides a managed, distributed, and clusterable data grid server. Applications can remotely access the data grid server using Hot Rod, Memcached or REST client APIs.
All Red Hat JBoss Data Grid operations in Remote Client-Server mode are non-transactional. As a result, a number of features cannot be performed when running JBoss Data Grid in Remote Client-Server mode.
There are a number of benefits to running JBoss Data Grid in Remote Client-Server mode if Library mode features are not required. Remote Client-Server mode is client language agnostic, provided there is a client library for your chosen protocol. As a result, Remote Client-Server mode provides:
  • easier scaling of the data grid.
  • easier upgrades of the data grid without impact on client applications.
Run the following commands to start JBoss Data Grid in Remote Client-Server mode.
For Linux: 
$JBOSS_HOME/bin/standalone.sh
Copy to Clipboard Toggle word wrap
For Windows: 
$JBOSS_HOME\bin\standalone.bat
Copy to Clipboard Toggle word wrap
Report a bug

1.3.2. Library Mode
Copy link

Library mode allows building and deploying a custom runtime environment. The Library mode hosts a single data grid node in the applications process, with remote access to nodes hosted in other JVMs. Tested containers for Red Hat JBoss Data Grid 6 Library mode includes Red Hat JBoss Enterprise Web Server 2.x and JBoss Enterprise Application Platform 6.x.
A number of features in JBoss Data Grid can be used in Library mode, but not Remote Client-Server mode.
The following features require Library mode:
  • transactions
  • listeners and notifications
JBoss Data Grid can also be run as a standalone application in Java SE. Standalone mode is a supported alternative to running JBoss Data Grid in a container.
Report a bug

1.4. Red Hat JBoss Data Grid Benefits
Copy link

Red Hat JBoss Data Grid provides the following benefits:

Benefits of JBoss Data Grid

Performance
Accessing objects from local memory is faster than accessing objects from remote data stores (such as a database). JBoss Data Grid provides an efficient way to store in-memory objects coming from a slower data source, resulting in faster performance than a remote data store. JBoss Data Grid also offers optimization for both clustered and non clustered caches to further improve performance.
Consistency
Storing data in a cache carries the inherent risk: at the time it is accessed, the data may be outdated (stale). To address this risk, JBoss Data Grid uses mechanisms such as cache invalidation and expiration to remove stale data entries from the cache. Additionally, JBoss Data Grid supports JTA, distributed (XA) and two-phase commit transactions along with transaction recovery and a version API to remove or replace data according to saved versions.
Massive Heap and High Availability
In JBoss Data Grid, applications no longer need to delegate the majority of their data lookup processes to a large single server database for performance benefits. JBoss Data Grid employs techniques such as replication and distribution to completely remove the bottleneck that exists in the majority of current enterprise applications.

Example 1.1. Massive Heap and High Availability Example

In a sample grid with 16 blade servers, each node has 2 GB storage space dedicated for a replicated cache. In this case, all the data in the grid is copies of the 2 GB data. In contrast, using a distributed grid (assuming the requirement of one copy per data item, resulting in the capacity of the overall heap being divided by two) the resulting memory backed virtual heap contains 16 GB data. This data can now be effectively accessed from anywhere in the grid. In case of a server failure, the grid promptly creates new copies of the lost data and places them on operational servers in the grid.
Scalability
A significant benefit of a distributed data grid over a replicated clustered cache is that a data grid is scalable in terms of both capacity and performance. Add a node to JBoss Data Grid to increase throughput and capacity for the entire grid. JBoss Data Grid uses a consistent hashing algorithm that limits the impact of adding or removing a node to a subset of the nodes instead of every node in the grid.
Due to the even distribution of data in JBoss Data Grid, the only upper limit for the size of the grid is the group communication on the network. The network's group communication is minimal and restricted only to the discovery of new nodes. Nodes are permitted by all data access patterns to communicate directly via peer-to-peer connections, facilitating further improved scalability. JBoss Data Grid clusters can be scaled up or down in real time without requiring an infrastructure restart. The result of the real time application of changes in scaling policies results in an exceptionally flexible environment.
Data Distribution
JBoss Data Grid uses consistent hash algorithms to determine the locations for keys in clusters. Benefits associated with consistent hashing include:
  • cost effectiveness.
  • speed.
  • deterministic location of keys with no requirements for further metadata or network traffic.
Data distribution ensures that sufficient copies exist within the cluster to provide durability and fault tolerance, while not an abundance of copies, which would reduce the environment's scalability.
Persistence
JBoss Data Grid exposes a CacheStore interface and several high-performance implementations, including the JDBC Cache stores and file system based cache stores. Cache stores can be used to populate the cache when it starts and to ensure that the relevant data remains safe from corruption. The cache store also overflows data to the disk when required to prevent running out of memory.
Language bindings
JBoss Data Grid supports both the popular Memcached protocol, with existing clients for a large number of popular programming languages, as well as an optimized JBoss Data Grid specific protocol called Hot Rod. As a result, instead of being restricted to Java, JBoss Data Grid can be used for any major website or application. Additionally, remote caches can be accessed using the HTTP protocol via a RESTful API.
Management
In a grid environment of several hundred or more servers, management is an important feature. JBoss Operations Network, the enterprise network management software, is the best tool to manage multiple JBoss Data Grid instances. JBoss Operations Network's features allow easy and effective monitoring of the Cache Manager and cache instances.
Remote Data Grids
Rather than scale up the entire application server architecture to scale up your data grid, JBoss Data Grid provides a Remote Client-Server mode which allows the data grid infrastructure to be upgraded independently from the application server architecture. Additionally, the data grid server can be assigned different resources than the application server and also allow independent data grid upgrades and application redeployment within the data grid.
Report a bug

1.5. Red Hat JBoss Data Grid Version Information
Copy link

Red Hat JBoss Data Grid is based on Infinispan, the open source community version of the data grid software. Infinispan uses code, designs, and ideas from JBoss Cache, which have been tried, tested, and proved in high stress environments. As a result, JBoss Data Grid's first release is version 6.0 as a result of its deployment history.
The following table lists the correlation between JBoss Data Grid and Infinispan versions.
Expand
Table 1.1. JBoss Data Grid and Infinispan Correlation
JBoss Data Grid Product Infinispan Version
JBoss Data Grid 6.0.0 Infinispan 5.1.5
JBoss Data Grid 6.0.1 Infinispan 5.1.7
JBoss Data Grid 6.1.0 Infinispan 5.2.4
JBoss Data Grid 6.2.0 Infinispan 6.0.1
JBoss Data Grid 6.3.0 Infinispan 6.1.0
JBoss Data Grid 6.3.1 Infinispan 6.1.1
JBoss Data Grid 6.4.0 Infinispan 6.2.0

Note

From Red Hat JBoss Data Grid 6.2.0 onwards, there is no direct corresponding version of Infinispan for each JBoss Data Grid release. The Infinispan version provided for JBoss Data Grid 6.3.0 and later are based on an internal version number (possibly an unreleased version) of Infinispan.
Report a bug

1.6. Red Hat JBoss Data Grid Cache Architecture
Copy link

Red Hat JBoss Data Grid Cache Architecture Diagram
View larger image
Red Hat JBoss Data Grid Cache Architecture Diagram

Figure 1.1. Red Hat JBoss Data Grid Cache Architecture

Red Hat JBoss Data Grid's cache infrastructure depicts the individual elements and their interaction with each other in each JBoss Data Grid Usage Mode (Library and Remote Client-Server). For clarity, each cache architecture diagram is separated into two parts:
  • Elements that a user cannot directly interact with are depicted within a dark grey box in the diagram. In Remote Client-Server mode, this includes Persistent Store, Cache, Cache Manager, L1 Cache, and Server Module. In Library mode, user cannot directly interact with Persistent Store and L1 Cache.
  • Elements that a user can interact directly with are depicted in a light grey box in the diagram. In Remote Client-Server mode, this includes the Application and the Cache Client. In Library mode, users are allowed to interact with the Cache and Cache Manager, as well as the Application.
Cache Architecture Elements

JBoss Data Grid's cache architecture includes the following elements:

  1. The Persistent Store is an optional component. It can permanently store the cached entries for restoration after a data grid shutdown.
  2. The Level 1 Cache (or L1 Cache) stores remote cache entries after they are initially accessed, preventing unnecessary remote fetch operations for each subsequent use of the same entries.
  3. The Cache Manager controls the life cycle of Cache instances and can store and retrieve them when required.
  4. The Cache is the main component for storage and retrieval of the key-value entries.
Library and Remote Client-Server Mode Architecture

In Library mode, the Application (user code) can interact with the Cache and Cache Manager components directly. In this case the Application resides in the same Java Virtual Machine (JVM) and can call Cache and Cache Manager Java API methods directly.

In Remote Client-Server mode, the Application does not directly interact with the cache. Additionally, the Application usually resides in a different JVM, on different physical host, or does not need to be a Java Application. In this case, the Application uses a Cache Client that communicates with a remote JBoss Data Grid Server over the network using one of the supported protocols such as Memcached, Hot Rod, or REST. The appropriate server module handles the communication on the server side. When a request is sent to the server remotely, it translates the protocol back to the concrete operations performed on the cache component to store and retrieve data.
Report a bug

1.7. Red Hat JBoss Data Grid APIs
Copy link

Red Hat JBoss Data Grid provides the following programmable APIs:
  • Cache
  • Batching
  • Grouping
  • Persistence (formerly CacheStore)
  • ConfigurationBuilder
  • Externalizable
  • Notification (also known as the Listener API because it deals with Notifications and Listeners)
JBoss Data Grid offers the following APIs to interact with the data grid in Remote Client-Server mode:
  • The Asynchronous API (can only be used in conjunction with the Hot Rod Client in Remote Client-Server Mode)
  • The REST Interface
  • The Memcached Interface
  • The Hot Rod Interface
    • The RemoteCache API
Report a bug

Chapter 2. Download Red Hat JBoss Data Grid
Copy link

The only prerequisite to set up Red Hat JBoss Data Grid is an installed Java Virtual Machine (compatible with Java 6.0 or later).
Report a bug

2.2. Java Virtual Machine
Copy link

A Java Virtual Machine (JVM) is a virtual environment that runs and executes Java programs on a host operating system. The JVM acts as an abstract computer and is a platform-independent execution environment that converts the Java programming code into machine language. A Java Virtual Machine (JVM) makes Java portable by providing an abstraction layer between the compiled Java program and the underlying hardware platform and operating system.
Red Hat recommends using OpenJDK Java platform as it is an open source, supported Java Virtual Machine that runs well on Red Hat Enterprise Linux systems. For Windows users, Oracle JDK 1.6 installation is recommended.
Report a bug

2.3. Install OpenJDK on Red Hat Enterprise Linux
Copy link

Procedure 2.1. Install OpenJDK on Red Hat Enterprise Linux

  1. Subscribe to the Base Channel

    Obtain the OpenJDK from the RHN base channel. Your installation of Red Hat Enterprise Linux is subscribed to this channel by default.

  2. Install the Package

    Use the yum utility to install OpenJDK: 
    $ sudo yum install java-1.6.0-openjdk-devel
    Copy to Clipboard Toggle word wrap

  3. Verify that OpenJDK is the System Default

    Ensure that the correct JDK is set as the system default as follows:
    1. Log in as a user with root privileges and run the alternatives command: 
      $ /usr/sbin/alternatives --config java
      Copy to Clipboard Toggle word wrap
    2. Depending on the OpenJDK version, select /usr/lib/jvm/jre-1.6.0-openjdk.x86_64/bin/java or /usr/lib/jvm/jre-1.7.0-openjdk.x86_64/bin/java.
    3. Use the following command to set javac: 
      $ /usr/sbin/alternatives --config javac
      Copy to Clipboard Toggle word wrap
    4. Depending on the OpenJDK version used, select /usr/lib/jvm/java-1.6.0-openjdk/bin/java or /usr/lib/jvm/java-1.7.0-openjdk/bin/java.
Report a bug

2.4. Download and Install JBoss Data Grid
Copy link

Use the following steps to download and install Red Hat JBoss Data Grid:
  1. Download JBoss Data Grid from the Red Hat Customer Portal.
  2. Verify the downloaded files.
  3. Install JBoss Data Grid.
Report a bug

2.4.1. Download Red Hat JBoss Data Grid
Copy link

Follow the listed steps to download Red Hat JBoss Data Grid from the Customer Portal:

Procedure 2.2. Download JBoss Data Grid

  1. Log into the Customer Portal at https://access.redhat.com.
  2. Click the Downloads button near the top of the page.
  3. In the Product Downloads page, click Red Hat JBoss Data Grid.
  4. Select the appropriate JBoss Data Grid version from the Version: drop down menu.
  5. Download the appropriate files from the list that displays.
Report a bug

2.4.2. About the Red Hat Customer Portal
Copy link

The Red Hat Customer Portal is the centralized platform for Red Hat knowledge and subscription resources. Use the Red Hat Customer Portal to do the following:
  • Manage and maintain Red Hat entitlements and support contracts.
  • Download officially-supported software.
  • Access product documentation and the Red Hat Knowledgebase.
  • Contact Global Support Services.
  • File bugs against Red Hat products.
The Customer Portal is available here: https://access.redhat.com.
Report a bug

2.4.3. Checksum Validation
Copy link

Checksum validation is used to ensure a downloaded file has not been corrupted. Checksum validation employs algorithms that compute a fixed-size datum (or checksum) from an arbitrary block of digital data. If two parties compute a checksum of a particular file using the same algorithm, the results will be identical. Therefore, when computing the checksum of a downloaded file using the same algorithm as the supplier, if the checksums match, the integrity of the file is confirmed. If there is a discrepancy, the file has been corrupted in the download process.
Report a bug

2.4.4. Verify the Downloaded File
Copy link

Procedure 2.3. Verify the Downloaded File

  1. To verify that a file downloaded from the Red Hat Customer Portal is error-free, access the portal site and go to that package's Software Details page. The Software Details page displays the MD5 and SHA256 "checksum" values. Use the checksum values to check the integrity of the file.
  2. Open a terminal window and run either the md5sum or sha256sum command, with the downloaded file as an argument. The program displays the checksum value for the file as the output for the command.
  3. Compare the checksum value returned by the command to the corresponding value displayed on the Software Details page for the file.

    Note

    Microsoft Windows does not come equipped with a checksum tool. Windows operating system users have to download a third-party product instead.
Result

If the two checksum values are identical then the file has not been altered or corrupted and is, therefore, safe to use.

If the two checksum values are not identical, then download the file again. A difference between the checksum values means that the file has either been corrupted during download or has been modified since it was uploaded to the server. If, after several downloads, the checksum will still not successfully validate, contact Red Hat Support for assistance.
Report a bug

2.4.5. Install Red Hat JBoss Data Grid
Copy link

Prerequisite

Locate the appropriate version, platform, and file type and download Red Hat JBoss Data Grid from the Customer Portal.

Procedure 2.4. Install JBoss Data Grid

  1. Copy the downloaded JBoss Data Grid package to the preferred location on your machine.
  2. Run the following command to extract the downloaded JBoss Data Grid package: 
    $ unzip JDG_PACKAGE
    Copy to Clipboard Toggle word wrap
    Replace JDG_PACKAGE with the name of the JBoss Data Grid usage mode package downloaded from the Red Hat Customer Portal.
  3. The resulting unzipped directory will now be referred to as $JDG_HOME.
Report a bug

2.4.6. Red Hat Documentation Site
Copy link

Red Hat's official documentation site is available at https://access.redhat.com/site/documentation/. There you will find the latest version of every book, including this one.
Report a bug

Chapter 3. Install and Use the Maven Repositories
Copy link

3.1. About Maven
Copy link

Apache Maven is a distributed build automation tool used in Java application development to create, manage, and build software projects. Maven uses standard configuration files called Project Object Model (POM) files to define projects and manage the build process. POM files describe the module and component dependencies, build order, and targets for the resulting project packaging and output using an XML file. This ensures that the project is built correctly and in a uniform manner.

Important

Red Hat JBoss Data Grid requires Maven 3 (or better) for all quickstarts and general use.
Visit the Maven Download page (http://maven.apache.org/download.html) for instructions to download and install Maven.
Report a bug

3.2. Required Maven Repositories
Copy link

Red Hat JBoss Data Grid Quickstarts require the following Maven repositories to be set up as a prerequisite:
Both Maven repositories are installed in the same way. As a result, the subsequent instructions are for both repositories.
Report a bug

3.3. Install the Maven Repository
Copy link

There are three ways to install the required repositories:
  1. On your local file system (Section 3.3.1, “Local File System Repository Installation”).
  2. On Apache Web Server.
  3. With a Maven repository manager (Section 3.3.2, “Maven Repository Manager Installation”).
Use the option that best suits your environment.
Report a bug

3.3.1. Local File System Repository Installation
Copy link

This option is best suited for initial testing in a small team. Follow the outlined procedure to extract the Red Hat JBoss Data Grid and JBoss Enterprise Application Platform Maven repositories to a directory in your local file system:

Procedure 3.1. Local File System Repository Installation (JBoss Data Grid)

  1. Log Into the Customer Portal

    In a browser window, navigate to the Customer Portal page (https://access.redhat.com/home) and log in.

  2. Download the JBoss Data Grid Repository File

    Download the jboss-datagrid-{VERSION}-maven-repository.zip file from the Red Hat Customer Portal.
  3. Unzip the file to a directory on your local file system (for example $JDG_HOME/projects/maven-repositories/).
Report a bug

3.3.2. Maven Repository Manager Installation
Copy link

This option is ideal if you are already using a repository manager.
The Red Hat JBoss Data Grid and JBoss Enterprise Application Server repositories are installed using a Maven repository manager using its documentation. Examples of such repository managers are:
Report a bug

3.4. Configure the Maven Repository
Copy link

To configure the installed Red Hat JBoss Data Grid Maven repository, edit the settings.xml file. The default version of this file is available in the conf directory of your Maven installation.
Maven user settings are located in the .m2 sub-directory of the user's home directory. See http://maven.apache.org/settings.html (the Maven documentation) for more information about configuring Maven.
See Section B.2, “Maven Repository Configuration Example” to view a sample Maven configuration.
Report a bug

3.4.1. Next Steps
Copy link

After the newest available version of Red Hat JBoss Data Grid is installed and Maven is set up and configured, see Section 9.1, “Create a New Red Hat JBoss Data Grid Project” to learn how to use JBoss Data Grid for the first time.
Report a bug
Red Hat JBoss Data Grid can be used in the following runtimes:
  • Java SE, started by your application.
  • As a standalone JBoss Data Grid server.
  • Bundled as a library in your application, deployed to an application server, and started by your application. For example, JBoss Data Grid can be used with Tomcat or Weblogic.
  • Inside an OSGi runtime environment, in this case, Apache Karaf.
For a list of containers supported with Red Hat JBoss Data Grid, see the Release Notes or the support information here: https://access.redhat.com/knowledge/articles/115883
Report a bug
Red Hat JBoss Data Grid provides a set of modules for Red Hat JBoss Enterprise Application Platform 6.x. Using these modules means that JBoss Data Grid libraries do not need to be included in the user deployment. To avoid conflicts with the Infinispan modules that are already included with JBoss EAP, the JBoss Data Grid modules are placed within a separate slot and identified by the JBoss Data Grid version (major.minor).

Note

The JBoss EAP modules are not included in JBoss EAP. Instead, navigate to the Customer Support Portal at http://access.redhat.com to download these modules from the Red Hat JBoss Data Grid downloads page.
To deploy JBoss Data Grid in JBoss EAP, add dependencies from the JBoss Data Grid module to the application's classpath (the JBoss EAP deployer) in one of the following ways:
  • Add a dependency to the jboss-deployment-structure.xml file.
  • Add a dependency to the MANIFEST.MF file.
  • Generate the MANIFEST.MF file via Maven.
Add a Dependency to the jboss-deployment-structure.xml File

Add the following configuration to the jboss-deployment-structure.xml file: 

<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.2">
    <deployment>
        <dependencies>
            <module name="org.infinispan" slot="jdg-6.4" services="export"/>
        </dependencies>
    </deployment>
</jboss-deployment-structure>
Copy to Clipboard Toggle word wrap

Note

For details about the jboss-deployment-structure.xml file, see the Red Hat JBoss Enterprise Application Platform documentation.
Add a Dependency to the MANIFEST.MF File.

Add a dependency to the MANIFEST.MF files as follows:

Example 4.1. Example MANIFEST.MF File

Manifest-Version: 1.0
Dependencies: org.infinispan:jdg-6.4 services
Copy to Clipboard Toggle word wrap
The first line remains the same as the example. Depending on the dependency required, add one of the following to the second line of the file:
  • JBoss Data Grid Core: 
    Dependencies: org.infinispan:jdg-6.4 services
    Copy to Clipboard Toggle word wrap
  • Embedded Query: 
    Dependencies: org.infinispan:jdg-6.4 services, org.infinispan.query:jdg-6.4 services
    Copy to Clipboard Toggle word wrap
  • JDBC Cache Store: 
    Dependencies: org.infinispan:jdg-6.4 services, org.infinispan.persistence.jdbc:jdg-6.4 services
    Copy to Clipboard Toggle word wrap
  • JPA Cache Store: 
    Dependencies: org.infinispan:jdg-6.4 services, org.infinispan.persistence.jpa:jdg-6.4 services
    Copy to Clipboard Toggle word wrap
  • LevelDB Cache Store: 
    Dependencies: org.infinispan:jdg-6.4 services, org.infinispan.persistence.leveldb:jdg-6.4 services
    Copy to Clipboard Toggle word wrap
  • CDI: 
    Dependencies: org.infinispan:jdg-6.4 services, org.infinispan.cdi:jdg-6.4 meta-inf
    Copy to Clipboard Toggle word wrap
Generate the MANIFEST.MF file via Maven

The MANIFEST.MF file is generated during the build (specifically during the JAR or WAR process). As an alternative to adding a dependency to the MANIFEST.MF file, configure the dependency directly in Maven by adding the following to the pom.xml file: 

<plugin>
	<artifactId>maven-war-plugin</artifactId>
	<version>2.4</version>
	<configuration>
		<failOnMissingWebXml>false</failOnMissingWebXml>
		<archive>
			<manifestEntries>
				<Dependencies>org.infinispan:jdg-6.4 services</Dependencies>
			</manifestEntries>
		</archive>
	</configuration>
</plugin>
Copy to Clipboard Toggle word wrap
Report a bug
Red Hat JBoss Data Grid provides a set of modules for Red Hat JBoss Enterprise Application Platform 6.x. Using these modules means that JBoss Data Grid libraries do not need to be included in the user deployment. To avoid conflicts with the Infinispan modules that are already included with JBoss EAP, the JBoss Data Grid modules are placed within a separate slot and identified by the JBoss Data Grid version (major.minor).

Note

The JBoss EAP modules are not included in JBoss EAP. Instead, navigate to the Customer Support Portal at http://access.redhat.com to download these modules from the Red Hat JBoss Data Grid downloads page.
To deploy JBoss Data grid in JBoss EAP, add dependencies from the JBoss Data Grid module to the application's classpath (the JBoss EAP deployer) in one of the following ways:
  • Add a dependency to the jboss-deployment-structure.xml file.
  • Add a dependency to the MANIFEST.MF file.
Add a Dependency to the jboss-deployment-structure.xml File

Add the following configuration to the jboss-deployment-structure.xml file: 

<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.2">
    <deployment>
        <dependencies>
            <module name="org.infinispan.commons" slot="jdg-6.4" services="export"/>
            <module name="org.infinispan.client.hotrod" slot="jdg-6.4" services="export"/>
        </dependencies>
    </deployment>
</jboss-deployment-structure>
Copy to Clipboard Toggle word wrap

Note

For details about the jboss-deployment-structure.xml file, see the Red Hat JBoss Enterprise Application Platform documentation.
Add a Dependency to the MANIFEST.MF File.

Add a dependency to the MANIFEST.MF files as follows:

Example 4.2. Example MANIFEST.MF File

Manifest-Version: 1.0
Dependencies: org.infinispan.commons:jdg-6.4 services, org.infinispan.client.hotrod:jdg-6.4 services
Copy to Clipboard Toggle word wrap
The first line remains the same as the example. Depending on the dependency required, add one of the following to the second line of the file:
  • Basic Hot Rod client: 
    org.infinispan.commons:jdg-6.4 services, org.infinispan.client.hotrod:jdg-6.4 services
    Copy to Clipboard Toggle word wrap
  • Hot Rod client with Remote Query functionality: 
    org.infinispan.commons:jdg-6.4 services, org.infinispan.client.hotrod:jdg-6.4 services, org.infinispan.query.dsl:jdg-6.4 services, org.jboss.remoting3
    Copy to Clipboard Toggle word wrap
Report a bug
Red Hat JBoss Data Grid supports JBoss Enterprise Web Server in Library and Remote Client Server mode. To use JBoss Data Grid with JBoss Enterprise Web Server, bundle the JDG libraries in a web application and deploy the application on the server.
For further information on how to deploy JBoss Data Grid on JBoss Enterprise Web Server, see ( Section 14.4, “The (Non-transactional) CarMart Quickstart Using JBoss Enterprise Web Server” and Section 14.6, “The (Non-Transactional) CarMart Quickstart in Remote Client-Server Mode (JBoss Enterprise Web Server)”.
Report a bug
Red Hat JBoss Data Grid supports the WebLogic 12c application server in Library mode. The following procedure describes how to deploy web applications on a WebLogic server.
Prerequisites

The prerequisites to deploy the web applications are as follows:

  1. WebLogic Server 12c.
  2. JBoss Data Grid Library (Embedded) mode.

Procedure 4.1. Deploying Web Applications on a WebLogic Server

  1. Create Web Applications

    Create a web application and add the libraries in the WEB-INF folder.

  2. Create a weblogic.xml Deployment Descriptor

    Create a weblogic.xml deployment descriptor with the following elements in it: 
    <?xml version="1.0" encoding="UTF-8"?>
<weblogic-web-app
        xmlns="http://www.bea.com/ns/weblogic/90"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://www.bea.com/ns/weblogic/90 http://www.bea.com/ns/weblogic/90/weblogic-web-app.xsd">
    <container-descriptor>
        <prefer-web-inf-classes>true</prefer-web-inf-classes>
    </container-descriptor>
</weblogic-web-app>
    Copy to Clipboard Toggle word wrap

    Note

    The prefer-web-inf-classes class indicates that the libraries and the classes in the WEB-INF/lib folder is preferred over the default libraries bundled in the WebLogic server. For example, the commons-pool.jar file in the WebLogic server has version 1.4 and is automatically loaded by the classloader, but the Hot Rod client uses a newer version of this library.

  3. Pack the Web Application into a Web Archive File

    Create a web application archive (WAR) file of the web application and verify that the JBoss Data Grid libraries are in the WEB-INF folder along with the WebLogic deployment descriptor file.

  4. Deploy the Application onto WebLogic Server

    To deploy the web application using the Infinispan CDI module, stop the WebLogic server if it is running, apply the patch on it (Patch file p17424706_121200_Generic.zip) and restart the WebLogic server. If the Infinispan CDI module is not being used, deploy the web application normally.
    For more information about applying patch to the WebLogic Server, see the Oracle patch database on the Oracle website.
Report a bug
Red Hat JBoss Data Grid supports the WebLogic 12c application server in Remote Client-Server mode. The following procedure describes how to deploy web applications on a WebLogic server.

Procedure 4.2. Deploying Web Applications on a WebLogic Server

  1. To install the WebLogic server, see http://docs.oracle.com/cd/E24329_01/doc.1211/e24492/toc.htm.
  2. Configure JBoss Data Grid in Remote Client-Server mode, define cache, cache container, and endpoint configuration. After configuration, start JBoss Data Grid to confirm that the Hot Rod endpoint is listening on the configured port. For information about configuring JBoss Data Grid in Remote Client-Server, see Chapter 7, Run Red Hat JBoss Data Grid in Remote Client-Server Mode.
  3. Create a web application and add the infinispan-remote library as a dependency if Maven is used.
  4. Create a weblogic.xml deployment descriptor with the following elements in it: 
    <?xml version="1.0" encoding="UTF-8"?>
<weblogic-web-app
        xmlns="http://www.bea.com/ns/weblogic/90"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://www.bea.com/ns/weblogic/90 http://www.bea.com/ns/weblogic/90/weblogic-web-app.xsd">
    <container-descriptor>
        <prefer-web-inf-classes>true</prefer-web-inf-classes>
    </container-descriptor>
</weblogic-web-app>
    Copy to Clipboard Toggle word wrap

    Note

    The prefer-web-inf-classes class indicates that the libraries and classes in the WEB-INF/lib folder are preferred over the default libraries bundled in the WebLogic server. For example, the commons-pool.jar file in the WebLogic server has version 1.4 and is automatically loaded by the classloader, however the Hot Rod client uses a newer version of this library.
  5. Add deployment descriptor file in the WEB-INF folder.
  6. Ensure that the infinispan-remote dependency is added to the pom.xml file, then use a Maven plugin to create a web archive.
    Alternatively, create the web archive manually and add the library manually.
  7. Deploy the application in the WebLogic server and verify that the Hot Rod client embedded inside the web application connects to the remote JBoss Data Grid server.
Report a bug
Apache Karaf is a powerful, lightweight OSGi-based runtime container into which components and applications are deployed. OSGi implements a dynamic component model that does not exist in standalone JVM environments. OSGi containers such as Karaf include a rich set of tools for managing the life cycle of an application.
All dependencies between individual modules, including version numbers, must be explicitly specified. Where more than one class of the same name exists, the strict rules of OSGi specify which of the classes will be used by your bundle.
Report a bug
The Red Hat JBoss Data Grid Hot Rod client can be run in an OSGi-based container such as Karaf.
Use the path in the JBoss Data Grid Maven repository to set up Karaf. Additionally, JBoss Data Grid requires a features file, located in org/infinispan/infinispan-remote/${VERSION}. This file lists all dependencies for the Hot Rod client in OSGi, while also making it simpler to install the feature into Karaf (version 2.3.3 or 3.0).
Report a bug
Red Hat JBoss Data Grid's Hot Rod feature is installed in Karaf as follows:
Prerequisite

Configure the Red Hat JBoss Data Grid Maven Repository.

Procedure 4.3. Install the Hot Rod Feature in Karaf

  1. Karaf 2.3.3

    For Karaf 2.3.3 use the following commands: 
    1. karaf@root> features:addUrl mvn:org.infinispan/infinispan-remote/${VERSION}/xml/features
      Copy to Clipboard Toggle word wrap 
    2. karaf@root> features:install infinispan-remote
      Copy to Clipboard Toggle word wrap
    3. Verify that the feature was successfully installed as follows: 
      karaf@root> features:list
 //output
      Copy to Clipboard Toggle word wrap

  2. Karaf 3.0.0

    For Karaf use the following commands. 
    1. karaf@root> feature:repo-add mvn:org.infinispan/infinispan-remote/${VERSION}/xml/features
      Copy to Clipboard Toggle word wrap 
    2. karaf@root> feature:install infinispan-remote
      Copy to Clipboard Toggle word wrap
    3. Verify that the feature was successfully installed: 
      karaf@root> feature:list
      Copy to Clipboard Toggle word wrap
    Alternatively, use the -i command parameter to install the Hot Rod Client feature using the following: 
    karaf@root()> feature:repo-add -i mvn:org.infinispan/infinispan-remote/${VERSION}/xml/features
    Copy to Clipboard Toggle word wrap
Report a bug
The Red Hat JBoss Data Grid JAR files contain the required OSGi manifest headers and are used inside OSGi runtime environments as OSGi bundles. Additionally, the required third-party dependencies must be installed. These can be installed individually, or altogether via the features file, which defines all required dependencies.
To install bundles using the features file:
  • Register the feature repositories inside Karaf.
  • Install the features contained in the repositories.

Procedure 4.4. Installing bundles using the features file

  1. Start the Karaf console

    Start the Karaf console using the following commands: 
    $ cd $APACHE_KARAF_HOME/bin
$ ./karaf
    Copy to Clipboard Toggle word wrap

  2. Register a feature repository

    Register a feature repository as follows:
    • For Karaf 2.3.3: 
      karaf@root()> features:addUrl mvn:org.infinispan/infinispan-embedded/${VERSION}/xml/features
      Copy to Clipboard Toggle word wrap 
      karaf@root> features:install infinispan-embedded
      Copy to Clipboard Toggle word wrap
    • For Karaf 3.0.0: 
      karaf@root()> feature:repo-add mvn:org.infinispan/infinispan-embedded/${VERSION}/xml/features
      Copy to Clipboard Toggle word wrap 
      karaf@root> feature:install infinispan-embedded
      Copy to Clipboard Toggle word wrap
Result

JBoss Data Grid runs in library mode using Karaf.

The URL for feature repositories is constructed from the Maven artifact coordinates using the following format: 
mvn:<groupId>/<artifactId>/<version>/xml/features
Copy to Clipboard Toggle word wrap

Important

The JPA Cache Store is not supported in Apache Karaf in JBoss Data Grid 6.4.

Important

Querying in Library mode (which is covered in the Infinispan Query Guide) is not supported in Apache Karaf in JBoss Data Grid 6.4.
Report a bug
Apache Camel is an open source integration and routing system that allows transference of messages from various sources to different destinations, providing an integration framework that allows interaction with various systems using the same API, regardless of the protocol or data type. Using Camel with Red Hat JBoss Data Grid and Red Hat JBoss Fuse simplifies integration in large enterprise applications by providing a wide variety of transports and APIs that add connectivity.
JBoss Data Grid provides support for caching on Camel routes in JBoss Fuse, partially replacing Ehcache. JBoss Data Grid is supported as an embedded cache (local or clustered) or as a remote cache in a Camel route.
Report a bug

5.1. The camel-jbossdatagrid Component
Copy link

Red Hat JBoss Data Grid's camel-jbossdatagrid component includes the following features:
  • Local Camel Consumer

    Receives cache change notifications and sends them to be processed. This can be done synchronously or asynchronously, and is also supported with a replicated or distributed cache.

  • Local Camel Producer

    A producer creates and sends messages to an endpoint. The camel-jbossdatagrid producer uses GET, PUT, REMOVE, and CLEAR operations. The local producer is also supported with a replicated or distributed cache.

  • Remote Camel Producer

    In Remote Client-Server mode, the Camel producer can send messages using Hot Rod.

The following camel-jbossdatagrid dependency must be added to the pom.xml file to run JBoss Data Grid with Camel: 
<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-jbossdatagrid</artifactId>
    <version>6.4.0.Final-redhat-3</version>
    <!-- use the same version as your JBoss Data Grid version -->
</dependency>
Copy to Clipboard Toggle word wrap

Note

The camel-jbossdatagrid component ships with JBoss Data Grid, and is not included in the JBoss Fuse 6.1 or JBoss Fuse Service Works 6.0 distributions.
Camel components are the main extension point in Camel, and are associated with the name used in a URI, and act as a factory of endpoints. For example, a FileComponent is referred to in a URI as file, which creates FileEndpoints.
URI Format

The following URI format is used for camel-jbossdatagrid: 

infinispan://hostname?[options]
Copy to Clipboard Toggle word wrap
URI Options

The producer can create and send messages to a local JBoss Data Grid cache configured in the registry, or to a remote cache using the Hot Rod protocol. If a cacheContainer is present, the cache will be local. If it is not present, the cache will try to connect to remote cache using the supplied hostname/port.

A consumer listens for events from the local JBoss Data Grid cache accessible from the registry.
Expand
Table 5.1. URI Options
Name Default Value Type Context Description
cacheContainer null CacheContainer Shared Reference to a org.infinispan.manager.CacheContainer in the Registry.
cacheName null String Shared The cache name to use. If not specified, the default cache is used.
command PUT String Producer The operation to perform. Only the PUT, GET, REMOVE, and CLEAR values are currently supported.
eventTypes null Set<String> Consumer The event types to register. By default, this listens for all event types. Possible values are defined in org.infinispan.notifications.cachelistener.event.Event.Type
sync true Boolean Consumer By default the consumer will receive notifications synchronously by the same thread that process the cache operation.
clustered false Boolean Consumer By default the consumer will only receive local events. By using this option, the consumer also listens to events originated on other nodes in the cluster. The only events available for clustered listeners are CACHE_ENTRY_CREATED, CACHE_ENTRY_REMOVED, and CACHE_ENTRY_MODIFIED.
Expand
Table 5.2. Message Headers
Name Default Value Type Context Description
CamelInfinispanCacheName null String Shared The cache participating in the operation or event.
CamelInfinispanOperation PUT String Producer The operation to perform: CamelInfinispanOperationPut, CamelInfinispanOperationGet, CamelInfinispanOperationRemove, CamelInfinispanOperationClear.
CamelInfinispanKey null Object Shared The key to perform the operation to or the key generating the event.
CamelInfinispanValue null Object Producer The value to use for the operation.
CamelInfinispanOperationResult null Object Producer The result of the operation.
CamelInfinispanEventType null String Consumer The type of the received event. Possible values are defined in org.infinispan.notifications.cachelistener.event.Event.Type
CamelInfinispanIsPre null Boolean Consumer Infinispan fires two events for each operation: one before and one after the operation.
Report a bug

5.2. Routing with Camel in JBoss Data Grid
Copy link

Camel routing is a chain of processors that move messages in the background. The following is an example of a route that retrieves a value from the cache for a specific key. 
from("direct:start")
        .setHeader(InfinispanConstants.OPERATION, constant(InfinispanConstants.GET))
        .setHeader(InfinispanConstants.KEY, constant("123"))
        .to("infinispan://localhost?cacheContainer=#cacheContainer");
Copy to Clipboard Toggle word wrap
Routing can also be performed using XML configuration. The following example demonstrates camel-jbossdatagrid's Local Camel Producer, a camel route that uses the camel-jbossdatagrid component to send data to an embedded cache created by the local-cache module. 
<camelContext id="local-producer" xmlns="http://camel.apache.org/schema/blueprint">
	<route>
		<from uri="timer://local?fixedRate=true&amp;period=5000"/>
		<setHeader headerName="CamelInfinispanKey">
			<property>CamelTimerCounter</property>
		</setHeader>
		<setHeader headerName="CamelInfinispanValue">
			<property>CamelTimerCounter</property>
		</setHeader>
		<to uri="infinispan://foo?cacheContainer=#cacheManager"/>
		<to uri="log:local-put?showAll=true"/>
	</route>
</camelContext>
Copy to Clipboard Toggle word wrap
The provided example requires the cacheManager to be instantiated.
The cacheManager bean for Spring XML can be instantiated as follows: 
<bean id="cacheManager" class="org.infinispan.manager.DefaultCacheManager" init-method="start" destroy-method="stop">
  <constructor-arg type="java.lang.String" value="infinispan.xml"/>
</bean>
Copy to Clipboard Toggle word wrap
The following demonstrates how to instantiate the cacheManager bean using Blueprint XML. 
<bean id="cacheManager" class="org.infinispan.manager.DefaultCacheManager" init-method="start" destroy-method="stop">
      <argument value="infinispan.xml" />
</bean>
Copy to Clipboard Toggle word wrap

Note

Both the Spring XML and Blueprint XML examples use the configuration file infinispan.xml for configuration of the cache. This file must be present on the classpath.
Report a bug
Red Hat JBoss Fuse is an OSGi container based on the Karaf container. To run Red Hat JBoss Data Grid and JBoss Fuse using camel-jbossdatagrid, ensure that both JBoss Data Grid 6.4 and JBoss Fuse 6.1 (Full Installation) are installed.

Procedure 5.1. Installing JBoss Data Grid

  • For information about installing JBoss Data Grid, see Part II, “Download and Install Red Hat JBoss Data Grid”. Only the following JBoss Data Grid components are required to run the camel component in JBoss Fuse:
    • JBoss Data Grid Maven repository.
    • The JBoss Data Grid Server package (to use the Hot Rod client).
The camel-jbossdatagrid library is also available in a separate distribution called jboss-datagrid-6.4.0-camel-library.

Procedure 5.2. Installing JBoss Fuse

Prerequisites

Before attempting to install and use Red Hat JBoss Fuse, ensure your system meets the minimum requirements. For supported Platforms and recommended Java Runtime platforms, see the Red Hat JBoss Fuse Installation Guide.

The following hardware is required for the JBoss Fuse 6.1 Full Installation.
  • 700 MB of free disk space
  • 2 GB of RAM
In addition to the disk space required for the base installation, a running system will require space for caching, persistent message stores, and other functions.

  1. Download the JBoss Fuse Full Installation

    You can download the Red Hat JBoss Fuse archive from the Red Hat Customer Portal>Downloads>Red Hat JBoss Middleware>Downloads page, after you register and login to your customer account.
    When logged in:
    1. Select Fuse, listed under Integrated Platforms in the sidebar menu.
    2. Select 6.1.0 from the Version drop-down list on the Software Downloads page.
    3. Click the Download button next to the Red Hat JBoss Fuse 6.1.0 distribution file to download.
    JBoss Fuse allows you to choose between installations that contain different feature sets. To run JBoss Data Grid with JBoss Fuse, the Full installation is required. The Full installation includes the following:
    • Apache Karaf
    • Apache Camel
    • Apache ActiveAMQ
    • Apache CXF
    • Fuse Management
    • Console (hawtio)
    • JBI components

  2. Unpacking the Archive

    Red Hat JBoss Fuse is installed by unpacking an archive system on a system. JBoss Fuse is packaged as a zip file. Using a suitable archive tool, unpack Red Hat JBoss Fuse into a directory to which you have full access.

    Warning

    Do not unpack the archive file into a folder that has spaces in its path name. For example, do not unpack into C:\Documents and Settings\Greco Roman\Desktop\fusesrc.
    Additionally, do not unpack the archive file into a folder that has any of the following special characters in its path name: #, %, ^, ".

  3. Adding a Remote Console User

    The server's remote command console is not configured with a default user. Before remotely connecting to the server's console, add a user to the configuration.

    Important

    The information in this file is unencrypted so it is not suitable for environments that require strict security.
    To add a user:
    1. Open InstallDir/etc/users.properties in your favorite text editor.
    2. Locate the line #admin=admin,admin. This line specifies a user admin with the password admin and the role admin.
    3. Remove the leading # to uncomment the line.
    4. Replace the first admin with a name for the user.
    5. Replace the second admin with the password for the user.
    6. Leave the last admin as it is, and save the changes.

    Note

    To access the Fuse Management Console to monitor and manage your Camel routes, ActiveMQ brokers, Web applications, and so on, open a browser to

    http://localhost:8181/hawtio

    , after starting Red Hat JBoss Fuse.

  4. Red Hat JBoss Fuse Maven Repositories

    To use Maven to build projects, specify the location of the artifacts in a Maven settings.xml file.
    The following JBoss Fuse Maven repository contains the required dependencies for Camel and must be added to the settings.xml file. 
    https://repo.fusesource.com/nexus/content/groups/public/
    Copy to Clipboard Toggle word wrap
    The JBoss Fuse repository runs alongside the JBoss Data Grid repository.
    JBoss Data Grid includes a features.xml file for Karaf that deploys all artifacts required for the camel-jbossdatagrid component. This file is not included in the JBoss Fuse container distribution. The features.xml file is in jboss-datagrid-6.4.0-maven-repository/org/apache/camel/camel-jbossdatagrid/${version}/. No further configuration of the JBoss Data Grid repository is required.
    For more information about installing and getting started with JBoss Fuse, see the Red Hat JBoss Fuse documentation on the Red Hat Customer Portal.
Report a bug

5.4. Red Hat JBoss Data Grid and Red Hat JBoss EAP
Copy link

Red Hat JBoss Enterprise Application Platform 6 (JBoss EAP 6) is a middleware platform built on open standards and compliant with the Java Enterprise Edition 6 specification.
As Camel is only supported through Red Hat JBoss Fuse valid entitlements for all of the following products will be necessary:
  • Red Hat JBoss EAP
  • Red Hat JBoss Fuse
  • Red Hat JBoss Data Grid

Note

Entitlement to Red Hat JBoss Fuse Service Works includes entitlements to Red Hat JBoss EAP and Red Hat JBoss Fuse.
The following variables are used instead of specific version numbers in the installation procedures below:
  • jdg.version - the latest version of Red Hat JBoss Data Grid
    fuse.version - the latest version of Red Hat JBoss Fuse
  • infinispan.version - the version of Infinispan that is included in the latest version of Red Hat JBoss Data Grid
  • camel.version - the version of Apache Camel that is included in the latest version of Red Hat JBoss Fuse
For more information on tested integrations for camel-jbossdatagrid, please refer to https://access.redhat.com/articles/115883.

Procedure 5.3. Installing JBoss Data Grid

  • For information about installing JBoss Data Grid, see Part II, “Download and Install Red Hat JBoss Data Grid”. Only the following JBoss Data Grid components are required to run the camel component in JBoss EAP:
    • JBoss Data Grid Maven repository.
    • The JBoss Data Grid Server package (to use the Hot Rod client).
The camel-jbossdatagrid library is also available in a separate distribution called jboss-datagrid-${jdg.version}-camel-library.

Procedure 5.4. Installing JBoss EAP

  1. Before attempting to install and use Red Hat JBoss EAP ensure your system meets the minimum requirements as documented in Red Hat JBoss EAP Installation Guide.

  2. Unpacking the Archive

    Red Hat JBoss EAP is installed by unpacking an archive system on a system, as JBoss EAP is packaged as a zip file; using a suitable archive tool, unpack Red Hat JBoss EAP into a directory to which you have full access.

    Warning

    Do not unpack the archive file into a folder that has spaces in its path name. For example, do not unpack into C:\Documents and Settings\Greco Roman\Desktop\JBoss.
    Additionally, do not unpack the archive file into a folder that has any of the following special characters in its path name: #, %, ^, ".
  3. Once the archive has been extracted JBoss EAP will have been successfully installed. For more information on installation options refer to theRed Hat JBoss EAP Installation Guide.
  4. If JBoss Data Grid is being used in Library mode then refer to Section 4.1, “Deploy JBoss Data Grid in JBoss EAP (Library Mode)” to ensure the necessary dependencies have been installed.
  5. If JBoss Data Grid is being used in Remote Client-Server mode then refer to Section 4.2, “Deploy JBoss Data Grid in JBoss EAP (Remote Client-Server Mode)” to ensure the necessary dependencies have been installed.
Report a bug

5.4.2. Deploy Camel with EAP:
Copy link

5.4.2.1. Add development and runtime dependencies
Copy link
In order to compile your application the dependent libraries for Camel and JBoss Data Grid will have to be added to the pom.xml (if using Maven).

Procedure 5.5. Add Camel from Fuse

  1. Ensure that the Fuse repository has been added to the pom.xml: 
    <repository>
  <id>fusesource</id>
  <name>FuseSource Release Repository</name>
  <url>https://repo.fusesource.com/nexus/content/groups/public/</url>
  <snapshots>
    <enabled>false</enabled>
  </snapshots>
  <releases>
    <enabled>true</enabled>
  </releases>
</repository>
    Copy to Clipboard Toggle word wrap
  2. Add the Camel components as a dependency in the pom.xml: 
    <dependency>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-core</artifactId>
  <version>${camel.version}</version>
</dependency>
    Copy to Clipboard Toggle word wrap

Procedure 5.6. Add camel-jbossdatagrid to the deployment

  1. Follow the instructions in Chapter 3, Install and Use the Maven Repositories to add the maven repository.
  2. Add camel-jbossdatagrid as a dependency in the pom.xml: 
    <dependency>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-jbossdatagrid</artifactId>
  <version>${jdg.version}</version>
</dependency>
    Copy to Clipboard Toggle word wrap
  3. Add in the remaining JBoss Data Grid dependencies depending on which functionality is in use: 
    <!-- If Remote Camel Producer is used add the following dependency -->
<dependency>
	<groupId>org.infinispan</groupId>
	<artifactId>infinispan-remote</artifactId>
	<version>${infinispan.version}</version>
</dependency>
	
<!-- If the Local Camel Producer or Local Camel Consumer are in use add -->
<!-- the following dependency -->
<dependency>
	<groupId>org.infinispan</groupId>
	<artifactId>infinispan-embedded</artifactId>
	<version>${infinispan.version}</version>
</dependency>
    Copy to Clipboard Toggle word wrap
Report a bug
Sometimes it is preferable to maintain other product libraries in JBoss EAP as modules. This requires some additional procedures to create these modules.

Note

When using modules for dependencies the pom.xml will need to have the scope set to "provided" for any dependencies provided as modules. For example: 
<dependency>
	<groupId>org.apache.camel</groupId>
	<artifactId>camel-jbossdatagrid</artifactId>
	<scope>provided</scope>
	<version>${jdg.version}</version>
</dependency>
Copy to Clipboard Toggle word wrap
Download jboss-datagrid-${jdg.version}-camel-library.zip from Red Hat JBoss Data Grid 6.4.0 Camel Component for JBoss Fuse.
Extract the apache-camel-${camel.version}.zip found in Red Hat JBoss Fuse's extras/ directory: 
user@example modules] unzip /path/to/jboss-fuse-${fuse.version}/extras/apache-camel-${camel.version}
Copy to Clipboard Toggle word wrap

Procedure 5.7. Add in the Camel components from JBoss Fuse

  1. Create a directory under $EAP_HOME/modules: 
    user@example jboss-eap-6.4] cd modules
user@example modules] mkdir -p org/apache/camel/core
    Copy to Clipboard Toggle word wrap
  2. Create a main subdirectory to store the jars: 
    user@example modules] mkdir org/apache/camel/core/main
    Copy to Clipboard Toggle word wrap
  3. Copy over the camel-core jar from apache-camel-${camel.version}.zip to the newly created main directory: 
    user@example modules] cp /path/to/jboss/fuse/extras/apache-camel-${camel.version}/lib/camel-core-${camel.version}.jar ./org/apache/camel/core/main/
    Copy to Clipboard Toggle word wrap
  4. Create the module.xml descriptor by adding in the following text to org/apache/camel/core/main/module.xml: 
    <?xml version="1.0" encoding="UTF-8"?>
<module xmlns="urn:jboss:module:1.1" name="org.apache.camel.core">
  <resources>
    <resource-root path="camel-core-${camel.version}.jar"/>
  </resources>
</module>
    Copy to Clipboard Toggle word wrap
  5. Repeat the above steps to create a module for each dependency in use; note that modules may have dependencies on other modules as described in the Red Hat JBoss Administration and Configuration Guide.

Procedure 5.8. Add in Camel components from JBoss Data Grid

  1. Create a main subdirectory for the JDG Camel components: 
    user@example jboss-eap-6.4] mkdir -p modules/org/apache/camel/main
    Copy to Clipboard Toggle word wrap
  2. Unzip jboss-datagrid-${jdg.version}-camel-library.zip.
  3. Copy camel-jbossdatagrid-${jdg.version}.jar into the newly created directory: 
    user@example jboss-eap-6.4] cp jboss-datagrid-${jdg.version}-camel-library/camel-jbossdatagrid-${jdg.version}.jar modules/org/apache/camel/main/
    Copy to Clipboard Toggle word wrap
  4. Create a module.xml descriptor by adding in the following text to org/apache/camel/main/module.xml: 
    <?xml version="1.0" encoding="UTF-8"?>
<module xmlns="urn:jboss:module:1.1" name="org.apache.camel">
  <resources>
    <resource-root path="camel-jbossdatagrid-${jdg.version}.jar"/>
  </resources>
  <dependencies>
    <module name="org.apache.camel.core" />
  </dependencies>
</module>
    Copy to Clipboard Toggle word wrap
Create a jboss-deployment-structure.xml in the WEB-INF of the war, and add dependencies on the newly created module: 
<?xml version="1.0" encoding="UTF-8"?>
<jboss-deployment-structure>
    <deployment>
        <dependencies>
            <module name="org.apache.camel" meta-inf="import"/>
            
            <!-- Add the following lines if Library mode is used -->
            <module name="org.infinispan" slot="jdg-6.4" />
            <module name="org.jgroups" slot="jdg-6.4" />
            
            <!-- Add the following lines if Remote Client-Server mode is used -->
            <module name="org.infinispan.client.hotrod" slot="jdg-6.4" />
        </dependencies>
    </deployment>
</jboss-deployment-structure>
Copy to Clipboard Toggle word wrap
Report a bug

Part IV. Running Red Hat JBoss Data Grid
Copy link

Use the following instructions to run Red Hat JBoss Data Grid JAR files with Maven in Remote Client-Server mode.

Note

To simplify embedding Red Hat JBoss Data Grid directly in your application, the distribution of JBoss Data Grid contains fewer, consolidated jars. For the list of supported jar files, see the Packaging Revisions in the Release Notes.
Hot Rod Client with Querying

Add the following dependencies to the pom.xml file:

  1. Add infinispan-remote dependency: 
    <dependency>
   <groupId>org.infinispan</groupId>
   <artifactId>infinispan-remote</artifactId>
   <version>${infinispan.version}</version>
</dependency>
    Copy to Clipboard Toggle word wrap
  2. For Remote Cache Store specific use case add also infinispan-embedded dependency: 
    <dependency>
   <groupId>org.infinispan</groupId>
   <artifactId>infinispan-embedded</artifactId>
   <version>${infinispan.version}</version>
</dependency>
    Copy to Clipboard Toggle word wrap

Warning

The Infinispan query API directly exposes the Hibernate Search and the Lucene APIs and cannot be embedded within the infinispan-embedded-query.jar file. Do not include other versions of Hibernate Search and Lucene in the same deployment as infinispan-embedded-query. This action will cause classpath conflicts and result in unexpected behavior.
Report a bug

6.2. Run JBoss Data Grid (Library Mode)
Copy link

Use the provided instructions to run Red Hat JBoss Data Grid with Maven in Library mode.

Note

To simplify embedding Red Hat JBoss Data Grid directly in your application, the distribution of JBoss Data Grid contains fewer, consolidated jars. For the list of supported jar files, see the Packaging Revisions in the Release Notes.
Infinispan Embedded without Querying

Add the following dependencies to the pom.xml file:

  1. Add infinispan-embedded dependency: 
    <dependency>
   <groupId>org.infinispan</groupId>
   <artifactId>infinispan-embedded</artifactId>
   <version>${infinispan.version}</version>
</dependency>
    Copy to Clipboard Toggle word wrap
Infinispan Embedded with Querying

Add the following dependencies to the pom.xml file:

  1. Add infinispan-embedded-query dependency: 
    <dependency>
   <groupId>org.infinispan</groupId>
   <artifactId>infinispan-embedded-query</artifactId>
   <version>${infinispan.version}</version>
</dependency>
    Copy to Clipboard Toggle word wrap

Warning

The Infinispan query API directly exposes the Hibernate Search and the Lucene APIs and cannot be embedded within the infinispan-embedded-query.jar file. Do not include other versions of Hibernate Search and Lucene in the same deployment as infinispan-embedded-query. This action will cause classpath conflicts and result in unexpected behavior.
Report a bug

7.1. Prerequisites
Copy link

The following is a list of prerequisites to run Red Hat JBoss Data Grid in Remote Client-Server mode for the first time:
Report a bug
Standalone mode refers to a single instance of Red Hat JBoss Data Grid operating in local mode. In local mode, JBoss Data Grid operates as a simple single node in-memory data cache.
Run the following script to start JBoss Data Grid in standalone mode: 
$JDG_HOME/bin/standalone.sh
Copy to Clipboard Toggle word wrap
This command starts JBoss Data Grid using the default configuration information provided in the $JDG_HOME/standalone/configuration/standalone.xml file.
Report a bug

7.3. Run Red Hat JBoss Data Grid in Clustered Mode
Copy link

Clustered mode refers to a cluster made up of two or more Red Hat JBoss Data Grid instances.
Run the following script to start JBoss Data Grid in clustered mode: 
$JDG_HOME/bin/clustered.sh
Copy to Clipboard Toggle word wrap
This command starts JBoss Data Grid using the default configuration information provided in the $JDG_HOME/standalone/configuration/clustered.xml file.
Report a bug
To run Red Hat JBoss Data Grid with a custom configuration, add a configuration file to the $JDG_HOME/standalone/configuration directory.
Use the following command to specify the created custom configuration file for standalone mode: 
$JDG_HOME/bin/standalone.sh -c ${FILENAME}
Copy to Clipboard Toggle word wrap
Use the following command to specify the created custom configuration file for clustered mode: 
$JDG_HOME/bin/clustered.sh -c ${FILENAME}
Copy to Clipboard Toggle word wrap
The -c used for this script does not allow absolute paths, therefore the specified file must be available in the $JDG_HOME/standalone/configuration directory.
If the command is run without the -c parameter, JBoss Data Grid uses the default configuration.
Report a bug
For production use, the Red Hat JBoss Data Grid server must be bound to a specified IP address rather than to 127.0.0.1/localhost. Use the -b parameter with the script to specify an IP address.
For standalone mode, set the IP address as follows: 
$JDG_HOME/bin/standalone.sh -b ${IP_ADDRESS}
Copy to Clipboard Toggle word wrap
For clustered mode, set the IP address as follows: 
$JDG_HOME/bin/clustered.sh -b ${IP_ADDRESS}
Copy to Clipboard Toggle word wrap
Report a bug

7.6. Running Red Hat JBoss Data Grid
Copy link

JBoss Data Grid can be run in one of three ways:
  • Use the following command to run JBoss Data Grid using the configuration defined in the standalone.xml file (located at $JDG_HOME/standalone/configuration): 
    $JDG_HOME/bin/standalone.sh
    Copy to Clipboard Toggle word wrap
  • Use the following command with an appended -c followed by the configuration file name to run JBoss Data Grid with a non-default configuration file: 
    $JDG_HOME/bin/standalone.sh -c clustered.xml
    Copy to Clipboard Toggle word wrap
  • Use the following command to run JBoss Data Grid with a default clustered configuration: 
    $JDG_HOME/bin/clustered.sh
    Copy to Clipboard Toggle word wrap
Report a bug
Services send messages using channels to communicate with each other. An endpoint is a communications point for these services and is used to send and receive the messages sent through the channels. As a result, a node with no endpoints can communicate with other nodes in the same cluster, but not with clients.
Report a bug

8.1. Benefits of a Node Without Endpoints
Copy link

The primary benefit for creating a node without endpoints in Red Hat JBoss Data Grid involves data replication.
A node without any endpoints cannot be accessed by the client directly. As a result, they are primarily used to replicate data from other nodes that can communicate with clients. The result is a node with a backup copy of the data that cannot be accessed by the client, which protects it from failure via an error sent by the client.
Report a bug
Red Hat JBoss Data Grid provides a sample configuration to configure a node without an endpoint:

Procedure 8.1. Find the JBoss Data Grid Sample Configuration for a Node Without Endpoints

  1. Extract the JBoss Data Grid ZIP

    1. Extract the ZIP file for JBoss Data Grid Remote Client-Server mode. This is named jboss-datagrid-server-${version}. Add the relevant version to the file name.

  2. Navigate to the Appropriate Folder

    In the extracted folder, navigate to the $JDG_HOME/docs/examples/config folder.

  3. Find the Configuration Sample File

    View the clustered-storage-only.xml file, which contains the configuration for a node with no endpoints.
Report a bug

8.3. Configure a Node with No Endpoints
Copy link

A standard configuration, such as a standalone high availability configuration, can be changed into a configuration for a node with no endpoints using the following steps:
  1. Remove the datagrid subsystem.
  2. Remove the modcluster subsystem.
  3. Remove the datasource definition.
  4. Remove socket-bindings for mod_cluster, Hot Rod and memcached.
Removing the listed items ensure that all endpoints are removed from the configuration and that clustering is not possible. The resulting configuration is a node with no endpoints.
Report a bug
This part includes information about using Red Hat JBoss Data Grid in Library Mode.
Report a bug

9.1. Create a New Red Hat JBoss Data Grid Project
Copy link

This chapter is a guide to creating a new Red Hat JBoss Data Grid project. The tasks prescribed are a prerequisite for the quickstart tasks provided in Chapter 10, Run Red Hat JBoss Data Grid in Library Mode (Single-Node Setup) and Chapter 11, Run Red Hat JBoss Data Grid in Library Mode (Multi-Node Setup)
Report a bug

9.2. Add Dependencies to Your Project
Copy link

Set up Red Hat JBoss Data Grid by adding dependencies to your project. If you are using Maven or other build systems that support Maven dependencies, add the following to your pom.xml file, located in the Maven repository folder: 
<dependency>
          <groupId>org.infinispan</groupId>
          <artifactId>infinispan-embedded</artifactId>
          <version>$VERSION</version>
</dependency>
Copy to Clipboard Toggle word wrap

Note

Replace the version value with the appropriate version of the libraries included in JBoss Data Grid.
Report a bug

9.3. Add a Profile to Your Project
Copy link

To enable the JBoss Maven repository for your project, add a profile to your settings.xml file in $HOME/.m2/settings.xml as follows:

Example 9.1. Adding a Profile

<profiles>

    <!-- Configure the JBoss GA Maven repository -->
    <profile>
      <id>jboss-ga-repository</id>
      <repositories>
        <repository>
          <id>jboss-ga-repository</id>
          <url>http://maven.repository.redhat.com/techpreview/all</url>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
          <id>jboss-ga-plugin-repository</id>
          <url>http://maven.repository.redhat.com/techpreview/all</url>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
        </pluginRepository>
      </pluginRepositories>
    </profile>
    <!-- Configure the JBoss Early Access Maven repository -->
    <profile>
      <id>jboss-earlyaccess-repository</id>
      <repositories>
        <repository>
          <id>jboss-earlyaccess-repository</id>
          <url>http://maven.repository.redhat.com/earlyaccess/all/</url>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
          <id>jboss-earlyaccess-plugin-repository</id>
          <url>http://maven.repository.redhat.com/earlyaccess/all/</url>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
        </pluginRepository>
      </pluginRepositories>
    </profile>

  </profiles>

<!-- Add active profiles information here -->
Copy to Clipboard Toggle word wrap
Enable the profile by ensuring the following is included in the settings.xml file:

Example 9.2. Enable the Profile

  <activeProfiles>
    <!-- Optionally, make the repositories active by default -->
    <activeProfile>jboss-ga-repository</activeProfile>
    <activeProfile>jboss-earlyaccess-repository</activeProfile>
  </activeProfiles>
Copy to Clipboard Toggle word wrap
If you are using a build system that does not support declarative dependency management, add the contents of the client/java/ directory, included in the Red Hat JBoss Data Grid package to the build classpath.
Report a bug

10.1. Create a Main Method in the Quickstart Class
Copy link

Create a new Quickstart class by following the outlined steps:
Prerequisites

These quickstarts use the Infinispan quickstarts located at https://github.com/infinispan/infinispan-quickstart. The following procedure uses the infinispan-quickstart/embedded-cache quickstart.

Procedure 10.1. Create a Main Method in the Quickstart Class

  1. Create the Quickstart.java File

    Create a file called Quickstart.java at your project's location.

  2. Add the Quickstart Class

    Add the following class and method to the Quickstart.java file: 
    package com.mycompany.app;

import org.infinispan.manager.DefaultCacheManager
import org.infinispan.Cache

public class Quickstart {
  public static void main(String args[]) throws Exception {
       Cache<Object, Object> cache = new DefaultCacheManager().getCache();
    }
 }
    Copy to Clipboard Toggle word wrap

  3. Copy Dependencies and Compile Java Classes

    Use the following command to copy all project dependencies to a directory and compile the Java classes from your project: 
    $ mvn clean compile dependency:copy-dependencies -DstripVersion
    Copy to Clipboard Toggle word wrap

  4. Run the Main Method

    Use the following command to run the main method: 
    $ java -cp target/classes/:target/dependency/* com.mycompany.app.Quickstart
    Copy to Clipboard Toggle word wrap
Report a bug

10.2. Use the Default Cache
Copy link

10.2.1. Add and Remove Data from the Cache
Copy link

Red Hat JBoss Data Grid offers an interface that is similar to the proposed JSR-107 API to access and alter data stored in a cache.
The following procedure is an example that defines what each line entered into the DefaultCacheQuickstart.java file does:

Procedure 10.2. Add and Remove Data from the Cache

  1. Add an entry, replacing key and value with the desired key and value: 
    cache.put("key", "value");
    Copy to Clipboard Toggle word wrap
  2. Confirm that the entry is present in the cache: 
    assertEquals(1, cache.size());
assertTrue(cache.containsKey("key"));
    Copy to Clipboard Toggle word wrap
  3. Remove the entry from the cache: 
    Object v = cache.remove("key");
    Copy to Clipboard Toggle word wrap
  4. Confirm that the entry is no longer present in the cache: 
    assertEquals("value", v);
assertTrue(cache.isEmpty());
    Copy to Clipboard Toggle word wrap
Report a bug

10.2.2. Adding and Replacing a Key Value
Copy link

Red Hat JBoss Data Grid offers a thread-safe data structure.
The following procedure is an example that defines what each line entered into the DefaultCacheQuickstart.java file does:

Procedure 10.3. Adding and Replacing a Key Value

  • Add an entry key with value as the key's value. 
    cache.put("key", "value");
    Copy to Clipboard Toggle word wrap

Procedure 10.4. Replacing a Key Value

  1. The following code searches for keys (named key and key2). If the two specific keys beings searched for are not found, JBoss Data Grid creates two new keys with the specified key names and values. 
    cache.putIfAbsent("key", "newValue");
cache.putIfAbsent("key2", "value2");
    Copy to Clipboard Toggle word wrap
  2. The following code confirms that the value of the stored key equals the value we wanted to store. 
    assertEquals(cache.get("key"), "value");
assertEquals(cache.get("key2"), "value2");
    Copy to Clipboard Toggle word wrap

See Also:

Report a bug

10.2.3. Adjust Data Life
Copy link

Red Hat JBoss Data Grid entries are immortal by default, but these settings can be altered.
The following procedure is an example that defines what each line entered into the DefaultCacheQuickstart.java file does:

Procedure 10.5. Adjust the Data Life

  1. Alter the key's lifespan value: 
    cache.put("key", "value", 5, TimeUnit.SECONDS);
    Copy to Clipboard Toggle word wrap
  2. Check if the cache contains the key: 
    assertTrue(cache.containsKey("key"));
    Copy to Clipboard Toggle word wrap
  3. After the allocated lifespan time has expired, the key is no longer in the cache: 
    Thread.sleep(10000);
assertFalse(cache.containsKey("key"));
    Copy to Clipboard Toggle word wrap
Report a bug

10.2.4. Default Data Mortality
Copy link

As a default, newly created entries do not have a life span or maximum idle time value set. Without these two values, a data entry will never expire and is therefore known as immortal data.
Report a bug

10.2.5. Register the Named Cache Using XML
Copy link

To configure the named cache declaratively (using XML) rather than programmatically, configure the infinispan.xml file.
The infinispan.xml file is located in https://github.com/infinispan/infinispan-quickstart in the infinispan-quickstart/embedded-cache/src/main/resources folder.
Report a bug

11.1. Sharing JGroup Channels
Copy link

Red Hat JBoss Data Grid offers an easy to use form of clustering using JGroups as the network transport. As a result, JGroups manages the initial operations required to form a cluster for JBoss Data Grid.
All caches created from a single CacheManager share the same JGroups channel by default. This JGroups channel is used to multiplex replication/distribution messages.
In the following example, all three caches used the same JGroups channel:

Example 11.1. Shared JGroups Channel

EmbeddedCacheManager cm = $LOCATION
Cache<Object, Object> cache1 = cm.getCache("replSyncCache");
Cache<Object, Object> cache2 = cm.getCache("replAsyncCache");
Cache<Object, Object> cache3 = cm.getCache("invalidationSyncCache");
Copy to Clipboard Toggle word wrap
Substitute $LOCATION with the CacheManager's location.
Report a bug

11.2. Run Red Hat JBoss Data Grid in a Cluster
Copy link

The clustered quickstarts for Red Hat JBoss Data Grid are based on the quickstarts found in https://github.com/infinispan/infinispan-quickstart/tree/master/clustered-cache.
Report a bug

11.2.1. Compile the Project
Copy link

Use Maven to compile your project with the following command: 
$ mvn clean compile dependency:copy-dependencies -DstripVersion
Copy to Clipboard Toggle word wrap
Report a bug
To run Red Hat JBoss Data Grid's replication mode example of a clustered cache, launch two nodes from different consoles.

Procedure 11.1. Run the Clustered Cache with Replication Mode

  1. Use the following command to launch the first node: 
    $ java -cp target/classes/:target/dependency/* org.infinispan.quickstart.clusteredcache.replication.Node0
    Copy to Clipboard Toggle word wrap
  2. Use the following command to launch the second node: 
    $ java -cp target/classes/:target/dependency/* org.infinispan.quickstart.clusteredcache.replication.Node1
    Copy to Clipboard Toggle word wrap
Result

JGroups and JBoss Data Grid initialized on both nodes. After approximately fifteen seconds, the cache entry log message appears on the console of the first node.

Report a bug
To run Red Hat JBoss Data Grid's distribution mode example of a clustered cache, launch three nodes from different consoles.

Procedure 11.2. Run the Clustered Cache with Distribution Mode

  1. Use the following command to launch the first node: 
    $ java -cp target/classes/:target/dependency/* org.infinispan.quickstart.clusteredcache.distribution.Node0
    Copy to Clipboard Toggle word wrap
  2. Use the following command to launch the second node: 
    $ java -cp target/classes/:target/dependency/* org.infinispan.quickstart.clusteredcache.distribution.Node1
    Copy to Clipboard Toggle word wrap
  3. Use the following command to launch the third node: 
    $ java -cp target/classes/:target/dependency/* org.infinispan.quickstart.clusteredcache.distribution.Node2
    Copy to Clipboard Toggle word wrap
Result

JGroups and JBoss Data Grid initialized on the three nodes. After approximately fifteen seconds, the ten entries added by the third node are visible as they are distributed to the first and second nodes.

Report a bug

11.2.4. Configure the Cluster
Copy link

Use the following steps to add and configure your cluster:

Procedure 11.3. Configure the Cluster

  1. Add the default configuration for a new cluster.
  2. Customize the default cluster configuration according to the requirements of your network. This is done declaratively (using XML) or programmatically.
  3. Configure the replicated or distributed data grid.
Report a bug
11.2.4.1. Add the Default Cluster Configuration
Copy link
Add a cluster configuration to ensure that Red Hat JBoss Data Grid is aware that a cluster exists and is defined. The following is a default configuration that serves this purpose:

Example 11.2. Default Configuration

new ConfigurationBuilder()
   .clustering().cacheMode(CacheMode.REPL_SYNC)
   .build()
Copy to Clipboard Toggle word wrap

Note

Use the new GlobalConfigurationBuilder().clusteredDefault() to quickly create a preconfigured and cluster-aware GlobalConfiguration for clusters. This configuration can also be customized.
Report a bug
Depending on the network requirements, you may need to customize your JGroups configuration.
Programmatic Configuration:

Use the following GlobalConfiguration code to specify the name of the file to use for JGroups configuration: 

new GlobalConfigurationBuilder().transport().addProperty("configurationFile", "jgroups.xml")
   .build()
Copy to Clipboard Toggle word wrap
Replace jgroups.xml with the desired file name.
The jgroups.xml file is located at Infinispan-Quickstart/clustered-cache/src/main/resources/.

Note

To bind JGroups solely to your loopback interface (to avoid any configured firewalls), use the system property -Djgroups.bind_addr="127.0.0.1". This is particularly useful to test a cluster where all nodes are on a single machine.
Declarative Configuration:

Use the following XML snippet in the infinispan.xml file to configure the JGroups properties to use Red Hat JBoss Data Grid's XML configuration: 

<global>
   <transport>
      <properties>
         <property name="configurationFile" value="jgroups.xml"/>
      </properties>
   </transport>
</global>
Copy to Clipboard Toggle word wrap
Report a bug
11.2.4.3. Configure the Replicated Data Grid
Copy link
Red Hat JBoss Data Grid's replicated mode ensures that every entry is replicated on every node in the data grid.
This mode offers security against data loss due to node failures and excellent data availability. These benefits are at the cost of limiting the storage capacity to the amount of storage available on the node with the least memory.
Programmatic Configuration:

Use the following code snippet to programmatically configure the cache for replication mode (either synchronous or asynchronous): 

private static EmbeddedCacheManager createCacheManagerProgramatically() {
   return new DefaultCacheManager(
      new GlobalConfigurationBuilder()
         .transport().addProperty("configurationFile", "jgroups.xml")
         .build(),
      new ConfigurationBuilder()
         .clustering().cacheMode(CacheMode.REPL_SYNC)
         .build()
   );
}
Copy to Clipboard Toggle word wrap
Declarative Configuration:

Edit the infinispan.xml file to include the following XML code to declaratively configure the cache for replication mode (either synchronous or asynchronous): 

<infinispan xsi:schemaLocation="urn:infinispan:config:6.0 http://www.infinispan.org/schemas/infinispan-config-6.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:infinispan:config:6.0">
   <global>
      <transport>
         <properties>
            <property name="configurationFile" value="jgroups.xml"/>
         </properties>
      </transport>
   </global>
   <default>
      <clustering mode="replication">
         <sync/>
      </clustering>
   </default>
</infinispan>
Copy to Clipboard Toggle word wrap
Use the following code to initialize and return a DefaultCacheManager with the XML configuration file: 
private static EmbeddedCacheManager createCacheManagerFromXml() throws IOException {
   return new DefaultCacheManager("infinispan.xml");}
Copy to Clipboard Toggle word wrap

Note

JBoss EAP includes its own underlying JMX. This can cause a collision when using the sample code with JBoss EAP and display an error such as org.infinispan.jmx.JmxDomainConflictException: Domain already registered org.infinispan.
To avoid this, configure global configuration as follows: 
GlobalConfiguration glob = new GlobalConfigurationBuilder()
	.clusteredDefault()
        .globalJmxStatistics()
          .allowDuplicateDomains(true)
          .enable()
        .build();
Copy to Clipboard Toggle word wrap
Report a bug
11.2.4.4. Configure the Distributed Data Grid
Copy link
Red Hat JBoss Data Grid's distributed mode ensures that each entry is stored on a subset of the total nodes in the data grid. The number of nodes in the subset is controlled by the numOwners parameter, which sets how many owners each entry has.
Distributed mode offers increased storage capacity but also results in increased access times and less durability (protection against node failures). Adjust the numOwners value to set the desired trade off between space, durability and availability. Durability is further improved by JBoss Data Grid's topology aware consistent hash, which locates entry owners across a variety of data centers, racks and nodes.
Programmatic Configuration:

Programmatically configure the cache for distributed mode (either synchronous or asynchronous) as follows: 

new ConfigurationBuilder()
   .clustering()
      .cacheMode(CacheMode.DIST_SYNC)
      .hash().numOwners(2)
   .build()
Copy to Clipboard Toggle word wrap
Declarative Configuration:

Edit the infinispan.xml file to include the following XML code to declaratively configure the cache for distributed mode (either synchronous or asynchronous): 

<default>
   <clustering mode="distribution">
      <sync/>
      <hash numOwners="2"/>
   </clustering>
</default>
Copy to Clipboard Toggle word wrap
Report a bug
Red Hat JBoss Data Grid library applications (in the form of WAR or EAR files) can be deployed within JBoss Enterprise Application Server 6 (or better) and then monitored using JBoss Operations Network.
Report a bug

12.1. Prerequisites
Copy link

The following are prerequisites to monitor a Red Hat JBoss Data Grid library application in JBoss Enterprise Application Platform:
  • Install and configure JBoss Enterprise Application Platform 6 (or better).
  • Install and configure JBoss Operations Network 3.2.2 (or better).
  • Install and configure JBoss Data Grid (6.3 or better) Library mode plug-in.
Report a bug
Ensure that all requirements outlined as prerequisites are met. Follow the listed steps to monitor Red Hat JBoss Data Grid applications in JBoss Enterprise Application Platform using JBoss Operations Network or RHQ.

Procedure 12.1. Monitor JBoss Data Grid Applications in JBoss Enterprise Application Platform

  1. Configure RHQ/JBoss Operations Network

    Add an RHQ/JBoss Operations Network specific property (named org.rhq.resourceKey) to the /bin/standalone.conf file as follows: 
    JAVA_OPTS="$JAVA_OPTS -Dorg.rhq.resourceKey=MyEAP"
    Copy to Clipboard Toggle word wrap
    This command adds the property to the JBoss Enterprise Application Platform's command line indirectly.

  2. Check RHQ/JBoss Operations Network is Running Using a Full JDK

    Ensure that the RHQ/JBoss Operations Network agent started using a full JDK instead of a JRE. This is because the agent requires access to the JDK's tools.jar file.
    To configure your RHQ/JBoss Operations Network agent to use the JDK, follow the instructions relevant to your operating system:
    1. For Linux users, set the RHQ_AGENT_JAVA_HOME environment variable to the JDK home directory in the agent's rhq-agent-env.sh file.
    2. For Windows users, set the RHQ_AGENT_JAVA_HOME environment variable to the JDK home directory in the agent's rhq-agent-env.bat file.

  3. Ensure the Agent is Local to the JBoss Enterprise Application Platform Instance

    Ensure that the RHQ/JBoss Operations Network agent runs locally to and under the same user as the JBoss Application Platform instance. This is required for the Java Attach API to connect to the process.

  4. Import Resources to the Agent Inventory

    RHQ/JBoss Operations Network can now discover resources. These resources can subsequently be imported into the agent inventory.
    When a JBoss Data Grid user deployment enables JMX statistics to expose JBoss Data Grid Cache Managers or caches, the resources appear as children resources of the JBoss Enterprise Application Platform instance.
Report a bug

Part V. Red Hat JBoss Data Grid Quickstarts
Copy link

The following lists the quickstarts included in this document and provides information about which container and mode they are used in:
Expand
Table 4. Quickstarts Information
Quickstart Name Container JBoss Data Grid Mode Link to Details
Hello World JBoss EAP Library mode Chapter 13, The Hello World Quickstart
Carmart Non-Transactional JBoss EAP and JBoss Enterprise Web Server Library mode Section 14.3, “The (Non-transactional) CarMart Quickstart Using JBoss EAP”
Carmart Non-Transactional JBoss EAP and JBoss Enterprise Web Server Remote Client-Server mode Section 14.5, “The (Non-transactional) CarMart Quickstart in Remote Client-Server Mode (JBoss EAP)” and Section 14.6, “The (Non-Transactional) CarMart Quickstart in Remote Client-Server Mode (JBoss Enterprise Web Server)”
Carmart Transactional JBoss EAP and JBoss Enterprise Web Server Library mode Section 14.7, “The (Transactional) CarMart Quickstart Using JBoss EAP” and Section 14.8, “The (Transactional) CarMart Quickstart Using JBoss Enterprise Web Server”
Football Application No container Remote Client-Server mode Chapter 15, The Football Quickstart Endpoint Examples
Rapid Stock Market No container Remote Client-Server mode Chapter 16, The Rapid Stock Market Quickstart
Report a bug

Chapter 13. The Hello World Quickstart
Copy link

Hello World is a simple quickstart that illustrates how to store and retrieve data from a cache using Red Hat JBoss Data Grid. For this quickstart, users can access the cache in two ways:
  • from a servlet.
  • from a JSF page using request scoped beans.
All libraries (JAR files) bundles with the application are deployed to JBoss Enterprise Application Platform 6.x. JBoss Data Grid's Library mode only allows local access to a single node in a distributed cluster. This mode also allows the application to access the data grid functionality within a virtual machine in the target container.

Important

The Hello World quickstart works only in JBoss Data Grid's Library mode.
Location

JBoss Data Grid's Hello World quickstart is available at the following location: jboss-datagrid-{VERSION}-quickstarts/

Report a bug

13.1. Quickstart Prerequisites
Copy link

The prerequisites for this quickstart are as follows:
Report a bug

13.2. Start Two Application Server Instances
Copy link

Before deploying the Hello World quickstart, start two instances of your application server (JBoss Enterprise Application Platform 6.x).

Procedure 13.1. Start the First Application Server Instance

  1. Navigate to the Root Directory

    In the command line terminal, navigate to the root for your JBoss server directory.

  2. Start the First Application Server

    Depending on your operating system, use the appropriate command from the following to start the first instance of your selected application server:
    1. For Linux: 
      $JBOSS_HOME/bin/standalone.sh
      Copy to Clipboard Toggle word wrap
    2. For Windows: 
      $JBOSS_HOME\bin\standalone.bat
      Copy to Clipboard Toggle word wrap

Procedure 13.2. Start the Second Application Server Instance

  1. Clone the Application Server

    Create a copy of the selected JBoss Server to create a second instance.

  2. Navigate to the Root Directory

    In the command line terminal, navigate to the root for your JBoss server directory.

  3. Start the Second Application Server

    Use the appropriate command for your operating system from the following commands. This command starts the server with the provided port offset to ensure that both the server instances run on the same host.
    1. For Linux: 
      $JBOSS_HOME2/bin/standalone.sh -Djboss.socket.binding.port-offset=100
      Copy to Clipboard Toggle word wrap
    2. For Windows: 
      $JBOSS_HOME2\bin\standalone.bat -Djboss.socket.binding.port-offset=100
      Copy to Clipboard Toggle word wrap
Report a bug

13.3. Build and Deploy the Hello World Quickstart
Copy link

Before building and deploying the quickstart, ensure that all the listed prerequisites are met and that the two application server instances are running (see Section 13.2, “Start Two Application Server Instances” for details).

Procedure 13.3. Build and Deploy the Hello World Quickstart

  1. Navigate to the Required Directory

    In the command line terminal, navigate to the root directory of the quickstart on the command line interface.

  2. Build and Deploy to the First Application Server Instance

    Use the following command to build and deploy the quickstart to the first application server instance as follows: 
    # mvn clean package jboss-as:deploy
    Copy to Clipboard Toggle word wrap
    This command deploys target/jboss-helloworld-jdg.war to the first running server instance.

  3. Build and Deploy to the Second Application Server Instance

    Use the following command to build and deploy the quickstart to the second application server instance with the specified ports as follows: 
    # mvn clean package jboss-as:deploy -Djboss-as.port=10099
    Copy to Clipboard Toggle word wrap
    This command deploys target/jboss-helloworld-jdg.war to the second running server instance.
Report a bug

13.4. Access the Running Application
Copy link

The Hello World quickstart application runs on the following URLs:
Report a bug

13.5. Test Replication on the Application
Copy link

Use the following instructions to test that cache entries are replicating from the first server instance to the second as desired.

Procedure 13.4. Test Replication on the Application

  1. Access the First Server

    Access the first application server and enter the key and value.
    1. Access the first application server in a browser window using the following URL: 
      http://localhost:8080/jboss-helloworld-jdg
      Copy to Clipboard Toggle word wrap
    2. Insert the key foo.
    3. Insert the value bar.

  2. Access the Second Server

    Access the second application server and enter the key and value.
    1. Access the second application server in a browser window using the following URL: 
      http://localhost:8180/jboss-helloworld-jdg
      Copy to Clipboard Toggle word wrap
    2. Click Get Some.
    3. Get the key foo.
    4. Click Put Some More.
    5. Insert the key mykey.
    6. Insert the value myvalue.

  3. Get All Keys and Values

    Access the first server and request all keys.
    1. Access the first application server in a browser window using the following URL: 
      http://localhost:8080/jboss-helloworld-jdg
      Copy to Clipboard Toggle word wrap
    2. Click Get Some.
    3. Click Get All to request all key and values.
Result

As the results of the last step show, all the data added at each server has been replicated to the other server.

Note

Entries expire after 60 seconds from the most recent update.
Directly Access Keys in the Cache

To interact with predefined servlets or to directly store and retrieve keys from the cache, use the following URLs: 

http://localhost:8080/jboss-helloworld-jdg/TestServletPut
Copy to Clipboard Toggle word wrap 
http://localhost:8180/jboss-helloworld-jdg/TestServletGet
Copy to Clipboard Toggle word wrap
Report a bug

13.6. Remove the Application
Copy link

Use the following procedure to remove the Hello World application:

Procedure 13.5. Remove the Application

  1. Start the Application Servers

    Ensure that both server instances are running.

  2. Navigate to the Root

    In the command line terminal, navigate to the root directory of the quickstart.

  3. Remove the Archive

    Use the following commands to remove the archive from both the server instances.
    1. Remove the archive from the first server as follows: 
      mvn jboss-as:undeploy
      Copy to Clipboard Toggle word wrap
    2. Remove the archive from the second server as follows: 
      mvn jboss-as:undeploy -Djboss-as.port=10099
      Copy to Clipboard Toggle word wrap
Report a bug

Chapter 14. The CarMart Quickstarts
Copy link

Red Hat JBoss Data Grid includes a transactional and non-transactional CarMart quickstart. The CarMart quickstart is a simple web application that uses JBoss Data Grid instead of a relational database. Information about each car is stored in a cache. Caches are configured declaratively or programmatically depending on the usage mode.
Features

The CarMart quickstart offers the following features:

  • List all cars
  • Add new cars
  • Remove cars
  • View statistics for caches, such as hits, stores, and retrievals
Usage Modes

The CarMart quickstart can be used in the following JBoss Data Grid usage modes:

  • Remote Client-Server Mode, where the application includes the Hot Rod client to communicate with a remote JBoss Data Grid server.
  • Library Mode, where all libraries are bundled with the application in the form of jar files.
Location

JBoss Data Grid's CarMart quickstart is available at the following location: jboss-datagrid-{VERSION}-quickstarts/

Report a bug

14.1. About the CarMart Transactional Quickstart
Copy link

The transactional version of the CarMart quickstart is a simple web application that uses Red Hat JBoss Data Grid instead of a relational database. Information about each car is stored in a cache. Caches are configured declaratively or programmatically (depending on the usage mode) and run in the same Java Virtual Machine (JVM) as the web application.
Features

The Transactional CarMart Quickstart offers the following features:

  • List all cars
  • Add new cars
  • Add new cars with rollback
  • Remove cars
  • View statistics for caches, such as hits, stores, and retrievals
Usage Modes

The Transactional CarMart Quickstart can only be used in JBoss Data Grid's Library mode. A standalone transaction manager from JBoss Transactions is used when the Transactional CarMart Quickstart is run in Red Hat JBoss Enterprise Web Server 2.x.

Location

JBoss Data Grid's Transactional CarMart Quickstart can be found at the following location: jboss-datagrid-{VERSION}-quickstarts/carmart-tx

Report a bug
Despite the similarity in steps to build, deploy and remove the transactional and non-transactional CarMart quickstarts, some differences must be noted. The following is a list of such differences:
  • CarMart is available for both Remote Client-Server Mode and Library Mode. Transactional CarMart is only available in Library Mode because transactions are not available in Remote Client-Server Mode.
  • The Transactional Quickstart also displays how a transaction rollback occurs. Use the Add car with rollback button to view the rollback. The CarMart example has a simple Add car button instead.
Report a bug
The Carmart (non-transactional) quickstart is supported for JBoss Data Grid's Library Mode with the JBoss EAP container.
Report a bug

14.3.1. Quickstart Prerequisites
Copy link

The prerequisites for this quickstart are as follows:
Report a bug
The following procedure provides directions to build and deploy the CarMart application to JBoss EAP.
Prerequisites

Prerequisites for this procedure are as follows:

  1. Obtain the supported JBoss Data Grid Library Mode distribution files.
  2. Ensure that the JBoss Data Grid and JBoss Enterprise Application Platform Maven repositories are installed and configured. For details, see Chapter 3, Install and Use the Maven Repositories
  3. Select a JBoss server to use (JBoss Enterprise Application Platform 6 (or better) or JBoss EAP 6 (or better).

Procedure 14.1. Build and Deploy CarMart to JBoss EAP

  1. Start JBoss EAP

    Navigate to the root of the JBoss EAP server directory in a terminal window and enter the following command:
    For Linux users: 
    $JBOSS_HOME/bin/standalone.sh
    Copy to Clipboard Toggle word wrap
    For Windows users: 
    $JBOSS_HOME\bin\standalone.bat
    Copy to Clipboard Toggle word wrap

  2. Build and Deploy the Application

    Use the following command to build and deploy the application using Maven: 
    $ mvn clean package jboss-as:deploy
    Copy to Clipboard Toggle word wrap
Result

The target war file (target/jboss-carmart.war) is deployed to the running instance of JBoss EAP.

Report a bug

14.3.3. View the CarMart Quickstart on JBoss EAP
Copy link

The following procedure outlines how to view the CarMart quickstart on JBoss EAP:
Prerequisite

The CarMart quickstart must be built and deployed to be viewed.

Procedure 14.2. View the CarMart Quickstart on JBoss EAP

  • To view the application, use your browser to navigate to the following link: 
    http://localhost:8080/jboss-carmart
    Copy to Clipboard Toggle word wrap
Report a bug
The following procedure provides directions to remove a deployed application from JBoss EAP.

Procedure 14.3. Remove an Application from JBoss EAP

  • To remove an application, use the following command: 
    $ mvn jboss-as:undeploy
    Copy to Clipboard Toggle word wrap
Report a bug
The Carmart (non-transactional) quickstart is supported for JBoss Data Grid's Library Mode with the JBoss Enterprise Web Server container.
Report a bug
The following procedure provides directions to build and deploy the CarMart quickstart to the JBoss Enterprise Web Server.
Prerequisites

Prerequisites for this procedure are as follows:

  1. Ensure that the JBoss Data Grid and JBoss Enterprise Application Platform Maven repositories are installed and configured. For details, see Chapter 3, Install and Use the Maven Repositories
  2. Select JBoss Enterprise Web Server 2 (or better) for your application and install it.

Procedure 14.4. Build the CarMart Quickstart to the Server (Library Mode)

  1. Start the Server

    Run the selected server by navigating to the root directory in a terminal window and enter the following command:
    For Linux users: 
    $JBOSS_EWS_HOME/tomcat7/bin/catalina.sh run
    Copy to Clipboard Toggle word wrap
    For Windows users: 
    $JBOSS_EWS_HOME\tomcat7\bin\catalina.bat run
    Copy to Clipboard Toggle word wrap

  2. Build and Deploy your Application

    Use the following command to build and deploy your application using Maven: 
    $ mvn -Plibrary-tomcat clean package tomcat:deploy
    Copy to Clipboard Toggle word wrap
Result

The target war file (target/jboss-carmart.war) is deployed to the running instance of the selected server.

Report a bug
The following procedure outlines how to view the CarMart quickstart on the JBoss Enterprise Web Server:
Prerequisite

The CarMart quickstart must be built and deployed to be viewed.

Procedure 14.5. View the CarMart Quickstart

  • To view the application, use your browser to navigate to the following link: 
    http://localhost:8080/jboss-carmart
    Copy to Clipboard Toggle word wrap
Report a bug
The following procedure provides directions to remove an already deployed application from JBoss Enterprise Web Server.

Procedure 14.6. Remove an Application from JBoss Enterprise Web Server

  • To remove an application, use the following command: 
    $ mvn tomcat:undeploy -Plibrary-tomcat
    Copy to Clipboard Toggle word wrap
Report a bug
The Carmart (non-transactional) quickstart is supported for JBoss Data Grid's Remote Client-Server Mode with the JBoss Enterprise Application Platform container.
Report a bug
This quickstart accesses Red Hat JBoss Data Grid via Hot Rod. This feature is not available for the Transactional CarMart quickstart.

Important

This quickstart deploys to JBoss Enterprise Application Platform. The application cannot be deployed to JBoss Data Grid because it does not support application deployment.
Prerequisites

Prerequisites for this procedure are as follows:

  1. Obtain the most recent supported JBoss Data Grid Remote Client-Server Mode distribution files from Red Hat.
  2. Ensure that the JBoss Data Grid and JBoss Enterprise Application Platform Maven repositories are installed and configured. For details, see Chapter 3, Install and Use the Maven Repositories
  3. Select a JBoss server to use (JBoss Enterprise Application Platform 6 (or better). Navigate to the root of the JBoss server directory in a terminal window and enter the following command:
    For Linux users: 
    $JBOSS_HOME/bin/standalone.sh
    Copy to Clipboard Toggle word wrap
    For Windows users: 
    $JBOSS_HOME\bin\standalone.bat
    Copy to Clipboard Toggle word wrap

Procedure 14.7. Build and Deploy the CarMart Quickstart in Remote Client-Server Mode

  1. Configure the Standalone File

    Add the following configuration to the standalone.xml file located in the $JDG_HOME/standalone/configuration/ directory.
    1. Add the following configuration within the infinispan subsystem tags: 
      <local-cache name="carcache" 
	     start="EAGER" 
	     batching="false"
	     statistics="true">
	<eviction strategy="LIRS" 
		  max-entries="4"/>
</local-cache>
      Copy to Clipboard Toggle word wrap

      Note

      If the carcache element already exists in your configuration, replace it with the provided configuration.

  2. Start the JBoss Data Grid Server

    Run the following script to start the JBoss Data Grid Server: 
    $JDG_HOME/bin/standalone.sh -Djboss.socket.binding.port-offset=100
    Copy to Clipboard Toggle word wrap

  3. Start the JBoss Server

    Run the following script to start the JBoss server instance where your application will deploy: 
    $JBOSS_HOME/bin/standalone.sh
    Copy to Clipboard Toggle word wrap

  4. Optional: Specify the Host and Port Address

    The application uses the values in the jboss-datagrid-{VERSION}-quickstarts/carmart/src/main/resources/META-INF/datagrid.properties file to locate the JBoss Data Grid server. If your JBoss Data Grid server is not running using the default host and port values, edit the file and insert the correct host and port values, as follows: 
    datagrid.host=localhost
datagrid.hotrod.port=11322
    Copy to Clipboard Toggle word wrap

  5. Build and Deploy the Application

    Use the following command to build and deploy your application in the relevant directory: 
    $ mvn clean package jboss-as:deploy -Premote-jbossas
    Copy to Clipboard Toggle word wrap
Report a bug
The following procedure outlines how to view the CarMart quickstart in Red Hat JBoss Data Grid's Remote Client-Server Mode:
Prerequisite

The CarMart quickstart must be built and deployed be viewed.

Procedure 14.8. View the CarMart Quickstart in Remote Client-Server Mode

  • Visit the following link in a browser window to view the application: 
    http://localhost:8080/jboss-carmart
    Copy to Clipboard Toggle word wrap
Report a bug
The following procedure provides directions to remove an already deployed application in Red Hat JBoss Data Grid's Remote Client-Server mode.

Procedure 14.9. Remove an Application in Remote Client-Server Mode

  • To remove an application, use the following command: 
    $ mvn jboss-as:undeploy -Premote-jbossas
    Copy to Clipboard Toggle word wrap
Report a bug
The Carmart (non-transactional) quickstart is supported for JBoss Data Grid's Remote Client-Server Mode with the JBoss Enterprise Web Server container.
Report a bug
This quickstart accesses Red Hat JBoss Data Grid via Hot Rod. This feature is not available for the Transactional CarMart quickstart.

Important

This quickstart deploys to JBoss Enterprise Web Server or Tomcat. The application cannot be deployed to JBoss Data Grid because it does not support application deployment.
Prerequisites

Prerequisites for this procedure are as follows:

  1. Obtain the most recent supported JBoss Data Grid Remote Client-Server Mode distribution files from Red Hat.
  2. Ensure that the JBoss Data Grid and JBoss Enterprise Application Platform Maven repositories are installed and configured. For details, see Chapter 3, Install and Use the Maven Repositories
  3. Add a server element to the Maven settings.xml file. In the id elements within server, add the appropriate tomcat credentials. 
    <server>
    <id>tomcat</id>
    <username>admin</username>
    <password>admin</password>
</server>
    Copy to Clipboard Toggle word wrap

Procedure 14.10. Build and Deploy the CarMart Quickstart in Remote Client-Server Mode

  1. Configure the Standalone File

    Add the following configuration to the standalone.xml file located in the $JDG_HOME/standalone/configuration/ directory.
    1. Add the following configuration within the infinispan subsystem tags: 
      <local-cache name="carcache" 
	     start="EAGER" 
	     batching="false"
	     statistics="true">
	<eviction strategy="LIRS" 
		  max-entries="4"/>
</local-cache>
      Copy to Clipboard Toggle word wrap

      Note

      If the carcache element already exists in your configuration, replace it with the provided configuration.

  2. Start the Container

    Start the JBoss server instance where your application will deploy.
    For Linux: 
    $JBOSS_EWS_HOME/tomcat7/bin/catalina.sh run
    Copy to Clipboard Toggle word wrap
    For Windows: 
    $JBOSS_EWS_HOME\tomcat7\bin\catalina.bat run
    Copy to Clipboard Toggle word wrap

  3. Build the Application

    Use the following command to build your application in the relevant directory: 
    $ mvn clean package -Premote-tomcat
    Copy to Clipboard Toggle word wrap

  4. Deploy the Application

    Use the following command to deploy the application in the relevant directory: 
    mvn tomcat:deploy -Premote-tomcat
    Copy to Clipboard Toggle word wrap
Report a bug
The following procedure outlines how to view the CarMart quickstart in Red Hat JBoss Data Grid's Remote Client-Server Mode:
Prerequisite

The CarMart quickstart must be built and deployed be viewed.

Procedure 14.11. View the CarMart Quickstart in Remote Client-Server Mode

  • Visit the following link in a browser window to view the application: 
    http://localhost:8080/jboss-carmart
    Copy to Clipboard Toggle word wrap
Report a bug
The following procedure provides directions to remove an already deployed application in Red Hat JBoss Data Grid's Remote Client-Server mode.

Procedure 14.12. Remove an Application in Remote Client-Server Mode

  • To remove an application, use the following command: 
    $ mvn tomcat:undeploy -Premote-tomcat
    Copy to Clipboard Toggle word wrap
Report a bug
This CarMart Transactional quickstart requires JBoss Data Grid's Library mode with the JBoss Enterprise Application Platform container.
All required libraries (jar files) are bundled with the application and deployed to the server. Caches are configured programmatically and run in the same JVM as the web application.
All operations are transactional and are configured at JBossASCacheContainerProvider/TomcatCacheContainerProvider implementation classes for the CacheContainerProvider interface.
Report a bug

14.7.1. Quickstart Prerequisites
Copy link

The prerequisites for this quickstart are as follows:
Report a bug
Prerequisites

Ensure that the following prerequisites are met before building and deploying the CarMart quickstart.

  1. Configure Maven (See Section 14.7.1, “Quickstart Prerequisites”)
  2. Start JBoss Enterprise Application Platform:
    1. In a command line terminal, navigate to the root of the JBoss EAP server directory.
    2. Use one of the following commands to start the server with a web profile:
      For Linux: 
      $JBOSS_HOME/bin/standalone.sh
      Copy to Clipboard Toggle word wrap
      For Windows: 
      %JBOSS_HOME%\bin\standalone.bat
      Copy to Clipboard Toggle word wrap

Procedure 14.13. Build and Deploy the Transactional Quickstart

  1. In a command line terminal, navigate to the root of the JBoss EAP server directory.
  2. Enter the following command to build and deploy the archive: 
    mvn clean package jboss-as:deploy
    Copy to Clipboard Toggle word wrap
  3. The target/jboss-carmart-tx.war file is deployed to the running instance of the server.
Report a bug

14.7.3. View the Transactional CarMart Quickstart
Copy link

The following procedure outlines how to view the CarMart quickstart:
Prerequisite

The CarMart quickstart must be built and deployed to be viewed.

Procedure 14.14. View the CarMart Quickstart

  • To view the application, use your browser to navigate to the following link: 
    http://localhost:8080/jboss-carmart-tx
    Copy to Clipboard Toggle word wrap
Report a bug
Undeploy the transactional CarMart quickstart as follows:
  1. In a command line terminal, navigate to the root directory of the quickstart.
  2. Undeploy the archive as follows: 
    mvn jboss-as:undeploy
    Copy to Clipboard Toggle word wrap
Report a bug

14.7.5. Test the Transactional CarMart Quickstart
Copy link

The JBoss Data Grid quickstarts include Arquillian Selenium tests. To run these tests:
  1. Stop JBoss EAP, if it is running.
  2. In a command line terminal, navigate to root directory for the quickstart.
  3. Build the quickstarts as follows: 
    mvn clean package
    Copy to Clipboard Toggle word wrap
  4. Run the tests as follows: 
    mvn test -Puitests-jbossas -Das7home=/path/to/server
    Copy to Clipboard Toggle word wrap
Report a bug
This CarMart Transactional quickstart requires JBoss Data Grid's Library mode with the JBoss Enterprise Web Server container.
All the required libraries (jar files) are bundled with the application and deployed to the server. Caches are configured programatically and run in the same JVM as the web application for this quickstart.
Additionally, all operations are transactional. The standalone transaction manager from JBoss Transactions is used to run the application in JBoss Enterprise Web Server.
Only the library-tomcat profile can be used when running this quickstart with JBoss Enterprise Web Server because this profile enables library mode.
Report a bug

14.8.1. Quickstart Prerequisites
Copy link

The prerequisites for this quickstart are as follows:
Report a bug
Prerequisites

Ensure that the following prerequisites are met before building and deploying the CarMart quickstart.

  1. Configure Maven (See Section 14.8.1, “Quickstart Prerequisites”)
  2. To configure JBoss Enterprise Web Server, add the following lines to the conf/tomcat-users.xml file: 
    <role rolename="manager-script"/>
    <user username="admin" password="admin" roles="manager-script"/>
    Copy to Clipboard Toggle word wrap
  3. Configure Maven by adding the following configuration information to the Maven settings.xml file with the appropriate credentials: 
    <server>
	<id>tomcat</id>
	<username>admin</username>
	<password>admin</password>
</server>
    Copy to Clipboard Toggle word wrap
  4. Start JBoss Enterprise Web Server:
    1. In a command line terminal, navigate to the root of the JBoss Enterprise Web Server directory.
    2. Use one of the following commands to start the server with a web profile:
      For Linux: 
      $TOMCAT_HOME/bin/catalina.sh run
      Copy to Clipboard Toggle word wrap
      For Windows: 
      %TOMCAT_HOME%\bin\catalina.bat run
      Copy to Clipboard Toggle word wrap

Procedure 14.15. Build and Deploy the Transactional CarMart Quickstart

  1. In a command line terminal, navigate to the root directory for the quickstart.
  2. Enter the following command to build and deploy archive: 
    mvn -Plibrary-tomcat clean package tomcat:deploy
    Copy to Clipboard Toggle word wrap
  3. The target/jboss-carmart-tx.war file is deployed to the running instance of JBoss Enterprise Web Server.
Report a bug

14.8.3. View the Transactional CarMart Quickstart
Copy link

The following procedure outlines how to view the CarMart quickstart:
Prerequisite

The CarMart quickstart must be built and deployed to be viewed.

Procedure 14.16. View the CarMart Quickstart

  • To view the application, use your browser to navigate to the following link: 
    http://localhost:8080/jboss-carmart-tx
    Copy to Clipboard Toggle word wrap
Report a bug
Undeploy the transactional CarMart quickstart as follows:
  1. In a command line terminal, navigate to the root directory of the quickstart.
  2. Undeploy the archive as follows: 
    mvn -Plibrary-tomcat tomcat:undeploy
    Copy to Clipboard Toggle word wrap
Report a bug

14.8.5. Test the Transactional CarMart Quickstart
Copy link

The JBoss Data Grid quickstarts include Arquillian Selenium tests. To run these tests:
  1. Undeploy the archive (see Section 14.8.4, “Undeploy The Transactional CarMart Quickstart”)
  2. Stop JBoss Enterprise Web Server, if it is running.
  3. In a command line terminal, navigate to root directory for the quickstart.
  4. Build the quickstarts as follows: 
    mvn clean package
    Copy to Clipboard Toggle word wrap
  5. Run the tests as follows: 
    mvn test -Puitests-jbossas -Das7home=/path/to/server
    Copy to Clipboard Toggle word wrap
Report a bug
The Football application is a simple example to illustrate the use of Red Hat JBoss Data Grid endpoints, namely Hot Rod, REST, and Memcached. Each example shows one of these protocols used to connect to JBoss Data Grid to remotely store, retrieve, and remove data from caches.
Each application is a variation of a simple football team manager utility as a console application.
Features

The following features are available with the example Football Manager application:

  • Add a team
  • Add players
  • Remove all entities (teams and players)
  • Listing all teams and players
Location

JBoss Data Grid's Football quickstart can be found at the following locations:

  • jboss-datagrid-{VERSION}-quickstarts/rest-endpoint
  • jboss-datagrid-{VERSION}-quickstarts/hotrod-endpoint
  • jboss-datagrid-{VERSION}-quickstarts/memcached-endpoint
Report a bug

15.1. Quickstart Prerequisites
Copy link

The prerequisites for this quickstart are as follows:
Report a bug

15.2. Build the Football Application
Copy link

The following procedure outlines the steps to build a football manager application as an example of REST, Hot Rod and memcached endpoints in Red Hat JBoss Data Grid.

Important

JBoss Data Grid does not support deploying applications, therefore this quickstart cannot be installed as a deployment.
Prerequisites

Prerequisites for this procedure are as follows:

  1. Obtain the most recent supported JBoss Data Grid Remote Client-Server Mode distribution files from Red Hat.
  2. Ensure that the JBoss Data Grid and JBoss Enterprise Application Platform Maven repositories are installed and configured. For details, see Chapter 3, Install and Use the Maven Repositories

Procedure 15.1. Build the Football Application

  1. Add Configurations

    Edit the standalone.xml file (located at $JDG_HOME/standalone/configuration/) to add definitions for the datasource and infinispan subsystems.
    1. Add the following subsystem definition for the datasource: 
      <subsystem xmlns="urn:jboss:domain:datasources:1.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>
      Copy to Clipboard Toggle word wrap
    2. Add the following subsystem definition for infinispan: 
      <subsystem xmlns="urn:infinispan:server:core:6.0"
	     default-cache-container="local">

	<cache-container name="local" 
			 default-cache="default"
			 statistics="true">

	        <local-cache name="default" 
			     start="EAGER"
			     statistics="true">

			<locking isolation="NONE" 
				 acquire-timeout="30000" 
				 concurrency-level="1000" 
				 striping="false"/>

			<transaction mode="NONE"/>

		</local-cache>

		<local-cache name="memcachedCache" 
			     start="EAGER"
			     statistics="true">

			<locking isolation="NONE" 
				 acquire-timeout="30000" 
				 concurrency-level="1000" 
				 striping="false"/>
			<transaction mode="NONE"/>

		</local-cache>

	        <local-cache name="namedCache" 
			     start="EAGER" 
			     statistics="true"/>
	
	        <!-- ADD a local cache called 'teams' -->
	
		<local-cache name="teams"
		             start="EAGER"
	         	     batching="false" 
	         	     statistics="true">
	
	            <!-- Disable transactions for this cache -->
			<transaction mode="NONE" />

	            <!-- Define the JdbcBinaryStores 
			to point to the ExampleDS previously 
			defined -->

			<string-keyed-jdbc-store 
				datasource="java:jboss/datasources/ExampleDS" 
 				passivation="false" 
				preload="false" 
				purge="false">
	
		                <!-- Define the database dialect -->
		                <property name="databaseType">H2</property>

	                <!-- 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>
      Copy to Clipboard Toggle word wrap

    Note

    The Hot Rod and REST endpoints use the cache named teams and memcached endpoint uses memcachedCache as a default.

  2. Disable REST Security

    As a default, the standalone.xml configuration file protects the REST endpoint with BASIC authentication. This quickstart cannot perform authentication, therefore the REST authentication must be disabled in the REST connector by removing the security-domain and auth-method parameters. The resulting configuration (with REST authentication disabled) is as follows: 
    <rest-connector virtual-server="default-host"
                cache-container="local" />
    Copy to Clipboard Toggle word wrap
    For more details about security, see the REST Authentication Chapter in JBoss Data Grid's Developer Guide.

  3. Edit the Submodule Configuration File

    Each submodule (specifically hotrod-endpoint, rest-endpoint and memcached-endpoint) contains a configuration file (located at $JDG_QUICKSTART/src/main/resources/jdg.properties). Modify the default values in the configuration file to set the values required for your specific JBoss Data Grid installation.

  4. Build the Application

    Use the following command to build the example application in its directory: 
    mvn clean package
    Copy to Clipboard Toggle word wrap
    This step results in the use of Maven's shade plugin, which bundles all dependencies into a single jar file for ease of use. This file is named {PROTOCOL}-endpoint-quickstart.jar, for example rest-endpoint-quickstart.jar for the REST version.

  5. Start JBoss Data Grid

    Run the following script to run JBoss Data Grid: 
    $JDG_HOME/bin/standalone.sh
    Copy to Clipboard Toggle word wrap

  6. Run the Application

    Run the example application in its directory with the following command: 
    mvn exec:java
    Copy to Clipboard Toggle word wrap
Report a bug

Chapter 16. The Rapid Stock Market Quickstart
Copy link

The Rapid Stock Market quickstart demonstrates how JBoss Data Grid's compatibility mode works with a Hot Rod client (to store data) and a HTTP client using REST (to retrieve data). This quickstart is only available in JBoss Data Grid's Remote Client-Server mode and does not use any containers.
The Rapid Stock Market quickstart includes a server-side and a client-side application.
Report a bug
The Rapid Stock Market quickstart requires the following configuration for the server and client sides of the application.

Procedure 16.1. Rapid Stock Market Quickstart Server-side Configuration

  1. Build a server module for the JBoss Data Grid Server by packaging a class that is common for the client and server in a jar file: 
    $ mvn clean package -Pprepare-server-module
    Copy to Clipboard Toggle word wrap
    Place the new jar file in a directory structure that is similar to the server module.
  2. Install the server module into the server.
    1. Copy the prepared module to the server: 
      $ cp -r target/modules ${JDG_SERVER_HOME}/
      Copy to Clipboard Toggle word wrap
    2. Add the new module as a dependency of the org.infinispan.commons module by adding the following into the modules/system/layers/base/org/infinispan/commons/mainmodule.xml file: 
      <module name="org.infinispan.quickstart.compatibility.common"/>
      Copy to Clipboard Toggle word wrap
  3. Build the application: 
    $ mvn clean package
    Copy to Clipboard Toggle word wrap
  4. Configure the JBoss Data Grid to use the appropriate configuration file.
    1. Copy the example configuration file for compatibility mode to a location where the JBoss Data Grid Server can locate and use it: 
      $ cp ${JDG_SERVER_HOME}/docs/examples/configs/standalone-compatibility-mode.xml ${JDG_SERVER_HOME}/standalone/configuration
      Copy to Clipboard Toggle word wrap
    2. Remove the security-domain and auth-method attributes from the rest-connector element to disable REST security.
  5. Start the JBoss Data Grid Server in compatibility mode: 
    $ ${JDG_SERVER_HOME}/bin/standalone.sh -c standalone-compatibility-mode.xml
    Copy to Clipboard Toggle word wrap

Procedure 16.2. Rapid Stock Market Quickstart Client-side Configuration

  1. In a new command line terminal window, start the client-side application: 
    $ mvn exec:java -Pclient
    Copy to Clipboard Toggle word wrap
  2. Use the instructions in the help menu for the client application.
Report a bug

Part VI. Uninstall Red Hat JBoss Data Grid
Copy link

Chapter 17. Remove Red Hat JBoss Data Grid
Copy link

The following procedures contain instructions to remove Red Hat JBoss Data Grid from your Linux system.

Warning

Once deleted, all JBoss Data Grid configuration and settings are permanently lost.

Procedure 17.1. Remove JBoss Data Grid from Your Linux System

  1. Shut Down Server

    Ensure that the JBoss Data Grid server is shut down.

  2. Navigate to the JBoss Data Grid Home Directory

    Use the command line to change into the level above the $JDG_HOME folder.

  3. Delete the JBoss Data Grid Home Directory

    Enter the following command in the terminal to remove JBoss Data Grid, replacing $JDG_HOME with the name of your JBoss Data Grid home directory: 
    $ rm -Rf $JDG_HOME
    Copy to Clipboard Toggle word wrap
Report a bug
The following procedures contain instructions to remove Red Hat JBoss Data Grid from your Microsoft Windows system.

Warning

Once deleted, all JBoss Data Grid configuration and settings are permanently lost.

Procedure 17.2. Remove JBoss Data Grid from Your Windows System

  1. Shut Down Server

    Ensure that the JBoss Data Grid server is shut down.

  2. Navigate to the JBoss Data Grid Home Directory

    Use the Windows Explorer to navigate to the directory in which the $JDG_HOME folder is located.

  3. Delete the JBoss Data Grid Home Directory

    Select the $JDG_HOME folder and delete it.
Report a bug

Appendix A. References
Copy link

A.1. About Key-Value Pairs
Copy link

A key-value pair (KVP) is a set of data consisting of a key and a value.
  • A key is unique to a particular data entry. It consists of entry data attributes from the related entry.
  • A value is the data assigned to and identified by the key.
Report a bug

Appendix B. Maven Configuration Information
Copy link

This example outlines the steps to install the JBoss Enterprise Application Platform 6 Maven Repository using Sonatype Nexus Maven Repository Manager. For further instructions, see http://www.sonatype.org/nexus/.

Procedure B.1. Download the JBoss Enterprise Application Platform 6 Maven Repository ZIP archive

  1. Open a web browser and access the following URL: https://access.redhat.com/jbossnetwork/restricted/listSoftware.html?product=appplatform.
  2. Find Application Platform 6 Maven Repository in the list.
  3. Click Download to download a ZIP file that contains the repository.
  4. Unzip the files into the desired target directory.

Procedure B.2. Add the JBoss Enterprise Application Platform 6 Maven Repository using Nexus Maven Repository Manager

  1. Log into Nexus as an Administrator.
  2. Select the Repositories section from the Views → Repositories menu to the left of your repository manager.
  3. Click the Add... drop-down menu, then select Hosted Repository.
  4. Provide a name and ID for the new repository.
  5. Enter the unzipped repository path in the Override Local Storage Location field.
  6. Continue if the artifact must be available in a repository group. If not, do not continue with this procedure.
  7. Select the repository group.
  8. Click on the Configure tab.
  9. Drag the new JBoss Maven repository from the Available Repositories list to the Ordered Group Repositories list on the left.

    Note

    The order of this list determines the priority for searching Maven artifacts.
Result

The repository is configured using Nexus Maven Repository Manager.

Report a bug

B.2. Maven Repository Configuration Example
Copy link

A sample Maven repository file named example-settings.xml is available in the root directory of the Maven repository folder after it is unzipped. The following is an excerpt that contains the relevant parts of the example-settings.xml file:

Example B.1. Sample Maven Repository Configuration

<?xml version="1.0" encoding="UTF-8"?>

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" 
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 
          http://maven.apache.org/xsd/settings-1.0.0.xsd">
  
  <proxies>
    <!-- proxy
      Specification for one proxy, to be used in connecting to the network.

    <proxy>
      <id>optional</id>
      <active>true</active>
      <protocol>http</protocol>
      <username>proxyuser</</username>
      <password>proxypass</password>
      <host>proxy.host.net</host>
      <port>80</port>
      <nonProxyHosts>local.net|some.host.com</nonProxyHosts>
    </proxy>
    -->
  </proxies>
  
  <profiles>

    <!-- Configure the JBoss GA Maven repository -->
    <profile>
      <id>jboss-ga-repository</id>
      <repositories>
        <repository>
          <id>jboss-ga-repository</id>
          <url>http://maven.repository.redhat.com/techpreview/all</url>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
          <id>jboss-ga-plugin-repository</id>
          <url>http://maven.repository.redhat.com/techpreview/all</url>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
        </pluginRepository>
      </pluginRepositories>
    </profile>
    <!-- Configure the JBoss Early Access Maven repository -->
    <profile>
      <id>jboss-earlyaccess-repository</id>
      <repositories>
        <repository>
          <id>jboss-earlyaccess-repository</id>
          <url>http://maven.repository.redhat.com/earlyaccess/all/</url>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
          <id>jboss-earlyaccess-plugin-repository</id>
          <url>http://maven.repository.redhat.com/earlyaccess/all/</url>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
        </pluginRepository>
      </pluginRepositories>
    </profile>

  </profiles>

  <activeProfiles>
    <!-- Optionally, make the repositories active by default -->
    <activeProfile>jboss-ga-repository</activeProfile>
    <activeProfile>jboss-earlyaccess-repository</activeProfile>
  </activeProfiles>

</settings>
Copy to Clipboard Toggle word wrap
Report a bug

Appendix C. Revision History
Copy link

Revision History
Revision 6.4.0-11Wed Apr 1 2015Christian Huffman
Updated versions for release.
Revision 6.4.0-10Fri Mar 27 2015Christian Huffman
BZ-1200004: Corrected feature name.
Revision 6.4.0-9Tue Mar 17 2015Rakesh Ghatvisave
BZ-1200004: Updated feature name.
Revision 6.4.0-8Fri Mar 13 2015Rakesh Ghatvisave
BZ-1200004: Updated feature names.
Revision 6.4.0-7Wed Feb 18 2015Rakesh Ghatvisave
BZ-1183208: Fixed repeated dependency definition.
Revision 6.4.0-6Tue Jan 27 2015Misha Husnain Ali
Updated for release.
Revision 6.4.0-5Fri Jan 23 2015Gemma Sheldon
BZ-1183016: Added Spring xml examples for instantiating the cacheManager.
BZ-1182988: Explained URI difference between local and remote client-server modes.
Revision 6.4.0-4Mon Jan 05 2015Rakesh Ghatvisave
BZ-1108463: Made changes to Karaf section.
BZ-1108463: Implemented Martin's feedback.
BZ-1172863: Added support caveat.
Revision 6.4.0-3Tue Nov 18 2014Misha Husnain Ali
Final version for Beta.
Revision 6.4.0-2Thu Nov 13 2014Gemma Sheldon
BZ-1110066: Added chapter about camel-jbossdatagrid component.
Updated package names and technical preview notes from 6.3 to 6.4 where applicable.
Revision 6.4.0-1Wed Oct 22 2014Misha Husnain Ali
Updated programlisting for improved display.
Revision 6.4.0-0Wed Sep 24 2014Misha Husnain Ali
First draft for new release.

Legal Notice
Copy link

Copyright © 2015 Red Hat, Inc.
This document is licensed by Red Hat under the Creative Commons Attribution-ShareAlike 3.0 Unported License. If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc. and provide a link to the original. If the document is modified, all Red Hat trademarks must be removed.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat