public interface CsvFileAccessLogPublisherCfgClient extends AccessLogPublisherCfgClient
CSV File Access Log Publishers publish access messages to CSV files.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends CsvFileAccessLogPublisherCfgClient,? extends CsvFileAccessLogPublisherCfg> |
definition()
Get the configuration definition associated with this CSV File Access Log Publisher.
|
ValueOrExpression<String> |
getCsvDelimiterChar()
Gets the "csv-delimiter-char" property.
|
ValueOrExpression<String> |
getCsvEolSymbols()
Gets the "csv-eol-symbols" property.
|
ValueOrExpression<String> |
getCsvQuoteChar()
Gets the "csv-quote-char" property.
|
ValueOrExpression<String> |
getJavaClass()
Gets the "java-class" property.
|
ValueOrExpression<String> |
getKeyStoreFile()
Gets the "key-store-file" property.
|
ValueOrExpression<String> |
getKeyStorePin()
Gets the "key-store-pin" property.
|
ValueOrExpression<String> |
getLogDirectory()
Gets the "log-directory" property.
|
SortedSet<ValueOrExpression<String>> |
getRetentionPolicy()
Gets the "retention-policy" property.
|
SortedSet<ValueOrExpression<String>> |
getRotationPolicy()
Gets the "rotation-policy" property.
|
ValueOrExpression<Long> |
getSignatureTimeInterval()
Gets the "signature-time-interval" property.
|
ValueOrExpression<Boolean> |
isAsynchronous()
Gets the "asynchronous" property.
|
ValueOrExpression<Boolean> |
isAutoFlush()
Gets the "auto-flush" property.
|
ValueOrExpression<Boolean> |
isLogControlOids()
Gets the "log-control-oids" property.
|
ValueOrExpression<Boolean> |
isTamperEvident()
Gets the "tamper-evident" property.
|
void |
setAsynchronous(ValueOrExpression<Boolean> value)
Sets the "asynchronous" property.
|
void |
setAutoFlush(ValueOrExpression<Boolean> value)
Sets the "auto-flush" property.
|
void |
setCsvDelimiterChar(ValueOrExpression<String> value)
Sets the "csv-delimiter-char" property.
|
void |
setCsvEolSymbols(ValueOrExpression<String> value)
Sets the "csv-eol-symbols" property.
|
void |
setCsvQuoteChar(ValueOrExpression<String> value)
Sets the "csv-quote-char" property.
|
void |
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.
|
void |
setKeyStoreFile(ValueOrExpression<String> value)
Sets the "key-store-file" property.
|
void |
setKeyStorePin(ValueOrExpression<String> value)
Sets the "key-store-pin" property.
|
void |
setLogControlOids(ValueOrExpression<Boolean> value)
Sets the "log-control-oids" property.
|
void |
setLogDirectory(ValueOrExpression<String> value)
Sets the "log-directory" property.
|
void |
setRetentionPolicy(Collection<ValueOrExpression<String>> values)
Sets the "retention-policy" property.
|
void |
setRotationPolicy(Collection<ValueOrExpression<String>> values)
Sets the "rotation-policy" property.
|
void |
setSignatureTimeInterval(ValueOrExpression<Long> value)
Sets the "signature-time-interval" property.
|
void |
setTamperEvident(ValueOrExpression<Boolean> value)
Sets the "tamper-evident" property.
|
createAccessLogFilteringCriteria, getAccessLogFilteringCriteria, getFilteringPolicy, isSuppressInternalOperations, isSuppressSynchronizationOperations, listAccessLogFilteringCriteria, removeAccessLogFilteringCriteria, setFilteringPolicy, setSuppressInternalOperations, setSuppressSynchronizationOperations
isEnabled, setEnabled
commit, properties
ManagedObjectDefinition<? extends CsvFileAccessLogPublisherCfgClient,? extends CsvFileAccessLogPublisherCfg> definition()
definition
in interface AccessLogPublisherCfgClient
definition
in interface ConfigurationClient
definition
in interface LogPublisherCfgClient
ValueOrExpression<Boolean> isAsynchronous()
Indicates whether the CSV File Access Log Publisher will publish records asynchronously.
void setAsynchronous(ValueOrExpression<Boolean> value) throws PropertyException
Indicates whether the CSV File Access Log Publisher will publish records asynchronously.
value
- The value of the "asynchronous" property.PropertyException
- If the new value is invalid.ValueOrExpression<Boolean> isAutoFlush()
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.
void setAutoFlush(ValueOrExpression<Boolean> value) throws PropertyException
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.
value
- The value of the "auto-flush" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getCsvDelimiterChar()
The delimiter character to use when writing in CSV format.
void setCsvDelimiterChar(ValueOrExpression<String> value) throws PropertyException
The delimiter character to use when writing in CSV format.
value
- The value of the "csv-delimiter-char" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getCsvEolSymbols()
The string that marks the end of a line.
void setCsvEolSymbols(ValueOrExpression<String> value) throws PropertyException
The string that marks the end of a line.
value
- The value of the "csv-eol-symbols" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getCsvQuoteChar()
The character to append and prepend to a CSV field when writing in CSV format.
void setCsvQuoteChar(ValueOrExpression<String> value) throws PropertyException
The character to append and prepend to a CSV field when writing in CSV format.
value
- The value of the "csv-quote-char" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getJavaClass()
The fully-qualified name of the Java class that provides the CSV File Access Log Publisher implementation.
getJavaClass
in interface AccessLogPublisherCfgClient
getJavaClass
in interface LogPublisherCfgClient
void setJavaClass(ValueOrExpression<String> value) throws PropertyException
The fully-qualified name of the Java class that provides the CSV File Access Log Publisher implementation.
setJavaClass
in interface AccessLogPublisherCfgClient
setJavaClass
in interface LogPublisherCfgClient
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getKeyStoreFile()
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.
void setKeyStoreFile(ValueOrExpression<String> value) throws PropertyException
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.
value
- The value of the "key-store-file" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getKeyStorePin()
Specifies the clear-text PIN needed to access the CSV File Access Log Publisher .
void setKeyStorePin(ValueOrExpression<String> value) throws PropertyException
Specifies the clear-text PIN needed to access the CSV File Access Log Publisher .
value
- The value of the "key-store-pin" property.PropertyException
- If the new value is invalid.ValueOrExpression<Boolean> isLogControlOids()
Specifies whether control OIDs will be included in operation log records.
void setLogControlOids(ValueOrExpression<Boolean> value) throws PropertyException
Specifies whether control OIDs will be included in operation log records.
value
- The value of the "log-control-oids" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getLogDirectory()
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.
void setLogDirectory(ValueOrExpression<String> value) throws PropertyException
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.
value
- The value of the "log-directory" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<String>> getRetentionPolicy()
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.
void setRetentionPolicy(Collection<ValueOrExpression<String>> values) throws PropertyException
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.
values
- The values of the "retention-policy" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<String>> getRotationPolicy()
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.
void setRotationPolicy(Collection<ValueOrExpression<String>> values) throws PropertyException
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.
values
- The values of the "rotation-policy" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<Long> getSignatureTimeInterval()
Specifies the interval at which to sign the log file when the tamper-evident option is enabled.
void setSignatureTimeInterval(ValueOrExpression<Long> value) throws PropertyException
Specifies the interval at which to sign the log file when the tamper-evident option is enabled.
value
- The value of the "signature-time-interval" property.PropertyException
- If the new value is invalid.ValueOrExpression<Boolean> isTamperEvident()
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.
void setTamperEvident(ValueOrExpression<Boolean> value) throws PropertyException
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.
value
- The value of the "tamper-evident" property.PropertyException
- If the new value is invalid.Copyright 2010-2018 ForgeRock AS.