org.glowroot.agent.plugin.api.config

Interface ConfigService

public interface ConfigService

Method Summary

Modifier and Type	Method and Description
BooleanProperty	getBooleanProperty(String name) Returns the boolean plugin property value with the specified name.
DoubleProperty	getDoubleProperty(String name) Returns the Double plugin property value with the specified name.
BooleanProperty	getEnabledProperty(String name)
StringProperty	getStringProperty(String name) Returns the String plugin property value with the specified name.
boolean	isEnabled() Returns whether the plugin is enabled.
void	registerConfigListener(ConfigListener listener) Registers a listener that will receive a callback when the plugin's property values are changed, the plugin is enabled/disabled.

Method Detail

registerConfigListener

void registerConfigListener(ConfigListener listener)

Registers a listener that will receive a callback when the plugin's property values are changed, the plugin is enabled/disabled. This allows the useful plugin optimization of caching the results of isEnabled(), getStringProperty(String), getBooleanProperty(String), and getDoubleProperty(String) as volatile fields, and updating the cached values anytime ConfigListener.onChange() is called.

isEnabled

boolean isEnabled()

Returns whether the plugin is enabled. When Glowroot itself is disabled, this returns false. Plugins can be individually disabled on the configuration page.

getStringProperty

StringProperty getStringProperty(String name)

Returns the String plugin property value with the specified name. null is never returned. If there is no String plugin property with the specified name then the empty string "" is returned. Plugin properties are scoped per plugin. The are defined in the plugin's META-INF/glowroot.plugin.json file, and can be modified (assuming they are not marked as hidden) on the configuration page under the plugin's configuration section.

getBooleanProperty

BooleanProperty getBooleanProperty(String name)

Returns the boolean plugin property value with the specified name. If there is no boolean plugin property with the specified name then false is returned. Plugin properties are scoped per plugin. The are defined in the plugin's META-INF/glowroot.plugin.json file, and can be modified (assuming they are not marked as hidden) on the configuration page under the plugin's configuration section.

getDoubleProperty

DoubleProperty getDoubleProperty(String name)

Returns the Double plugin property value with the specified name. If there is no Double plugin property with the specified name then null is returned. Plugin properties are scoped per plugin. The are defined in the plugin's META-INF/glowroot.plugin.json file, and can be modified (assuming they are not marked as hidden) on the configuration page under the plugin's configuration section.

getEnabledProperty

BooleanProperty getEnabledProperty(String name)