net.nitrado.api.services.gameservers.Gameserver Maven / Gradle / Ivy
package net.nitrado.api.services.gameservers;
import com.google.gson.JsonObject;
import com.google.gson.annotations.SerializedName;
import net.nitrado.api.common.http.Parameter;
import net.nitrado.api.services.Service;
import net.nitrado.api.services.gameservers.customersettings.CustomerSettings;
import net.nitrado.api.services.gameservers.ddoshistory.DDoSAttack;
import net.nitrado.api.services.gameservers.fileserver.FileServer;
import net.nitrado.api.services.gameservers.minecraft.Minecraft;
import net.nitrado.api.services.gameservers.pluginsystem.PluginSystem;
import net.nitrado.api.services.gameservers.taskmanager.TaskManager;
import java.util.HashMap;
/**
* This class represents a gameserver.
*/
public class Gameserver extends Service {
/**
* This enum represents the type of a gameserver.
*/
public enum Type {
@SerializedName("Gameserver")
GAMESERVER,
@SerializedName("Gameserver_Basic")
GAMESERVER_BASIC,
@SerializedName("Gameserver_EPS")
GAMESERVER_EPS
}
/**
* This enum represents the type of the memory of a gameserver.
*/
public enum MemoryType {
@SerializedName("Standard")
STANDARD,
@SerializedName("Advanced")
ADVANCED,
@SerializedName("Professional")
PROFESSIONAL,
@SerializedName("Ultimate")
ULTIMATE
}
/**
* This enum represents the status of a gameserver.
*/
public enum Status {
/**
* Will be returned if the gameserver is currently running.
*/
@SerializedName("started")
STARTED,
/**
* The server is currently stopped.
*/
@SerializedName("stopped")
STOPPED,
/**
* The server will be stopped now.
*/
@SerializedName("stopping")
STOPPING,
/**
* The server is currently performing a restart.
*/
@SerializedName("restarting")
RESTARTING,
/**
* Will be returned if the server is suspended, which means it needs to be reactivated on the website.
*/
@SerializedName("suspended")
SUSPENDED,
/**
* If your services are guardian protected, you are currently outside of the allowed times.
*/
@SerializedName("guardian_locked")
GUARDIAN_LOCKED,
/**
* The server is currently performing a game switching action.
*/
@SerializedName("gs_installation")
GS_INSTALLATION,
/**
* A backup will be restored now.
*/
@SerializedName("backup_restore")
BACKUP_RESTORE,
/**
* A new backup will be created now.
*/
@SerializedName("backup_creation")
BACKUP_CREATION,
/**
* The Server is running a chunkfix.
*
* Only available for Minecraft.
*/
@SerializedName("chunkfix")
CHUNKFIX,
/**
* The Server is running a overview map rendering.
*
* Only available for Minecraft.
*/
@SerializedName("overviewmap_render")
OVERVIEWMAP_RENDER,
/**
* The host of this gameserver is currently unreachable.
*/
@SerializedName("hostdown")
HOST_DOWN
}
/**
* Detailed informations on the gameserver that can be refreshed.
*/
private class GameserverInfo {
private Status status;
@SerializedName("websocket_token")
private String websocketToken;
@SerializedName("minecraft_mode")
private boolean minecraftMode;
private String ip;
private int port;
private String label;
private Type type;
private MemoryType memory;
@SerializedName("memory_total")
private int memoryTotal;
private String game;
@SerializedName("game_human")
private String gameReadable;
@SerializedName("game_specific")
private GameSpecific gameSpecific;
private HashMap modpacks;
private int slots;
private String location;
private HashMap credentials;
private CustomerSettings settings;
private Quota quota;
private Query query;
}
private class GameSpecific {
private String path;
@SerializedName("path_avaiable")
private boolean pathAvaiable; // TODO: ??
private class Features {
@SerializedName("has_backups")
private boolean hasBackups;
@SerializedName("has_application_server")
private boolean hasApplicationServer;
@SerializedName("has_file_browser")
private boolean hasFileBrowser;
@SerializedName("has_ftp")
private boolean hasFtp;
@SerializedName("has_expert_mode")
private boolean hasExpertMode;
@SerializedName("has_plugin_system")
private boolean hasPluginSystem;
@SerializedName("has_restart_message_support")
private boolean hasRestartMessageSupport;
@SerializedName("has_database")
private boolean hasDatabase;
}
private Features features;
@SerializedName("log_files")
private String[] logFiles;
@SerializedName("config_files")
private String[] configFiles;
}
private transient GameserverInfo info;
@Override
public void refresh() {
JsonObject data = api.dataGet("services/" + getId() + "/gameservers", null);
GameserverInfo infos = api.fromJson(data.get("gameserver"), GameserverInfo.class);
infos.settings.init(api, getId());
this.info = infos;
}
/**
* Returns the status of this gameserver.
*
* @return the status
*/
public Status getGameserverStatus() {
return info!=null?info.status:null;
}
/**
* Returns the token you need to connect to the websocket.
*
* @return the websocket token
*/
public String getWebsocketToken() {
return info!=null?info.websocketToken:"";
}
/**
* Returns true if this server is in minecraft mode.
* Relevant for backend. Does not imply that games/minecraft is avaiable.
*
* @return whether this server is in minecraft mode
*/
public boolean isMinecraftMode() {
return info!=null?info.minecraftMode:false;
}
/**
*
* @return true when the
*/
public boolean isMinecraftGame() {
return getGame().startsWith("mcr") && !getGame().equals("mcrpocket");
}
/**
* Returns the ip of this gameserver.
*
* @return the ip
*/
public String getIp() {
return info!=null?info.ip:"";
}
/**
* Returns the port of this gameserver.
*
* @return the port
*/
public int getPort() {
return info!=null?info.port:0;
}
/**
* Returns the label of this gameserver.
* You need the label to connect to the websocket
*
* @return the label
*/
public String getLabel() {
return info!=null?info.label:"";
}
/**
* Returns the type of this gameserver.
*
* @return the type
*/
public Type getType() {
return info!=null?info.type:null;
}
/**
* Returns the memory type of this gameserver.
*
* @return the memory type
*/
public MemoryType getMemoryType() {
return info!=null?info.memory:null;
}
/**
* Returns the total amount of memory of this gameserver.
*
* @return the total amount of memory
*/
public int getMemoryTotal() {
return info!=null?info.memoryTotal:0;
}
/**
* Returns the foldershort of the game running on this server.
*
* @return the game
*/
public String getGame() {
return info!=null?info.game:"";
}
/**
* Returns the readable name of the game running on this server.
* @return
*/
public String getGameReadable() {
return info!=null?info.gameReadable:"";
}
public String getPath() {
if (info == null || info.gameSpecific==null) {
return "";
}
return info.gameSpecific.path;
}
public boolean isPathAvaiable() {
if (info == null || info.gameSpecific==null) {
return false;
}
return info.gameSpecific.pathAvaiable;
}
public boolean hasBackups() {
if (info == null || info.gameSpecific == null || info.gameSpecific.features == null) {
return false;
}
return info.gameSpecific.features.hasBackups;
}
public boolean hasApplicationServer() {
if (info == null || info.gameSpecific == null || info.gameSpecific.features == null) {
return false;
}
return info.gameSpecific.features.hasApplicationServer;
}
public boolean hasFileBrowser() {
if (info == null || info.gameSpecific == null || info.gameSpecific.features == null) {
return false;
}
return info.gameSpecific.features.hasFileBrowser;
}
public boolean hasFtp() {
if (info == null || info.gameSpecific == null || info.gameSpecific.features == null) {
return false;
}
return info.gameSpecific.features.hasFtp;
}
public boolean hasExpertMode() {
if (info == null || info.gameSpecific == null || info.gameSpecific.features == null) {
return false;
}
return info.gameSpecific.features.hasExpertMode;
}
public boolean hasPluginSystem() {
if (info == null || info.gameSpecific == null || info.gameSpecific.features == null) {
return false;
}
return info.gameSpecific.features.hasPluginSystem;
}
public boolean hasRestartMessageSupport() {
if (info == null || info.gameSpecific == null || info.gameSpecific.features == null) {
return false;
}
return info.gameSpecific.features.hasRestartMessageSupport;
}
public boolean hasDatabase() {
if (info == null || info.gameSpecific == null || info.gameSpecific.features == null) {
return false;
}
return info.gameSpecific.features.hasRestartMessageSupport;
}
public String[] getLogFiles() {
if (info == null || info.gameSpecific == null ) {
return new String[0];
}
return info.gameSpecific.logFiles;
}
public String[] getConfigFiles() {
if (info == null || info.gameSpecific == null ) {
return new String[0];
}
return info.gameSpecific.configFiles;
}
/**
* Returns the modpacks installed on this gameserver.
*
* @return a list of modpacks
*/
public HashMap getModpacks() {
return info!=null?info.modpacks:null;
}
/**
* Returns the number of slots.
*
* @return the number of slots
*/
public int getSlots() {
return info!=null?info.slots:0;
}
/**
* Returns the location of this gameserver.
*
* @return the ISO short of the country the gameserver is in
*/
public String getLocation() {
return info!=null?info.location:"";
}
/**
* Returns credentials.
*
* @param type the service you want the credentials of (mysql, ftp)
* @return the credentials
*/
public Credentials getCredentials(String type) {
if (info == null || info.credentials == null) {
return null;
}
return info.credentials.get(type);
}
/**
* Returns the customer settings.
*
* @return the customer settings
*/
public CustomerSettings getCustomerSettings() {
return info!=null?info.settings:null;
}
/**
* Returns the quota of this gameserver.
*
* @return the quota
*/
public Quota getQuota() {
return info!=null?info.quota:null;
}
/**
* Returns the query of this gameserver.
*
* @return the query
*/
public Query getQuery() {
return info!=null?info.query:null;
}
/**
* Starts or restarts the gameserver.
* @permission ROLE_WEBINTERFACE_GENERAL_CONTROL
*/
public void doRestart() {
api.dataPost("services/" + getId() + "/gameservers/restart", new Parameter[]{new Parameter("message", "Server restart requested (" + api.getApplicationName() + ");)")});
}
/**
* Starts or restarts the gameserver.
* @permission ROLE_WEBINTERFACE_GENERAL_CONTROL
*
* @param message message for the users
*/
public void doRestart(String message) {
api.dataPost("services/" + getId() + "/gameservers/restart", new Parameter[]{new Parameter("restart_message", message), new Parameter("message", "Server restart requested (" + api.getApplicationName() + ");)")});
}
/**
* Stops the gameserver.
*
* @permission ROLE_WEBINTERFACE_GENERAL_CONTROL
*/
public void doStop() {
api.dataPost("services/" + getId() + "/gameservers/stop", new Parameter[]{ new Parameter("message", "Server stop requested (" + api.getApplicationName() + ")")});
}
/**
* Stops the gameserver.
*
* @permission ROLE_WEBINTERFACE_GENERAL_CONTROL
* @param message message for users
*/
public void doStop(String message) {
api.dataPost("services/" + getId() + "/gameservers/stop", new Parameter[]{new Parameter("stop_message", message), new Parameter("message", "Server stop requested (" + api.getApplicationName() + ")")});
}
/**
* Changes the FTP password.
*
* @permission ROLE_WEBINTERFACE_FTP_CREDENTIALS_WRITE
* @param password new password
*/
public void changeFTPPassword(String password) {
api.dataPost("services/" + getId() + "/gameservers/ftp/password", new Parameter[]{new Parameter("password", password)});
}
/**
* Changes the MySQL password.
*
* @permission ROLE_WEBINTERFACE_MYSQL_CREDENTIALS_WRITE
* @param password new password
*/
public void changeMySQLPassword(String password) {
api.dataPost("services/" + getId() + "/gameservers/mysql/password", new Parameter[]{new Parameter("password", password)});
}
/**
* Truncates the MySQL database of the gameserver.
* @permission ROLE_WEBINTERFACE_MYSQL_CREDENTIALS_WRITE
*/
public void resetMySQLDatabase() {
api.dataPost("services/" + getId() + "/gameservers/mysql/reset", null);
}
/**
* Returns the full list of games.
*
* Contains all available games.
*
* @permission ROLE_GAMESERVER_CHANGE_GAME
* @return a GameList object
*/
public GameList getGames() {
return GameList.newInstance(api, getId());
}
/**
* Installs a new game. Optional with modpack.
*
* @param game folder_short of the game
* @param modpack filename of the modpack
*/
public void installGame(String game, String modpack) {
Parameter[] params = new Parameter[modpack == null ? 1 : 2];
params[0] = new Parameter("game", game);
if (modpack != null) {
params[1] = new Parameter("modpack", modpack);
}
api.dataPost("services/" + getId() + "/gameservers/games/install", params);
}
/**
* Installs a new game.
*
* @permission ROLE_GAMESERVER_CHANGE_GAME
* @param game folder_short of the game
*/
public void installGame(String game) {
installGame(game, null);
}
/**
* Uninstalls a specific game.
*
* @permission ROLE_GAMESERVER_CHANGE_GAME
* @param game folder_short of the game
*/
public void uninstallGame(String game) {
api.dataDelete("services/" + getId() + "/gameservers/games/uninstall", new Parameter[]{new Parameter("game", game)});
}
/**
* Starts an already installed game.
*
* @permission ROLE_GAMESERVER_CHANGE_GAME
* @param game folder_short of the game
*/
public void startGame(String game) {
api.dataPost("services/" + getId() + "/gameservers/games/start", new Parameter[]{new Parameter("game", game)});
}
/**
* Returns a FileServer object.
*
* @return a FileServer object
*/
public FileServer getFileServer() {
return new FileServer(this, api);
}
/**
* Returns a PluginSystem object.
*
* @permission ROLE_WEBINTERFACE_SETTINGS_READ
* @permission ROLE_WEBINTERFACE_SETTINGS_WRITE
* @return a PluginSystem object
*/
public PluginSystem getPluginSystem() {
return new PluginSystem(this, api);
}
/**
* Returns the DDoS history
*
* @return a list of DDoS-Attacks
* @see DDoSAttack
*/
public DDoSAttack[] getDDoSHistory() {
JsonObject data = api.dataGet("services/" + getId() + "/gameservers/ddos", null);
return api.fromJson(data.get("history"), DDoSAttack[].class);
}
/**
* Returns the task manager.
*
* @return a task manager object
*/
public TaskManager getTaskManager() {
return new TaskManager(this, api);
}
/**
* Returns the usage statistics of the gameserver.
*
* @return the usage statistics
*/
public Stats getStats() {
return getStats(24);
}
/**
* Returns the usage statistics of the gameserver.
*
* @param hours time range. Can be between 1 and 24.
* @return a Stats object
*/
public Stats getStats(int hours) {
JsonObject data = api.dataGet("services/" + getId() + "/gameservers/stats", new Parameter[]{new Parameter("hours", "" + hours)});
return api.fromJson(data.get("stats"), Stats.class);
}
/**
* Sends a command to the server.
*
* Output will be send to the websocket if activated.
*
* @permission ROLE_WEBINTERFACE_GENERAL_CONTROL
* @param command the command to execute
*/
public void sendCommand(String command) {
api.dataPost("services/" + getId() + "/gameservers/app_server/command", new Parameter[]{new Parameter("command", command)});
}
/**
* Returns information about the minecraft plugin system.
*
* Only available for minecraft games.
*
* @permission ROLE_WEBINTERFACE_GENERAL_CONTROL
* @return minecraft specific information
*/
public Minecraft getMinecraft() {
JsonObject data = api.dataGet("services/" + getId() + "/gameservers/games/minecraft", null);
Minecraft minecraft = api.fromJson(data.get("minecraft"), Minecraft.class);
minecraft.init(this, api);
return minecraft;
}
/**
* Internally used
* updates the status when received via websocket.
*/
public void updateStatus(Status status) {
if (info != null) {
this.info.status = status;
}
}
public void updateQuery(Query query) {
if (info != null) {
this.info.query.update(query);
}
}
}