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

Interface ExternalHttpAccessLogPublisherCfgClient

All Superinterfaces:
ConfigurationClient, HttpAccessLogPublisherCfgClient, LogPublisherCfgClient
public interface ExternalHttpAccessLogPublisherCfgClient extends HttpAccessLogPublisherCfgClient
A client-side interface for reading and modifying External HTTP Access Log Publisher settings.

External HTTP Access Log Publishers publish HTTP access messages to an external handler.

  • Method Details

    • definition

      ManagedObjectDefinition<? extends ExternalHttpAccessLogPublisherCfgClient,? extends ExternalHttpAccessLogPublisherCfg> definition()
      Get the configuration definition associated with this External HTTP Access Log Publisher.
      Specified by:
      definition in interface ConfigurationClient
      Specified by:
      definition in interface HttpAccessLogPublisherCfgClient
      Specified by:
      definition in interface LogPublisherCfgClient
      Returns:
      Returns the configuration definition associated with this External HTTP Access Log Publisher.

    • getConfigFile

      @MandatoryProperty ValueOrExpression<String> getConfigFile()
      Gets the "config-file" property.

      The JSON configuration file that defines the External HTTP Access Log Publisher. The content of the JSON configuration file depends on the type of external audit event handler. The path to the file is relative to the server root.

      Default value is undefined

      Returns:
      Returns the value of the "config-file" property.

    • setConfigFile

      @MandatoryProperty void setConfigFile(ValueOrExpression<String> value) throws PropertyException
      Sets the "config-file" property.

      The JSON configuration file that defines the External HTTP Access Log Publisher. The content of the JSON configuration file depends on the type of external audit event handler. The path to the file is relative to the server root.

      Parameters:
      value - The value of the "config-file" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getJavaClass

      @MandatoryProperty ValueOrExpression<String> getJavaClass()
      Gets the "java-class" property.

      The fully-qualified name of the Java class that provides the External HTTP Access Log Publisher implementation.

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

      Specified by:
      getJavaClass in interface HttpAccessLogPublisherCfgClient
      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 External HTTP Access Log Publisher implementation.

      Specified by:
      setJavaClass in interface HttpAccessLogPublisherCfgClient
      Specified by:
      setJavaClass in interface LogPublisherCfgClient
      Parameters:
      value - The value of the "java-class" 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.

    • 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

      void setLogFieldWhitelist(Collection<ValueOrExpression<String>> values) throws PropertyException
      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.