WIP: Add redis backed cache as alternative for infinispan

bom/pom.xml

@@ -326,6 +326,26 @@ quarkus.vertx.max-event-loop-execute-time=${max.event-loop.execute-time:20000}
         <artifactId>hono-client-core</artifactId>
         <version>${project.version}</version>
       </dependency>
+      <dependency>
+        <groupId>org.eclipse.hono</groupId>
+        <artifactId>hono-cache-common</artifactId>
+        <version>${project.version}</version>
+      </dependency>
+      <dependency>
+        <groupId>org.eclipse.hono</groupId>
+        <artifactId>hono-cache-infinispan</artifactId>
+        <version>${project.version}</version>
+      </dependency>
+      <dependency>
+        <groupId>org.eclipse.hono</groupId>
+        <artifactId>hono-cache-redis</artifactId>
+        <version>${project.version}</version>
+      </dependency>
+      <dependency>
+        <groupId>org.eclipse.hono</groupId>
+        <artifactId>hono-client-device-connection</artifactId>
+        <version>${project.version}</version>
+      </dependency>
       <dependency>
         <groupId>org.eclipse.hono</groupId>
         <artifactId>hono-client-common</artifactId>

caches/cache-common/pom.xml

@@ -0,0 +1,112 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+    Copyright (c) 2021, 2022 Contributors to the Eclipse Foundation
+
+    See the NOTICE file(s) distributed with this work for additional
+    information regarding copyright ownership.
+
+    This program and the accompanying materials are made available under the
+    terms of the Eclipse Public License 2.0 which is available at
+    http://www.eclipse.org/legal/epl-2.0
+
+    SPDX-License-Identifier: EPL-2.0
+ -->
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>org.eclipse.hono</groupId>
+        <artifactId>hono-caches-parent</artifactId>
+        <version>2.5.0-SNAPSHOT</version>
+    </parent>
+    <artifactId>hono-cache-common</artifactId>
+
+    <name>Hono Cache Common</name>
+    <description>Classes required for implementing Hono caches</description>
+
+    <dependencies>
+        <dependency>
+            <groupId>io.vertx</groupId>
+            <artifactId>vertx-core</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.eclipse.hono</groupId>
+            <artifactId>hono-client-common</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-core</artifactId>
+            <optional>true</optional>
+            <exclusions>
+                <exclusion>
+                    <groupId>org.jboss.logmanager</groupId>
+                    <artifactId>jboss-logmanager-embedded</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>org.jboss.logging</groupId>
+                    <artifactId>jboss-logging-annotations</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>io.quarkus</groupId>
+                    <artifactId>quarkus-development-mode-spi</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>io.quarkus</groupId>
+                    <artifactId>quarkus-bootstrap-runner</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>org.jboss.slf4j</groupId>
+                    <artifactId>slf4j-jboss-logmanager</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>org.graalvm.sdk</groupId>
+                    <artifactId>graal-sdk</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>io.quarkus</groupId>
+                    <artifactId>quarkus-fs-util</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
+
+        <!--
+        <dependency>
+            <groupId>org.eclipse.hono</groupId>
+            <artifactId>hono-core</artifactId>
+            <exclusions>
+                <exclusion>
+                    <groupId>io.opentracing</groupId>
+                    <artifactId>opentracing-noop</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
+        <dependency>
+            <groupId>io.vertx</groupId>
+            <artifactId>vertx-core</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.vertx</groupId>
+            <artifactId>vertx-health-check</artifactId>
+            <exclusions>
+                <exclusion>
+                    <groupId>io.vertx</groupId>
+                    <artifactId>vertx-auth-common</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
+-->
+        <!-- testing -->
+        <!--
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-classic</artifactId>
+            <scope>test</scope>
+        </dependency>
+-->
+    </dependencies>
+</project>

caches/cache-common/src/main/java/org/eclipse/hono/cache/Cache.java

