Server options: validate URI, make server return with bound port

Author: greenrobot-team

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

@@ -30,12 +30,15 @@
 public interface SyncServer extends Closeable {
 
     /**
-     * Gets the URL the server is running at.
+     * Returns the URL this server is listening on, including the bound port (see {@link #getPort()}).
      */
     String getUrl();
 
     /**
-     * Gets the port the server has bound to.
+     * Returns the port this server listens on, or 0 if the server was not yet started.
+     * <p>
+     * This is especially useful if the port was assigned arbitrarily (a "0" port was used in the URL when building the
+     * server).
      */
     int getPort();
 

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

@@ -16,6 +16,8 @@
 
 package io.objectbox.sync.server;
 
+import java.net.URI;
+import java.net.URISyntaxException;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -37,7 +39,7 @@
 public class SyncServerBuilder {
 
     final BoxStore boxStore;
-    final String url;
+    final URI url;
     private final List<SyncCredentialsToken> credentials = new ArrayList<>();
 
     private @Nullable String certificatePath;
@@ -64,7 +66,11 @@ public SyncServerBuilder(BoxStore boxStore, String url, SyncCredentials authenti
                             "Please visit https://objectbox.io/sync/ for options.");
         }
         this.boxStore = boxStore;
-        this.url = url;
+        try {
+            this.url = new URI(url);
+        } catch (URISyntaxException e) {
+            throw new IllegalArgumentException("Sync server URL is invalid: " + url, e);
+        }
         authenticatorCredentials(authenticatorCredentials);
     }
 
@@ -263,7 +269,7 @@ byte[] buildSyncServerOptions() {
         fbb.forceDefaults(true);
 
         // Serialize non-integer values first to get their offset
-        int urlOffset = fbb.createString(url);
+        int urlOffset = fbb.createString(url.toString());
         int certificatePathOffset = 0;
         if (certificatePath != null) {
             certificatePathOffset = fbb.createString(certificatePath);

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

@@ -16,6 +16,9 @@
 
 package io.objectbox.sync.server;
 
+import java.net.URI;
+import java.net.URISyntaxException;
+
 import javax.annotation.Nullable;
 
 import io.objectbox.annotation.apihint.Internal;
@@ -28,7 +31,7 @@
 @Internal
 public class SyncServerImpl implements SyncServer {
 
-    private final String url;
+    private final URI url;
     private volatile long handle;
 
     /**
@@ -63,7 +66,11 @@ private long getHandle() {
 
     @Override
     public String getUrl() {
-        return url;
+        try {
+            return new URI(url.getScheme(), null, url.getHost(), getPort(), null, null, null).toString();
+        } catch (URISyntaxException e) {
+            throw new RuntimeException("Server URL can not be constructed", e);
+        }
     }
 
     @Override