CloudAPI (CloudNet-API-Core 2.1.17 API)

java.lang.Object
- de.dytanic.cloudnet.api.CloudAPI

All Implemented Interfaces:: MetaObj

public final class CloudAPI
extends Object
implements MetaObj

Field Summary

Fields
Modifier and Type	Field and Description
`private CloudConfigLoader`	`cloudConfigLoader`
`private CloudNetwork`	`cloudNetwork`
`private ICloudService`	`cloudService`
`private Document`	`config`
`private DatabaseManager`	`databaseManager`
`private static CloudAPI`	`instance`
`private Logger`	`logger` Logger instance set by the respective bootstrap.
`private int`	`memory`
`private NetworkConnection`	`networkConnection`
`private NetworkHandlerProvider`	`networkHandlerProvider`
`private ServiceId`	`serviceId`
`private Runnable`	`shutdownTask`

Constructor Summary

Constructors
Constructor and Description

CloudAPI(CloudConfigLoader loader, Runnable cancelTask)

Constructors
Constructor and Description
`CloudAPI(CloudConfigLoader loader, Runnable cancelTask)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`bootstrap()` Deprecated.
`private CloudPlayer`	`checkAndGet(String name)`
`private CloudPlayer`	`checkAndGet(UUID uniqueId)`
`void`	`copyDirectory(ServerInfo serverInfo, String directory)`
`String`	`createServerLogUrl(String serverId)` Creates a custom server log url for one server screen
`void`	`dispatchConsoleMessage(String output)` Dispatch a console message
`CloudConfigLoader`	`getCloudConfigLoader()` Returns the Configuration Loader from this Plugin
`CloudNetwork`	`getCloudNetwork()` Returns a simple cloudnetwork information base
`Collection<ServerInfo>`	`getCloudServers()` Returns the ServerInfo from all CloudGameServers
`ICloudService`	`getCloudService()` Deprecated.
`Document`	`getConfig()` Returns the wingui Config
`DatabaseManager`	`getDatabaseManager()` Returns the Database Manager for the CloudNetDB functions
`String`	`getGroup()` Returns the group name from this instance
`int`	`getGroupInitId()` Returns the Id (Lobby-1 -> "1")
`static CloudAPI`	`getInstance()` Returns the instance of the CloudAPI
`Logger`	`getLogger()`
`int`	`getMemory()` Returns the memory from this instance calc by Wrapper
`Document`	`getModuleProperties()` Returns all the module properties
`NetworkConnection`	`getNetworkConnection()` Returns the internal network connection to the cloudnet root
`NetworkHandlerProvider`	`getNetworkHandlerProvider()` Returns the network server manager from cloudnet
`OfflinePlayer`	`getOfflinePlayer(String name)` Returns a offline player which registerd or null
`OfflinePlayer`	`getOfflinePlayer(UUID uniqueId)` Returns a offline player which registerd or null
`int`	`getOnlineCount()` Returns the global onlineCount
`int`	`getOnlineCount(String group)` Returns synchronized the OnlineCount from the group
`CloudPlayer`	`getOnlinePlayer(UUID uniqueId)` Retuns a online CloudPlayer on network or null if the player isn't online
`Collection<CloudPlayer>`	`getOnlinePlayers()` Returns all OnlinePlayers on Network
`PermissionGroup`	`getPermissionGroup(String group)` Returns the permission group from the permissions-system
`PermissionPool`	`getPermissionPool()` Returns the permissionPool of the cloudnetwork
`String`	`getPlayerName(UUID uniqueId)` Returns from a registerd Player the name or null if the player doesn't exists
`UUID`	`getPlayerUniqueId(String name)` Returns from a registerd Player the uniqueId or null if the player doesn't exists
`String`	`getPrefix()` Returns the cloud prefix
`ProxyGroup`	`getProxyGroupData(String group)` Returns the ProxyGroup of the parameter
`Map<String,ProxyGroup>`	`getProxyGroupMap()`
`Collection<ProxyInfo>`	`getProxys()` Returns all proxyInfos on network
`Collection<ProxyInfo>`	`getProxys(String group)` Returns the ProxyInfos from all proxys in the group #group
`int`	`getRegisteredPlayerCount()` Returns the amount of players that are registered in the Cloud
`private Map<UUID,OfflinePlayer>`	`getRegisteredPlayers()` Deprecated.
`ServerGroup`	`getServerGroup(String name)` Returns the ServerGroup from the name or null
`SimpleServerGroup`	`getServerGroupData(String group)` Returns the SimpleServerGroup of the parameter
`Map<String,SimpleServerGroup>`	`getServerGroupMap()`
`String`	`getServerId()` Returns the serverId (Lobby-1)
`ServerInfo`	`getServerInfo(String serverName)` Returns the ServerInfo from one gameServer where serverName = serverId
`Collection<ServerInfo>`	`getServers()` Returns all servers on network
`Collection<ServerInfo>`	`getServers(String group)` Returns all serverInfos from group #group
`ServiceId`	`getServiceId()` Returns the ServiceId from this instance
`Runnable`	`getShutdownTask()` Returns the shutdownTask which is default init
`Document`	`getStatistics()` Returns a Document with all collected statistics
`UUID`	`getUniqueId()` Returns the UUID from this instance
`WrapperInfo`	`getWrapper(String wrapperId)` Returns one of the wrapper infos
`String`	`getWrapperId()` Returns the wrapperid from this instance
`Collection<WrapperInfo>`	`getWrappers()` Returns all active wrappers on cloudnet
`private void`	`initDefaultHandlers()`
`boolean`	`isDebug()`
`void`	`sendCloudCommand(String commandLine)` Dispatch a command on cloudnet-core
`void`	`sendConsoleMessage(DefaultType defaultType, String serverId, String commandLine)` Writes into the console of the server/proxy the command line
`void`	`sendCustomSubProxyMessage(String channel, String message, Document value)` Sends the data of the custom channel message to all proxys
`void`	`sendCustomSubProxyMessage(String channel, String message, Document value, String serverName)` Sends the data of the custom channel message to proxy server
`void`	`sendCustomSubServerMessage(String channel, String message, Document value)` Sends the data of the custom channel message to all server
`void`	`sendCustomSubServerMessage(String channel, String message, Document value, String serverName)` Sends the data of the custom channel message to one server
`void`	`setCloudNetwork(CloudNetwork cloudNetwork)` Internal CloudNetwork update set
`void`	`setCloudService(ICloudService cloudService)` Deprecated.
`void`	`setDebug(boolean debug)`
`void`	`setLogger(Logger logger)`
`void`	`shutdown()` Deprecated.
`void`	`startCloudServer(String serverName, int memory, boolean priorityStop)` Start a Cloud-Server with those Properties
`void`	`startCloudServer(String serverName, ServerConfig serverConfig, int memory, boolean priorityStop)` Start a Cloud-Server with those Properties
`void`	`startCloudServer(String serverName, ServerConfig serverConfig, int memory, boolean priorityStop, String[] processPreParameters, Collection<ServerInstallablePlugin> plugins, Properties properties, ServerGroupType serverGroupType)` Start a Cloud-Server with those Properties
`void`	`startCloudServer(WrapperInfo wrapperInfo, String serverName, int memory, boolean priorityStop)` Start a Cloud-Server with those Properties
`void`	`startCloudServer(WrapperInfo wrapperInfo, String serverName, ServerConfig serverConfig, int memory, boolean priorityStop)` Start a Cloud-Server with those Properties
`void`	`startCloudServer(WrapperInfo wrapperInfo, String serverName, ServerConfig serverConfig, int memory, boolean priorityStop, String[] processPreParameters, Collection<ServerInstallablePlugin> plugins, Properties properties, ServerGroupType serverGroupType)` Start a Cloud-Server with those Properties
`void`	`startGameServer(SimpleServerGroup simpleServerGroup)` Start a game server
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, ServerConfig serverConfig)` Start a game server
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, boolean priorityStop)` Start a game server
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, boolean priorityStop, String serverId)` Start a game server
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, boolean priorityStop, Template template)` Start a game server
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, boolean priorityStop, Template template, String serverId)` Start a game server
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, int memory, boolean priorityStop)` Start a game server
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, int memory, boolean priorityStop, Properties properties)` Start a game server
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, int memory, boolean priorityStop, Properties properties, String serverId)` Start a game server
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, int memory, boolean priorityStop, Properties properties, Template template)` Start a game server
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, int memory, boolean priorityStop, Properties properties, Template template, String serverId)` Start a game server
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, int memory, boolean priorityStop, String serverId)` Start a game server
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, int memory, boolean priorityStop, Template template)` Start a game server
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, int memory, boolean priorityStop, Template template, String serverId)` Start a game server
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, int memory, String[] processParameters, Template template, String customServerName, boolean onlineMode, boolean priorityStop, Properties properties, String url, Collection<ServerInstallablePlugin> plugins)` Start a new game server with full parameters
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, int memory, String[] processParameters, Template template, String customServerName, boolean onlineMode, boolean priorityStop, Properties properties, String url, Collection<ServerInstallablePlugin> plugins, String serverId)` Start a new game server with full parameters
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, String serverId)` Start a game server
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, Template template)` Start a game server
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, Template template, String serverId)` Start a game server
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, String serverId)` Start a game server
`void`	`startGameServer(SimpleServerGroup simpleServerGroup, Template template)` Start a game server
`void`	`startGameServer(WrapperInfo wrapperInfo, SimpleServerGroup simpleServerGroup)` Start a game server
`void`	`startGameServer(WrapperInfo wrapperInfo, SimpleServerGroup simpleServerGroup, ServerConfig serverConfig)` Start a game server
`void`	`startGameServer(WrapperInfo wrapperInfo, SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, boolean priorityStop)` Start a game server
`void`	`startGameServer(WrapperInfo wrapperInfo, SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, int memory, boolean priorityStop)` Start a game server
`void`	`startGameServer(WrapperInfo wrapperInfo, SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, int memory, boolean priorityStop, Properties properties)` Start a game server
`void`	`startGameServer(WrapperInfo wrapperInfo, SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, int memory, boolean priorityStop, Properties properties, Template template)` Start a game server
`void`	`startGameServer(WrapperInfo wrapperInfo, SimpleServerGroup simpleServerGroup, ServerConfig serverConfig, int memory, String[] processParameters, Template template, String customServerName, boolean onlineMode, boolean priorityStop, Properties properties, String url, Collection<ServerInstallablePlugin> plugins)` Start a new game server with full parameters
`void`	`startGameServer(WrapperInfo wrapperInfo, SimpleServerGroup simpleServerGroup, String serverId, ServerConfig serverConfig, int memory, String[] processParameters, Template template, String customServerName, boolean onlineMode, boolean priorityStop, Properties properties, String url, Collection<ServerInstallablePlugin> plugins)` Start a new game server with full parameters
`void`	`startProxy(ProxyGroup proxyGroup)` Start a proxy server with a group
`void`	`startProxy(ProxyGroup proxyGroup, int memory, String[] processParameters)` Start a proxy server with a group
`void`	`startProxy(ProxyGroup proxyGroup, int memory, String[] processParameters, Document document)` Start a proxy server with a group
`void`	`startProxy(ProxyGroup proxyGroup, int memory, String[] processParameters, String url, Collection<ServerInstallablePlugin> plugins, Document properties)` Start a proxy server with a group
`void`	`startProxy(WrapperInfo wrapperInfo, ProxyGroup proxyGroup)` Start a proxy server with a group
`void`	`startProxy(WrapperInfo wrapperInfo, ProxyGroup proxyGroup, int memory, String[] processParameters)` Start a proxy server with a group
`void`	`startProxy(WrapperInfo wrapperInfo, ProxyGroup proxyGroup, int memory, String[] processParameters, Document document)` Start a proxy server with a group
`void`	`startProxy(WrapperInfo wrapperInfo, ProxyGroup proxyGroup, int memory, String[] processParameters, String url, Collection<ServerInstallablePlugin> plugins, Document properties)` Start a proxy server with a group
`void`	`stopProxy(String proxyId)` Stop a BungeeCord proxy server with the id @proxyId
`void`	`stopServer(String serverId)` Stop a game server with the parameter of the serverId
`CloudAPI`	`update(ProxyInfo proxyInfo)`
`CloudAPI`	`update(ServerInfo serverInfo)`
`void`	`updatePermissionGroup(PermissionGroup permissionGroup)` Update the permission group
`void`	`updatePlayer(CloudPlayer cloudPlayer)` Update the CloudPlayer objective
`void`	`updatePlayer(OfflinePlayer offlinePlayer)` Updates a offlinePlayer Objective on the database
`void`	`updateProxyGroup(ProxyGroup proxyGroup)` Update the proxy group
`void`	`updateServerGroup(ServerGroup serverGroup)` Update the server group

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

