org.opends.server.core

Class EntryCacheConfigManager

java.lang.Object

org.opends.server.core.EntryCacheConfigManager

All Implemented Interfaces:

org.forgerock.opendj.config.server.ConfigurationAddListener<org.forgerock.opendj.server.config.server.EntryCacheCfg>, org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.EntryCacheCfg>, org.forgerock.opendj.config.server.ConfigurationDeleteListener<org.forgerock.opendj.server.config.server.EntryCacheCfg>

public class EntryCacheConfigManager
extends Object
implements org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.EntryCacheCfg>, org.forgerock.opendj.config.server.ConfigurationAddListener<org.forgerock.opendj.server.config.server.EntryCacheCfg>, org.forgerock.opendj.config.server.ConfigurationDeleteListener<org.forgerock.opendj.server.config.server.EntryCacheCfg>

This class defines a utility that will be used to manage the configuration for the Directory Server entry cache. The default entry cache is always enabled.

Constructor Summary

Constructors

Constructor and Description
EntryCacheConfigManager(ServerContext serverContext) Creates a new instance of this entry cache config manager.

Method Summary

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationAdd(org.forgerock.opendj.server.config.server.EntryCacheCfg configuration)
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(org.forgerock.opendj.server.config.server.EntryCacheCfg configuration)
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationDelete(org.forgerock.opendj.server.config.server.EntryCacheCfg configuration)
void	initializeDefaultEntryCache() Initializes the default entry cache.
void	initializeEntryCache() Initializes the configuration associated with the Directory Server entry cache.
boolean	isConfigurationAddAcceptable(org.forgerock.opendj.server.config.server.EntryCacheCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
boolean	isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.EntryCacheCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
boolean	isConfigurationDeleteAcceptable(org.forgerock.opendj.server.config.server.EntryCacheCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Methods inherited from class java.lang.Object

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

Constructor Detail

EntryCacheConfigManager

public EntryCacheConfigManager(ServerContext serverContext)

Creates a new instance of this entry cache config manager.

Parameters:

serverContext - The server context.

Method Detail

initializeDefaultEntryCache

public void initializeDefaultEntryCache()
                                 throws InitializationException

Initializes the default entry cache. This should only be called at Directory Server startup.

Throws:

InitializationException - If a problem occurs while trying to install the default entry cache.

initializeEntryCache

public void initializeEntryCache()
                          throws org.forgerock.opendj.config.server.ConfigException

Initializes the configuration associated with the Directory Server entry cache. This should only be called at Directory Server startup. If an error occurs, then a message will be logged for each entry cache that is failed to initialize.

Throws:

org.forgerock.opendj.config.server.ConfigException - If a configuration problem causes the entry cache initialization process to fail.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.EntryCacheCfg configuration,
                                               List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Specified by:

isConfigurationChangeAcceptable in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.EntryCacheCfg>

applyConfigurationChange

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(org.forgerock.opendj.server.config.server.EntryCacheCfg configuration)

Specified by:

applyConfigurationChange in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.EntryCacheCfg>

isConfigurationAddAcceptable

public boolean isConfigurationAddAcceptable(org.forgerock.opendj.server.config.server.EntryCacheCfg configuration,
                                            List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Specified by:

isConfigurationAddAcceptable in interface org.forgerock.opendj.config.server.ConfigurationAddListener<org.forgerock.opendj.server.config.server.EntryCacheCfg>

applyConfigurationAdd

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationAdd(org.forgerock.opendj.server.config.server.EntryCacheCfg configuration)

Specified by:

applyConfigurationAdd in interface org.forgerock.opendj.config.server.ConfigurationAddListener<org.forgerock.opendj.server.config.server.EntryCacheCfg>

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(org.forgerock.opendj.server.config.server.EntryCacheCfg configuration,
                                               List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Specified by:

isConfigurationDeleteAcceptable in interface org.forgerock.opendj.config.server.ConfigurationDeleteListener<org.forgerock.opendj.server.config.server.EntryCacheCfg>

applyConfigurationDelete

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationDelete(org.forgerock.opendj.server.config.server.EntryCacheCfg configuration)

Specified by:

applyConfigurationDelete in interface org.forgerock.opendj.config.server.ConfigurationDeleteListener<org.forgerock.opendj.server.config.server.EntryCacheCfg>