Package org.opends.server.plugins

Class OpenTelemetryPlugin

java.lang.Object

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

org.opends.server.plugins.OpenTelemetryPlugin

All Implemented Interfaces:

ConfigurationChangeListener<OpenTelemetryPluginCfg>

public final class OpenTelemetryPlugin
extends DirectoryServerPlugin<OpenTelemetryPluginCfg>
implements ConfigurationChangeListener<OpenTelemetryPluginCfg>

DirectoryServerPlugin responsible for pushing telemetry data to an OpenTelemetry server.

Constructor Summary

Constructors

Constructor	Description
OpenTelemetryPlugin()

Method Summary

Modifier and Type	Method	Description
ConfigChangeResult	applyConfigurationChange(OpenTelemetryPluginCfg 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.
void	finalizePlugin()	Performs any necessary finalization for this plugin.
void	initializePlugin(Set<PluginType> pluginTypes, OpenTelemetryPluginCfg configuration)	Performs any initialization necessary for this plugin.
boolean	isConfigurationChangeAcceptable(OpenTelemetryPluginCfg 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, doStartup, getPluginEntryDN, getPluginTypes, getServerContext, initializeInternal, invokeForInternalOperations, isConfigurationAcceptable, 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

OpenTelemetryPlugin

public OpenTelemetryPlugin()

Method Details

initializePlugin

public void initializePlugin(Set<PluginType> pluginTypes,
 OpenTelemetryPluginCfg 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<OpenTelemetryPluginCfg>

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<OpenTelemetryPluginCfg>

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<OpenTelemetryPluginCfg>

Parameters:

reason - The human-readable reason for the shutdown.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(OpenTelemetryPluginCfg 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<OpenTelemetryPluginCfg>

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(OpenTelemetryPluginCfg configuration)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<OpenTelemetryPluginCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.