Package org.forgerock.audit.retention

Class FreeDiskSpaceRetentionPolicy

java.lang.Object

org.forgerock.audit.retention.FreeDiskSpaceRetentionPolicy

All Implemented Interfaces:

RetentionPolicy

public class FreeDiskSpaceRetentionPolicy
extends Object
implements RetentionPolicy

A RetentionPolicy that will retain/delete log files given a minimum amount of disk space the file system must contain.

Constructor Summary

Constructors

Constructor	Description
FreeDiskSpaceRetentionPolicy(long minFreeSpaceRequired)	Constructs a FreeDiskSpaceRetentionPolicy given a minimum amount of disk space the file system must contain.

Method Summary

Modifier and Type	Method	Description
List<File>	deleteFiles(boolean hasRotated, FileNamingPolicy fileNamingPolicy)	Returns all files that should be deleted according to the policy.

Methods inherited from class java.lang.Object

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

Constructor Details

FreeDiskSpaceRetentionPolicy

public FreeDiskSpaceRetentionPolicy(long minFreeSpaceRequired)

Constructs a FreeDiskSpaceRetentionPolicy given a minimum amount of disk space the file system must contain.

Parameters:

minFreeSpaceRequired - The minimum amount of free disk space the the file system must contain in bytes.

Method Details

deleteFiles

public List<File> deleteFiles(boolean hasRotated,
 FileNamingPolicy fileNamingPolicy)

Description copied from interface: RetentionPolicy

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

Specified by:

deleteFiles in interface RetentionPolicy

Parameters:

hasRotated - true if one of the rotation policies rotated the file at last call.

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

Returns:

Not-null, An array of files that should be deleted according to the policy.