org.opends.server.core
Class EntryCacheConfigManager

java.lang.Object
  extended by org.opends.server.core.EntryCacheConfigManager
All Implemented Interfaces:
ConfigurationAddListener<EntryCacheCfg>, ConfigurationChangeListener<EntryCacheCfg>, ConfigurationDeleteListener<EntryCacheCfg>

public class EntryCacheConfigManager
extends java.lang.Object
implements ConfigurationChangeListener<EntryCacheCfg>, ConfigurationAddListener<EntryCacheCfg>, ConfigurationDeleteListener<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
EntryCacheConfigManager()
          Creates a new instance of this entry cache config manager.
 
Method Summary
 ConfigChangeResult applyConfigurationAdd(EntryCacheCfg configuration)
          Adds a new configuration to this add listener.
 ConfigChangeResult applyConfigurationChange(EntryCacheCfg configuration)
          Applies the configuration changes to this change listener.
 ConfigChangeResult applyConfigurationDelete(EntryCacheCfg configuration)
          Deletes an existing configuration from this delete listener.
 void initializeDefaultEntryCache()
          Initializes the default entry cache.
 void initializeEntryCache()
          Initializes the configuration associated with the Directory Server entry cache.
 boolean isConfigurationAddAcceptable(EntryCacheCfg configuration, java.util.List<Message> unacceptableReasons)
          Indicates whether the proposed addition of a new configuration is acceptable to this add listener.
 boolean isConfigurationChangeAcceptable(EntryCacheCfg configuration, java.util.List<Message> unacceptableReasons)
          Indicates whether the proposed change to the configuration is acceptable to this change listener.
 boolean isConfigurationDeleteAcceptable(EntryCacheCfg configuration, java.util.List<Message> unacceptableReasons)
          Indicates whether the proposed deletion of an existing configuration is acceptable to this delete listener.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EntryCacheConfigManager

public EntryCacheConfigManager()
Creates a new instance of this entry cache config manager.

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 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:
ConfigException - If a configuration problem causes the entry cache initialization process to fail.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(EntryCacheCfg configuration,
                                               java.util.List<Message> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:
isConfigurationChangeAcceptable in interface ConfigurationChangeListener<EntryCacheCfg>
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(EntryCacheCfg configuration)
Applies the configuration changes to this change listener.

Specified by:
applyConfigurationChange in interface ConfigurationChangeListener<EntryCacheCfg>
Parameters:
configuration - The new configuration containing the changes.
Returns:
Returns information about the result of changing the configuration.

isConfigurationAddAcceptable

public boolean isConfigurationAddAcceptable(EntryCacheCfg configuration,
                                            java.util.List<Message> unacceptableReasons)
Indicates whether the proposed addition of a new configuration is acceptable to this add listener.

Specified by:
isConfigurationAddAcceptable in interface ConfigurationAddListener<EntryCacheCfg>
Parameters:
configuration - The configuration that will be added.
unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.
Returns:
Returns true if the proposed addition is acceptable, or false if it is not.

applyConfigurationAdd

public ConfigChangeResult applyConfigurationAdd(EntryCacheCfg configuration)
Adds a new configuration to this add listener.

Specified by:
applyConfigurationAdd in interface ConfigurationAddListener<EntryCacheCfg>
Parameters:
configuration - The configuration that will be added.
Returns:
Returns information about the result of adding the configuration.

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(EntryCacheCfg configuration,
                                               java.util.List<Message> unacceptableReasons)
Indicates whether the proposed deletion of an existing configuration is acceptable to this delete listener.

Specified by:
isConfigurationDeleteAcceptable in interface ConfigurationDeleteListener<EntryCacheCfg>
Parameters:
configuration - The configuration that will be deleted.
unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.
Returns:
Returns true if the proposed deletion is acceptable, or false if it is not.

applyConfigurationDelete

public ConfigChangeResult applyConfigurationDelete(EntryCacheCfg configuration)
Deletes an existing configuration from this delete listener.

Specified by:
applyConfigurationDelete in interface ConfigurationDeleteListener<EntryCacheCfg>
Parameters:
configuration - The existing configuration that will be deleted.
Returns:
Returns information about the result of deleting the configuration.