Data Grid Spring Boot Starter

1. Red Hat Data Grid
Link kopieren

Data Grid is a high-performance, distributed in-memory data store.

Schemaless data structure: Flexibility to store different objects as key-value pairs.
Grid-based data storage: Designed to distribute and replicate data across clusters.
Elastic scaling: Dynamically adjust the number of nodes to meet demand without service disruption.
Data interoperability: Store, retrieve, and query data in the grid from different endpoints.

1.1. Data Grid Documentation
Link kopieren

Documentation for Data Grid is available on the Red Hat customer portal.

1.2. Data Grid Downloads
Link kopieren

Access the Data Grid Software Downloads on the Red Hat customer portal.

Note

You must have a Red Hat account to access and download Data Grid software.

2. Setting Up Your Project
Link kopieren

Add dependencies for the Data Grid Spring Boot Starter to your project.

2.1. Enforcing Data Grid Versions
Link kopieren

This starter uses a high-level API to ensure compatibility between major versions of Data Grid. However you can enforce a specific version of Data Grid with the infinispan-bom module.

Add infinispan-bom to your pom.xml file before the starter dependencies, as follows:

<dependencyManagement>
    <dependencies>
       <dependency>
           <groupId>org.infinispan</groupId>
           <artifactId>infinispan-bom</artifactId>
           <version>${version.infinispan}</version>
           <type>pom</type>
           <scope>import</scope>
       </dependency>
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-parent</artifactId>
           <version>${version.spring.boot}</version>
           <type>pom</type>
           <scope>import</scope>
       </dependency>
       <dependency>
           <groupId>org.infinispan</groupId>
           <artifactId>infinispan-spring-boot-starter</artifactId>
           <version>2.2.4.Final-redhat-00001</version>
       </dependency>
    </dependencies>
 </dependencyManagement>

<dependencyManagement>
    <dependencies>
       <dependency>
           <groupId>org.infinispan</groupId>
           <artifactId>infinispan-bom</artifactId>
           <version>${version.infinispan}</version>
           <type>pom</type>
           <scope>import</scope>
       </dependency>
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-parent</artifactId>
           <version>${version.spring.boot}</version>
           <type>pom</type>
           <scope>import</scope>
       </dependency>
       <dependency>
           <groupId>org.infinispan</groupId>
           <artifactId>infinispan-spring-boot-starter</artifactId>
           <version>2.2.4.Final-redhat-00001</version>
       </dependency>
    </dependencies>
 </dependencyManagement>

Copy to Clipboard

Toggle word wrap

Important

The Data Grid Spring Boot starter uses different Spring Boot versions to other projects such as Red Hat OpenShift Application Runtimes. If you want to use a specific Spring Boot version for compatibility with other projects, you must add the correct dependency to your project.

2.2. Adding Dependencies for Usage Modes
Link kopieren

Data Grid provides different dependencies for each usage mode. Add one of the following to your pom.xml file:

Embedded Mode

<dependency>
  <groupId>org.infinispan</groupId>
  <artifactId>infinispan-spring-boot-starter-embedded</artifactId>
  <version>2.2.4.Final-redhat-00001</version>
</dependency>

<dependency>
  <groupId>org.infinispan</groupId>
  <artifactId>infinispan-spring-boot-starter-embedded</artifactId>
  <version>2.2.4.Final-redhat-00001</version>
</dependency>

Copy to Clipboard

Toggle word wrap

Remote Client/Server Mode

<dependency>
  <groupId>org.infinispan</groupId>
  <artifactId>infinispan-spring-boot-starter-remote</artifactId>
  <version>2.2.4.Final-redhat-00001</version>
</dependency>

<dependency>
  <groupId>org.infinispan</groupId>
  <artifactId>infinispan-spring-boot-starter-remote</artifactId>
  <version>2.2.4.Final-redhat-00001</version>
</dependency>

Copy to Clipboard

Toggle word wrap

3. Running in Embedded Mode
Link kopieren

Embed the Data Grid library in your project for in-memory data storage.

3.1. Adding the EmbeddedCacheManager Bean
Link kopieren

Add infinispan-spring-boot-starter-embedded to your project’s classpath to enable Embedded mode.
This starter operates in Remote Client/Server mode with infinispan-spring-boot-starter-remote on the classpath by default.

Use the Spring @Autowired annotation to include an EmbeddedCacheManager bean in your Java configuration classes, as in the following example:

private final EmbeddedCacheManager cacheManager;

