Embedding Data Grid in Java Applications

Procedure

1. Log in to the Red Hat customer portal.
2. Navigate to the Software Downloads for Data Grid.
3. Download the Red Hat Data Grid 8.3 Maven Repository.
4. Extract the archived Maven repository to your local file system.
5. Open the README.md file and follow the appropriate installation instructions.

Procedure

1. Open your project pom.xml for editing.
2. Define the version.infinispan property with the correct Data Grid version.

3. Include the infinispan-bom in a dependencyManagement section.

   The Bill Of Materials (BOM) controls dependency versions, which avoids version conflicts and means you do not need to set the version for each Data Grid artifact you add as a dependency to your project.

4. Save and close pom.xml.

Procedure

1. Initialize the default cache manager so you can add embedded caches.
2. Add at least one embedded cache with the ConfigurationBuilder API.
3. Invoke the getOrCreateCache() method that either creates embedded caches on all nodes in the cluster or returns caches that already exist.

Procedure

1. Open your Data Grid configuration for editing.
2. Add the statistics="true" attribute or the .statistics(true) method.
3. Save and close your Data Grid configuration.

Procedure

1. Open your Data Grid configuration for editing.
2. Add the metrics element or object to the cache container.
3. Enable or disable gauges with the gauges attribute or field.
4. Enable or disable histograms with the histograms attribute or field.
5. Save and close your client configuration.

Procedure

1. Open your Data Grid configuration for editing.
2. Add the jmx element or object to the cache container and specify true as the value for the enabled attribute or field.
3. Add the domain attribute or field and specify the domain where JMX MBeans are exposed, if required.
4. Save and close your client configuration.

Procedure

1. Create a new JGroups stack declaration in your infinispan.xml file.
2. Add the extends attribute and specify a JGroups stack to inherit properties from.
3. Use the stack.combine attribute to modify properties for protocols configured in the inherited stack.
4. Use the stack.position attribute to define the location for your custom stack.

5. Specify the stack name as the value for the stack attribute in the transport configuration.

   For example, you might evaluate using a Gossip router and symmetric encryption with the default TCP stack as follows:

   <infinispan>
     <jgroups>
       <!-- Creates a custom JGroups stack named "my-stack". -->
       <!-- Inherits properties from the default TCP stack. -->
       <stack name="my-stack" extends="tcp">
         <!-- Uses TCPGOSSIP as the discovery mechanism instead of MPING -->
         <TCPGOSSIP initial_hosts="${jgroups.tunnel.gossip_router_hosts:localhost[12001]}"
                stack.combine="REPLACE"
                stack.position="MPING" />
         <!-- Removes the FD_SOCK protocol from the stack. -->
         <FD_SOCK stack.combine="REMOVE"/>
         <!-- Modifies the timeout value for the VERIFY_SUSPECT protocol. -->
         <VERIFY_SUSPECT timeout="2000"/>
         <!-- Adds SYM_ENCRYPT to the stack after VERIFY_SUSPECT. -->
         <SYM_ENCRYPT sym_algorithm="AES"
                      keystore_name="mykeystore.p12"
                      keystore_type="PKCS12"
                      store_password="changeit"
                      key_password="changeit"
                      alias="myKey"
                      stack.combine="INSERT_AFTER"
                      stack.position="VERIFY_SUSPECT" />
       </stack>
       <cache-container name="default" statistics="true">
         <!-- Uses "my-stack" for cluster transport. -->
         <transport cluster="${infinispan.cluster.name}"
                    stack="my-stack"
                    node-name="${infinispan.node.name:}"/>
      </cache-container>
     </jgroups>
   </infinispan>

   Copy to Clipboard Toggle word wrap

6. Check Data Grid logs to ensure it uses the stack.

   [org.infinispan.CLUSTER] ISPN000078: Starting JGroups channel cluster with stack my-stack

   Copy to Clipboard Toggle word wrap

Procedure

1. Put custom JGroups stack files on the application classpath.

   Alternatively you can specify an absolute path when you declare the external stack file.

2. Reference the external stack file with the stack-file element.

   <infinispan>
     <jgroups>
        <!-- Creates a "prod-tcp" stack that references an external file. -->
        <stack-file name="prod-tcp" path="prod-jgroups-tcp.xml"/>
     </jgroups>
     <cache-container default-cache="replicatedCache">
       <!-- Use the "prod-tcp" stack for cluster transport. -->
       <transport stack="prod-tcp" />
       <replicated-cache name="replicatedCache"/>
     </cache-container>
     <!-- Cache configuration goes here. -->
   </infinispan>

   Copy to Clipboard Toggle word wrap