org.mcstats

Class MetricsLite

java.lang.Object

org.mcstats.MetricsLite

public class MetricsLite
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	BASE_URL The base url of the metrics domain
private org.bukkit.configuration.file.YamlConfiguration	configuration The plugin configuration file
private java.io.File	configurationFile The plugin configuration file
private boolean	debug Debug mode
private java.lang.String	guid Unique server id
private java.lang.Object	optOutLock Lock for synchronization
private static int	PING_INTERVAL Interval of time to ping (in minutes)
private org.bukkit.plugin.Plugin	plugin The plugin this metrics submits for
private static java.lang.String	REPORT_URL The url used to report a server's status
private static int	REVISION The current revision number
private org.bukkit.scheduler.BukkitTask	task Id of the scheduled task

Constructor Summary

Constructors

Constructor and Description
MetricsLite(org.bukkit.plugin.Plugin plugin)

Method Summary

Methods

Modifier and Type	Method and Description
void	disable() Disables metrics for the server by setting "opt-out" to true in the config file and canceling the metrics task.
void	enable() Enables metrics for the server by setting "opt-out" to false in the config file and starting the metrics task.
private static java.lang.String	encode(java.lang.String text) Encode text as UTF-8
private static void	encodeDataPair(java.lang.StringBuilder buffer, java.lang.String key, java.lang.String value) Encode a key/value data pair to be used in a HTTP post request.
java.io.File	getConfigFile() Gets the File object of the config file that should be used to store data such as the GUID and opt-out status
private boolean	isMineshafterPresent() Check if mineshafter is present.
boolean	isOptOut() Has the server owner denied plugin metrics?
private void	postPlugin(boolean isPing) Generic method that posts a plugin to the metrics website
boolean	start() Start measuring statistics.

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

private static final int REVISION

The current revision number

See Also:

Constant Field Values

BASE_URL

private static final java.lang.String BASE_URL

The base url of the metrics domain

See Also:

Constant Field Values

REPORT_URL

private static final java.lang.String REPORT_URL

The url used to report a server's status

See Also:

Constant Field Values

PING_INTERVAL

private static final int PING_INTERVAL

Interval of time to ping (in minutes)

See Also:

Constant Field Values

plugin

private final org.bukkit.plugin.Plugin plugin

The plugin this metrics submits for

configuration

private final org.bukkit.configuration.file.YamlConfiguration configuration

The plugin configuration file

configurationFile

private final java.io.File configurationFile

The plugin configuration file

guid

private final java.lang.String guid

Unique server id

debug

private final boolean debug

Debug mode

optOutLock

private final java.lang.Object optOutLock

Lock for synchronization

task

private volatile org.bukkit.scheduler.BukkitTask task

Id of the scheduled task

Constructor Detail

MetricsLite

public MetricsLite(org.bukkit.plugin.Plugin plugin)
            throws java.io.IOException

Throws:

java.io.IOException

Method Detail

encode

private static java.lang.String encode(java.lang.String text)
                                throws java.io.UnsupportedEncodingException

Encode text as UTF-8

Parameters:

text - the text to encode

Returns:

the encoded text, as UTF-8

Throws:

java.io.UnsupportedEncodingException

encodeDataPair

private static void encodeDataPair(java.lang.StringBuilder buffer,
                  java.lang.String key,
                  java.lang.String value)
                            throws java.io.UnsupportedEncodingException

Encode a key/value data pair to be used in a HTTP post request. This INCLUDES a & so the first key/value pair MUST be included manually, e.g:

StringBuffer data = new StringBuffer(); data.append(encode("guid")).append('=').append(encode(guid)); encodeDataPair(data, "version", description.getVersion());

Parameters:

buffer - the stringbuilder to append the data pair onto

key - the key value

value - the value

Throws:

java.io.UnsupportedEncodingException

disable

public void disable()
             throws java.io.IOException

Disables metrics for the server by setting "opt-out" to true in the config file and canceling the metrics task.

Throws:

java.io.IOException

enable

public void enable()
            throws java.io.IOException

Enables metrics for the server by setting "opt-out" to false in the config file and starting the metrics task.

Throws:

java.io.IOException

getConfigFile

public java.io.File getConfigFile()

Gets the File object of the config file that should be used to store data such as the GUID and opt-out status

Returns:

the File object for the config file

isMineshafterPresent

private boolean isMineshafterPresent()

Check if mineshafter is present. If it is, we need to bypass it to send POST requests

Returns:

true if mineshafter is installed on the server

isOptOut

public boolean isOptOut()

Has the server owner denied plugin metrics?

Returns:

true if metrics should be opted out of it

postPlugin

private void postPlugin(boolean isPing)
                 throws java.io.IOException

Generic method that posts a plugin to the metrics website

Throws:

java.io.IOException

start

public boolean start()

Start measuring statistics. This will immediately create an async repeating task as the plugin and send the initial data to the metrics backend, and then after that it will post in increments of PING_INTERVAL * 1200 ticks.

Returns:

True if statistics measuring is running, otherwise false.