@Autowired
public YourClassName(EmbeddedCacheManager cacheManager) {
    this.cacheManager = cacheManager;
}

private final EmbeddedCacheManager cacheManager;

@Autowired
public YourClassName(EmbeddedCacheManager cacheManager) {
    this.cacheManager = cacheManager;
}

Copy to Clipboard

Toggle word wrap

You are now ready to use Data Grid in Embedded Mode. Here is a simple example:

cacheManager.getCache("testCache").put("testKey", "testValue");
System.out.println("Received value from cache: " + cacheManager.getCache("testCache").get("testKey"));

cacheManager.getCache("testCache").put("testKey", "testValue");
System.out.println("Received value from cache: " + cacheManager.getCache("testCache").get("testKey"));

Copy to Clipboard

Toggle word wrap

3.2. Cache Manager Configuration Beans
Link kopieren

You can customize the cache manager with the following configuration beans:

InfinispanGlobalConfigurer
InfinispanCacheConfigurer
Configuration
InfinispanConfigurationCustomizer
InfinispanGlobalConfigurationCustomizer
Note
You can create one InfinispanGlobalConfigurer bean only. However you can create multiple configurations with the other beans.

InfinispanCacheConfigurer Bean

@Bean
public InfinispanCacheConfigurer cacheConfigurer() {
	return manager -> {
		final Configuration ispnConfig = new ConfigurationBuilder()
                        .clustering()
                        .cacheMode(CacheMode.LOCAL)
                        .build();

		manager.defineConfiguration("local-sync-config", ispnConfig);
	};
}

@Bean
public InfinispanCacheConfigurer cacheConfigurer() {
	return manager -> {
		final Configuration ispnConfig = new ConfigurationBuilder()
                        .clustering()
                        .cacheMode(CacheMode.LOCAL)
                        .build();

		manager.defineConfiguration("local-sync-config", ispnConfig);
	};
}

Copy to Clipboard

Toggle word wrap

Configuration Bean

Link the bean name to the cache that it configures, as follows:

@Bean(name = "small-cache")
public org.infinispan.configuration.cache.Configuration smallCache() {
    return new ConfigurationBuilder()
        .read(baseCache)
        .memory().size(1000L)
        .memory().evictionType(EvictionType.COUNT)
        .build();
}

@Bean(name = "large-cache")
public org.infinispan.configuration.cache.Configuration largeCache() {
    return new ConfigurationBuilder()
        .read(baseCache)
        .memory().size(2000L)
        .build();
}

@Bean(name = "small-cache")
public org.infinispan.configuration.cache.Configuration smallCache() {
    return new ConfigurationBuilder()
        .read(baseCache)
        .memory().size(1000L)
        .memory().evictionType(EvictionType.COUNT)
        .build();
}

@Bean(name = "large-cache")
public org.infinispan.configuration.cache.Configuration largeCache() {
    return new ConfigurationBuilder()
        .read(baseCache)
        .memory().size(2000L)
        .build();
}

Copy to Clipboard

Toggle word wrap

Customizer Beans

@Bean
public InfinispanGlobalConfigurationCustomizer globalCustomizer() {
   return builder -> builder.transport().clusterName(CLUSTER_NAME);
}

@Bean
public InfinispanConfigurationCustomizer configurationCustomizer() {
   return builder -> builder.memory().evictionType(EvictionType.COUNT);
}

@Bean
public InfinispanGlobalConfigurationCustomizer globalCustomizer() {
   return builder -> builder.transport().clusterName(CLUSTER_NAME);
}

@Bean
public InfinispanConfigurationCustomizer configurationCustomizer() {
   return builder -> builder.memory().evictionType(EvictionType.COUNT);
}

Copy to Clipboard

Toggle word wrap

3.3. Enabling Spring Cache Support
Link kopieren

Add the @EnableCaching annotation to your application to enable Spring Cache support.

When this starter detects the EmbeddedCacheManager bean, it instantiates a new SpringEmbeddedCacheManager, which provides an implementation of Spring Cache.

4. Running in Server Mode
Link kopieren

Store and retrieve data from remote Data Grid clusters using Hot Rod, a custom TCP binary wire protocol.

4.1. Setting Up the RemoteCacheManager
Link kopieren

Provide the location for the Data Grid server so the starter can create the RemoteCacheManager bean.
The starter first tries to find the server location in hotrod-client.properties and then from application.properties.

Use the Spring @Autowired annotation to include your own custom cache manager class in your application:

private final RemoteCacheManager cacheManager;

@Autowired
public YourClassName(RemoteCacheManager cacheManager) {
    this.cacheManager = cacheManager;
}

