Package org.opends.server.loggers

Class FixedTimeRotationPolicy

java.lang.Object

org.opends.server.loggers.FixedTimeRotationPolicy

All Implemented Interfaces:

ConfigurationChangeListener<FixedTimeLogRotationPolicyCfg>, RotationPolicy<FixedTimeLogRotationPolicyCfg>

public final class FixedTimeRotationPolicy
extends Object
implements RotationPolicy<FixedTimeLogRotationPolicyCfg>, ConfigurationChangeListener<FixedTimeLogRotationPolicyCfg>

This class implements a rotation policy based on fixed day/time of day.

Constructor Summary

Constructors

Constructor	Description
FixedTimeRotationPolicy()

Method Summary

Modifier and Type	Method	Description
ConfigChangeResult	applyConfigurationChange(FixedTimeLogRotationPolicyCfg config)	Applies the configuration changes to this change listener.
void	initializeLogRotationPolicy(FixedTimeLogRotationPolicyCfg config)	Initializes this log rotation policy based on the information in the provided rotation policy configuration.
boolean	isConfigurationChangeAcceptable(FixedTimeLogRotationPolicyCfg config, List<LocalizableMessage> unacceptableReasons)	Indicates whether the proposed change to the configuration is acceptable to this change listener.
boolean	rotateFile(RotatableLogFile writer)	This method indicates if the log file should be rotated or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

FixedTimeRotationPolicy

public FixedTimeRotationPolicy()

Method Detail

initializeLogRotationPolicy

public void initializeLogRotationPolicy(FixedTimeLogRotationPolicyCfg config)

Description copied from interface: RotationPolicy

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

Specified by:

initializeLogRotationPolicy in interface RotationPolicy<FixedTimeLogRotationPolicyCfg>

Parameters:

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

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(FixedTimeLogRotationPolicyCfg 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<FixedTimeLogRotationPolicyCfg>

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

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<FixedTimeLogRotationPolicyCfg>

Parameters:

config - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.

rotateFile

public boolean rotateFile(RotatableLogFile writer)

Description copied from interface: RotationPolicy

This method indicates if the log file should be rotated or not.

Specified by:

rotateFile in interface RotationPolicy<FixedTimeLogRotationPolicyCfg>

Parameters:

writer - the file writer to be checked.

Returns:

true if the log file should be rotated, false otherwise.