org.spongepowered.api.util.metric

Interface MetricsConfigManager

public interface MetricsConfigManager

Provides information about whether a server has granted permission for server metric data to be transmitted on a per plugin basis.

This manager is @Injectable into plugin classes.

Method Summary

Modifier and Type	Method and Description
default boolean	areMetricsEnabled(Object plugin) Deprecated.
boolean	areMetricsEnabled(PluginContainer container) Deprecated.
Tristate	getCollectionState(PluginContainer container) Gets the current state of collection for the specified plugin.
Tristate	getGlobalCollectionState() Gets the current global state of collection.

Method Detail

areMetricsEnabled

@Deprecated
boolean areMetricsEnabled(PluginContainer container)

Deprecated.

Gets whether permission for third-party metrics gathering has been granted for a specific plugin (or the global permission if the plugin has not got a specific permission or lack thereof).

The value returned from this should not be stored. As the configuration/permission can be updated at any time, it is best to check this each time metrics collection is due to occur.

Parameters:

container - The PluginContainer to check for permission for

Returns:

true if metrics gathering plugins have permission to gather data about this plugin

areMetricsEnabled

@Deprecated
default boolean areMetricsEnabled(Object plugin)
                                       throws IllegalArgumentException

Deprecated.

Gets whether permission for third-party metrics gathering has been granted for a specific plugin (or the global permission if the plugin has not got a specific permission or lack thereof).

The value returned from this should not be stored. As the configuration/permission can be updated at any time, it is best to check this each time server metric collection is due to occur.

Parameters:

plugin - The plugin object (annotated with Plugin)

Returns:

true if metrics gathering plugins have permission to gather data about this plugin

Throws:

IllegalArgumentException - if the supplied object is not a plugin object

getGlobalCollectionState

Tristate getGlobalCollectionState()

Gets the current global state of collection. The collection state determines how data collection should be handled. Global state determines how an undefined state for a specific plugin should be handled. If a plugin has a state specified then it will override the global state. Tristate.TRUE Permits data collection Tristate.FALSE Disallows data collection, this has been explicitly set Tristate.UNDEFINED Disallows data collection, this is set by default

Returns:

The global state of collection

getCollectionState

Tristate getCollectionState(PluginContainer container)

Gets the current state of collection for the specified plugin. The collection state determines how data collection should be handled. Tristate.TRUE Permits data collection Tristate.FALSE Disallows data collection, this has been explicitly set Tristate.UNDEFINED Inherit from getGlobalCollectionState(), this is set by default

Parameters:

container - The PluginContainer

Returns:

The current collection state