instance
```
private static CloudAPI instance
```

config
```
private Document config
```

serviceId
```
private ServiceId serviceId
```

cloudConfigLoader

private CloudConfigLoader cloudConfigLoader

networkConnection

private NetworkConnection networkConnection

memory
```
private int memory
```

shutdownTask
```
private Runnable shutdownTask
```

cloudService
```
private ICloudService cloudService
```

cloudNetwork
```
private CloudNetwork cloudNetwork
```

networkHandlerProvider

private NetworkHandlerProvider networkHandlerProvider

databaseManager

private DatabaseManager databaseManager

logger
```
private Logger logger
```
Logger instance set by the respective bootstrap. Don't use in constructor!

Constructor Detail

CloudAPI

public CloudAPI(CloudConfigLoader loader,
                Runnable cancelTask)

Method Detail

initDefaultHandlers
```
private void initDefaultHandlers()
```

getInstance
```
public static CloudAPI getInstance()
```
Returns the instance of the CloudAPI

bootstrap
```
@Deprecated
public void bootstrap()
```
Deprecated.

shutdown
```
@Deprecated
public void shutdown()
```
Deprecated.

update

public CloudAPI update(ServerInfo serverInfo)

update

public CloudAPI update(ProxyInfo proxyInfo)

getOnlineCount
```
public int getOnlineCount(String group)
```
Returns synchronized the OnlineCount from the group

