org.opends.server.monitors

Class EntryCacheMonitorProvider

java.lang.Object

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

org.opends.server.monitors.EntryCacheMonitorProvider

public class EntryCacheMonitorProvider
extends MonitorProvider<EntryCacheMonitorProviderCfg>

This class defines a Directory Server monitor provider that can be used to obtain information about the entry cache state. Note that the information reported is obtained with no locking, so it may not be entirely consistent.

Constructor Summary

Constructors

Constructor and Description
EntryCacheMonitorProvider() Creates default instance of this monitor provider.
EntryCacheMonitorProvider(String entryCacheName, EntryCache<? extends EntryCacheCfg> entryCache) Creates implementation specific instance of this monitor provider.

Method Summary

Methods

Modifier and Type	Method and Description
List<Attribute>	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(EntryCacheMonitorProviderCfg 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

EntryCacheMonitorProvider

public EntryCacheMonitorProvider()

Creates default instance of this monitor provider.

EntryCacheMonitorProvider

public EntryCacheMonitorProvider(String entryCacheName,
                         EntryCache<? extends EntryCacheCfg> entryCache)

Creates implementation specific instance of this monitor provider.

Parameters:

entryCacheName - The name to use for this monitor provider.

entryCache - The entry cache to associate this monitor provider with.

Method Detail

initializeMonitorProvider

public void initializeMonitorProvider(EntryCacheMonitorProviderCfg configuration)
                               throws org.forgerock.opendj.config.server.ConfigException

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

Overrides:

initializeMonitorProvider in class MonitorProvider<EntryCacheMonitorProviderCfg>

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.

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

Returns:

The name of this monitor provider.

getMonitorData

public List<Attribute> getMonitorData()

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

Returns:

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