org.forgerock.audit.retention

Class DiskSpaceUsedRetentionPolicy

java.lang.Object

org.forgerock.audit.retention.DiskSpaceUsedRetentionPolicy

All Implemented Interfaces:

RetentionPolicy

public class DiskSpaceUsedRetentionPolicy
extends Object
implements RetentionPolicy

A RetentionPolicy that will retain/delete log files based off the total disk space used.

Constructor Summary

Constructors

Constructor and Description
DiskSpaceUsedRetentionPolicy(long maxDiskSpaceToUse) Constructs a DiskSpaceUsedRetentionPolicy with a given maximum of disk space to use in bytes.

Method Summary

Modifier and Type	Method and Description
List<File>	deleteFiles(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 Detail

DiskSpaceUsedRetentionPolicy

public DiskSpaceUsedRetentionPolicy(long maxDiskSpaceToUse)

Constructs a DiskSpaceUsedRetentionPolicy with a given maximum of disk space to use in bytes.

Parameters:

maxDiskSpaceToUse - The maximum amount of disk space the historical audit files can occupy.

Method Detail

deleteFiles

public List<File> deleteFiles(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:

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.