Package org.forgerock.audit.rotation

Class SizeBasedRotationPolicy

java.lang.Object

org.forgerock.audit.rotation.SizeBasedRotationPolicy

All Implemented Interfaces:

RotationPolicy

public class SizeBasedRotationPolicy
extends Object
implements RotationPolicy

Creates a file size based rotation policy. Once a file is a given size in bytes it is rotated.

Constructor Summary

Constructors

Constructor	Description
SizeBasedRotationPolicy(long maxFileSizeInBytes)	Constructs a SizeBasedRotationPolicy given a max file size in bytes.

Method Summary

Modifier and Type	Method	Description
long	getMaxFileSizeInBytes()	Gets the maximum size (in bytes) a file may grow to before being rotated.
boolean	shouldRotateFile(RotatableObject file)	Indicates whether or not a RotatableObject needs rotation.

Methods inherited from class java.lang.Object

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

Constructor Details

SizeBasedRotationPolicy

public SizeBasedRotationPolicy(long maxFileSizeInBytes)

Constructs a SizeBasedRotationPolicy given a max file size in bytes.

Parameters:

maxFileSizeInBytes - A max file size in bytes.

Method Details

shouldRotateFile

public boolean shouldRotateFile(RotatableObject file)

Indicates whether or not a RotatableObject needs rotation.

Specified by:

shouldRotateFile in interface RotationPolicy

Parameters:

file - The RotatableObject to be checked.

Returns:

True - If the RotatableObject needs rotation. False - If the RotatableObject doesn't need rotation.

getMaxFileSizeInBytes

public long getMaxFileSizeInBytes()

Gets the maximum size (in bytes) a file may grow to before being rotated.

Returns:

the maximum file size permitted by this policy.