org.opends.server.admin.std.server

Interface CsvFileAccessLogPublisherCfg

All Superinterfaces:

AccessLogPublisherCfg, Configuration, LogPublisherCfg

public interface CsvFileAccessLogPublisherCfg
extends AccessLogPublisherCfg

A server-side interface for querying Csv File Access Log Publisher settings.

Csv File Access Log Publishers publish access messages to CSV files.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCsvFileAccessChangeListener(ConfigurationChangeListener<CsvFileAccessLogPublisherCfg> listener) Register to be notified when this Csv File Access Log Publisher is changed.
Class<? extends CsvFileAccessLogPublisherCfg>	configurationClass() Gets the configuration class associated with this Csv File Access Log Publisher.
String	getCsvDelimiterChar() Gets the "csv-delimiter-char" property.
String	getCsvEolSymbols() Gets the "csv-eol-symbols" property.
String	getCsvQuoteChar() Gets the "csv-quote-char" property.
String	getJavaClass() Gets the "java-class" property.
String	getKeyStoreFile() Gets the "key-store-file" property.
String	getKeyStorePinFile() Gets the "key-store-pin-file" property.
String	getLogDirectory() Gets the "log-directory" 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	getSignatureTimeInterval() Gets the "signature-time-interval" property.
boolean	isAsynchronous() Gets the "asynchronous" property.
boolean	isAutoFlush() Gets the "auto-flush" property.
boolean	isLogControlOids() Gets the "log-control-oids" property.
boolean	isTamperEvident() Gets the "tamper-evident" property.
void	removeCsvFileAccessChangeListener(ConfigurationChangeListener<CsvFileAccessLogPublisherCfg> listener) Deregister an existing Csv File Access Log Publisher configuration change listener.

Methods inherited from interface org.opends.server.admin.std.server.AccessLogPublisherCfg

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

Methods inherited from interface org.opends.server.admin.std.server.LogPublisherCfg

addChangeListener, isEnabled, removeChangeListener

Methods inherited from interface org.opends.server.admin.Configuration

dn

Method Detail

configurationClass

Class<? extends CsvFileAccessLogPublisherCfg> configurationClass()

Gets the configuration class associated with this Csv File Access 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 Csv File Access Log Publisher.

addCsvFileAccessChangeListener

void addCsvFileAccessChangeListener(ConfigurationChangeListener<CsvFileAccessLogPublisherCfg> listener)

Register to be notified when this Csv File Access Log Publisher is changed.

Parameters:

listener - The Csv File Access Log Publisher configuration change listener.

removeCsvFileAccessChangeListener

void removeCsvFileAccessChangeListener(ConfigurationChangeListener<CsvFileAccessLogPublisherCfg> listener)

Deregister an existing Csv File Access Log Publisher configuration change listener.

Parameters:

listener - The Csv File Access Log Publisher configuration change listener.

isAsynchronous

boolean isAsynchronous()

Gets the "asynchronous" property.

Indicates whether the Csv File Access 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.

getCsvDelimiterChar

String getCsvDelimiterChar()

Gets the "csv-delimiter-char" property.

The delimiter character to use when writing in CSV format.

Returns:

Returns the value of the "csv-delimiter-char" property.

getCsvEolSymbols

String getCsvEolSymbols()

Gets the "csv-eol-symbols" property.

The string that marks the end of a line.

Returns:

Returns the value of the "csv-eol-symbols" property.

getCsvQuoteChar

String getCsvQuoteChar()

Gets the "csv-quote-char" property.

The character to append and prepend to a CSV field when writing in CSV format.

Returns:

Returns the value of the "csv-quote-char" property.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

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

Specified by:

getJavaClass in interface AccessLogPublisherCfg

Specified by:

getJavaClass in interface LogPublisherCfg

Returns:

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

getKeyStoreFile

String getKeyStoreFile()

Gets the "key-store-file" property.

Specifies the path to the file that contains the private key information. This may be an absolute path, or a path that is relative to the OpenDJ instance root.

Changes to this property will take effect the next time that the key store is accessed.

Returns:

Returns the value of the "key-store-file" property.

getKeyStorePinFile

String getKeyStorePinFile()

Gets the "key-store-pin-file" property.

Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the Csv File Access Log Publisher .

Returns:

Returns the value of the "key-store-pin-file" property.

isLogControlOids

boolean isLogControlOids()

Gets the "log-control-oids" property.

Specifies whether control OIDs will be included in operation log records.

Returns:

Returns the value of the "log-control-oids" property.

getLogDirectory

String getLogDirectory()

Gets the "log-directory" property.

The directory to use for the log files generated by the Csv File Access Log Publisher. The path to the directory is relative to the server root.

Returns:

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

getRetentionPolicy

SortedSet<String> getRetentionPolicy()

Gets the "retention-policy" property.

The retention policy to use for the Csv File Access 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 Csv File Access 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 Csv File Access 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 Csv File Access 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.

getSignatureTimeInterval

long getSignatureTimeInterval()

Gets the "signature-time-interval" property.

Specifies the interval at which to sign the log file when the tamper-evident option is enabled.

Returns:

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

isTamperEvident

boolean isTamperEvident()

Gets the "tamper-evident" property.

Specifies whether the log should be signed in order to detect tampering.

Every log record will be signed, making it possible to verify that the log has not been tampered with. This feature has a significative impact on performance of the server.

Returns:

Returns the value of the "tamper-evident" property.