Merge branch '25-sync-certificate-api' into 'sync'

Java: add option to pass trusted certificate paths

See merge request objectbox/objectbox-java!27

Author: greenrobot-team

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

@@ -1,11 +1,11 @@
 package io.objectbox.sync;
 
+import javax.annotation.Nullable;
+
 import io.objectbox.BoxStore;
 import io.objectbox.annotation.apihint.Experimental;
 import io.objectbox.sync.internal.Platform;
 
-import javax.annotation.Nullable;
-
 /**
  * A builder to create a {@link SyncClient}; the builder itself should be created via
  * {@link Sync#client(BoxStore, String, SyncCredentials)}.
@@ -19,12 +19,11 @@ public class SyncBuilder {
     final String url;
     final SyncCredentials credentials;
 
-    @Nullable
-    String certificatePath;
-
     SyncClientListener listener;
     SyncChangesListener changesListener;
 
+    @Nullable
+    String[] trustedCertPaths;
     boolean uncommittedAcks;
     boolean manualStart;
 
@@ -72,9 +71,15 @@ public SyncBuilder(BoxStore boxStore, String url, SyncCredentials credentials) {
         this.credentials = credentials;
     }
 
-    // TODO Check if this should remain exposed in the final API
-    public SyncBuilder certificatePath(String certificatePath) {
-        this.certificatePath = certificatePath;
+    /**
+     * Configures a custom set of directory or file paths to search for trusted certificates in.
+     * The first path that exists will be used.
+     * <p>
+     * Using this option is not recommended in most cases, as by default the sync client uses
+     * the certificate authorities trusted by the host platform.
+     */
+    public SyncBuilder trustedCertificates(String[] paths) {
+        this.trustedCertPaths = paths;
         return this;
     }
 

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

@@ -32,7 +32,7 @@ public class SyncClientImpl implements SyncClient {
         this.connectivityMonitor = builder.platform.getConnectivityMonitor();
 
         long boxStoreHandle = InternalAccess.getHandle(builder.boxStore);
-        this.handle = nativeCreate(boxStoreHandle, serverUrl, builder.certificatePath);
+        this.handle = nativeCreate(boxStoreHandle, serverUrl, builder.trustedCertPaths);
         if (handle == 0) {
             throw new RuntimeException("Failed to create sync client: handle is zero.");
         }
@@ -214,7 +214,11 @@ private void checkNotNull(Object object, String message) {
         }
     }
 
-    private static native long nativeCreate(long storeHandle, String uri, @Nullable String certificatePath);
+    /**
+     * Creates a native sync client for the given store handle ready to connect to the server at the given URI.
+     * Uses certificate authorities trusted by the host if no trusted certificate paths are passed.
+     */
+    private static native long nativeCreate(long storeHandle, String uri, @Nullable String[] certificateDirsOrPaths);
 
     private native void nativeDelete(long handle);