💥 Rework status management in event

A manager now handles status requests and triggers the status event.
The status event has been reworked to support get/set response, and disable automatic sending.

Author: YvanMazy

api/src/main/java/net/transferproxy/api/event/EventType.java

@@ -28,8 +28,8 @@
 import net.transferproxy.api.event.listener.EmptyListener;
 import net.transferproxy.api.event.listener.EventListener;
 import net.transferproxy.api.event.login.PreLoginEvent;
+import net.transferproxy.api.event.status.StatusRequestEvent;
 import net.transferproxy.api.network.connection.PlayerConnection;
-import net.transferproxy.api.status.listener.DefaultStatusListener;
 import org.jetbrains.annotations.Contract;
 import org.jetbrains.annotations.NotNull;
 
@@ -40,7 +40,7 @@ public enum EventType {
 
     HANDSHAKE(PlayerConnection.class, EmptyListener::getInstance),
     PRE_LOGIN(PreLoginEvent.class, EmptyListener::getInstance),
-    STATUS(PlayerConnection.class, DefaultStatusListener::new),
+    STATUS(StatusRequestEvent.class, EmptyListener::getInstance),
     READY(PlayerConnection.class, DefaultReadyListener::new);
 
     private final Class<?> eventClass;

api/src/main/java/net/transferproxy/api/event/listener/StatusListener.java

@@ -24,21 +24,21 @@
 
 package net.transferproxy.api.event.listener;
 
-import net.transferproxy.api.network.connection.PlayerConnection;
+import net.transferproxy.api.event.status.StatusRequestEvent;
 import org.jetbrains.annotations.NotNull;
 
 /**
  * The listener used to handle every status request
  */
 @FunctionalInterface
-public interface StatusListener extends EventListener<PlayerConnection> {
+public interface StatusListener extends EventListener<StatusRequestEvent> {
 
     /**
      * Handle the status request
      *
-     * @param connection The {@link PlayerConnection} who request
+     * @param event The called event
      */
     @Override
-    void handle(final @NotNull PlayerConnection connection);
+    void handle(final @NotNull StatusRequestEvent event);
 
 }

api/src/main/java/net/transferproxy/api/event/status/StatusRequestEvent.java

@@ -0,0 +1,73 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2025 Yvan Mazy
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package net.transferproxy.api.event.status;
+
+import net.transferproxy.api.network.connection.PlayerConnection;
+import net.transferproxy.api.status.StatusResponse;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Objects;
+
+public class StatusRequestEvent {
+
+    private final PlayerConnection connection;
+    private StatusResponse response;
+    private boolean canSendResponsePacket;
+
+    public StatusRequestEvent(final @NotNull PlayerConnection connection) {
+        this(connection, true);
+    }
+
+    public StatusRequestEvent(final @NotNull PlayerConnection connection, final boolean canSendResponsePacket) {
+        this.connection = Objects.requireNonNull(connection, "connection must not be null");
+        this.canSendResponsePacket = canSendResponsePacket;
+    }
+
+    @Contract(pure = true)
+    public @NotNull PlayerConnection getConnection() {
+        return this.connection;
+    }
+
+    @Contract(pure = true)
+    public @Nullable StatusResponse getResponse() {
+        return this.response;
+    }
+
+    public void setResponse(final @Nullable StatusResponse response) {
+        this.response = response;
+    }
+
+    @Contract(pure = true)
+    public boolean canSendResponsePacket() {
+        return this.canSendResponsePacket;
+    }
+
+    public void setCanSendResponsePacket(final boolean canSendSuccessPacket) {
+        this.canSendResponsePacket = canSendSuccessPacket;
+    }
+
+}

api/src/main/java/net/transferproxy/api/module/ModuleManager.java

@@ -27,6 +27,7 @@
 import net.transferproxy.api.event.EventManager;
 import net.transferproxy.api.network.packet.provider.PacketProviderGroup;
 import net.transferproxy.api.plugin.PluginManager;
+import net.transferproxy.api.status.StatusManager;
 import net.transferproxy.api.terminal.TerminalExecutor;
 import org.jetbrains.annotations.Contract;
 import org.jetbrains.annotations.NotNull;
@@ -51,6 +52,14 @@ public interface ModuleManager {
     @Contract(pure = true)
     @NotNull EventManager getEventManager();
 
+    /**
+     * Gets the current {@link StatusManager} implementation.
+     *
+     * @return the status manager
+     */
+    @Contract(pure = true)
+    @NotNull StatusManager getStatusManager();
+
     /**
      * Gets the current {@link PluginManager} implementation.
      *
@@ -84,6 +93,13 @@ public interface ModuleManager {
      */
     void setEventManager(final @NotNull EventManager eventManager);
 
+    /**
+     * Sets the {@link StatusManager} implementation to use.
+     *
+     * @param statusManager the status manager
+     */
+    void setStatusManager(final @NotNull StatusManager statusManager);
+
     /**
      * Sets the {@link PluginManager} implementation to use.
      *

api/src/main/java/net/transferproxy/api/status/StatusManager.java

@@ -0,0 +1,38 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2025 Yvan Mazy
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package net.transferproxy.api.status;
+
+import net.transferproxy.api.network.connection.PlayerConnection;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull;
+
+public interface StatusManager {
+
+    void process(final @NotNull PlayerConnection connection);
+
+    @Contract("_ -> new")
+    @NotNull StatusResponse buildDefaultResponse(final int protocol);
+
+}

api/src/main/java/net/transferproxy/api/status/listener/CachedStatusListener.java

@@ -25,7 +25,7 @@
 package net.transferproxy.api.status.listener;
 
 import net.transferproxy.api.event.listener.StatusListener;
-import net.transferproxy.api.network.connection.PlayerConnection;
+import net.transferproxy.api.event.status.StatusRequestEvent;
 import net.transferproxy.api.status.StatusResponse;
 import org.jetbrains.annotations.NotNull;
 
@@ -40,8 +40,8 @@ public CachedStatusListener(final @NotNull StatusResponse response) {
     }
 
     @Override
-    public void handle(final @NotNull PlayerConnection connection) {
-        connection.sendStatusResponse(this.response);
+    public void handle(final @NotNull StatusRequestEvent event) {
+        event.setResponse(this.response);
     }
 
 }

api/src/main/java/net/transferproxy/api/status/listener/DynamicStatusListener.java

@@ -25,15 +25,16 @@
 package net.transferproxy.api.status.listener;
 
 import net.transferproxy.api.event.listener.StatusListener;
+import net.transferproxy.api.event.status.StatusRequestEvent;
 import net.transferproxy.api.network.connection.PlayerConnection;
 import net.transferproxy.api.status.StatusResponse;
 import org.jetbrains.annotations.NotNull;
 
 public abstract class DynamicStatusListener implements StatusListener {
 
     @Override
-    public void handle(final @NotNull PlayerConnection connection) {
-        connection.sendStatusResponse(this.buildResponse(connection));
+    public void handle(final @NotNull StatusRequestEvent event) {
+        event.setResponse(this.buildResponse(event.getConnection()));
     }
 
     protected abstract StatusResponse buildResponse(final @NotNull PlayerConnection connection);

core/src/main/java/net/transferproxy/module/ModuleManagerImpl.java

@@ -28,11 +28,13 @@
 import net.transferproxy.api.module.ModuleManager;
 import net.transferproxy.api.network.packet.provider.PacketProviderGroup;
 import net.transferproxy.api.plugin.PluginManager;
-import net.transferproxy.api.terminal.TerminalExecutor;
+import net.transferproxy.api.status.StatusManager;
 import net.transferproxy.api.terminal.DefaultTerminalExecutor;
+import net.transferproxy.api.terminal.TerminalExecutor;
 import net.transferproxy.event.EventManagerImpl;
 import net.transferproxy.network.packet.provider.PacketProviderGroups;
 import net.transferproxy.plugin.PluginManagerImpl;
+import net.transferproxy.status.StatusManagerImpl;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.VisibleForTesting;
 
@@ -42,6 +44,7 @@
 public class ModuleManagerImpl implements ModuleManager {
 
     private EventManager eventManager;
+    private StatusManager statusManager;
     private PluginManager pluginManager;
     private IntFunction<PacketProviderGroup> packetProviderGroupFunction;
     private TerminalExecutor terminalExecutor;
@@ -56,6 +59,11 @@ public void initializeDefaults() {
         return this.eventManager;
     }
 
+    @Override
+    public @NotNull StatusManager getStatusManager() {
+        return this.statusManager;
+    }
+
     @Override
     public @NotNull PluginManager getPluginManager() {
         return this.pluginManager;
@@ -81,6 +89,11 @@ public void setEventManager(final @NotNull EventManager eventManager) {
         this.eventManager = Objects.requireNonNull(eventManager, "eventManager must not be null");
     }
 
+    @Override
+    public void setStatusManager(final @NotNull StatusManager statusManager) {
+        this.statusManager = Objects.requireNonNull(statusManager, "statusManager must not be null");
+    }
+
     @Override
     public void setPacketProviderGroupFunction(final @NotNull IntFunction<PacketProviderGroup> packetProviderGroupFunction) {
         this.packetProviderGroupFunction =
@@ -97,6 +110,9 @@ public void initializeDefaults(final boolean force) {
         if (force || this.eventManager == null) {
             this.eventManager = new EventManagerImpl();
         }
+        if (force || this.statusManager == null) {
+            this.statusManager = new StatusManagerImpl();
+        }
         if (force || this.pluginManager == null) {
             this.pluginManager = new PluginManagerImpl();
         }

core/src/main/java/net/transferproxy/network/packet/status/serverbound/StatusRequestPacket.java

@@ -26,7 +26,6 @@
 
 import io.netty.buffer.ByteBuf;
 import net.transferproxy.api.TransferProxy;
-import net.transferproxy.api.event.EventType;
 import net.transferproxy.api.network.connection.PlayerConnection;
 import net.transferproxy.api.network.packet.serverbound.ServerboundPacket;
 import net.transferproxy.api.network.protocol.Protocolized;
@@ -40,7 +39,7 @@ public StatusRequestPacket(final @SuppressWarnings("unused") @NotNull ByteBuf bu
 
     @Override
     public void handle(final @NotNull PlayerConnection connection) {
-        TransferProxy.getInstance().getModuleManager().getEventManager().call(EventType.STATUS, connection);
+        TransferProxy.getInstance().getModuleManager().getStatusManager().process(connection);
     }
 
     @Override

core/src/main/java/net/transferproxy/status/SnapshotStatusListener.java

@@ -25,7 +25,7 @@
 package net.transferproxy.status;
 
 import net.transferproxy.api.event.listener.StatusListener;
-import net.transferproxy.api.network.connection.PlayerConnection;
+import net.transferproxy.api.event.status.StatusRequestEvent;
 import net.transferproxy.api.network.packet.built.ProtocolizedBuiltPacket;
 import net.transferproxy.api.status.StatusResponse;
 import net.transferproxy.api.util.ComponentProtocolUtil;
@@ -46,8 +46,9 @@ public SnapshotStatusListener(final @NotNull StatusResponse response) {
     }
 
     @Override
-    public void handle(final @NotNull PlayerConnection connection) {
-        connection.sendPacket(this.builtPacket);
+    public void handle(final @NotNull StatusRequestEvent event) {
+        event.setCanSendResponsePacket(false);
+        event.getConnection().sendPacket(this.builtPacket);
     }
 
 }