Package net.ME1312.SubServers.Bungee.Host.External

Class ExternalHost

java.lang.Object

net.ME1312.SubServers.Bungee.Host.Host

net.ME1312.SubServers.Bungee.Host.External.ExternalHost

All Implemented Interfaces:

ExtraDataHandler<String>, ClientHandler, SubDataSerializable

public class ExternalHost
extends Host
implements ClientHandler

External Host Class

Constructor Summary

Constructors

Constructor	Description
ExternalHost(SubProxy plugin, String name, boolean enabled, com.google.common.collect.Range<Integer> ports, boolean log, InetAddress address, String directory, String gitBash)	Creates an External Host

Method Summary

Modifier and Type	Method	Description
boolean	addSubServer(UUID player, SubServer server)	Adds a SubServer
SubServer	constructSubServer(String name, boolean enabled, int port, String motd, boolean log, String directory, String executable, String stopcmd, boolean hidden, boolean restricted)	Constructs a SubServer (but doesn't add it to the server manager)
protected boolean	deleteSubServer(UUID player, String name, boolean forced)	Deletes a SubServer
boolean	destroy()	Resets this Host object
ObjectMap<String>	forSubData()
InetAddress	getAddress()	Get the Address of this Host
SubCreator	getCreator()	Gets the SubCreator Instance for this Host
String	getName()	Get the Name of this Host
String	getPath()	Get the host Directory Path
DataClient[]	getSubData()
SubServer	getSubServer(String name)	Gets a SubServer
Map<String,? extends SubServer>	getSubServers()	Gets the SubServers on this Host
boolean	isAvailable()	Is this Host Available?
boolean	isEnabled()	Is this Host Enabled?
protected boolean	recycleSubServer(UUID player, String name, boolean forced)	Deletes a SubServer (will move to 'Recently Deleted')
void	removeSubData(DataClient client)
protected boolean	removeSubServer(UUID player, String name, boolean forced)	Removes a SubServer
void	setEnabled(boolean value)	Set if this Host is Enabled
void	setSubData(DataClient client, int channel)

Methods inherited from class net.ME1312.SubServers.Bungee.Host.Host

addExtra, addSubServer, addSubServer, addSubServer, command, command, deleteSubServer, deleteSubServer, equals, forceDeleteSubServer, forceDeleteSubServer, forceRecycleSubServer, forceRecycleSubServer, forceRemoveSubServer, forceRemoveSubServer, getDisplayName, getExtra, getExtra, getPlayers, getRemotePlayers, getSignature, hasExtra, recycleSubServer, recycleSubServer, removeExtra, removeSubServer, removeSubServer, setDisplayName, start, start, stop, stop, terminate, terminate

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ExternalHost

public ExternalHost(SubProxy plugin,
 String name,
 boolean enabled,
 com.google.common.collect.Range<Integer> ports,
 boolean log,
 InetAddress address,
 String directory,
 String gitBash)

Creates an External Host

Parameters:

plugin - SubServers Internals

name - The Name of your Host

ports - The range of ports to auto-select from

log - Whether apps like SubCreator should log to console (does not apply to servers)

enabled - If your host is Enabled

address - The address of your Host

directory - The runtime directory of your Host

gitBash - The Git Bash directory

Method Details

getSubData

public DataClient[] getSubData()

Specified by:

getSubData in interface ClientHandler

setSubData

public void setSubData(DataClient client,
 int channel)

removeSubData

public void removeSubData(DataClient client)

Specified by:

removeSubData in interface ClientHandler

isAvailable

public boolean isAvailable()

Description copied from class: Host

Is this Host Available?

Overrides:

isAvailable in class Host

Returns:

Availability Status

isEnabled

public boolean isEnabled()

Description copied from class: Host

Is this Host Enabled?

Specified by:

isEnabled in class Host

Returns:

Enabled Status

setEnabled

public void setEnabled(boolean value)

Description copied from class: Host

Set if this Host is Enabled

Specified by:

setEnabled in class Host

Parameters:

value - Value

getAddress

public InetAddress getAddress()

Description copied from class: Host

Get the Address of this Host

Specified by:

getAddress in class Host

Returns:

Host Address

getPath

public String getPath()

Description copied from class: Host

Get the host Directory Path

Specified by:

getPath in class Host

Returns:

Host Directory Path

getName

public String getName()

Description copied from class: Host

Get the Name of this Host

Specified by:

getName in class Host

Returns:

Host Name

getCreator

public SubCreator getCreator()

Description copied from class: Host

Gets the SubCreator Instance for this Host

Specified by:

getCreator in class Host

Returns:

SubCreator

getSubServers

public Map<String,? extends SubServer> getSubServers()

Description copied from class: Host

Gets the SubServers on this Host

Specified by:

getSubServers in class Host

Returns:

SubServer Map

getSubServer

public SubServer getSubServer(String name)

Description copied from class: Host

Gets a SubServer

Specified by:

getSubServer in class Host

Parameters:

name - SubServer Name

Returns:

a SubServer

constructSubServer

public SubServer constructSubServer(String name,
 boolean enabled,
 int port,
 String motd,
 boolean log,
 String directory,
 String executable,
 String stopcmd,
 boolean hidden,
 boolean restricted)
                             throws InvalidServerException

Description copied from class: Host

Constructs a SubServer (but doesn't add it to the server manager)

Specified by:

constructSubServer in class Host

Parameters:

name - Name of Server

enabled - Enabled Status

port - Port Number

motd - Motd of the Server

log - Logging Status

directory - Directory

executable - Executable String

stopcmd - Command to Stop the Server

hidden - if the server should be hidden from players

restricted - Players will need a permission to join if true

Returns:

The SubServer

Throws:

InvalidServerException

addSubServer

public boolean addSubServer(UUID player,
 SubServer server)
                     throws InvalidServerException

Description copied from class: Host

Adds a SubServer

Specified by:

addSubServer in class Host

Parameters:

player - Player who added

server - SubServer to add

Returns:

Success status

Throws:

InvalidServerException

removeSubServer

protected boolean removeSubServer(UUID player,
 String name,
 boolean forced)
                           throws InterruptedException

Description copied from class: Host

Removes a SubServer

Specified by:

removeSubServer in class Host

Parameters:

player - Player Removing

name - SubServer Name

forced - Forces the Removal

Returns:

Success Status

Throws:

InterruptedException

recycleSubServer

protected boolean recycleSubServer(UUID player,
 String name,
 boolean forced)
                            throws InterruptedException

Description copied from class: Host

Deletes a SubServer (will move to 'Recently Deleted')

Specified by:

recycleSubServer in class Host

Parameters:

player - Player Deleting

name - SubServer Name

forced - Forces the Deletion

Returns:

Success Status

Throws:

InterruptedException

deleteSubServer

protected boolean deleteSubServer(UUID player,
 String name,
 boolean forced)
                           throws InterruptedException

Description copied from class: Host

Deletes a SubServer

Specified by:

deleteSubServer in class Host

Parameters:

player - Player Deleting

name - SubServer Name

forced - Forces the Deletion

Returns:

Success Status

Throws:

InterruptedException

destroy

public boolean destroy()

Description copied from class: Host

Resets this Host object

Overrides:

destroy in class Host

Returns:

Success Status

forSubData

public ObjectMap<String> forSubData()

Specified by:

forSubData in interface ClientHandler

Specified by:

forSubData in interface SubDataSerializable

Overrides:

forSubData in class Host