getServers
```
public Collection<ServerInfo> getServers(String group)
```
Returns all serverInfos from group #group

Parameters:

group -

getCloudService

@Deprecated
public ICloudService getCloudService()

Deprecated.

setCloudService

@Deprecated
public void setCloudService(ICloudService cloudService)

Deprecated.

getCloudConfigLoader
```
public CloudConfigLoader getCloudConfigLoader()
```
Returns the Configuration Loader from this Plugin

getConfig
```
public Document getConfig()
```
Returns the wingui Config

getCloudNetwork
```
public CloudNetwork getCloudNetwork()
```
Returns a simple cloudnetwork information base

setCloudNetwork
```
public void setCloudNetwork(CloudNetwork cloudNetwork)
```
Internal CloudNetwork update set

Parameters:

cloudNetwork -

getNetworkHandlerProvider
```
public NetworkHandlerProvider getNetworkHandlerProvider()
```
Returns the network server manager from cloudnet

getNetworkConnection
```
public NetworkConnection getNetworkConnection()
```
Returns the internal network connection to the cloudnet root

getPrefix
```
public String getPrefix()
```
Returns the cloud prefix

getMemory
```
public int getMemory()
```
Returns the memory from this instance calc by Wrapper

getShutdownTask
```
public Runnable getShutdownTask()
```
Returns the shutdownTask which is default init

