sync: add methods to initialize SyncBuilder with multiple auth credentials #252

Author: Shubham

objectbox-java/src/main/java/io/objectbox/sync/Sync.java

@@ -93,6 +93,23 @@ public static SyncServerBuilder server(BoxStore boxStore, String url, SyncCreden
         return new SyncServerBuilder(boxStore, url, authenticatorCredentials);
     }
 
+    /**
+     * Starts building a {@link SyncServer}. Once done, complete with {@link SyncServerBuilder#build() build()}.
+     * <p>
+     * Note: when also using Admin, make sure it is started before the server.
+     *
+     * @param boxStore The {@link BoxStore} the server should use.
+     * @param url The URL of the Sync server on which the Sync protocol is exposed. This is typically a WebSockets URL
+     * starting with {@code ws://} or {@code wss://} (for encrypted connections), for example
+     * {@code ws://0.0.0.0:9999}.
+     * @param multipleAuthenticatorCredentials An authentication method available to Sync clients and peers. Additional
+     * authenticator credentials can be supplied using the returned builder. For the embedded server, currently only
+     * {@link SyncCredentials#sharedSecret} and {@link SyncCredentials#none} are supported.
+     */
+    public static SyncServerBuilder server(BoxStore boxStore, String url, SyncCredentials[] multipleAuthenticatorCredentials) {
+        return new SyncServerBuilder(boxStore, url, multipleAuthenticatorCredentials);
+    }
+
     /**
      * Starts building a {@link SyncHybrid}, a client/server hybrid typically used for embedded cluster setups.
      * <p>

objectbox-java/src/main/java/io/objectbox/sync/SyncClient.java

@@ -133,6 +133,10 @@ public interface SyncClient extends Closeable {
      */
     void setLoginCredentials(SyncCredentials credentials);
 
+    /**
+     * Updates the login credentials. This should not be required during regular use.
+     * It allows passing login credentials that the client can use to authenticate with the server.
+     */
     void setLoginCredentials(SyncCredentials[] multipleCredentials);
 
     /**

objectbox-java/src/main/java/io/objectbox/sync/server/SyncServerBuilder.java

@@ -81,6 +81,28 @@ public SyncServerBuilder(BoxStore boxStore, String url, SyncCredentials authenti
         authenticatorCredentials(authenticatorCredentials);
     }
 
+    /**
+     * Use {@link Sync#server(BoxStore, String, SyncCredentials)} instead.
+     */
+    @Internal
+    public SyncServerBuilder(BoxStore boxStore, String url, SyncCredentials[] multipleAuthenticatorCredentials) {
+        checkNotNull(boxStore, "BoxStore is required.");
+        checkNotNull(url, "Sync server URL is required.");
+        checkNotNull(multipleAuthenticatorCredentials, "Authenticator credentials are required.");
+        if (!BoxStore.isSyncServerAvailable()) {
+            throw new IllegalStateException(
+                    "This library does not include ObjectBox Sync Server. " +
+                            "Please visit https://objectbox.io/sync/ for options.");
+        }
+        this.boxStore = boxStore;
+        try {
+            this.url = new URI(url);
+        } catch (URISyntaxException e) {
+            throw new IllegalArgumentException("Sync server URL is invalid: " + url, e);
+        }
+        authenticatorCredentials(multipleAuthenticatorCredentials);
+    }
+
     /**
      * Sets the path to a directory that contains a cert.pem and key.pem file to use to establish encrypted
      * connections.
@@ -109,6 +131,20 @@ public SyncServerBuilder authenticatorCredentials(SyncCredentials authenticatorC
         return this;
     }
 
+    /**
+     * Adds additional authenticator credentials to authenticate clients or peers with.
+     * <p>
+     * For the embedded server, currently only {@link SyncCredentials#sharedSecret} and {@link SyncCredentials#none}
+     * are supported.
+     */
+    public SyncServerBuilder authenticatorCredentials(SyncCredentials[] multipleAuthenticatorCredentials) {
+        checkNotNull(multipleAuthenticatorCredentials, "Authenticator credentials must not be null.");
+        for (SyncCredentials credentials : multipleAuthenticatorCredentials) {
+            authenticatorCredentials(credentials);
+        }
+        return this;
+    }
+
     /**
      * Sets a listener to observe fine granular changes happening during sync.
      * <p>

objectbox-java/src/main/java/io/objectbox/sync/server/SyncServerOptions.java

@@ -129,6 +129,15 @@ public final class SyncServerOptions extends Table {
    */
   public io.objectbox.sync.server.JwtConfig jwtConfig() { return jwtConfig(new io.objectbox.sync.server.JwtConfig()); }
   public io.objectbox.sync.server.JwtConfig jwtConfig(io.objectbox.sync.server.JwtConfig obj) { int o = __offset(30); return o != 0 ? obj.__assign(__indirect(o + bb_pos), bb) : null; }
