protocols

Class BaseProtocol

java.lang.Object

protocols.BaseProtocol

public abstract class BaseProtocol
extends Object

Every protocol class has to extend this. Contains methods to prepare the ServerStatus. The prepareServerStatus method is declared final because this does NOT need to be modified.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	DEBUG If true, print gathered information to console
protected String	infoStr Holds the common server status information.
protected String	ip The IP of the server whose status we're querying.
protected int	port The IP of the server whose status we're querying.

Constructor Summary

Constructors

Constructor and Description
BaseProtocol()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract String	getInfo() Send a status query and return the response.
protected PlayerList	getPlayers() Processes an info/status string and reads out player data.
abstract int	getSupportedOptions() Information this plugin is able to gather.
ServerStatus	prepareServerStatus(String ip, int port) Prepares a ServerStatus object for the given server and returns it.
protected abstract void	processInfo(ServerStatus st) Process the gathered information and set up the ServerStatus.

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

protected final boolean DEBUG

If true, print gathered information to console

See Also:

Constant Field Values

ip

protected String ip

The IP of the server whose status we're querying.

port

protected int port

The IP of the server whose status we're querying.

infoStr

protected String infoStr

Holds the common server status information.

Constructor Detail

BaseProtocol

public BaseProtocol()

Method Detail

getInfo

protected abstract String getInfo()

Send a status query and return the response.

Returns:

Server response.

processInfo

protected abstract void processInfo(ServerStatus st)

Process the gathered information and set up the ServerStatus. Practically you have to only set the map and hasPassword in this method.

Parameters:

st - The ServerStatus that has to be filled.

getSupportedOptions

public abstract int getSupportedOptions()

Information this plugin is able to gather.

The return value states wether this plugin supports an option or not. You just have to return the options for this plugin.

You can combine them with the binary or -> |
return PluginOptions.GET_MAPS | PluginOptions.RECOGNIZE_BOTS;

Returns:

An integer holding the bitflags.

getPlayers

protected PlayerList getPlayers()

Processes an info/status string and reads out player data. In this method you read the player info (name & ping) add it to a PlayerList and return it!

Returns:

PlayerList filled with information.

prepareServerStatus

public final ServerStatus prepareServerStatus(String ip,
                               int port)

Prepares a ServerStatus object for the given server and returns it.

Parameters:

ip - Server IP/DNS

port - Server port

Returns:

The ServerStatus with gathered information.