Package org.forgerock.opendj.server.config.client

Interface JsonFileAccessLogPublisherCfgClient

All Superinterfaces:

AccessLogPublisherCfgClient, CommonAuditAccessLogPublisherCfgClient, ConfigurationClient, LogPublisherCfgClient

public interface JsonFileAccessLogPublisherCfgClient
extends CommonAuditAccessLogPublisherCfgClient

A client-side interface for reading and modifying JSON File Based Access Log Publisher settings.

JSON File Based Access Log Publishers publish access messages to JSON files.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends JsonFileAccessLogPublisherCfgClient,? extends JsonFileAccessLogPublisherCfg>	definition()	Get the configuration definition associated with this JSON File Based Access Log Publisher.
SortedSet<ValueOrExpression<AttributeType>>	getExcludeValuesOfAttributes()	Gets the "exclude-values-of-attributes" property.
SortedSet<ValueOrExpression<AttributeType>>	getIncludeValuesOfAttributes()	Gets the "include-values-of-attributes" property.
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.
ValueOrExpression<Boolean>	isLogModifiedAttributeValues()	Gets the "log-modified-attribute-values" property.
void	setExcludeValuesOfAttributes(Collection<ValueOrExpression<AttributeType>> values)	Sets the "exclude-values-of-attributes" property.
void	setIncludeValuesOfAttributes(Collection<ValueOrExpression<AttributeType>> values)	Sets the "include-values-of-attributes" 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	setLogModifiedAttributeValues(ValueOrExpression<Boolean> value)	Sets the "log-modified-attribute-values" 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.server.config.client.AccessLogPublisherCfgClient

createAccessLogFilteringCriteria, getAccessLogFilteringCriteria, getFilteringPolicy, isSuppressInternalOperations, isSuppressSynchronizationOperations, listAccessLogFilteringCriteria, removeAccessLogFilteringCriteria, setFilteringPolicy, setSuppressInternalOperations, setSuppressSynchronizationOperations

Methods inherited from interface org.forgerock.opendj.server.config.client.CommonAuditAccessLogPublisherCfgClient

isLogControls, setLogControls

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 JsonFileAccessLogPublisherCfgClient,? extends JsonFileAccessLogPublisherCfg> definition()

Get the configuration definition associated with this JSON File Based Access Log Publisher.

Specified by:

definition in interface AccessLogPublisherCfgClient

Specified by:

definition in interface CommonAuditAccessLogPublisherCfgClient

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface LogPublisherCfgClient

Returns:

Returns the configuration definition associated with this JSON File Based Access Log Publisher.

getExcludeValuesOfAttributes

SortedSet<ValueOrExpression<AttributeType>> getExcludeValuesOfAttributes()

Gets the "exclude-values-of-attributes" property.

Attributes types targeted by a modify operation for which the modified values should be omitted from the access log.

Default value is undefined

Returns:

Returns the values of the "exclude-values-of-attributes" property.

setExcludeValuesOfAttributes

void setExcludeValuesOfAttributes(Collection<ValueOrExpression<AttributeType>> values)
                           throws PropertyException

Sets the "exclude-values-of-attributes" property.

Attributes types targeted by a modify operation for which the modified values should be omitted from the access log.

Parameters:

values - The values of the "exclude-values-of-attributes" property.

Throws:

PropertyException - If one or more of the new values are invalid.

getIncludeValuesOfAttributes

SortedSet<ValueOrExpression<AttributeType>> getIncludeValuesOfAttributes()

Gets the "include-values-of-attributes" property.

Attributes types targeted by a modify operation for which the modified values should be included in the access log.

Default value is undefined

Returns:

Returns the values of the "include-values-of-attributes" property.

setIncludeValuesOfAttributes

void setIncludeValuesOfAttributes(Collection<ValueOrExpression<AttributeType>> values)
                           throws PropertyException

Sets the "include-values-of-attributes" property.

Attributes types targeted by a modify operation for which the modified values should be included in the access log.

Parameters:

values - The values of the "include-values-of-attributes" property.

Throws:

PropertyException - If one or more of the new values are invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

Default value: org.opends.server.loggers.JsonFileAccessLogPublisher

Specified by:

getJavaClass in interface AccessLogPublisherCfgClient

Specified by:

getJavaClass in interface LogPublisherCfgClient

Returns:

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

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

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

Specified by:

setJavaClass in interface AccessLogPublisherCfgClient

Specified by:

setJavaClass in interface LogPublisherCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getLogDirectory

@MandatoryProperty
ValueOrExpression<String> getLogDirectory()

Gets the "log-directory" property.

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.

Default value: logs

Returns:

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

setLogDirectory

@MandatoryProperty
void setLogDirectory(ValueOrExpression<String> value)
              throws PropertyException

Sets the "log-directory" property.

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.

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

void setLogFieldBlacklist(Collection<ValueOrExpression<String>> values)
                   throws PropertyException

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.

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: ldap-access

Returns:

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

setLogFileNamePrefix

void setLogFileNamePrefix(ValueOrExpression<String> value)
                   throws PropertyException

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.

isLogModifiedAttributeValues

ValueOrExpression<Boolean> isLogModifiedAttributeValues()

Gets the "log-modified-attribute-values" property.

The access log contains the values of attributes targeted by a modify operation.

Default value: false

Returns:

Returns the value of the "log-modified-attribute-values" property.

setLogModifiedAttributeValues

void setLogModifiedAttributeValues(ValueOrExpression<Boolean> value)
                            throws PropertyException

Sets the "log-modified-attribute-values" property.

The access log contains the values of attributes targeted by a modify operation.

Parameters:

value - The value of the "log-modified-attribute-values" 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 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

void setRetentionPolicy(Collection<ValueOrExpression<String>> values)
                 throws PropertyException

Sets the "retention-policy" property.

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.

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 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

void setRotationPolicy(Collection<ValueOrExpression<String>> values)
                throws PropertyException

Sets the "rotation-policy" property.

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.

Parameters:

values - The values of the "rotation-policy" property.

Throws:

PropertyException - If one or more of the new values are invalid.