Replace java-websocket with native java 11 implementation

Author: JulianVennen

CHANGELOG.md

@@ -36,6 +36,9 @@ JSON body you can use `ApiRequest#jsonBodyPublisher(Object)`. This only affects
 `ExarotonClient#request(ApiRequest, HttpResponse.BodyHandler)` use the respective body handlers to get an input stream,
 string or object.
 
+### WebSockets
+The `java-websocket` library has been replaced by the built-in Java 11 websocket implementation. Unless you were using
+the `WebSocketClient` or `WebSocketManager` classes directly this shouldn't require any changes to your code.
 
 ### Other
 - `Server#subscribe` and `Server#unsubscribe` now accept the `StreamName` enum instead of any string
@@ -49,6 +52,7 @@ string or object.
 - Added `ApiStatus` annotations to many classes and methods
 - Removed debug/error handler from `WebsocketManager` and `WebsocketClient`. Errors and debug messages are now
   exclusively logged using SLF4J
+- Removed `ExarotonClient#getApiToken()`
 
 ## Improvements
 - Update dependencies

build.gradle

@@ -19,7 +19,6 @@ dependencies {
     compileOnly(libs.jetbrains.annotations)
 
     implementation(libs.gson)
-    implementation(libs.java.websocket)
     implementation(libs.slf4j.api)
 
 

gradle/libs.versions.toml

@@ -1,14 +1,12 @@
 [versions]
 gson = "2.12.1"
-java-websocket = "1.6.0"
 jetbrains-annotations = "26.0.2"
 slf4j = "2.0.17"
 # Test dependencies
 junit = "5.12.0"
 
 [libraries]
 gson = { module = "com.google.code.gson:gson", version.ref = "gson" }
-java-websocket = { module = "org.java-websocket:Java-WebSocket", version.ref = "java-websocket" }
 jetbrains-annotations = { module = "org.jetbrains:annotations", version.ref = "jetbrains-annotations" }
 slf4j-api = { module = "org.slf4j:slf4j-api", version.ref = "slf4j" }
 # Test dependencies

src/main/java/com/exaroton/api/ExarotonClient.java

@@ -7,8 +7,10 @@
 import com.exaroton.api.request.server.GetServersRequest;
 import com.exaroton.api.server.Server;
 import com.exaroton.api.server.config.ConfigOptionTypeAdapterFactory;
+import com.exaroton.api.ws.WebSocketConnection;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 
 import java.io.IOException;
@@ -20,7 +22,6 @@
 import java.util.Locale;
 import java.util.Objects;
 import java.util.concurrent.CompletableFuture;
-import java.util.concurrent.CompletionException;
 
 public class ExarotonClient {
     /**
@@ -120,13 +121,6 @@ public String getBasePath() {
         return basePath;
     }
 
-    /**
-     * @return API token
-     */
-    public String getApiToken() {
-        return apiToken;
-    }
-
     /**
      * Change the protocol used for API requests
      * Supported values: http, https
@@ -268,4 +262,21 @@ public Server getCurrentServer() {
         if (id == null) return null;
         return this.getServer(id);
     }
+
+    /**
+     * Create a new websocket connection
+     * @param server server to connect to
+     * @param path websocket path
+     * @return websocket manager
+     */
+    @ApiStatus.Internal
+    public WebSocketConnection connectToWebSocket(Server server, String path) {
+        String protocol = this.getProtocol().equals("http") ? "ws" : "wss";
+        try {
+            URL url = new URL(protocol, getHost(), getBasePath());
+            return new WebSocketConnection(httpClient, gson, url.toURI().resolve(path), apiToken, server);
+        } catch (URISyntaxException | MalformedURLException e) {
+            throw new RuntimeException(e);
+        }
+    }
 }

src/main/java/com/exaroton/api/server/Server.java

@@ -1,10 +1,9 @@
 package com.exaroton.api.server;
 
-import com.exaroton.api.APIException;
 import com.exaroton.api.ExarotonClient;
 import com.exaroton.api.Initializable;
 import com.exaroton.api.request.server.*;
-import com.exaroton.api.ws.WebSocketManager;
+import com.exaroton.api.ws.WebSocketConnection;
 import com.exaroton.api.ws.stream.StreamName;
 import com.exaroton.api.ws.subscriber.*;
 import com.google.gson.Gson;
@@ -22,7 +21,7 @@ public final class Server implements Initializable {
     /**
      * has this server been fetched from the API yet
      */
-    private boolean fetched;
+    private boolean fetched = false;
 
     /**
      * Unique server ID
@@ -85,7 +84,7 @@ public final class Server implements Initializable {
     /**
      * web socket client
      */
-    private transient WebSocketManager webSocket;
+    private transient WebSocketConnection webSocket;
 
     /**
      * gson instance
@@ -101,7 +100,6 @@ public final class Server implements Initializable {
      */
     @ApiStatus.Internal
     public Server(@NotNull ExarotonClient client, @NotNull Gson gson, @NotNull String id) {
-        this.fetched = false;
         this.client = Objects.requireNonNull(client);
         this.gson = Objects.requireNonNull(gson);
         this.id = Objects.requireNonNull(id);
@@ -277,10 +275,7 @@ public ExarotonClient getClient() {
      */
     public CompletableFuture<Server> get() throws IOException {
         return client.request(new GetServerRequest(this.client, this.gson, this.id))
-                .thenApply(data -> {
-                    this.fetched = true;
-                    return this.setFromObject(data);
-                });
+                .thenApply(this::setFromObject);
     }
 
     /**
@@ -422,6 +417,7 @@ public PlayerList getPlayerList(String name) {
      */
     @ApiStatus.Internal
     public Server setFromObject(Server server) {
+        this.fetched = true;
         this.id = server.getId();
         this.name = server.getName();
         this.address = server.getAddress();
@@ -457,9 +453,7 @@ public void subscribe() {
             throw new IllegalStateException("Websocket connection already active.");
         }
 
-        String protocol = this.client.getProtocol().equals("https") ? "wss" : "ws";
-        String uri = protocol + "://" + this.client.getHost() + this.client.getBasePath() + "servers/" + this.id + "/websocket";
-        this.webSocket = new WebSocketManager(gson, uri, this.client.getApiToken(), this);
+        this.webSocket = client.connectToWebSocket(this, "servers/" + this.id + "/websocket");
     }
 
     /**
@@ -551,7 +545,7 @@ public void addTickSubscriber(TickSubscriber subscriber) {
     /**
      * @return web socket manager
      */
-    public WebSocketManager getWebSocket() {
+    public WebSocketConnection getWebSocket() {
         return webSocket;
     }
 }