public interface JsonFileAccessLogPublisherCfgClient extends CommonAuditAccessLogPublisherCfgClient
JSON File Based Access Log Publishers publish access messages to JSON files.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends JsonFileAccessLogPublisherCfgClient,? extends JsonFileAccessLogPublisherCfg> |
definition()
Get the configuration definition associated with this JSON File Based Access Log Publisher.
|
ValueOrExpression<String> |
getJavaClass()
Gets the "java-class" property.
|
ValueOrExpression<String> |
getLogDirectory()
Gets the "log-directory" property.
|
SortedSet<ValueOrExpression<String>> |
getLogFieldBlacklist()
Gets the "log-field-blacklist" property.
|
ValueOrExpression<String> |
getLogFileNamePrefix()
Gets the "log-file-name-prefix" property.
|
SortedSet<ValueOrExpression<String>> |
getRetentionPolicy()
Gets the "retention-policy" property.
|
SortedSet<ValueOrExpression<String>> |
getRotationPolicy()
Gets the "rotation-policy" property.
|
void |
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.
|
void |
setLogDirectory(ValueOrExpression<String> value)
Sets the "log-directory" property.
|
void |
setLogFieldBlacklist(Collection<ValueOrExpression<String>> values)
Sets the "log-field-blacklist" property.
|
void |
setLogFileNamePrefix(ValueOrExpression<String> value)
Sets the "log-file-name-prefix" property.
|
void |
setRetentionPolicy(Collection<ValueOrExpression<String>> values)
Sets the "retention-policy" property.
|
void |
setRotationPolicy(Collection<ValueOrExpression<String>> values)
Sets the "rotation-policy" property.
|
isLogControlOids, setLogControlOids
createAccessLogFilteringCriteria, getAccessLogFilteringCriteria, getFilteringPolicy, isSuppressInternalOperations, isSuppressSynchronizationOperations, listAccessLogFilteringCriteria, removeAccessLogFilteringCriteria, setFilteringPolicy, setSuppressInternalOperations, setSuppressSynchronizationOperations
isEnabled, setEnabled
commit, properties
ManagedObjectDefinition<? extends JsonFileAccessLogPublisherCfgClient,? extends JsonFileAccessLogPublisherCfg> definition()
definition
in interface AccessLogPublisherCfgClient
definition
in interface CommonAuditAccessLogPublisherCfgClient
definition
in interface ConfigurationClient
definition
in interface LogPublisherCfgClient
@MandatoryProperty ValueOrExpression<String> getJavaClass()
The fully-qualified name of the Java class that provides the JSON File Based Access Log Publisher implementation.
getJavaClass
in interface AccessLogPublisherCfgClient
getJavaClass
in interface LogPublisherCfgClient
@MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
The fully-qualified name of the Java class that provides the JSON File Based 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.@MandatoryProperty ValueOrExpression<String> getLogDirectory()
The directory to use for the log files generated by the JSON File Based Access Log Publisher. The path to the directory is relative to the server root.
@MandatoryProperty void setLogDirectory(ValueOrExpression<String> value) throws PropertyException
The directory to use for the log files generated by the JSON File Based 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>> getLogFieldBlacklist()
List of fields that the server omits from access log messages.
Valid values for this property are JSON paths for fields present in the log file.
void setLogFieldBlacklist(Collection<ValueOrExpression<String>> values) throws PropertyException
List of fields that the server omits from access log messages.
Valid values for this property are JSON paths for fields present in the log file.
values
- The values of the "log-field-blacklist" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<String> getLogFileNamePrefix()
File name prefix (without extension) for CSV and JSON file based access log publishers.
void setLogFileNamePrefix(ValueOrExpression<String> value) throws PropertyException
File name prefix (without extension) for CSV and JSON file based access log publishers.
value
- The value of the "log-file-name-prefix" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<String>> getRetentionPolicy()
The retention policy to use for the JSON File Based 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 JSON File Based 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 JSON File Based 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 JSON File Based 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.Copyright 2010-2022 ForgeRock AS.