getServiceId
```
public ServiceId getServiceId()
```
Returns the ServiceId from this instance

getDatabaseManager
```
public DatabaseManager getDatabaseManager()
```
Returns the Database Manager for the CloudNetDB functions

getGroup
```
public String getGroup()
```
Returns the group name from this instance

getUniqueId
```
public UUID getUniqueId()
```
Returns the UUID from this instance

getServerId
```
public String getServerId()
```
Returns the serverId (Lobby-1)

getGroupInitId
```
public int getGroupInitId()
```
Returns the Id (Lobby-1 -> "1")

getWrapperId
```
public String getWrapperId()
```
Returns the wrapperid from this instance

getServerGroupData
```
public SimpleServerGroup getServerGroupData(String group)
```
Returns the SimpleServerGroup of the parameter

Parameters:

group -

getProxyGroupData
```
public ProxyGroup getProxyGroupData(String group)
```
Returns the ProxyGroup of the parameter

Parameters:

group -

getOnlineCount
```
public int getOnlineCount()
```
Returns the global onlineCount

getRegisteredPlayerCount
```
public int getRegisteredPlayerCount()
```
Returns the amount of players that are registered in the Cloud

getModuleProperties
```
public Document getModuleProperties()
```
Returns all the module properties

Returns:

getPermissionPool
```
public PermissionPool getPermissionPool()
```
Returns the permissionPool of the cloudnetwork

