org.forgerock.opendj.server.config.server

Interface FileBasedAuditLogPublisherCfg

All Superinterfaces:

AccessLogPublisherCfg, Configuration, LogPublisherCfg

public interface FileBasedAuditLogPublisherCfg
extends AccessLogPublisherCfg

A server-side interface for querying File Based Audit Log Publisher settings.

File Based Audit Log Publishers publish access messages to the file system.

Method Summary

Modifier and Type	Method and Description
void	addFileBasedAuditChangeListener(ConfigurationChangeListener<FileBasedAuditLogPublisherCfg> listener) Register to be notified when this File Based Audit Log Publisher is changed.
Class<? extends FileBasedAuditLogPublisherCfg>	configurationClass() Gets the configuration class associated with this File Based Audit Log Publisher.
long	getBufferSize() Gets the "buffer-size" property.
String	getJavaClass() Gets the "java-class" property.
String	getLogFile() Gets the "log-file" property.
String	getLogFilePermissions() Gets the "log-file-permissions" property.
int	getQueueSize() Gets the "queue-size" property.
SortedSet<String>	getRetentionPolicy() Gets the "retention-policy" property.
SortedSet<Dn>	getRetentionPolicyDns() Gets the "retention-policy" property as a set of DNs.
SortedSet<String>	getRotationPolicy() Gets the "rotation-policy" property.
SortedSet<Dn>	getRotationPolicyDns() Gets the "rotation-policy" property as a set of DNs.
long	getTimeInterval() Gets the "time-interval" property.
boolean	isAppend() Gets the "append" property.
boolean	isAsynchronous() Gets the "asynchronous" property.
boolean	isAutoFlush() Gets the "auto-flush" property.
void	removeFileBasedAuditChangeListener(ConfigurationChangeListener<FileBasedAuditLogPublisherCfg> listener) Deregister an existing File Based Audit Log Publisher configuration change listener.

Methods inherited from interface org.forgerock.opendj.server.config.server.AccessLogPublisherCfg

addAccessChangeListener, addAccessLogFilteringCriteriaAddListener, addAccessLogFilteringCriteriaDeleteListener, getAccessLogFilteringCriteria, getFilteringPolicy, isSuppressInternalOperations, isSuppressSynchronizationOperations, listAccessLogFilteringCriteria, removeAccessChangeListener, removeAccessLogFilteringCriteriaAddListener, removeAccessLogFilteringCriteriaDeleteListener

Methods inherited from interface org.forgerock.opendj.server.config.server.LogPublisherCfg

addChangeListener, isEnabled, removeChangeListener

Methods inherited from interface org.forgerock.opendj.config.Configuration

dn, name

Method Detail

configurationClass

Class<? extends FileBasedAuditLogPublisherCfg> configurationClass()

Gets the configuration class associated with this File Based Audit Log Publisher.

Specified by:

configurationClass in interface AccessLogPublisherCfg

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface LogPublisherCfg

Returns:

Returns the configuration class associated with this File Based Audit Log Publisher.

addFileBasedAuditChangeListener

void addFileBasedAuditChangeListener(ConfigurationChangeListener<FileBasedAuditLogPublisherCfg> listener)

Register to be notified when this File Based Audit Log Publisher is changed.

Parameters:

listener - The File Based Audit Log Publisher configuration change listener.

removeFileBasedAuditChangeListener

void removeFileBasedAuditChangeListener(ConfigurationChangeListener<FileBasedAuditLogPublisherCfg> listener)

Deregister an existing File Based Audit Log Publisher configuration change listener.

Parameters:

listener - The File Based Audit Log Publisher configuration change listener.

isAppend

boolean isAppend()

Gets the "append" property.

Specifies whether to append to existing log files.

Returns:

Returns the value of the "append" property.

isAsynchronous

boolean isAsynchronous()

Gets the "asynchronous" property.

Indicates whether the File Based Audit Log Publisher will publish records asynchronously.

Returns:

Returns the value of the "asynchronous" property.

isAutoFlush

boolean isAutoFlush()

Gets the "auto-flush" property.

Specifies whether to flush the writer after every log record.

If the asynchronous writes option is used, the writer is flushed after all the log records in the queue are written.

Returns:

Returns the value of the "auto-flush" property.

getBufferSize

long getBufferSize()

Gets the "buffer-size" property.

Specifies the log file buffer size.

Returns:

Returns the value of the "buffer-size" property.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

The fully-qualified name of the Java class that provides the File Based Audit Log Publisher implementation.

Specified by:

getJavaClass in interface AccessLogPublisherCfg

Specified by:

getJavaClass in interface LogPublisherCfg

Returns:

Returns the value of the "java-class" property.

getLogFile

String getLogFile()

Gets the "log-file" property.

The file name to use for the log files generated by the File Based Audit Log Publisher. The path to the file is relative to the server root.

Returns:

Returns the value of the "log-file" property.

getLogFilePermissions

String getLogFilePermissions()

Gets the "log-file-permissions" property.

The UNIX permissions of the log files created by this File Based Audit Log Publisher.

Returns:

Returns the value of the "log-file-permissions" property.

getQueueSize

int getQueueSize()

Gets the "queue-size" property.

The maximum number of log records that can be stored in the asynchronous queue.

Returns:

Returns the value of the "queue-size" property.

getRetentionPolicy

SortedSet<String> getRetentionPolicy()

Gets the "retention-policy" property.

The retention policy to use for the File Based Audit Log Publisher .

When multiple policies are used, log files are cleaned when any of the policy's conditions are met.

Returns:

Returns an unmodifiable set containing the values of the "retention-policy" property.

getRetentionPolicyDns

SortedSet<Dn> getRetentionPolicyDns()

Gets the "retention-policy" property as a set of DNs.

The retention policy to use for the File Based Audit Log Publisher .

When multiple policies are used, log files are cleaned when any of the policy's conditions are met.

Returns:

Returns the DN values of the "retention-policy" property.

getRotationPolicy

SortedSet<String> getRotationPolicy()

Gets the "rotation-policy" property.

The rotation policy to use for the File Based Audit Log Publisher .

When multiple policies are used, rotation will occur if any policy's conditions are met.

Returns:

Returns an unmodifiable set containing the values of the "rotation-policy" property.

getRotationPolicyDns

SortedSet<Dn> getRotationPolicyDns()

Gets the "rotation-policy" property as a set of DNs.

The rotation policy to use for the File Based Audit Log Publisher .

When multiple policies are used, rotation will occur if any policy's conditions are met.

Returns:

Returns the DN values of the "rotation-policy" property.

getTimeInterval

long getTimeInterval()

Gets the "time-interval" property.

Specifies the interval at which to check whether the log files need to be rotated.

Returns:

Returns the value of the "time-interval" property.