net.ME1312.SubServers.Bungee.Host

Class SubServerController

java.lang.Object

net.ME1312.SubServers.Bungee.Host.SubServerController

public abstract class SubServerController
extends java.lang.Object

API-Safe SubServer Layout Class

Constructor Summary

Constructors

Constructor and Description
SubServerController(Host host, java.lang.String name, int port, java.lang.String motd, boolean hidden, boolean restricted) Creates a SubServer

Method Summary

Modifier and Type	Method and Description
boolean	command(java.lang.String command) Commands the Server
abstract boolean	command(java.util.UUID player, java.lang.String command) Commands the Server
abstract int	edit(java.util.UUID player, YAMLSection edit) Edits the Server
int	edit(YAMLSection edit) Edits the Server
SubServer	get() Get the SubServer that is being controlled
abstract java.util.LinkedList<SubServer.LoggedCommand>	getCommandHistory() Gets all the commands that were sent to this Server successfully
abstract Executable	getExecutable() Get the Server's Executable String
abstract Host	getHost() Grabs the Host of the Server
abstract SubLogger	getLogger() Get Process Logger
abstract java.lang.String	getPath() Get the Server Directory Path
abstract java.lang.String	getStopCommand() Grab the Command to Stop the Server
abstract boolean	isEditable() If the Server is accepting requests to edit()
abstract boolean	isEnabled() If the Server is Enabled
abstract boolean	isLogging() If the Server is Logging
abstract boolean	isRunning() If the Server is Running
abstract boolean	isTemporary() If the Server is Temporary
abstract void	setAutoRestart(boolean value) Set if the Server will Auto Restart on unexpected shutdowns
abstract void	setEditable(boolean value) Set if the Server should accept requests to edit()
abstract void	setEnabled(boolean value) Set if the Server is Enabled
abstract void	setLogging(boolean value) Set if the Server is Logging
abstract void	setStopCommand(java.lang.String value) Set the Command that Stops the Server
abstract void	setTemporary(boolean value) Set If the Server is Temporary (will start server if not running)
boolean	start() Starts the Server
abstract boolean	start(java.util.UUID player) Starts the Server
boolean	stop() Stops the Server
abstract boolean	stop(java.util.UUID player) Stops the Server
boolean	terminate() Terminates the Server
abstract boolean	terminate(java.util.UUID player) Terminates the Server
java.lang.String	toString()
abstract void	waitFor() Waits for the Server to Stop
abstract boolean	willAutoRestart() If the Server will Auto Restart on unexpected shutdowns

Methods inherited from class java.lang.Object

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

Constructor Detail

SubServerController

public SubServerController(Host host,
                           java.lang.String name,
                           int port,
                           java.lang.String motd,
                           boolean hidden,
                           boolean restricted)
                    throws InvalidServerException

Creates a SubServer

Parameters:

host - Host

name - Server Name

port - Port Number

motd - Server MOTD

restricted - Players will need a permission to join if true

Throws:

InvalidServerException

Method Detail

get

public SubServer get()

Get the SubServer that is being controlled

Returns:

SubServer

start

public abstract boolean start(java.util.UUID player)

Starts the Server

Parameters:

player - Player who Started

Returns:

Success Status

start

public boolean start()

Starts the Server

Returns:

Success Status

stop

public abstract boolean stop(java.util.UUID player)

Stops the Server

Parameters:

player - Player who Stopped

Returns:

Success Status

stop

public boolean stop()

Stops the Server

Returns:

Success Status

terminate

public abstract boolean terminate(java.util.UUID player)

Terminates the Server

Parameters:

player - Player who Terminated

Returns:

Success Status

terminate

public boolean terminate()

Terminates the Server

Returns:

Success Status

command

public abstract boolean command(java.util.UUID player,
                                java.lang.String command)

Commands the Server

Parameters:

player - Player who Commanded

command - Command to Send

Returns:

Success Status

command

public boolean command(java.lang.String command)

Commands the Server

Parameters:

command - Command to Send

Returns:

Success Status

edit

public abstract int edit(java.util.UUID player,
                         YAMLSection edit)

Edits the Server

Parameters:

player - Player Editing

edit - Edits

Returns:

Success Status

edit

public int edit(YAMLSection edit)

Edits the Server

Parameters:

edit - Edits

Returns:

Success Status

waitFor

public abstract void waitFor()
                      throws java.lang.InterruptedException

Waits for the Server to Stop

Throws:

java.lang.InterruptedException

isRunning

public abstract boolean isRunning()

If the Server is Running

Returns:

Running Status

getHost

public abstract Host getHost()

Grabs the Host of the Server

Returns:

The Host

isEnabled

public abstract boolean isEnabled()

If the Server is Enabled

Returns:

Enabled Status

setEnabled

public abstract void setEnabled(boolean value)

Set if the Server is Enabled

Parameters:

value - Value

isEditable

public abstract boolean isEditable()

If the Server is accepting requests to edit()

Returns:

Edit Status

See Also:

edit(YAMLSection), edit(UUID, YAMLSection)

setEditable

public abstract void setEditable(boolean value)

Set if the Server should accept requests to edit()

Parameters:

value - Edit Status

See Also:

edit(YAMLSection), edit(UUID, YAMLSection)

isLogging

public abstract boolean isLogging()

If the Server is Logging

Returns:

Logging Status

setLogging

public abstract void setLogging(boolean value)

Set if the Server is Logging

Parameters:

value - Value

getLogger

public abstract SubLogger getLogger()

Get Process Logger

getCommandHistory

public abstract java.util.LinkedList<SubServer.LoggedCommand> getCommandHistory()

Gets all the commands that were sent to this Server successfully

Returns:

Command History

getPath

public abstract java.lang.String getPath()

Get the Server Directory Path

Returns:

Server Directory Path

getExecutable

public abstract Executable getExecutable()

Get the Server's Executable String

Returns:

Executable String

getStopCommand

public abstract java.lang.String getStopCommand()

Grab the Command to Stop the Server

Returns:

Stop Command

setStopCommand

public abstract void setStopCommand(java.lang.String value)

Set the Command that Stops the Server

Parameters:

value - Value

willAutoRestart

public abstract boolean willAutoRestart()

If the Server will Auto Restart on unexpected shutdowns

Returns:

Auto Restart Status

setAutoRestart

public abstract void setAutoRestart(boolean value)

Set if the Server will Auto Restart on unexpected shutdowns

Parameters:

value - Value

isTemporary

public abstract boolean isTemporary()

If the Server is Temporary

Returns:

Temporary Status

setTemporary

public abstract void setTemporary(boolean value)

Set If the Server is Temporary (will start server if not running)

Parameters:

value - Value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object