Interface JsonFileHttpAccessLogPublisherCfgClient
- All Superinterfaces:
ConfigurationClient
,HttpAccessLogPublisherCfgClient
,LogPublisherCfgClient
JSON File Based HTTP Access Log Publishers Publish access messages to Json files.
-
Method Summary
Modifier and TypeMethodDescriptionManagedObjectDefinition<? extends JsonFileHttpAccessLogPublisherCfgClient,
? extends JsonFileHttpAccessLogPublisherCfg> Get the configuration definition associated with this JSON File Based HTTP Access Log Publisher.Gets the "java-class" property.Gets the "log-directory" property.Gets the "log-field-blacklist" property.Gets the "log-field-whitelist" property.Gets the "log-file-name-prefix" property.Gets the "retention-policy" property.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
Sets the "log-field-blacklist" property.void
Sets the "log-field-whitelist" property.void
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.Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient
commit, properties
Methods inherited from interface org.forgerock.opendj.server.config.client.LogPublisherCfgClient
isEnabled, setEnabled
-
Method Details
-
definition
ManagedObjectDefinition<? extends JsonFileHttpAccessLogPublisherCfgClient,? extends JsonFileHttpAccessLogPublisherCfg> definition()Get the configuration definition associated with this JSON File Based HTTP Access Log Publisher.- Specified by:
definition
in interfaceConfigurationClient
- Specified by:
definition
in interfaceHttpAccessLogPublisherCfgClient
- Specified by:
definition
in interfaceLogPublisherCfgClient
- Returns:
- Returns the configuration definition associated with this JSON File Based HTTP Access Log Publisher.
-
getJavaClass
Gets the "java-class" property.The fully-qualified name of the Java class that provides the JSON File Based HTTP Access Log Publisher implementation.
Default value:
org.opends.server.loggers.CommonAuditHTTPAccessLogPublisher
- Specified by:
getJavaClass
in interfaceHttpAccessLogPublisherCfgClient
- Specified by:
getJavaClass
in interfaceLogPublisherCfgClient
- Returns:
- Returns the value of the "java-class" property.
-
setJavaClass
Sets the "java-class" property.The fully-qualified name of the Java class that provides the JSON File Based HTTP Access Log Publisher implementation.
- Specified by:
setJavaClass
in interfaceHttpAccessLogPublisherCfgClient
- Specified by:
setJavaClass
in interfaceLogPublisherCfgClient
- Parameters:
value
- The value of the "java-class" property.- Throws:
PropertyException
- If the new value is invalid.
-
getLogDirectory
Gets the "log-directory" property.The directory to use for the log files generated by the JSON File Based HTTP Access Log Publisher. The path to the directory is relative to the server root.
Default value:
logs
- Returns:
- Returns the value of the "log-directory" property.
-
setLogDirectory
Sets the "log-directory" property.The directory to use for the log files generated by the JSON File Based HTTP Access Log Publisher. The path to the directory is relative to the server root.
- Parameters:
value
- The value of the "log-directory" property.- Throws:
PropertyException
- If the new value is invalid.
-
getLogFieldBlacklist
SortedSet<ValueOrExpression<String>> getLogFieldBlacklist()Gets the "log-field-blacklist" property.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.
- Returns:
- Returns the values of the "log-field-blacklist" property.
-
setLogFieldBlacklist
Sets the "log-field-blacklist" property.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.
- Parameters:
values
- The values of the "log-field-blacklist" property.- Throws:
PropertyException
- If one or more of the new values are invalid.
-
getLogFieldWhitelist
SortedSet<ValueOrExpression<String>> getLogFieldWhitelist()Gets the "log-field-whitelist" property.List of fields that the server includes in access log messages.
Valid values for this property are JSON paths for fields present in the log file.
- Returns:
- Returns the values of the "log-field-whitelist" property.
-
setLogFieldWhitelist
Sets the "log-field-whitelist" property.List of fields that the server includes in access log messages.
Valid values for this property are JSON paths for fields present in the log file.
- Parameters:
values
- The values of the "log-field-whitelist" property.- Throws:
PropertyException
- If one or more of the new values are invalid.
-
getLogFileNamePrefix
ValueOrExpression<String> getLogFileNamePrefix()Gets the "log-file-name-prefix" property.File name prefix (without extension) for CSV and JSON file based access log publishers.
Default value:
http-access
- Returns:
- Returns the value of the "log-file-name-prefix" property.
-
setLogFileNamePrefix
Sets the "log-file-name-prefix" property.File name prefix (without extension) for CSV and JSON file based access log publishers.
- Parameters:
value
- The value of the "log-file-name-prefix" property.- Throws:
PropertyException
- If the new value is invalid.
-
getRetentionPolicy
SortedSet<ValueOrExpression<String>> getRetentionPolicy()Gets the "retention-policy" property.The retention policy to use for the JSON File Based HTTP Access Log Publisher.
When multiple policies are used, log files are cleaned when any of the policy's conditions are met.
- Returns:
- Returns the values of the "retention-policy" property.
-
setRetentionPolicy
Sets the "retention-policy" property.The retention policy to use for the JSON File Based HTTP Access Log Publisher.
When multiple policies are used, log files are cleaned when any of the policy's conditions are met.
- Parameters:
values
- The values of the "retention-policy" property.- Throws:
PropertyException
- If one or more of the new values are invalid.
-
getRotationPolicy
SortedSet<ValueOrExpression<String>> getRotationPolicy()Gets the "rotation-policy" property.The rotation policy to use for the JSON File Based HTTP Access Log Publisher.
When multiple policies are used, rotation will occur if any policy's conditions are met.
- Returns:
- Returns the values of the "rotation-policy" property.
-
setRotationPolicy
Sets the "rotation-policy" property.The rotation policy to use for the JSON File Based HTTP Access Log Publisher.
When multiple policies are used, rotation will occur if any policy's conditions are met.
- Parameters:
values
- The values of the "rotation-policy" property.- Throws:
PropertyException
- If one or more of the new values are invalid.
-