Package org.forgerock.audit.events.handlers

Class FileBasedEventHandlerConfiguration

java.lang.Object

org.forgerock.audit.events.handlers.EventHandlerConfiguration

org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration

Direct Known Subclasses:

CsvAuditEventHandlerConfiguration, JsonAuditEventHandlerConfiguration

public abstract class FileBasedEventHandlerConfiguration
extends EventHandlerConfiguration

Configures time-based or size-based log file rotation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FileBasedEventHandlerConfiguration.FilePermissions	This class provides a mechanism for setting file permissions in a more abstract manner than is provided by the underlying operating system and/or filesystem.
static class	FileBasedEventHandlerConfiguration.FileRetention	Groups the file retention config parameters.
static class	FileBasedEventHandlerConfiguration.FileRotation	Groups the file rotation config parameters.

Constructor Summary

Constructors

Constructor	Description
FileBasedEventHandlerConfiguration()

Method Summary

Modifier and Type	Method	Description
FileBasedEventHandlerConfiguration.FilePermissions	buildFilePermissions()	Returns The non-null file permissions.
FileBasedEventHandlerConfiguration.FileRetention	getFileRetention()	Gets the FileBasedEventHandlerConfiguration.FileRetention.
FileBasedEventHandlerConfiguration.FileRotation	getFileRotation()	Gets the FileBasedEventHandlerConfiguration.FileRotation.
String	getRotationRetentionCheckInterval()	Gets the interval to check time-based file rotation policies.
void	setFilePermissions(String filePermissions)	Sets the FileBasedEventHandlerConfiguration.FilePermissions.
void	setFileRetention(FileBasedEventHandlerConfiguration.FileRetention fileRetention)	Sets the FileBasedEventHandlerConfiguration.FileRetention.
void	setFileRotation(FileBasedEventHandlerConfiguration.FileRotation fileRotation)	Sets the FileBasedEventHandlerConfiguration.FileRotation.
void	setRotationRetentionCheckInterval(String rotationRetentionCheckInterval)	Sets the interval to check time-based file rotation policies.

Methods inherited from class org.forgerock.audit.events.handlers.EventHandlerConfiguration

getName, getTopics, isEnabled, isUsableForQueries, setEnabled, setName, setTopics

Methods inherited from class java.lang.Object

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

Constructor Details

FileBasedEventHandlerConfiguration

public FileBasedEventHandlerConfiguration()

Method Details

buildFilePermissions

public FileBasedEventHandlerConfiguration.FilePermissions buildFilePermissions()

Returns The non-null file permissions.

Returns:

The non-null file permissions

setFilePermissions

public void setFilePermissions(String filePermissions)

Sets the FileBasedEventHandlerConfiguration.FilePermissions.

Parameters:

filePermissions - The non-null file permissions.

getFileRotation

public FileBasedEventHandlerConfiguration.FileRotation getFileRotation()

Gets the FileBasedEventHandlerConfiguration.FileRotation.

Returns:

Not-null, The FileBasedEventHandlerConfiguration.FileRotation.

setFileRotation

public void setFileRotation(FileBasedEventHandlerConfiguration.FileRotation fileRotation)

Sets the FileBasedEventHandlerConfiguration.FileRotation.

Parameters:

fileRotation - Not-null, The FileBasedEventHandlerConfiguration.FileRotation.

getFileRetention

public FileBasedEventHandlerConfiguration.FileRetention getFileRetention()

Gets the FileBasedEventHandlerConfiguration.FileRetention.

Returns:

Not-null, The FileBasedEventHandlerConfiguration.FileRetention.

setFileRetention

public void setFileRetention(FileBasedEventHandlerConfiguration.FileRetention fileRetention)

Sets the FileBasedEventHandlerConfiguration.FileRetention.

Parameters:

fileRetention - Not-null, The FileBasedEventHandlerConfiguration.FileRetention.

getRotationRetentionCheckInterval

public String getRotationRetentionCheckInterval()

Gets the interval to check time-based file rotation policies. The interval should be set as a Duration.

Examples of valid durations are:

      5 seconds
      5 minutes
      5 hours
 

Value of "zero" or "disabled" are not acceptable.

Returns:

The interval duration.

setRotationRetentionCheckInterval

public void setRotationRetentionCheckInterval(String rotationRetentionCheckInterval)

Sets the interval to check time-based file rotation policies. The interval should be set as a Duration.

Examples of valid durations are:

      5 seconds
      5 minutes
      5 hours
 

Value of "zero" or "disabled" are not acceptable.

Parameters:

rotationRetentionCheckInterval - The interval duration.