feat(plugin-api): userId & clientName getters (lavalink-devs#743)

* feat(plugin-api): userId & clientName getters * fix: remove trailing space from javadoc * chore: convert user id to long in getter
trazhub · Oct 12, 2022 · 4524f67 · 4524f67
1 parent 5f23a15
commit 4524f67
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 2 deletions.
diff --git a/LavalinkServer/src/main/java/lavalink/server/io/SocketContext.kt b/LavalinkServer/src/main/java/lavalink/server/io/SocketContext.kt
@@ -55,7 +55,8 @@ class SocketContext(
     val serverConfig: ServerConfig,
     private var session: WebSocketSession,
     private val socketServer: SocketServer,
-    val userId: String,
+    private val userId: String,
+    private val clientName: String?,
     val koe: KoeClient,
     eventHandlers: Collection<PluginEventHandler>,
     webSocketExtensions: List<WebSocketExtension>,
@@ -105,6 +106,14 @@ class SocketContext(
 
     fun getPlayer(guildId: String) = getPlayer(guildId.toLong())
 
+    override fun getUserId(): Long {
+        return userId.toLong()
+    }
+
+    override fun getClientName(): String? {
+        return clientName
+    }
+
     override fun getPlayer(guildId: Long) = players.computeIfAbsent(guildId) {
         val player = Player(this, guildId, audioPlayerManager, serverConfig)
         eventEmitter.onNewPlayer(player)

diff --git a/LavalinkServer/src/main/java/lavalink/server/io/SocketServer.kt b/LavalinkServer/src/main/java/lavalink/server/io/SocketServer.kt
@@ -99,6 +99,7 @@ class SocketServer(
                 session,
                 this,
                 userId,
+                clientName,
                 koe.newClient(userId.toLong()),
                 eventHandlers,
                 webSocketExtensions,
@@ -176,4 +177,4 @@ class SocketServer(
     }
 
     internal fun canResume(key: String) = resumableSessions[key]?.stopResumeTimeout() ?: false
-}
+}
diff --git a/plugin-api/src/main/java/dev/arbjerg/lavalink/api/ISocketContext.java b/plugin-api/src/main/java/dev/arbjerg/lavalink/api/ISocketContext.java
@@ -1,13 +1,25 @@
 package dev.arbjerg.lavalink.api;
 
 import org.json.JSONObject;
+import org.springframework.lang.Nullable;
 
 import java.util.Map;
 
 /**
  * Represents a WebSocket connection
  */
 public interface ISocketContext {
+    /**
+     * @return the User ID of the Client.
+     */
+    long getUserId();
+
+    /**
+     * @return the name of the Client, or null if it was not specified.
+     */
+    @Nullable
+    String getClientName();
+
     /**
      * Returns the player of a guild. Never returns null.
      *