private final RemoteCacheManager cacheManager;

@Autowired
public YourClassName(RemoteCacheManager cacheManager) {
    this.cacheManager = cacheManager;
}

Copy to Clipboard

Toggle word wrap

Hot Rod client properties

Specify client configuration in hotrod-client.properties on your classpath, for example:

List Infinispan or Data Grid servers by IP address or hostname at port 11222.

# List Infinispan or Data Grid servers by IP address or hostname at port 11222.
infinispan.client.hotrod.server_list=127.0.0.1:6667

Copy to Clipboard

Toggle word wrap

For more information, see org.infinispan.client.hotrod.configuration.

Application properties

Configure your project with application.properties. See Application Properties for more information.

4.2. Configuring Marshalling
Link kopieren

Configure Data Grid servers to use Java serialization to marshall objects.

By default Data Grid server uses a ProtoStream serialization library as the default marshaller. However, the ProtoStream marshaller is not supported for Spring integration. For this reason you should use the Java Serialization Marshaller.

Specify the following properties in your application.properties:

infinispan.remote.marshaller=org.infinispan.commons.marshall.JavaSerializationMarshaller 
infinispan.remote.java-serial-whitelist=your_marshalled_beans_package.*

infinispan.remote.marshaller=org.infinispan.commons.marshall.JavaSerializationMarshaller

1


infinispan.remote.java-serial-whitelist=your_marshalled_beans_package.*

2

Copy to Clipboard

Toggle word wrap

1: Use the Java Serialization Marshaller.
2: Adds your classes to the serialization whitelist so Data Grid marshalls your objects. You can specify a comma-separated list of fully qualified class names or a regular expression to match classes.

4.3. Cache Manager Configuration Beans
Link kopieren

Customize the cache manager with the following configuration beans:

InfinispanRemoteConfigurer
Configuration
InfinispanRemoteCacheCustomizer
Note
You can create one InfinispanRemoteConfigurer bean only. However you can create multiple configurations with the other beans.

InfinispanRemoteConfigurer Bean

@Bean
public InfinispanRemoteConfigurer infinispanRemoteConfigurer() {
    return () -> new ConfigurationBuilder()
        .addServer()
        .host("127.0.0.1")
        .port(12345)
        .build();
}

@Bean
public InfinispanRemoteConfigurer infinispanRemoteConfigurer() {
    return () -> new ConfigurationBuilder()
        .addServer()
        .host("127.0.0.1")
        .port(12345)
        .build();
}

Copy to Clipboard

Toggle word wrap

Configuration Bean

@Bean
public org.infinispan.client.hotrod.configuration.Configuration customConfiguration() {
    new ConfigurationBuilder()
        .addServer()
        .host("127.0.0.1")
        .port(12345)
        .build();
}

@Bean
public org.infinispan.client.hotrod.configuration.Configuration customConfiguration() {
    new ConfigurationBuilder()
        .addServer()
        .host("127.0.0.1")
        .port(12345)
        .build();
}

Copy to Clipboard

Toggle word wrap

InfinispanRemoteCacheCustomizer Bean

@Bean
public InfinispanRemoteCacheCustomizer customizer() {
    return b -> b.tcpKeepAlive(false);
}

@Bean
public InfinispanRemoteCacheCustomizer customizer() {
    return b -> b.tcpKeepAlive(false);
}

Copy to Clipboard

Toggle word wrap

Tip

Use the @Ordered annotation to apply customizers in a specific order.

4.4. Enabling Spring Cache Support
Link kopieren

Add the @EnableCaching annotation to your application to enable Spring Cache support.

When the Data Grid starter detects the RemoteCacheManager bean, it instantiates a new SpringRemoteCacheManager, which provides an implementation of Spring Cache.

4.5. Exposing Data Grid Statistics
Link kopieren

Data Grid supports the Spring Boot Actuator to expose cache statistics as metrics.

To use the Actuator, add the following to your pom.xml file:

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-actuator</artifactId>
  <version>${version.spring.boot}</version>
 </dependency>

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
  <version>${version.spring.boot}</version>
</dependency>

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-actuator</artifactId>
  <version>${version.spring.boot}</version>
 </dependency>

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
  <version>${version.spring.boot}</version>
</dependency>

Copy to Clipboard

Toggle word wrap

You must then activate statistics for the appropriate cache instances, either programmatically or declaratively.

Programmatically

