net.ME1312.SubServers.Bungee

Class SubAPI

java.lang.Object

net.ME1312.SubServers.Bungee.SubAPI

public final class SubAPI
extends java.lang.Object

SubAPI Class

Method Summary

Modifier and Type	Method and Description
Host	addHost(java.lang.Class<? extends Host> driver, java.lang.String name, boolean enabled, java.net.InetAddress address, java.lang.String directory, java.lang.String gitBash) Add a Host with a potentially unregistered driver to the Network
boolean	addHost(Host host) Add a Host with a potentially invalid/unregistered driver to the Network
Host	addHost(java.lang.String driver, java.lang.String name, boolean enabled, java.net.InetAddress address, java.lang.String directory, java.lang.String gitBash) Add a Host to the Network
Host	addHost(java.util.UUID player, java.lang.Class<? extends Host> driver, java.lang.String name, boolean enabled, java.net.InetAddress address, java.lang.String directory, java.lang.String gitBash) Add a Host with a potentially unregistered driver to the Network
boolean	addHost(java.util.UUID player, Host host) Add a Host with a potentially invalid/unregistered driver to the Network
Host	addHost(java.util.UUID player, java.lang.String driver, java.lang.String name, boolean enabled, java.net.InetAddress address, java.lang.String directory, java.lang.String gitBash) Add a Host to the Network
void	addHostDriver(java.lang.Class<? extends Host> driver, java.lang.String handle) Adds a Driver for Hosts
void	addListener(java.lang.Runnable enable, java.lang.Runnable disable) Adds a SubAPI Listener
void	addListener(java.lang.Runnable enable, java.lang.Runnable reload, java.lang.Runnable disable) Adds a SubAPI Listener
Server	addServer(java.lang.String name, java.net.InetAddress ip, int port, java.lang.String motd, boolean hidden, boolean restricted) Adds a Server to the Network
Server	addServer(java.util.UUID player, java.lang.String name, java.net.InetAddress ip, int port, java.lang.String motd, boolean hidden, boolean restricted) Adds a Server to the Network
boolean	forceRemoveHost(java.lang.String name) Force Remove a Host from the Network
boolean	forceRemoveHost(java.util.UUID player, java.lang.String name) Force Remove a Host from the Network
boolean	forceRemoveServer(java.lang.String name) Force Remove a Server from the Network
boolean	forceRemoveServer(java.util.UUID player, java.lang.String name) Force Remove a Server from the Network
Version	getGameVersion() Gets the Recommended Minecraft Version
java.util.Collection<NamedContainer<java.lang.String,java.util.UUID>>	getGlobalPlayers() Get players on this network across all known proxies
java.util.List<Server>	getGroup(java.lang.String name) Gets a Server Group (Group names are case insensitive here)
java.util.Map<java.lang.String,java.util.List<Server>>	getGroups() Gets the Server Groups (Group names are case sensitive here)
Host	getHost(java.lang.String name) Gets a Host
java.util.List<java.lang.String>	getHostDrivers() Get a list of all available Host Drivers
java.util.Map<java.lang.String,Host>	getHosts() Gets the Hosts
static SubAPI	getInstance() Gets the SubAPI Methods
SubPlugin	getInternals() Deprecated. Use SubAPI Methods when available
java.util.Map<java.lang.String,java.lang.String>	getLang(java.lang.String channel) Gets values from the SubServers Lang
java.lang.String	getLang(java.lang.String channel, java.lang.String key) Gets a value from the SubServers Lang
java.util.Collection<java.lang.String>	getLangChannels() Gets the current SubServers Lang Channels
java.util.Map<java.lang.String,java.util.List<Server>>	getLowercaseGroups() Gets the Server Groups (Group names are all lowercase here)
<R> R	getObjectBySignature(java.lang.String signature) Get an Object by it's Signature
java.util.Map<java.lang.String,Proxy>	getProxies() Gets the known Proxies
Proxy	getProxy(java.lang.String name) Gets a Proxy
Version	getProxyVersion() Gets the BungeeCord Version
UniversalFile	getRuntimeDirectory() Gets the Runtime Directory
Server	getServer(java.lang.String name) Gets a Server
java.util.Map<java.lang.String,Server>	getServers() Gets the Servers (including SubServers)
SubDataServer	getSubDataNetwork() Gets the SubData Network Manager
SubServer	getSubServer(java.lang.String name) Gets a SubServer
java.util.Map<java.lang.String,SubServer>	getSubServers() Gets the SubServers
Version	getWrapperVersion() Gets the SubServers Version
void	invalidateObjectSignature(java.lang.String signature) Invalidate an Object Signature.
boolean	removeHost(java.lang.String name) Remove a Host from the Network
boolean	removeHost(java.util.UUID player, java.lang.String name) Remove a Host from the Network
boolean	removeServer(java.lang.String name) Remove a Server from the Network
boolean	removeServer(java.util.UUID player, java.lang.String name) Remove a Server from the Network
void	setLang(java.lang.String channel, java.lang.String key, java.lang.String value) Adds to the SubServers Lang
java.lang.String	signAnonymousObject() Get an Object Signature without linking the Signature to any object
java.lang.String	signObject(java.lang.Object object) Signs an Object

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static SubAPI getInstance()