getWrappers
```
public Collection<WrapperInfo> getWrappers()
```
Returns all active wrappers on cloudnet

getPermissionGroup
```
public PermissionGroup getPermissionGroup(String group)
```
Returns the permission group from the permissions-system

getWrapper
```
public WrapperInfo getWrapper(String wrapperId)
```
Returns one of the wrapper infos

Parameters:

wrapperId -

sendCustomSubProxyMessage

public void sendCustomSubProxyMessage(String channel,
                                      String message,
                                      Document value)

Sends the data of the custom channel message to all proxys

sendCustomSubServerMessage

public void sendCustomSubServerMessage(String channel,
                                       String message,
                                       Document value)

Sends the data of the custom channel message to all server

sendCustomSubServerMessage

public void sendCustomSubServerMessage(String channel,
                                       String message,
                                       Document value,
                                       String serverName)

Sends the data of the custom channel message to one server

sendCustomSubProxyMessage

public void sendCustomSubProxyMessage(String channel,
                                      String message,
                                      Document value,
                                      String serverName)

Sends the data of the custom channel message to proxy server

updateServerGroup
```
public void updateServerGroup(ServerGroup serverGroup)
```
Update the server group

Parameters:

serverGroup -

updatePermissionGroup

public void updatePermissionGroup(PermissionGroup permissionGroup)

Update the permission group

updateProxyGroup
```
public void updateProxyGroup(ProxyGroup proxyGroup)
```
Update the proxy group

Parameters:

proxyGroup -

sendCloudCommand

public void sendCloudCommand(String commandLine)

Dispatch a command on cloudnet-core

dispatchConsoleMessage
```
public void dispatchConsoleMessage(String output)
```
Dispatch a console message

Parameters:

output -

sendConsoleMessage

public void sendConsoleMessage(DefaultType defaultType,
                               String serverId,
                               String commandLine)

Writes into the console of the server/proxy the command line

Parameters:: defaultType -; serverId -; commandLine -

getServerGroupMap

public Map<String,SimpleServerGroup> getServerGroupMap()

getProxyGroupMap

public Map<String,ProxyGroup> getProxyGroupMap()

stopServer
```
public void stopServer(String serverId)
```
Stop a game server with the parameter of the serverId

Parameters:

serverId - the server-id to stop

stopProxy
```
public void stopProxy(String proxyId)
```
Stop a BungeeCord proxy server with the id @proxyId

createServerLogUrl
```
public String createServerLogUrl(String serverId)
```
Creates a custom server log url for one server screen

startProxy
```
public void startProxy(ProxyGroup proxyGroup)
```
Start a proxy server with a group

Parameters:

proxyGroup -