Replace RedisSecurityStore constructors with Builder

eclipse-leshan · Mar 2, 2023 · 58270cc · 58270cc
1 parent 070aa87
commit 58270cc
Show file tree

Hide file tree

Showing 3 changed files with 81 additions and 16 deletions.
diff --git a/...test/java/org/eclipse/leshan/integration/tests/util/RedisSecureIntegrationTestHelper.java b/...test/java/org/eclipse/leshan/integration/tests/util/RedisSecureIntegrationTestHelper.java
@@ -34,7 +34,7 @@ protected SecurityStore createSecurityStore() {
         } else {
             jedis = new JedisPool();
         }
-        securityStore = new RedisSecurityStore(jedis);
+        securityStore = new RedisSecurityStore.Builder(jedis).build();
         return securityStore;
     }
 }
diff --git a/leshan-server-demo/src/main/java/org/eclipse/leshan/server/demo/LeshanServerDemo.java b/leshan-server-demo/src/main/java/org/eclipse/leshan/server/demo/LeshanServerDemo.java
@@ -34,7 +34,7 @@
 import org.eclipse.californium.elements.util.CertPathUtil;
 import org.eclipse.californium.scandium.config.DtlsConfig;
 import org.eclipse.californium.scandium.config.DtlsConfig.DtlsRole;
-import org.eclipse.californium.scandium.config.DtlsConnectorConfig.Builder;
+import org.eclipse.californium.scandium.config.DtlsConnectorConfig;
 import org.eclipse.jetty.server.Server;
 import org.eclipse.jetty.servlet.ServletHolder;
 import org.eclipse.jetty.webapp.WebAppContext;
@@ -162,7 +162,7 @@ public static LeshanServer createLeshanServer(LeshanServerDemoCLI cli) throws Ex
             securityStore = new FileSecurityStore();
         } else {
             // use Redis Store
-            securityStore = new RedisSecurityStore(cli.main.redis);
+            securityStore = new RedisSecurityStore.Builder(cli.main.redis).build();
             builder.setRegistrationStore(new RedisRegistrationStore(cli.main.redis));
         }
         builder.setSecurityStore(securityStore);
@@ -190,8 +190,10 @@ public CaliforniumServerEndpointFactory createDefaultEndpointFactory(URI uri) {
                 return new CoapsServerEndpointFactory(uri) {
 
                     @Override
-                    protected Builder createDtlsConnectorConfigBuilder(Configuration endpointConfiguration) {
-                        Builder dtlsConfigBuilder = super.createDtlsConnectorConfigBuilder(endpointConfiguration);
+                    protected DtlsConnectorConfig.Builder createDtlsConnectorConfigBuilder(
+                            Configuration endpointConfiguration) {
+                        DtlsConnectorConfig.Builder dtlsConfigBuilder = super.createDtlsConnectorConfigBuilder(
+                                endpointConfiguration);
 
                         // Add MDC for connection logs
                         if (cli.helpsOptions.getVerboseLevel() > 0)

diff --git a/leshan-server-redis/src/main/java/org/eclipse/leshan/server/redis/RedisSecurityStore.java b/leshan-server-redis/src/main/java/org/eclipse/leshan/server/redis/RedisSecurityStore.java
@@ -38,9 +38,6 @@
  * <p>
  * Security info are stored using the endpoint as primary key and a secondary index is created for endpoint lookup by
  * PSK identity.
- * <p>
- * By default, uses {@code SEC#EP#} key prefix to find security info by endpoint and {@code EP#PSKID} key to get the
- * endpoint by PSK ID. Leshan v1.x used {@code SEC#EP#} and {@code PSKID#SEC} keys for that accordingly.
  */
 public class RedisSecurityStore implements EditableSecurityStore {
 
@@ -52,14 +49,10 @@ public class RedisSecurityStore implements EditableSecurityStore {
 
     private final List<SecurityStoreListener> listeners = new CopyOnWriteArrayList<>();
 
-    public RedisSecurityStore(Pool<Jedis> pool) {
-        this(pool, "SEC#EP#", "EP#PSKID");
-    }
-
-    public RedisSecurityStore(Pool<Jedis> pool, String securityInfoByEndpointPrefix, String endpointByPskIdKey) {
-        this.pool = pool;
-        this.securityInfoByEndpointPrefix = securityInfoByEndpointPrefix;
-        this.endpointByPskIdKey = endpointByPskIdKey;
+    private RedisSecurityStore(Builder builder) {
+        this.pool = builder.pool;
+        this.securityInfoByEndpointPrefix = builder.securityInfoByEndpointPrefix;
+        this.endpointByPskIdKey = builder.endpointByPskIdKey;
     }
 
     @Override
@@ -177,4 +170,74 @@ public void addListener(SecurityStoreListener listener) {
     public void removeListener(SecurityStoreListener listener) {
         listeners.remove(listener);
     }
+
+    /**
+     * Class helping to build and configure a {@link RedisSecurityStore}.
+     * <p>
+     * By default, uses {@code SECSTORE#} prefix for all keys, {@code SEC#EP#} key prefix to find security info by
+     * endpoint and {@code EP#PSKID} key to get the endpoint by PSK ID. Leshan v1.x used {@code SEC#EP#} and
+     * {@code PSKID#SEC} keys for that accordingly.
+     */
+    public static class Builder {
+        private Pool<Jedis> pool;
+        private String securityInfoByEndpointPrefix;
+
+        private String endpointByPskIdKey;
+
+        private String prefix;
+
+        /**
+         * Set the Redis connection pool for the {@link RedisSecurityStore}.
+         */
+        public void setPool(Pool<Jedis> pool) {
+            this.pool = pool;
+        }
+
+        /**
+         * Set the key prefix for security info lookup by endpoint.
+         * <p>
+         * Default value is {@literal SEC#EP#}.
+         */
+        public void setSecurityInfoByEndpointPrefix(String securityInfoByEndpointPrefix) {
+            this.securityInfoByEndpointPrefix = securityInfoByEndpointPrefix;
+        }
+
+        /**
+         * Set the key for endpoint lookup by PSK identity.
+         * <p>
+         * Default value is {@literal EP#PSKID}.
+         */
+        public void setEndpointByPskIdKey(String endpointByPskIdKey) {
+            this.endpointByPskIdKey = endpointByPskIdKey;
+        }
+
+        /**
+         * Set the prefix for all keys and prefixes including {@link #securityInfoByEndpointPrefix} and
+         * {@link #endpointByPskIdKey}.
+         * <p>
+         * Default value is {@literal SECSTORE#}.
+         */
+        public void setPrefix(String prefix) {
+            this.prefix = prefix;
+        }
+
+        public Builder(Pool<Jedis> pool) {
+            this.pool = pool;
+            this.prefix = "SECSTORE#";
+            this.securityInfoByEndpointPrefix = "SEC#EP#";
+            this.endpointByPskIdKey = "EP#PSKID";
+        }
+
+        /**
+         * Create the {@link RedisSecurityStore}.
+         * <p>
+         * @return the Redis security store.
+         */
+        public RedisSecurityStore build() {
+            this.securityInfoByEndpointPrefix = this.prefix + this.securityInfoByEndpointPrefix;
+            this.endpointByPskIdKey = this.prefix + this.endpointByPskIdKey;
+
+            return new RedisSecurityStore(this);
+        }
+    }
 }