public interface MetricsConfigManager
This manager is @Inject
able into plugin classes.
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.
|
@Deprecated boolean areMetricsEnabled(PluginContainer container)
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.
container
- The PluginContainer
to check for permission for@Deprecated default boolean areMetricsEnabled(Object plugin) throws IllegalArgumentException
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.
plugin
- The plugin object (annotated with
Plugin
)IllegalArgumentException
- if the supplied object is not a plugin
objectTristate getGlobalCollectionState()
Tristate.TRUE
Permits data collection
Tristate.FALSE
Disallows data collection, this has been explicitly set
Tristate.UNDEFINED
Disallows data collection, this is set by defaultTristate getCollectionState(PluginContainer container)
Tristate.TRUE
Permits data collection
Tristate.FALSE
Disallows data collection, this has been explicitly set
Tristate.UNDEFINED
Inherit from getGlobalCollectionState()
, this is set by defaultcontainer
- The PluginContainer