org.opends.server.monitors

Class ClientConnectionMonitorProvider

java.lang.Object

org.opends.server.api.MonitorProvider<ClientConnectionMonitorProviderCfg>

org.opends.server.monitors.ClientConnectionMonitorProvider

public class ClientConnectionMonitorProvider
extends MonitorProvider<ClientConnectionMonitorProviderCfg>

This class defines a Directory Server monitor provider that can be used to obtain information about the client connections established to the server. Note that the information reported is obtained with little or no locking, so it may not be entirely consistent, especially for active connections.

Constructor Summary

Constructors

Constructor and Description
ClientConnectionMonitorProvider() Creates an instance of this monitor provider.
ClientConnectionMonitorProvider(ConnectionHandler handler) Creates an instance of this monitor provider.

Method Summary

Methods

Modifier and Type	Method and Description
MonitorData	getMonitorData() Retrieves a set of attributes containing monitor data that should be returned to the client if the corresponding monitor entry is requested.
String	getMonitorInstanceName() Retrieves the name of this monitor provider.
void	initializeMonitorProvider(ClientConnectionMonitorProviderCfg configuration) Initializes this monitor provider based on the information in the provided configuration entry.

Methods inherited from class org.opends.server.api.MonitorProvider

finalizeMonitorProvider, getMonitorObjectClass, isConfigurationAcceptable, scheduleUpdate

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientConnectionMonitorProvider

public ClientConnectionMonitorProvider()

Creates an instance of this monitor provider.

ClientConnectionMonitorProvider

public ClientConnectionMonitorProvider(ConnectionHandler handler)

Creates an instance of this monitor provider.

Parameters:

handler - to which the monitor provider is associated.

Method Detail

initializeMonitorProvider

public void initializeMonitorProvider(ClientConnectionMonitorProviderCfg configuration)
                               throws org.forgerock.opendj.config.server.ConfigException,
                                      InitializationException

Initializes this monitor provider based on the information in the provided configuration entry.

Overrides:

initializeMonitorProvider in class MonitorProvider<ClientConnectionMonitorProviderCfg>

Parameters:

configuration - The configuration to use to initialize this monitor provider.

Throws:

org.forgerock.opendj.config.server.ConfigException - If an unrecoverable problem arises in the process of performing the initialization.

InitializationException - If a problem occurs during initialization that is not related to the server configuration.

getMonitorInstanceName

public String getMonitorInstanceName()

Retrieves the name of this monitor provider. It should be unique among all monitor providers, including all instances of the same monitor provider.

Specified by:

getMonitorInstanceName in class MonitorProvider<ClientConnectionMonitorProviderCfg>

Returns:

The name of this monitor provider.

getMonitorData

public MonitorData getMonitorData()

Description copied from class: MonitorProvider

Retrieves a set of attributes containing monitor data that should be returned to the client if the corresponding monitor entry is requested.

Specified by:

getMonitorData in class MonitorProvider<ClientConnectionMonitorProviderCfg>

Returns:

A set of attributes containing monitor data that should be returned to the client if the corresponding monitor entry is requested.