Package org.opends.server.loggers

Class SizeBasedRetentionPolicy

java.lang.Object

org.opends.server.loggers.SizeBasedRetentionPolicy

All Implemented Interfaces:

ConfigurationChangeListener<SizeLimitLogRetentionPolicyCfg>, RetentionPolicy<SizeLimitLogRetentionPolicyCfg>

public final class SizeBasedRetentionPolicy
extends Object
implements RetentionPolicy<SizeLimitLogRetentionPolicyCfg>, ConfigurationChangeListener<SizeLimitLogRetentionPolicyCfg>

This class implements a retention policy based on the amount of space taken by the log files.

Constructor Summary

Constructors

Constructor	Description
SizeBasedRetentionPolicy()

Method Summary

Modifier and Type	Method	Description
ConfigChangeResult	applyConfigurationChange(SizeLimitLogRetentionPolicyCfg config)	Applies the configuration changes to this change listener.
Path[]	deleteFiles(org.opends.server.loggers.FileNamingPolicy fileNamingPolicy)	Returns all files that should be deleted according to the policy.
void	initializeLogRetentionPolicy(SizeLimitLogRetentionPolicyCfg config)	Initializes this log retention policy based on the information in the provided retention policy configuration.
boolean	isConfigurationChangeAcceptable(SizeLimitLogRetentionPolicyCfg config, List<LocalizableMessage> unacceptableReasons)	Indicates whether the proposed change to the configuration is acceptable to this change listener.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SizeBasedRetentionPolicy

public SizeBasedRetentionPolicy()

Method Detail

initializeLogRetentionPolicy

public void initializeLogRetentionPolicy(SizeLimitLogRetentionPolicyCfg config)

Description copied from interface: RetentionPolicy

Initializes this log retention policy based on the information in the provided retention policy configuration.

Specified by:

initializeLogRetentionPolicy in interface RetentionPolicy<SizeLimitLogRetentionPolicyCfg>

Parameters:

config - The retention policy configuration that contains the information to use to initialize this policy.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(SizeLimitLogRetentionPolicyCfg config,
                                               List<LocalizableMessage> unacceptableReasons)

Description copied from interface: ConfigurationChangeListener

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

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<SizeLimitLogRetentionPolicyCfg>

Parameters:

config - 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(SizeLimitLogRetentionPolicyCfg config)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<SizeLimitLogRetentionPolicyCfg>

Parameters:

config - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.

deleteFiles

public Path[] deleteFiles(org.opends.server.loggers.FileNamingPolicy fileNamingPolicy)
                   throws IOException

Description copied from interface: RetentionPolicy

Returns all files that should be deleted according to the policy.

Specified by:

deleteFiles in interface RetentionPolicy<SizeLimitLogRetentionPolicyCfg>

Parameters:

fileNamingPolicy - The naming policy used generate the log file names.

Returns:

An array of files that should be deleted according to the policy or null if an error occurred while obtaining the file list.

Throws:

IOException - If an error occurs while obtaining a list of files to delete.

toString

public String toString()

Overrides:

toString in class Object