Merge pull request #8 from strifel/master

Adding RCON Connector

Author: J0B10

src/main/java/org/codeoverflow/chatoverflow/api/io/input/RconInput.java

@@ -0,0 +1,17 @@
+package org.codeoverflow.chatoverflow.api.io.input;
+
+import org.codeoverflow.chatoverflow.api.IsRequirement;
+
+@IsRequirement(requires = "remote control for game servers using RCON protocol")
+public interface RconInput extends Input {
+
+    /**
+     * Get the output of a rcon command
+     * Command will be directly executed on the rcon server and the returned response will be returned
+     * If null is returned this means that there is some problem with the connection (typically the server is shut down or there is some other reason for a lost connection)
+     * Notice: There is no way of knowing that a command exists, which does not return a response. Every command without response will return an empty string.
+     * @param command the command which should be executed on the remote server
+     * @return response of the server or null
+     */
+    String getCommandOutput(String command);
+}

src/main/java/org/codeoverflow/chatoverflow/api/io/output/RconOutput.java

@@ -0,0 +1,16 @@
+package org.codeoverflow.chatoverflow.api.io.output;
+
+import org.codeoverflow.chatoverflow.api.IsRequirement;
+
+@IsRequirement(requires = "remote control for game servers using RCON protocol")
+public interface RconOutput extends Output {
+
+
+    /**
+     * Execute a command on a remote (rcon) server.
+     * Notice: There is no way of knowing if the commands exists.
+     * @param command the command which should be executed
+     * @return if the command was successfully sent to the server. (Returns false for e.g. a not anymore existent server)
+     */
+    boolean sendCommand(String command);
+}

src/main/java/org/codeoverflow/chatoverflow/api/plugin/configuration/Input.java

@@ -3,6 +3,7 @@
 // THIS FILE IS GENERATED WHILE COMPILING. DO NOT CHANGE ANYTHING HERE!
 
 import org.codeoverflow.chatoverflow.api.io.input.FileInput;
+import org.codeoverflow.chatoverflow.api.io.input.RconInput;
 import org.codeoverflow.chatoverflow.api.io.input.SampleInput;
 import org.codeoverflow.chatoverflow.api.io.input.SerialInput;
 import org.codeoverflow.chatoverflow.api.io.input.chat.DiscordChatInput;
@@ -44,6 +45,28 @@ public Requirement<FileInput> file(String uniqueRequirementId) {
         return requirements.requireInput(uniqueRequirementId, "File", false, FileInput.class);
     }
 
+    /**
+     * Requires a remote control for game servers using RCON protocol which has to be specified by the user.
+     *
+     * @param uniqueRequirementId a plugin unique identifier which is stored for your plugin
+     * @param displayName         a string to display to the user while setting your requirement
+     * @param isOptional          true if this requirement is optional, false if mandatory
+     * @return the requirement object. Use the get() method only at runtime!
+     */
+    public Requirement<RconInput> rcon(String uniqueRequirementId, String displayName, boolean isOptional) {
+        return requirements.requireInput(uniqueRequirementId, displayName, isOptional, RconInput.class);
+    }
+
+    /**
+     * Requires a remote control for game servers using RCON protocol which has to be specified by the user.
+     *
+     * @param uniqueRequirementId a plugin unique identifier which is stored for your plugin
+     * @return the requirement object. Use the get() method only at runtime!
+     */
+    public Requirement<RconInput> rcon(String uniqueRequirementId) {
+        return requirements.requireInput(uniqueRequirementId, "Rcon", false, RconInput.class);
+    }
+
     /**
      * Requires a SampleInput which has to be specified by the user.
      *

src/main/java/org/codeoverflow/chatoverflow/api/plugin/configuration/Output.java

@@ -3,6 +3,7 @@
 // THIS FILE IS GENERATED WHILE COMPILING. DO NOT CHANGE ANYTHING HERE!
 
 import org.codeoverflow.chatoverflow.api.io.output.FileOutput;
+import org.codeoverflow.chatoverflow.api.io.output.RconOutput;
 import org.codeoverflow.chatoverflow.api.io.output.SerialOutput;
 import org.codeoverflow.chatoverflow.api.io.output.chat.DiscordChatOutput;
 import org.codeoverflow.chatoverflow.api.io.output.chat.TwitchChatOutput;
@@ -42,6 +43,28 @@ public Requirement<FileOutput> file(String uniqueRequirementId) {
         return requirements.requireOutput(uniqueRequirementId, "File", false, FileOutput.class);
     }
 
+    /**
+     * Requires a remote control for game servers using RCON protocol which has to be specified by the user.
+     *
+     * @param uniqueRequirementId a plugin unique identifier which is stored for your plugin
+     * @param displayName         a string to display to the user while setting your requirement
+     * @param isOptional          true if this requirement is optional, false if mandatory
+     * @return the requirement object. Use the get() method only at runtime!
+     */
+    public Requirement<RconOutput> rcon(String uniqueRequirementId, String displayName, boolean isOptional) {
+        return requirements.requireOutput(uniqueRequirementId, displayName, isOptional, RconOutput.class);
+    }
+
+    /**
+     * Requires a remote control for game servers using RCON protocol which has to be specified by the user.
+     *
+     * @param uniqueRequirementId a plugin unique identifier which is stored for your plugin
+     * @return the requirement object. Use the get() method only at runtime!
+     */
+    public Requirement<RconOutput> rcon(String uniqueRequirementId) {
+        return requirements.requireOutput(uniqueRequirementId, "Rcon", false, RconOutput.class);
+    }
+
     /**
      * Requires a connection with a device connected to a serial port (an Arduino for example) which has to be specified by the user.
      *