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

Interface JsonFileAccessLogPublisherCfg

All Superinterfaces:
AccessLogPublisherCfg, CommonAuditAccessLogPublisherCfg, Configuration, LogPublisherCfg
public interface JsonFileAccessLogPublisherCfg extends CommonAuditAccessLogPublisherCfg
A server-side interface for querying JSON File Based Access Log Publisher settings.

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

  • Method Details

    • configurationClass

      Class<? extends JsonFileAccessLogPublisherCfg> configurationClass()
      Gets the configuration class associated with this JSON File Based Access Log Publisher.
      Specified by:
      configurationClass in interface AccessLogPublisherCfg
      Specified by:
      configurationClass in interface CommonAuditAccessLogPublisherCfg
      Specified by:
      configurationClass in interface Configuration
      Specified by:
      configurationClass in interface LogPublisherCfg
      Returns:
      Returns the configuration class associated with this JSON File Based Access Log Publisher.

    • addJsonFileAccessChangeListener

      void addJsonFileAccessChangeListener(ConfigurationChangeListener<JsonFileAccessLogPublisherCfg> listener)
      Register to be notified when this JSON File Based Access Log Publisher is changed.
      Parameters:
      listener - The JSON File Based Access Log Publisher configuration change listener.

    • removeJsonFileAccessChangeListener

      void removeJsonFileAccessChangeListener(ConfigurationChangeListener<JsonFileAccessLogPublisherCfg> listener)
      Deregister an existing JSON File Based Access Log Publisher configuration change listener.
      Parameters:
      listener - The JSON File Based Access Log Publisher configuration change listener.

    • getExcludeValuesOfAttributes

      SortedSet<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 an unmodifiable set containing the values of the "exclude-values-of-attributes" property.

    • getIncludeValuesOfAttributes

      SortedSet<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 an unmodifiable set containing the values of the "include-values-of-attributes" property.

    • getJavaClass

      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 AccessLogPublisherCfg
      Specified by:
      getJavaClass in interface LogPublisherCfg
      Returns:
      Returns the value of the "java-class" property.

    • getLogDirectory

      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.

    • getLogFieldBlacklist

      SortedSet<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 an unmodifiable set containing the values of the "log-field-blacklist" property.

    • getLogFileNamePrefix

      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.

    • isLogModifiedAttributeValues

      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.

    • getRetentionPolicy

      SortedSet<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 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 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 DN values of the "retention-policy" property.

    • getRotationPolicy

      SortedSet<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 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 JSON File Based 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.