Add reason parameter to the serverstop and serverprocessstop commands

Author: rogermb

src/main/java/com/github/theholywaffle/teamspeak3/TS3Api.java

@@ -4084,6 +4084,22 @@ public void stopServer(int serverId) {
 		asyncApi.stopServer(serverId).getUninterruptibly();
 	}
 
+	/**
+	 * Stops the virtual server with the specified ID.
+	 *
+	 * @param serverId
+	 * 		the ID of the virtual server
+	 * @param reason
+	 * 		the reason message to display to clients when they are disconnected
+	 *
+	 * @throws TS3CommandFailedException
+	 * 		if the execution of a command fails
+	 * @querycommands 1
+	 */
+	public void stopServer(int serverId, String reason) {
+		asyncApi.stopServer(serverId, reason).getUninterruptibly();
+	}
+
 	/**
 	 * Stops the specified virtual server.
 	 *
@@ -4098,6 +4114,22 @@ public void stopServer(VirtualServer virtualServer) {
 		asyncApi.stopServer(virtualServer).getUninterruptibly();
 	}
 
+	/**
+	 * Stops the specified virtual server.
+	 *
+	 * @param virtualServer
+	 * 		the virtual server to stop
+	 * @param reason
+	 * 		the reason message to display to clients when they are disconnected
+	 *
+	 * @throws TS3CommandFailedException
+	 * 		if the execution of a command fails
+	 * @querycommands 1
+	 */
+	public void stopServer(VirtualServer virtualServer, String reason) {
+		asyncApi.stopServer(virtualServer, reason).getUninterruptibly();
+	}
+
 	/**
 	 * Stops the entire TeamSpeak 3 Server instance by shutting down the process.
 	 * <p>
@@ -4112,6 +4144,23 @@ public void stopServerProcess() {
 		asyncApi.stopServerProcess().getUninterruptibly();
 	}
 
+	/**
+	 * Stops the entire TeamSpeak 3 Server instance by shutting down the process.
+	 * <p>
+	 * To have permission to use this command, you need to use the server query admin login.
+	 * </p>
+	 *
+	 * @param reason
+	 * 		the reason message to display to clients when they are disconnected
+	 *
+	 * @throws TS3CommandFailedException
+	 * 		if the execution of a command fails
+	 * @querycommands 1
+	 */
+	public void stopServerProcess(String reason) {
+		asyncApi.stopServerProcess(reason).getUninterruptibly();
+	}
+
 	/**
 	 * Unregisters the server query from receiving any event notifications.
 	 *

src/main/java/com/github/theholywaffle/teamspeak3/TS3ApiAsync.java

@@ -4708,7 +4708,25 @@ public CommandFuture<Void> startServer(VirtualServer virtualServer) {
 	 * @querycommands 1
 	 */
 	public CommandFuture<Void> stopServer(int serverId) {
-		Command cmd = VirtualServerCommands.serverStop(serverId);
+		return stopServer(serverId, null);
+	}
+
+	/**
+	 * Stops the virtual server with the specified ID.
+	 *
+	 * @param serverId
+	 * 		the ID of the virtual server
+	 * @param reason
+	 * 		the reason message to display to clients when they are disconnected
+	 *
+	 * @return a future to track the progress of this command
+	 *
+	 * @throws TS3CommandFailedException
+	 * 		if the execution of a command fails
+	 * @querycommands 1
+	 */
+	public CommandFuture<Void> stopServer(int serverId, String reason) {
+		Command cmd = VirtualServerCommands.serverStop(serverId, reason);
 		return executeAndReturnError(cmd);
 	}
 
@@ -4725,7 +4743,25 @@ public CommandFuture<Void> stopServer(int serverId) {
 	 * @querycommands 1
 	 */
 	public CommandFuture<Void> stopServer(VirtualServer virtualServer) {
-		return stopServer(virtualServer.getId());
+		return stopServer(virtualServer.getId(), null);
+	}
+
+	/**
+	 * Stops the specified virtual server.
+	 *
+	 * @param virtualServer
+	 * 		the virtual server to stop
+	 * @param reason
+	 * 		the reason message to display to clients when they are disconnected
+	 *
+	 * @return a future to track the progress of this command
+	 *
+	 * @throws TS3CommandFailedException
+	 * 		if the execution of a command fails
+	 * @querycommands 1
+	 */
+	public CommandFuture<Void> stopServer(VirtualServer virtualServer, String reason) {
+		return stopServer(virtualServer.getId(), reason);
 	}
 
 	/**
@@ -4741,7 +4777,26 @@ public CommandFuture<Void> stopServer(VirtualServer virtualServer) {
 	 * @querycommands 1
 	 */
 	public CommandFuture<Void> stopServerProcess() {
-		Command cmd = ServerCommands.serverProcessStop();
+		return stopServerProcess(null);
+	}
+
+	/**
+	 * Stops the entire TeamSpeak 3 Server instance by shutting down the process.
+	 * <p>
+	 * To have permission to use this command, you need to use the server query admin login.
+	 * </p>
+	 *
+	 * @param reason
+	 * 		the reason message to display to clients when they are disconnected
+	 *
+	 * @return a future to track the progress of this command
+	 *
+	 * @throws TS3CommandFailedException
+	 * 		if the execution of a command fails
+	 * @querycommands 1
+	 */
+	public CommandFuture<Void> stopServerProcess(String reason) {
+		Command cmd = ServerCommands.serverProcessStop(reason);
 		return executeAndReturnError(cmd);
 	}
 

src/main/java/com/github/theholywaffle/teamspeak3/commands/ServerCommands.java

@@ -70,8 +70,10 @@ public static Command logView(int lines, boolean instance) {
 		return builder.build();
 	}
 
-	public static Command serverProcessStop() {
-		return new CommandBuilder("serverprocessstop").build();
+	public static Command serverProcessStop(String reason) {
+		CommandBuilder builder = new CommandBuilder("serverprocessstop", 1);
+		builder.addIf(reason != null, new KeyValueParam("reasonmsg", reason));
+		return builder.build();
 	}
 
 	public static Command version() {

src/main/java/com/github/theholywaffle/teamspeak3/commands/VirtualServerCommands.java

@@ -93,7 +93,10 @@ public static Command serverStart(int id) {
 		return new CommandBuilder("serverstart", 1).add(new KeyValueParam("sid", id)).build();
 	}
 
-	public static Command serverStop(int id) {
-		return new CommandBuilder("serverstop", 1).add(new KeyValueParam("sid", id)).build();
+	public static Command serverStop(int id, String reason) {
+		CommandBuilder builder = new CommandBuilder("serverstop", 2);
+		builder.add(new KeyValueParam("sid", id));
+		builder.addIf(reason != null, new KeyValueParam("reasonmsg", reason));
+		return builder.build();
 	}
 }