+  /**
+   * Credential types that are required for clients logging in.
+   */
+  public long requiredCredentials(int j) { int o = __offset(32); return o != 0 ? (long)bb.getInt(__vector(o) + j * 4) & 0xFFFFFFFFL : 0; }
+  public int requiredCredentialsLength() { int o = __offset(32); return o != 0 ? __vector_len(o) : 0; }
+  public IntVector requiredCredentialsVector() { return requiredCredentialsVector(new IntVector()); }
+  public IntVector requiredCredentialsVector(IntVector obj) { int o = __offset(32); return o != 0 ? obj.__assign(__vector(o), bb) : null; }
+  public ByteBuffer requiredCredentialsAsByteBuffer() { return __vector_as_bytebuffer(32, 4); }
+  public ByteBuffer requiredCredentialsInByteBuffer(ByteBuffer _bb) { return __vector_in_bytebuffer(_bb, 32, 4); }
 
   public static int createSyncServerOptions(FlatBufferBuilder builder,
                                             int urlOffset,
@@ -144,10 +153,12 @@ public static int createSyncServerOptions(FlatBufferBuilder builder,
                                             int clusterIdOffset,
                                             int clusterPeersOffset,
                                             long clusterFlags,
-                                            int jwtConfigOffset) {
-    builder.startTable(14);
+                                            int jwtConfigOffset,
+                                            int requiredCredentialsOffset) {
+    builder.startTable(15);
     SyncServerOptions.addHistorySizeTargetKb(builder, historySizeTargetKb);
     SyncServerOptions.addHistorySizeMaxKb(builder, historySizeMaxKb);
+    SyncServerOptions.addRequiredCredentials(builder, requiredCredentialsOffset);
     SyncServerOptions.addJwtConfig(builder, jwtConfigOffset);
     SyncServerOptions.addClusterFlags(builder, clusterFlags);
     SyncServerOptions.addClusterPeers(builder, clusterPeersOffset);
@@ -163,7 +174,7 @@ public static int createSyncServerOptions(FlatBufferBuilder builder,
     return SyncServerOptions.endSyncServerOptions(builder);
   }
 
-  public static void startSyncServerOptions(FlatBufferBuilder builder) { builder.startTable(14); }
+  public static void startSyncServerOptions(FlatBufferBuilder builder) { builder.startTable(15); }
   public static void addUrl(FlatBufferBuilder builder, int urlOffset) { builder.addOffset(0, urlOffset, 0); }
   public static void addAuthenticationMethods(FlatBufferBuilder builder, int authenticationMethodsOffset) { builder.addOffset(1, authenticationMethodsOffset, 0); }
   public static int createAuthenticationMethodsVector(FlatBufferBuilder builder, int[] data) { builder.startVector(4, data.length, 4); for (int i = data.length - 1; i >= 0; i--) builder.addOffset(data[i]); return builder.endVector(); }
@@ -182,6 +193,9 @@ public static int createSyncServerOptions(FlatBufferBuilder builder,
   public static void startClusterPeersVector(FlatBufferBuilder builder, int numElems) { builder.startVector(4, numElems, 4); }
   public static void addClusterFlags(FlatBufferBuilder builder, long clusterFlags) { builder.addInt(12, (int) clusterFlags, (int) 0L); }
   public static void addJwtConfig(FlatBufferBuilder builder, int jwtConfigOffset) { builder.addOffset(13, jwtConfigOffset, 0); }
+  public static void addRequiredCredentials(FlatBufferBuilder builder, int requiredCredentialsOffset) { builder.addOffset(14, requiredCredentialsOffset, 0); }
+  public static int createRequiredCredentialsVector(FlatBufferBuilder builder, long[] data) { builder.startVector(4, data.length, 4); for (int i = data.length - 1; i >= 0; i--) builder.addInt((int) data[i]); return builder.endVector(); }
+  public static void startRequiredCredentialsVector(FlatBufferBuilder builder, int numElems) { builder.startVector(4, numElems, 4); }
   public static int endSyncServerOptions(FlatBufferBuilder builder) {
     int o = builder.endTable();
     return o;