Interface JsonFileHttpAccessLogPublisherCfgClient

    • Method Detail

      • getLogDirectory

        @MandatoryProperty
        ValueOrExpression<String> 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

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

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

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

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

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