Package com.unboundid.directory.sdk.common.api

Class MonitorProvider

java.lang.Object

com.unboundid.directory.sdk.common.api.MonitorProvider

All Implemented Interfaces:

Configurable, ExampleUsageProvider, Reconfigurable<MonitorProviderConfig>, UnboundIDExtension

@Extensible
@DirectoryServerExtension
@DirectoryProxyServerExtension(appliesToLocalContent=true,
                               appliesToRemoteContent=false)
@SynchronizationServerExtension(appliesToLocalContent=true,
                                appliesToSynchronizedContent=false)
@MetricsEngineExtension
@BrokerExtension
@ThreadSafety(level=INTERFACE_THREADSAFE)
public abstract class MonitorProvider
extends java.lang.Object
implements UnboundIDExtension, Reconfigurable<MonitorProviderConfig>, ExampleUsageProvider

This class defines an API that must be implemented by extensions which expose monitoring information about server components. Each monitor provider instance will be used by the server to construct a single monitor entry. The monitor information will be obtained on demand whenever the server receives a request targeting a monitor entry, but monitor providers may also indicate that they should be periodically invoked by a background thread so that they can collect additional information on a regular basis even when no clients have requested monitor information.

Configuring Monitor Providers

In order to configure a monitor provider created using this API, use a command like:

      dsconfig create-monitor-provider \
           --provider-name "{provider-name}" \
           --type third-party \
           --set enabled:true \
           --set "extension-class:{class-name}" \
           --set "extension-argument:{name=value}"
 

where "{provider-name}" is the name to use for the monitor provider instance, "{class-name}" is the fully-qualified name of the Java class that extends com.unboundid.directory.sdk.common.api.MonitorProvider, and "{name=value}" represents name-value pairs for any arguments to provide to the monitor provider. If multiple arguments should be provided to the monitor provider, then the "--set extension-argument:{name=value}" option should be provided multiple times.

Constructor Summary

Constructors

Constructor	Description
MonitorProvider()	Creates a new instance of this monitor provider.

Method Summary

Modifier and Type	Method	Description
ResultCode	applyConfiguration(MonitorProviderConfig config, ArgumentParser parser, java.util.List<java.lang.String> adminActionsRequired, java.util.List<java.lang.String> messages)	Attempts to apply the configuration from the provided argument parser to this extension.
void	defineConfigArguments(ArgumentParser parser)	Updates the provided argument parser to define any configuration arguments which may be used by this extension.
void	finalizeMonitorProvider()	Performs any cleanup which may be necessary when this monitor provider is to be taken out of service.
java.util.Map<java.util.List<java.lang.String>,java.lang.String>	getExamplesArgumentSets()	Retrieves a map containing examples of configurations that may be used for this extension.
abstract java.lang.String[]	getExtensionDescription()	Retrieves a human-readable description for this extension.
abstract java.lang.String	getExtensionName()	Retrieves a human-readable name for this extension.
abstract java.util.List<Attribute>	getMonitorAttributes()	Retrieves a list of attributes containing the data to include in the monitor entry generated from this monitor provider.
abstract java.lang.String	getMonitorInstanceName()	Retrieves the name that identifies this monitor provider instance.
java.lang.String	getMonitorObjectClass()	Retrieves the name of the object class that will be used for monitor entries created from this monitor provider.
long	getUpdateIntervalMillis()	Retrieves the update interval in milliseconds that should be used for this monitor provider.
void	initializeMonitorProvider(ServerContext serverContext, MonitorProviderConfig config, ArgumentParser parser)	Initializes this monitor provider.
boolean	isConfigurationAcceptable(MonitorProviderConfig config, ArgumentParser parser, java.util.List<java.lang.String> unacceptableReasons)	Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.
void	updateMonitorData()	Updates the information collected by this monitor provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

MonitorProvider

public MonitorProvider()

Creates a new instance of this monitor provider. All monitor provider implementations must include a default constructor, but any initialization should generally be done in the initializeMonitorProvider method.

Method Detail

getExtensionName

public abstract java.lang.String getExtensionName()

Retrieves a human-readable name for this extension.

Specified by:

getExtensionName in interface UnboundIDExtension

Returns:

A human-readable name for this extension.

getExtensionDescription

public abstract java.lang.String[] getExtensionDescription()

Retrieves a human-readable description for this extension. Each element of the array that is returned will be considered a separate paragraph in generated documentation.

Specified by:

getExtensionDescription in interface UnboundIDExtension

Returns:

A human-readable description for this extension, or null or an empty array if no description should be available.

defineConfigArguments

public void defineConfigArguments(ArgumentParser parser)
                           throws ArgumentException

