Redis Key-Value Store Component

Prerequisites

An instance of Redis server needs to run on a node and needs to be accessible from the Blueriq Runtime.

Depending on the linux distribution, a Redis package may be available from the repository in any case consult their official documentation here.

Enable/Disable

In order to enable the component, the profile "keyvalue-redis-store" profile must be added in the bootstrap.properties

spring.profiles.active=native,keyvalue-redis-store

Properties

The Redis Key-Value Store Component defines the following properties used for 9. Concurrency Control on Multiple Nodes:

The Redis Key-Value Store Component uses the following default Spring Boot properties in order to connect to Redis:

The following example configuration connects the Runtime to a Redis instance running on localhost on the default port and using a password:

spring.redis.host=localhost
spring.redis.password=example

Using the key-value store in custom plug-ins

Blueriq provides an IKeyValueStore interface which can be used to interact with a generic key-value store. In order to use this interface, add blueriq-component-api to your project's dependencies:

<dependency>
  <groupId>com.blueriq</groupId>
  <artifactId>blueriq-component-api</artifactId>
  <version>${blueriq.version}</version>
</dependency>

Then, inject the IKeyValueStore in your components:

@Component
public class ExampleComponent {
 
  private final IKeyValueStore keyValueStore;
 
  public ExampleComponent(IKeyValueStore keyValueStore) {
    this.keyValueStore = keyValueStore;
  }
 
  public void operation() {
    keyValueStore.set(namespacedKey("key"), "value");
  }
 
  private String namespacedKey(String key) {
    return "example" + keyValueStore.getNamespaceSeparator() + key;
  }
}

Note that we recommend using namespaces for your keys, in order to keep them separate from keys used by Blueriq or Spring Session. The root namespace used by Blueriq is "blueriq". The root namespace used by Spring Session is "spring". 

If you would like to hide the namespace logic, the NamespacedKeyValueStore implementation may be used, available in the blueriq-runtime artifact. The code example below writes the same "example:key" key in the key-value store, but without having to explicitly prefix the key with a namespace every time:

@Component
public class ExampleComponent {
 
  private final IKeyValueStore keyValueStore;
 
  public ExampleComponent(IKeyValueStore keyValueStore) {
    this.keyValueStore = new NamespacedKeyValueStore(keyValueStore, "example");
  }
 
  public void operation() {
    keyValueStore.set("key", "value");
  }
}

Using other key-value store implementations

It is possible to replace the default Redis-based key-value store implementation with an implementation that uses another type of key-value store.

How to create your own implementation is documented here.