@@ -0,0 +1,119 @@
+/**
+ * Copyright (c) 2020, 2021 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+
+package org.eclipse.hono.cache;
+
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.TimeUnit;
+
+import io.vertx.core.Future;
+import io.vertx.core.json.JsonObject;
+
+/**
+ * A simple {@code Map} like interface to a data grid cache.
+ *
+ * @param <K> The type of keys used for looking up data.
+ * @param <V> The type of values stored in grid.
+ */
+public interface Cache<K, V> {
+
+    /**
+     * Checks if the cache is connected to the data grid.
+     * <p>
+     * If a cache is found to be not connected here, this method may trigger a connection (re)establishment.
+     *
+     * @return A future that is completed with information about a successful check's result.
+     *         Otherwise, the future will be failed with a
+     *         {@link org.eclipse.hono.client.ServerErrorException}.
+     */
+    Future<JsonObject> checkForCacheAvailability();
+
+    /**
+     * Puts a value to the cache.
+     *
+     * @param key The key.
+     * @param value The value.
+     * @return A succeeded future if the value has been stored successfully.
+     *         A failed future if the value could not be stored in the cache.
+     * @throws NullPointerException if any of the parameters is {@code null}.
+     */
+    Future<Void> put(K key, V value);
+
+    /**
+     * Puts a value to the cache.
+     *
+     * @param key The key.
+     * @param value The value.
+     * @param lifespan The lifespan of the entry. A negative value is interpreted as an unlimited lifespan.
+     * @param lifespanUnit The time unit for the lifespan.
+     * @return A succeeded future if the value has been stored successfully.
+     *         A failed future if the value could not be stored in the cache.
+     * @throws NullPointerException if any of the parameters is {@code null}.
+     */
+    Future<Void> put(K key, V value, long lifespan, TimeUnit lifespanUnit);
+
+    /**
+     * Puts all values of the given map to the cache.
+     *
+     * @param data The map with the entries to add.
+     * @return A succeeded future if the operation succeeded.
+     *         A failed future if there was an error storing the entries in the cache.
+     * @throws NullPointerException if data is {@code null}.
+     */
+    Future<Void> putAll(Map<? extends K, ? extends V> data);
+
+    /**
+     * Puts all values of the given map to the cache.
+     *
+     * @param data The map with the entries to add.
+     * @param lifespan The lifespan of the entries. A negative value is interpreted as an unlimited lifespan.
+     * @param lifespanUnit The time unit for the lifespan.
+     * @return A succeeded future if the operation succeeded.
+     *         A failed future if there was an error storing the entries in the cache.
+     * @throws NullPointerException if any of the parameters is {@code null}.
+     */
+    Future<Void> putAll(Map<? extends K, ? extends V> data, long lifespan, TimeUnit lifespanUnit);
+
+    /**
+     * Gets a value from the cache.
+     *
+     * @param key The key.
+     * @return A succeeded future containing the value or {@code null} if the
+     *         cache didn't contain the key yet.
+     *         A failed future if the value could not be read from the cache.
+     * @throws NullPointerException if key is {@code null}.
+     */
+    Future<V> get(K key);
+
+    /**
+     * Removes a key/value mapping from the cache.
+     *
+     * @param key The key.
+     * @param value The value.
+     * @return A succeeded future containing {@code true} if the key was
+     *         mapped to the value, {@code false} otherwise.
+     *         A failed future if the value could not be removed from the cache.
+     * @throws NullPointerException if any of the parameters is {@code null}.
+     */
+    Future<Boolean> remove(K key, V value);
+
+    /**
+     * Gets the values for the specified keys from the cache.
+     *
+     * @param keys The keys.
+     * @return A succeeded future containing a map with key/value pairs.
+     * @throws NullPointerException if keys is {@code null}.
+     */
+    Future<Map<K, V>> getAll(Set<? extends K> keys);
+}

caches/cache-common/src/main/java/org/eclipse/hono/cache/CommonCacheConfig.java

@@ -0,0 +1,86 @@
+/*******************************************************************************
+ * Copyright (c) 2020, 2022 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *******************************************************************************/
+
+package org.eclipse.hono.cache;
+
+import com.google.common.base.MoreObjects;
+
+/**
+ * Common cache configuration options.
+ */
+public class CommonCacheConfig {
+
+    /**
+     * The default name of the (remote) cache in the data grid that is used for
+     * storing device connection information.
+     */
+    public static final String DEFAULT_CACHE_NAME = "device-connection";
+
+    private String cacheName = DEFAULT_CACHE_NAME;
+
+    private String checkKey = "KEY_CONNECTION_CHECK";
+    private String checkValue = "VALUE_CONNECTION_CHECK";
+
+    /**
+     * Creates properties for default values.
+     */
+    public CommonCacheConfig() {
+        super();
+    }
+
+    /**
+     * Creates properties for existing options.
+     *
+     * @param options The options to copy.
+     */
+    public CommonCacheConfig(final CommonCacheOptions options) {
+        super();
+        this.cacheName = options.cacheName();
+        this.checkKey = options.checkKey();
+        this.checkValue = options.checkValue();
+    }
+
+    public void setCacheName(final String cacheName) {
+        this.cacheName = cacheName;
+    }
+
+    public String getCacheName() {
+        return cacheName;
+    }
+
+    public void setCheckKey(final String checkKey) {
+        this.checkKey = checkKey;
+    }
+
+    public String getCheckKey() {
+        return checkKey;
+    }
+
+    public void setCheckValue(final String checkValue) {
+        this.checkValue = checkValue;
+    }
+
+    public String getCheckValue() {
+        return checkValue;
+    }
+
+    @Override
+    public String toString() {
+        return MoreObjects
+                .toStringHelper(this)
+                .add("cacheName", this.cacheName)
+                .add("checkKey", this.checkKey)
+                .add("checkValue", this.checkValue)
+                .toString();
+    }
+}

caches/cache-common/src/main/java/org/eclipse/hono/cache/CommonCacheOptions.java

@@ -0,0 +1,52 @@
+/**
+ * Copyright (c) 2021 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+
+package org.eclipse.hono.cache;
+
+import org.eclipse.hono.util.CommandRouterConstants;
+
+import io.smallrye.config.ConfigMapping;
+import io.smallrye.config.ConfigMapping.NamingStrategy;
+import io.smallrye.config.WithDefault;
+
+/**
+ * Common options for configuring a cache.
+ *
+ */
+@ConfigMapping(prefix = "hono.cache.common", namingStrategy = NamingStrategy.VERBATIM)
+public interface CommonCacheOptions {
+
+    /**
+     * Gets the name of the cache.
+     *
+     * @return The name.
+     */
+    @WithDefault(CommandRouterConstants.DEFAULT_CACHE_NAME)
+    String cacheName();
+
+    /**
+     * Gets the key to use for checking the cache's availability.
+     *
+     * @return The key.
+     */
+    @WithDefault("KEY_CONNECTION_CHECK")
+    String checkKey();
+
+    /**
+     * The value to use for checking the cache's availability.
+     *
+     * @return The value.
+     */
+    @WithDefault("VALUE_CONNECTION_CHECK")
+    String checkValue();
+}