@Bean
public InfinispanCacheConfigurer cacheConfigurer() {
  return cacheManager -> {
     final org.infinispan.configuration.cache.Configuration config =
           new ConfigurationBuilder()
                 .jmxStatistics().enable()
                 .build();

     cacheManager.defineConfiguration("my-cache", config);
  };
}

@Bean
public InfinispanCacheConfigurer cacheConfigurer() {
  return cacheManager -> {
     final org.infinispan.configuration.cache.Configuration config =
           new ConfigurationBuilder()
                 .jmxStatistics().enable()
                 .build();

     cacheManager.defineConfiguration("my-cache", config);
  };
}

Copy to Clipboard

Toggle word wrap

Declaratively

<local-cache name="my-cache" statistics="true"/>

<local-cache name="my-cache" statistics="true"/>

Copy to Clipboard

Toggle word wrap

The Spring Boot Actuator registry binds cache instances when your application starts. If you create caches dynamically, you should use the CacheMetricsRegistrar bean to bind caches to the Actuator registry, as follows:

@Autowire
CacheMetricsRegistrar cacheMetricsRegistrar;

@Autowire
CacheManager cacheManager;
...

cacheMetricsRegistrar.bindCacheToRegistry(cacheManager.getCache("my-cache"));

@Autowire
CacheMetricsRegistrar cacheMetricsRegistrar;

@Autowire
CacheManager cacheManager;
...

cacheMetricsRegistrar.bindCacheToRegistry(cacheManager.getCache("my-cache"));

Copy to Clipboard

Toggle word wrap

5. Using Spring Session
Link kopieren

5.1. Enabling Spring Session Support
Link kopieren

Data Grid Spring Session support is built on SpringRemoteCacheManager and SpringEmbeddedCacheManager. This starter produces those beans by default.

To use Spring Session in your project, do the following:

Add this starter to your project.
Add Spring Session to the classpath.
Add the following annotations to your configuration:
- @EnableCaching
- @EnableInfinispanRemoteHttpSession
- @EnableInfinispanEmbeddedHttpSession

6. Application Properties
Link kopieren

Configure your project with application.properties or application.yaml.

List Infinispan or Data Grid servers by IP address or hostname at port 11222.
Embedded Properties - Uncomment properties to use them.
Enables embedded capabilities in your application.
Values are true (default) or false.
Sets the Spring state machine ID.
Sets the name of the embedded cluster.
Specifies a XML configuration file that takes priority over the global
configuration bean or any configuration customizer.
Server Properties - Uncomment properties to use them.
Specifies a custom filename for Hot Rod client properties.
Enables remote server connections.
Values are true (default) or false.
Defines a comma-separated list of servers in this format:
`host1[:port],host2[:port]`.
Sets a timeout value, in milliseconds, for socket connections.
Sets a timeout value for initializing connections with servers.
Sets the maximum number of attempts to connect to servers.
Specifies the marshaller to use.
Adds your classes to the serialization whitelist.

# List Infinispan or Data Grid servers by IP address or hostname at port 11222.
infinispan.remote.server-list=127.0.0.1:11222

#
# Embedded Properties - Uncomment properties to use them.
#

# Enables embedded capabilities in your application.
# Values are true (default) or false.
#infinispan.embedded.enabled =

# Sets the Spring state machine ID.
#infinispan.embedded.machineId =

# Sets the name of the embedded cluster.
#infinispan.embedded.clusterName =

# Specifies a XML configuration file that takes priority over the global
# configuration bean or any configuration customizer.
#infinispan.embedded.configXml =

#
# Server Properties - Uncomment properties to use them.
#

# Specifies a custom filename for Hot Rod client properties.
#infinispan.remote.clientProperties =

# Enables remote server connections.
# Values are true (default) or false.
#infinispan.remote.enabled =

# Defines a comma-separated list of servers in this format:
# `host1[:port],host2[:port]`.
#infinispan.remote.serverList =

# Sets a timeout value, in milliseconds, for socket connections.
#infinispan.remote.socketTimeout =

# Sets a timeout value for initializing connections with servers.
#infinispan.remote.connectTimeout =

# Sets the maximum number of attempts to connect to servers.
#infinispan.remote.maxRetries =

# Specifies the marshaller to use.
#infinispan.remote.marshaller =

# Adds your classes to the serialization whitelist.
#infinispan.remote.java-serial-whitelist=

Copy to Clipboard

Toggle word wrap

Dieser Inhalt ist in der von Ihnen ausgewählten Sprache nicht verfügbar.

Data Grid Documentation
Link kopieren

1. Red Hat Data Grid
Link kopieren