Gets the SubAPI Methods

Returns:

SubAPI

getInternals

@Deprecated
public SubPlugin getInternals()

Deprecated. Use SubAPI Methods when available

Gets the SubServers Internals

Returns:

SubPlugin Internals

addListener

public void addListener(java.lang.Runnable enable,
                        java.lang.Runnable disable)

Adds a SubAPI Listener

Parameters:

enable - An Event that will be called when SubAPI is ready

disable - An Event that will be called before SubAPI is disabled (your plugin should reset it's values in case this is a hard-reset instead of a shutdown)

addListener

public void addListener(java.lang.Runnable enable,
                        java.lang.Runnable reload,
                        java.lang.Runnable disable)

Adds a SubAPI Listener

Parameters:

enable - An Event that will be called when SubAPI is ready

reload - An Event that will be called after SubAPI is soft-reloaded

disable - An Event that will be called before SubAPI is disabled (your plugin should reset it's values in case this is a hard-reset instead of a shutdown)

getSubDataNetwork

public SubDataServer getSubDataNetwork()

Gets the SubData Network Manager

Returns:

SubData Network Manager

addHostDriver

public void addHostDriver(java.lang.Class<? extends Host> driver,
                          java.lang.String handle)

Adds a Driver for Hosts

Parameters:

driver - Driver to add

handle - Handle to Bind

getHostDrivers

public java.util.List<java.lang.String> getHostDrivers()

Get a list of all available Host Drivers

Returns:

Host Driver handle list

getHosts

public java.util.Map<java.lang.String,Host> getHosts()

Gets the Hosts

Returns:

Host Map

getHost

public Host getHost(java.lang.String name)

Gets a Host

Parameters:

name - Host name

Returns:

a Host

addHost

public Host addHost(java.lang.String driver,
                    java.lang.String name,
                    boolean enabled,
                    java.net.InetAddress address,
                    java.lang.String directory,
                    java.lang.String gitBash)
             throws java.lang.NoSuchMethodException,
                    java.lang.IllegalAccessException,
                    java.lang.reflect.InvocationTargetException,
                    java.lang.InstantiationException

Add a Host to the Network

Parameters:

driver - Driver to initiate

name - Name of the Host

enabled - Enabled Status

address - Address of the Host

directory - Directory of the Host

gitBash - Git Bash Directory

Returns:

The Host

Throws:

java.lang.NoSuchMethodException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

java.lang.InstantiationException

addHost

public Host addHost(java.util.UUID player,
                    java.lang.String driver,
                    java.lang.String name,
                    boolean enabled,
                    java.net.InetAddress address,
                    java.lang.String directory,
                    java.lang.String gitBash)
             throws java.lang.NoSuchMethodException,
                    java.lang.IllegalAccessException,
                    java.lang.reflect.InvocationTargetException,
                    java.lang.InstantiationException

Add a Host to the Network

Parameters:

player - Player who added

driver - Driver to initiate

name - Name of the Host

enabled - Enabled Status

address - Address of the Host

directory - Directory of the Host

gitBash - Git Bash Directory

Returns:

The Host

Throws:

java.lang.NoSuchMethodException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

java.lang.InstantiationException

addHost

public Host addHost(java.lang.Class<? extends Host> driver,
                    java.lang.String name,
                    boolean enabled,
                    java.net.InetAddress address,
                    java.lang.String directory,
                    java.lang.String gitBash)
             throws java.lang.NoSuchMethodException,
                    java.lang.IllegalAccessException,
                    java.lang.reflect.InvocationTargetException,
                    java.lang.InstantiationException

Add a Host with a potentially unregistered driver to the Network

Parameters:

driver - Driver to initiate

name - Name of the Host

enabled - Enabled Status

address - Address of the Host

directory - Directory of the Host

gitBash - Git Bash Directory

Returns:

The Host

Throws:

java.lang.NoSuchMethodException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

java.lang.InstantiationException

addHost

public Host addHost(java.util.UUID player,
                    java.lang.Class<? extends Host> driver,
                    java.lang.String name,
                    boolean enabled,
                    java.net.InetAddress address,
                    java.lang.String directory,
                    java.lang.String gitBash)
             throws java.lang.NoSuchMethodException,
                    java.lang.IllegalAccessException,
                    java.lang.reflect.InvocationTargetException,
                    java.lang.InstantiationException

Add a Host with a potentially unregistered driver to the Network

Parameters:

player - Player who added

driver - Driver to initiate

name - Name of the Host

enabled - Enabled Status

address - Address of the Host

directory - Directory of the Host

gitBash - Git Bash Directory

Returns:

The Host

Throws:

java.lang.NoSuchMethodException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

java.lang.InstantiationException

addHost

public boolean addHost(Host host)

Add a Host with a potentially invalid/unregistered driver to the Network

Parameters:

host - Host to add

Returns:

Success status

addHost

public boolean addHost(java.util.UUID player,
                       Host host)

Add a Host with a potentially invalid/unregistered driver to the Network

Parameters:

player - Player who added

host - Host to add

Returns:

Success status

removeHost

public boolean removeHost(java.lang.String name)

Remove a Host from the Network

Parameters:

name - Name of the Host

Returns:

Success Status

removeHost

public boolean removeHost(java.util.UUID player,
                          java.lang.String name)

Remove a Host from the Network

Parameters:

player - Player Removing

name - Name of the Host

Returns:

Success Status

forceRemoveHost

public boolean forceRemoveHost(java.lang.String name)

Force Remove a Host from the Network

Parameters:

name - Name of the Host

Returns:

Success Status

forceRemoveHost

public boolean forceRemoveHost(java.util.UUID player,
                               java.lang.String name)

Force Remove a Host from the Network

Parameters:

player - Player Removing

name - Name of the Host

Returns:

Success Status

getGroups

public java.util.Map<java.lang.String,java.util.List<Server>> getGroups()

Gets the Server Groups (Group names are case sensitive here)

Returns:

Group Map

getLowercaseGroups

public java.util.Map<java.lang.String,java.util.List<Server>> getLowercaseGroups()

Gets the Server Groups (Group names are all lowercase here)

Returns:

Group Map

getGroup

public java.util.List<Server> getGroup(java.lang.String name)

Gets a Server Group (Group names are case insensitive here)

Parameters:

name - Group name

Returns:

a Server Group

getServers

public java.util.Map<java.lang.String,Server> getServers()

Gets the Servers (including SubServers)

Returns:

Server Map

getServer

public Server getServer(java.lang.String name)

Gets a Server

Parameters:

name - Server name

Returns:

a Server

addServer

public Server addServer(java.lang.String name,
                        java.net.InetAddress ip,
                        int port,
                        java.lang.String motd,
                        boolean hidden,
                        boolean restricted)

Adds a Server to the Network

Parameters:

name - Name of the Server

ip - IP of the Server

port - Port of the Server

motd - MOTD of the Server

hidden - if the server should be hidden from players

restricted - Players will need a permission to join if true

Returns:

The Server

addServer

public Server addServer(java.util.UUID player,
                        java.lang.String name,
                        java.net.InetAddress ip,
                        int port,
                        java.lang.String motd,
                        boolean hidden,
                        boolean restricted)

Adds a Server to the Network

Parameters:

player - Player who added

name - Name of the Server

ip - IP of the Server

port - Port of the Server

motd - MOTD of the Server

hidden - If the server should be hidden from players

restricted - Players will need a permission to join if true

Returns:

The Server

removeServer

public boolean removeServer(java.lang.String name)

Remove a Server from the Network

Parameters:

name - Name of the Server

Returns:

Success Status

removeServer

public boolean removeServer(java.util.UUID player,
                            java.lang.String name)

Remove a Server from the Network

Parameters:

player - Player Removing

name - Name of the Server

Returns:

Success Status

forceRemoveServer

public boolean forceRemoveServer(java.lang.String name)

Force Remove a Server from the Network

Parameters:

name - Name of the Server

Returns:

Success Status

forceRemoveServer

public boolean forceRemoveServer(java.util.UUID player,
                                 java.lang.String name)

Force Remove a Server from the Network

Parameters:

player - Player Removing

name - Name of the Server

Returns:

Success Status

getSubServers

public java.util.Map<java.lang.String,SubServer> getSubServers()

Gets the SubServers

Returns:

SubServer Map

getSubServer

public SubServer getSubServer(java.lang.String name)

Gets a SubServer

Parameters:

name - SubServer name

Returns:

a SubServer

getProxies

public java.util.Map<java.lang.String,Proxy> getProxies()

Gets the known Proxies

Returns:

Proxy Map

getProxy

public Proxy getProxy(java.lang.String name)

Gets a Proxy

Parameters:

name - Proxy name

Returns:

a Proxy

getGlobalPlayers

public java.util.Collection<NamedContainer<java.lang.String,java.util.UUID>> getGlobalPlayers()

Get players on this network across all known proxies

Returns:

Player Collection

setLang

public void setLang(java.lang.String channel,
                    java.lang.String key,
                    java.lang.String value)

Adds to the SubServers Lang

Parameters:

channel - Lang Channel

key - Key

value - Lang Value

getLangChannels

public java.util.Collection<java.lang.String> getLangChannels()

Gets the current SubServers Lang Channels

Returns:

SubServers Lang Channel list

getLang

public java.util.Map<java.lang.String,java.lang.String> getLang(java.lang.String channel)

Gets values from the SubServers Lang

Parameters:

channel - Lang Channel

Returns:

Lang Value

getLang

public java.lang.String getLang(java.lang.String channel,
                                java.lang.String key)

Gets a value from the SubServers Lang

Parameters:

channel - Lang Channel

key - Key

Returns:

Lang Values

signAnonymousObject

public java.lang.String signAnonymousObject()

Get an Object Signature without linking the Signature to any object

Returns:

Anonymous Object Signature

signObject

public java.lang.String signObject(java.lang.Object object)

Signs an Object

Parameters:

object - Object to Sign

Returns:

Object's Signature (or an empty string if the object was null)

getObjectBySignature

public <R> R getObjectBySignature(java.lang.String signature)

Get an Object by it's Signature

Type Parameters:

R - Expected Object Type

Parameters:

signature - Object's Signature

Returns:

Object that is tied to this Signature (or null if the signature is unknown)

invalidateObjectSignature

public void invalidateObjectSignature(java.lang.String signature)

Invalidate an Object Signature. This will remove the link between the Signature and the Object

Parameters:

signature - Object's Signature

getRuntimeDirectory

public UniversalFile getRuntimeDirectory()

Gets the Runtime Directory

Returns:

Directory

getWrapperVersion

public Version getWrapperVersion()

Gets the SubServers Version

Returns:

SubServers Version

getProxyVersion

public Version getProxyVersion()

Gets the BungeeCord Version

Returns:

BungeeCord Version

getGameVersion

public Version getGameVersion()

Gets the Recommended Minecraft Version

Returns:

Minecraft Version