org.opends.server.core

Class LogRetentionPolicyConfigManager

java.lang.Object

org.opends.server.core.LogRetentionPolicyConfigManager

All Implemented Interfaces:

ConfigurationAddListener<LogRetentionPolicyCfg>, ConfigurationChangeListener<LogRetentionPolicyCfg>, ConfigurationDeleteListener<LogRetentionPolicyCfg>

public class LogRetentionPolicyConfigManager
extends Object
implements ConfigurationAddListener<LogRetentionPolicyCfg>, ConfigurationDeleteListener<LogRetentionPolicyCfg>, ConfigurationChangeListener<LogRetentionPolicyCfg>

This class defines a utility that will be used to manage the set of log retention policies used in the Directory Server. It will perform the initialization when the server is starting, and then will manage any additions, and removals of policies while the server is running.

Constructor Summary

Constructors

Constructor and Description
LogRetentionPolicyConfigManager(ServerContext serverContext) Creates this log retention policy manager.

Method Summary

Methods

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationAdd(LogRetentionPolicyCfg config) Adds a new configuration to this add listener.
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(LogRetentionPolicyCfg configuration) Applies the configuration changes to this change listener.
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationDelete(LogRetentionPolicyCfg config) Deletes an existing configuration from this delete listener.
void	initializeLogRetentionPolicyConfig() Initializes all the log retention policies.
boolean	isConfigurationAddAcceptable(LogRetentionPolicyCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed addition of a new configuration is acceptable to this add listener.
boolean	isConfigurationChangeAcceptable(LogRetentionPolicyCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed change to the configuration is acceptable to this change listener.
boolean	isConfigurationDeleteAcceptable(LogRetentionPolicyCfg configuration, List<LocalizableMessage> 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

LogRetentionPolicyConfigManager

public LogRetentionPolicyConfigManager(ServerContext serverContext)

Creates this log retention policy manager.

Parameters:

serverContext - The server context.

Method Detail

initializeLogRetentionPolicyConfig

public void initializeLogRetentionPolicyConfig()
                                        throws org.forgerock.opendj.config.server.ConfigException,
                                               InitializationException

Initializes all the log retention policies.

Throws:

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

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

isConfigurationAddAcceptable

public boolean isConfigurationAddAcceptable(LogRetentionPolicyCfg configuration,
                                   List<LocalizableMessage> unacceptableReasons)

Indicates whether the proposed addition of a new configuration is acceptable to this add listener.

Specified by:

isConfigurationAddAcceptable in interface ConfigurationAddListener<LogRetentionPolicyCfg>

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.

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(LogRetentionPolicyCfg configuration,
                                      List<LocalizableMessage> unacceptableReasons)

Indicates whether the proposed deletion of an existing configuration is acceptable to this delete listener.

Specified by:

isConfigurationDeleteAcceptable in interface ConfigurationDeleteListener<LogRetentionPolicyCfg>

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.

applyConfigurationAdd

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationAdd(LogRetentionPolicyCfg config)

Adds a new configuration to this add listener.

Specified by:

applyConfigurationAdd in interface ConfigurationAddListener<LogRetentionPolicyCfg>

Parameters:

config - The configuration that will be added.

Returns:

Returns information about the result of adding the configuration.

applyConfigurationDelete

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationDelete(LogRetentionPolicyCfg config)

Deletes an existing configuration from this delete listener.

Specified by:

applyConfigurationDelete in interface ConfigurationDeleteListener<LogRetentionPolicyCfg>

Parameters:

config - The existing configuration that will be deleted.

Returns:

Returns information about the result of deleting the configuration.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(LogRetentionPolicyCfg configuration,
                                      List<LocalizableMessage> unacceptableReasons)

Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<LogRetentionPolicyCfg>

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 org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(LogRetentionPolicyCfg configuration)

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<LogRetentionPolicyCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.