1.1. Data Grid Documentation
Link kopieren

1.2. Data Grid Downloads
Link kopieren

2. Setting Up Your Project
Link kopieren

2.1. Enforcing Data Grid Versions
Link kopieren

2.2. Adding Dependencies for Usage Modes
Link kopieren

3. Running in Embedded Mode
Link kopieren

3.1. Adding the EmbeddedCacheManager Bean
Link kopieren

3.2. Cache Manager Configuration Beans
Link kopieren

3.3. Enabling Spring Cache Support
Link kopieren

4. Running in Server Mode
Link kopieren

4.1. Setting Up the RemoteCacheManager
Link kopieren

4.2. Configuring Marshalling
Link kopieren

4.3. Cache Manager Configuration Beans
Link kopieren

4.4. Enabling Spring Cache Support
Link kopieren

4.5. Exposing Data Grid Statistics
Link kopieren

5. Using Spring Session
Link kopieren

5.1. Enabling Spring Session Support
Link kopieren

6. Application Properties
Link kopieren

Lernen

Testen, kaufen und verkaufen

Communitys

Über Red Hat Dokumentation

Mehr Inklusion in Open Source

Über Red Hat

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

Dieser Inhalt ist in der von Ihnen ausgewählten Sprache nicht verfügbar.

Data Grid Spring Boot Starter

Data Grid DocumentationLink kopierenLink in die Zwischenablage kopiert!

1. Red Hat Data GridLink kopierenLink in die Zwischenablage kopiert!

1.1. Data Grid DocumentationLink kopierenLink in die Zwischenablage kopiert!

1.2. Data Grid DownloadsLink kopierenLink in die Zwischenablage kopiert!

2. Setting Up Your ProjectLink kopierenLink in die Zwischenablage kopiert!

2.1. Enforcing Data Grid VersionsLink kopierenLink in die Zwischenablage kopiert!

2.2. Adding Dependencies for Usage ModesLink kopierenLink in die Zwischenablage kopiert!

3. Running in Embedded ModeLink kopierenLink in die Zwischenablage kopiert!

3.1. Adding the EmbeddedCacheManager BeanLink kopierenLink in die Zwischenablage kopiert!

3.2. Cache Manager Configuration BeansLink kopierenLink in die Zwischenablage kopiert!

3.3. Enabling Spring Cache SupportLink kopierenLink in die Zwischenablage kopiert!

4. Running in Server ModeLink kopierenLink in die Zwischenablage kopiert!

4.1. Setting Up the RemoteCacheManagerLink kopierenLink in die Zwischenablage kopiert!

4.2. Configuring MarshallingLink kopierenLink in die Zwischenablage kopiert!

4.3. Cache Manager Configuration BeansLink kopierenLink in die Zwischenablage kopiert!

4.4. Enabling Spring Cache SupportLink kopierenLink in die Zwischenablage kopiert!

4.5. Exposing Data Grid StatisticsLink kopierenLink in die Zwischenablage kopiert!

5. Using Spring SessionLink kopierenLink in die Zwischenablage kopiert!

5.1. Enabling Spring Session SupportLink kopierenLink in die Zwischenablage kopiert!

6. Application PropertiesLink kopierenLink in die Zwischenablage kopiert!

Lernen

Testen, kaufen und verkaufen

Communitys

Über Red Hat Dokumentation

Mehr Inklusion in Open Source

Über Red Hat

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

Data Grid Documentation
Link kopieren

1. Red Hat Data Grid
Link kopieren

1.1. Data Grid Documentation
Link kopieren

1.2. Data Grid Downloads
Link kopieren

2. Setting Up Your Project
Link kopieren

2.1. Enforcing Data Grid Versions
Link kopieren

2.2. Adding Dependencies for Usage Modes
Link kopieren

3. Running in Embedded Mode
Link kopieren

3.1. Adding the EmbeddedCacheManager Bean
Link kopieren

3.2. Cache Manager Configuration Beans
Link kopieren

3.3. Enabling Spring Cache Support
Link kopieren

4. Running in Server Mode
Link kopieren

4.1. Setting Up the RemoteCacheManager
Link kopieren

4.2. Configuring Marshalling
Link kopieren

4.3. Cache Manager Configuration Beans
Link kopieren

4.4. Enabling Spring Cache Support
Link kopieren

4.5. Exposing Data Grid Statistics
Link kopieren

5. Using Spring Session
Link kopieren

5.1. Enabling Spring Session Support
Link kopieren

6. Application Properties
Link kopieren