Package org.opends.server.plugins

Class GraphiteMonitorReporterPlugin

java.lang.Object

org.opends.server.api.plugin.DirectoryServerPlugin<GraphiteMonitorReporterPluginCfg>

org.opends.server.plugins.GraphiteMonitorReporterPlugin

All Implemented Interfaces:

ConfigurationChangeListener<GraphiteMonitorReporterPluginCfg>

public final class GraphiteMonitorReporterPlugin
extends DirectoryServerPlugin<GraphiteMonitorReporterPluginCfg>
implements ConfigurationChangeListener<GraphiteMonitorReporterPluginCfg>

DirectoryServerPlugin responsible for pushing monitoring data to a Graphite server.

Constructor Summary

Constructors

Constructor	Description
GraphiteMonitorReporterPlugin()

Method Summary

Modifier and Type	Method	Description
ConfigChangeResult	applyConfigurationChange(GraphiteMonitorReporterPluginCfg configuration)	Applies the configuration changes to this change listener.
void	doShutdown(LocalizableMessage reason)	Performs any processing that should be done when the Directory Server is in the process of performing a graceful shutdown.
PluginResult.Startup	doStartup()	Performs any processing that should be done when the Directory Server is in the process of starting.
void	finalizePlugin()	Performs any necessary finalization for this plugin.
void	initializePlugin(Set<PluginType> pluginTypes, GraphiteMonitorReporterPluginCfg configuration)	Performs any initialization necessary for this plugin.
boolean	isConfigurationAcceptable(GraphiteMonitorReporterPluginCfg configuration, List<LocalizableMessage> unacceptableReasons)	Indicates whether the provided configuration is acceptable for this plugin.
boolean	isConfigurationChangeAcceptable(GraphiteMonitorReporterPluginCfg configuration, List<LocalizableMessage> unacceptableReasons)	Indicates whether the proposed change to the configuration is acceptable to this change listener.

Methods inherited from class org.opends.server.api.plugin.DirectoryServerPlugin

doLDIFImport, doLDIFImportBegin, doLDIFImportEnd, doPostCommit, doPostCommit, doPostCommit, doPostCommit, doPostConnect, doPostDisconnect, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostSynchronization, doPostSynchronization, doPostSynchronization, doPostSynchronization, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, getPluginEntryDN, getPluginTypes, getServerContext, initializeInternal, invokeForInternalOperations, processIntermediateResponse, processSearchEntry, processSearchReference, processSubordinateDelete, processSubordinateModifyDN, setInvokeForInternalOperations

Methods inherited from class java.lang.Object

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

Constructor Details

GraphiteMonitorReporterPlugin

public GraphiteMonitorReporterPlugin()

Method Details

initializePlugin

public void initializePlugin(Set<PluginType> pluginTypes,
 GraphiteMonitorReporterPluginCfg configuration)
                      throws ConfigException

Description copied from class: DirectoryServerPlugin

Performs any initialization necessary for this plugin. This will be called as soon as the plugin has been loaded and before it is registered with the server.

Specified by:

initializePlugin in class DirectoryServerPlugin<GraphiteMonitorReporterPluginCfg>

Parameters:

pluginTypes - The set of plugin types that indicate the ways in which this plugin will be invoked.

configuration - The configuration for this plugin.

Throws:

ConfigException - If the provided entry does not contain a valid configuration for this plugin.

finalizePlugin

public void finalizePlugin()

Description copied from class: DirectoryServerPlugin

Performs any necessary finalization for this plugin. This will be called just after the plugin has been deregistered with the server but before it has been unloaded.

Overrides:

finalizePlugin in class DirectoryServerPlugin<GraphiteMonitorReporterPluginCfg>

doStartup

public PluginResult.Startup doStartup()

Description copied from class: DirectoryServerPlugin

Performs any processing that should be done when the Directory Server is in the process of starting. This method will be called after virtually all other initialization has been performed but before the connection handlers are started.

Overrides:

doStartup in class DirectoryServerPlugin<GraphiteMonitorReporterPluginCfg>

Returns:

The result of the startup plugin processing.

doShutdown

public void doShutdown(LocalizableMessage reason)

Description copied from class: DirectoryServerPlugin

Performs any processing that should be done when the Directory Server is in the process of performing a graceful shutdown. This method will be called early in the shutdown process after the connection handlers are stopped but before other finalization is performed.

Overrides:

doShutdown in class DirectoryServerPlugin<GraphiteMonitorReporterPluginCfg>

Parameters:

reason - The human-readable reason for the shutdown.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(GraphiteMonitorReporterPluginCfg configuration,
 List<LocalizableMessage> unacceptableReasons)

Description copied from class: DirectoryServerPlugin

Indicates whether the provided configuration is acceptable for this plugin. It should be possible to call this method on an uninitialized plugin instance in order to determine whether the plugin would be able to use the provided configuration.

Overrides:

isConfigurationAcceptable in class DirectoryServerPlugin<GraphiteMonitorReporterPluginCfg>

Parameters:

configuration - The plugin configuration for which to make the determination.

unacceptableReasons - A list that may be used to hold the reasons that the provided configuration is not acceptable.

Returns:

true if the provided configuration is acceptable for this plugin, or false if not.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(GraphiteMonitorReporterPluginCfg configuration,
 List<LocalizableMessage> unacceptableReasons)

Description copied from interface: ConfigurationChangeListener

Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<GraphiteMonitorReporterPluginCfg>

Parameters:

configuration - The new configuration containing the changes.

unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the proposed change is acceptable, or false if it is not.

applyConfigurationChange

public ConfigChangeResult applyConfigurationChange(GraphiteMonitorReporterPluginCfg configuration)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<GraphiteMonitorReporterPluginCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.