Package org.forgerock.audit.rotation

Class TimeLimitRotationPolicy

java.lang.Object

org.forgerock.audit.rotation.TimeLimitRotationPolicy

All Implemented Interfaces:

RotationPolicy

public class TimeLimitRotationPolicy
extends Object
implements RotationPolicy

Creates a rotation policy based on a time duration. Once the duration has passed the policy will indicate a file rotation is necessary.

Constructor Summary

Constructors

Constructor	Description
TimeLimitRotationPolicy(Duration rotationInterval)	Constructs a TimeLimitRotationPolicy with a given Duration.
TimeLimitRotationPolicy(Duration rotationInterval)	Deprecated, for removal: This API element is subject to removal in a future version. Use TimeLimitRotationPolicy(java.time.Duration) instead.

Method Summary

Modifier and Type	Method	Description
Duration	getRotationInterval()	Deprecated, for removal: This API element is subject to removal in a future version. Use getRotationIntervalDuration() instead.
Duration	getRotationIntervalDuration()	Gets the rotation duration interval.
boolean	shouldRotateFile(RotatableObject rotatable)	Checks whether a RotatableObject needs rotation.

Methods inherited from class java.lang.Object

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

Constructor Details

TimeLimitRotationPolicy

public TimeLimitRotationPolicy(Duration rotationInterval)

Constructs a TimeLimitRotationPolicy with a given Duration.

Parameters:

rotationInterval - The interval to rotate at.

TimeLimitRotationPolicy

@Deprecated(since="27.0.0",
            forRemoval=true)
public TimeLimitRotationPolicy(Duration rotationInterval)

Deprecated, for removal: This API element is subject to removal in a future version.

Use TimeLimitRotationPolicy(java.time.Duration) instead.

Constructs a TimeLimitRotationPolicy with a given Duration.

Parameters:

rotationInterval - The interval to rotate at.

Method Details

shouldRotateFile

public boolean shouldRotateFile(RotatableObject rotatable)

Checks whether a RotatableObject needs rotation.

Specified by:

shouldRotateFile in interface RotationPolicy

Parameters:

rotatable - The rotatable to be checked.

Returns:

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

getRotationIntervalDuration

public Duration getRotationIntervalDuration()

Gets the rotation duration interval.

Returns:

The interval as a Duration.

getRotationInterval

@Deprecated(since="27.0.0",
            forRemoval=true)
public Duration getRotationInterval()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getRotationIntervalDuration() instead.

Gets the rotation duration interval.

Returns:

The interval as a Duration.