Updates the provided argument parser to define any configuration arguments which may be used by this extension. The argument parser may also be updated to define relationships between arguments (e.g., to specify required, exclusive, or dependent argument sets).

Specified by:

defineConfigArguments in interface Configurable

Parameters:

parser - The argument parser to be updated with the configuration arguments which may be used by this extension.

Throws:

ArgumentException - If a problem is encountered while updating the provided argument parser.

initializeMonitorProvider

public void initializeMonitorProvider(ServerContext serverContext,
                                      MonitorProviderConfig config,
                                      ArgumentParser parser)
                               throws LDAPException

Initializes this monitor provider.

Parameters:

serverContext - A handle to the server context for the server in which this extension is running.

config - The general configuration for this monitor provider.

parser - The argument parser which has been initialized from the configuration for this monitor provider.

Throws:

LDAPException - If a problem occurs while initializing this monitor provider

isConfigurationAcceptable

public boolean isConfigurationAcceptable(MonitorProviderConfig config,
                                         ArgumentParser parser,
                                         java.util.List<java.lang.String> unacceptableReasons)

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension. The parser will have been used to parse any configuration available for this extension, and any automatic validation will have been performed. This method may be used to perform any more complex validation which cannot be performed automatically by the argument parser.

Specified by:

isConfigurationAcceptable in interface Reconfigurable<MonitorProviderConfig>

Parameters:

config - The general configuration for this extension.

parser - The argument parser that has been used to parse the proposed configuration for this extension.

unacceptableReasons - A list to which messages may be added to provide additional information about why the provided configuration is not acceptable.

Returns:

true if the configuration in the provided argument parser appears to be acceptable, or false if not.

applyConfiguration

public ResultCode applyConfiguration(MonitorProviderConfig config,
                                     ArgumentParser parser,
                                     java.util.List<java.lang.String> adminActionsRequired,
                                     java.util.List<java.lang.String> messages)

Attempts to apply the configuration from the provided argument parser to this extension.

Specified by:

applyConfiguration in interface Reconfigurable<MonitorProviderConfig>

Parameters:

config - The general configuration for this extension.

parser - The argument parser that has been used to parse the new configuration for this extension.

adminActionsRequired - A list to which messages may be added to provide additional information about any additional administrative actions that may be required to apply some of the configuration changes.

messages - A list to which messages may be added to provide additional information about the processing performed by this method.

Returns:

A result code providing information about the result of applying the configuration change. A result of SUCCESS should be used to indicate that all processing completed successfully. Any other result will indicate that a problem occurred during processing.

finalizeMonitorProvider

public void finalizeMonitorProvider()

Performs any cleanup which may be necessary when this monitor provider is to be taken out of service.

getMonitorInstanceName

public abstract java.lang.String getMonitorInstanceName()

Retrieves the name that identifies this monitor provider instance. It will be used as the value of the naming attribute for monitor entries. Each monitor provider instance must have a unique name.

Returns:

The name that identifies this monitor provider instance.

getMonitorObjectClass

public java.lang.String getMonitorObjectClass()

Retrieves the name of the object class that will be used for monitor entries created from this monitor provider. This does not need to be defined in the server schema. It may be null if a default object class should be used.

Returns:

The name of the object class that will be used for monitor entries created from this monitor provider.

getUpdateIntervalMillis

public long getUpdateIntervalMillis()

Retrieves the update interval in milliseconds that should be used for this monitor provider. A value that is greater than zero will cause the updateMonitorData() method to be repeatedly invoked at that interval. A value less than or equal to zero indicates that the monitor provider should not be periodically updated.

If the initial returned value is greater than zero, then this method will be invoked between each update to see if the update interval has changed. This way you can change the interval dynamically.

Returns:

The update interval in milliseconds that should be used for this monitor provider.

updateMonitorData

public void updateMonitorData()

Updates the information collected by this monitor provider. This method will be periodically invoked if the getUpdateIntervalMillis() method returns a positive value.

getMonitorAttributes

public abstract java.util.List<Attribute> getMonitorAttributes()

Retrieves a list of attributes containing the data to include in the monitor entry generated from this monitor provider.

Returns:

A list of attributes containing the data to include in the monitor entry generated from this monitor provider.

getExamplesArgumentSets

public java.util.Map<java.util.List<java.lang.String>,java.lang.String> getExamplesArgumentSets()

Retrieves a map containing examples of configurations that may be used for this extension. The map key should be a list of sample arguments, and the corresponding value should be a description of the behavior that will be exhibited by the extension when used with that configuration.

Specified by:

getExamplesArgumentSets in interface ExampleUsageProvider

Returns:

A map containing examples of configurations that may be used for this extension. It may be null or empty if there should not be any example argument sets.