Class CsvFileHttpAccessLogPublisherCfgDefn

    • Method Detail

      • getInstance

        public static CsvFileHttpAccessLogPublisherCfgDefn getInstance()
        Get the CSV File HTTP Access Log Publisher configuration definition singleton.
        Returns:
        Returns the CSV File HTTP Access Log Publisher configuration definition singleton.
      • getAsynchronousPropertyDefinition

        public BooleanPropertyDefinition getAsynchronousPropertyDefinition()
        Get the "asynchronous" property definition.

        Indicates whether the CSV File HTTP Access Log Publisher will publish records asynchronously.

        Returns:
        Returns the "asynchronous" property definition.
      • getAutoFlushPropertyDefinition

        public BooleanPropertyDefinition getAutoFlushPropertyDefinition()
        Get the "auto-flush" property definition.

        Specifies whether to flush the writer after every log record.

        If the asynchronous writes option is used, the writer is flushed after all the log records in the queue are written.

        Returns:
        Returns the "auto-flush" property definition.
      • getCsvDelimiterCharPropertyDefinition

        public StringPropertyDefinition getCsvDelimiterCharPropertyDefinition()
        Get the "csv-delimiter-char" property definition.

        The delimiter character to use when writing in CSV format.

        Returns:
        Returns the "csv-delimiter-char" property definition.
      • getCsvEolSymbolsPropertyDefinition

        public StringPropertyDefinition getCsvEolSymbolsPropertyDefinition()
        Get the "csv-eol-symbols" property definition.

        The string that marks the end of a line.

        Returns:
        Returns the "csv-eol-symbols" property definition.
      • getCsvQuoteCharPropertyDefinition

        public StringPropertyDefinition getCsvQuoteCharPropertyDefinition()
        Get the "csv-quote-char" property definition.

        The character to append and prepend to a CSV field when writing in CSV format.

        Returns:
        Returns the "csv-quote-char" property definition.
      • getEnabledPropertyDefinition

        public BooleanPropertyDefinition getEnabledPropertyDefinition()
        Get the "enabled" property definition.

        Indicates whether the CSV File HTTP Access Log Publisher is enabled for use.

        Returns:
        Returns the "enabled" property definition.
      • getJavaClassPropertyDefinition

        public ClassPropertyDefinition getJavaClassPropertyDefinition()
        Get the "java-class" property definition.

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

        Returns:
        Returns the "java-class" property definition.
      • getKeyStoreFilePropertyDefinition

        public StringPropertyDefinition getKeyStoreFilePropertyDefinition()
        Get the "key-store-file" property definition.

        Specifies the path to the file that contains the private key information. This may be an absolute path, or a path that is relative to the OpenDJ instance root.

        Changes to this property will take effect the next time that the key store is accessed.

        Returns:
        Returns the "key-store-file" property definition.
      • getKeyStorePinPropertyDefinition

        public StringPropertyDefinition getKeyStorePinPropertyDefinition()
        Get the "key-store-pin" property definition.

        Specifies the clear-text PIN needed to access the CSV File HTTP Access Log Publisher .

        Returns:
        Returns the "key-store-pin" property definition.
      • getLogDirectoryPropertyDefinition

        public StringPropertyDefinition getLogDirectoryPropertyDefinition()
        Get the "log-directory" property definition.

        The directory to use for the log files generated by the CSV File HTTP Access Log Publisher. The path to the directory is relative to the server root.

        Returns:
        Returns the "log-directory" property definition.
      • getLogFieldBlacklistPropertyDefinition

        public StringPropertyDefinition getLogFieldBlacklistPropertyDefinition()
        Get the "log-field-blacklist" property definition.

        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 "log-field-blacklist" property definition.
      • getLogFieldWhitelistPropertyDefinition

        public StringPropertyDefinition getLogFieldWhitelistPropertyDefinition()
        Get the "log-field-whitelist" property definition.

        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 "log-field-whitelist" property definition.
      • getLogFileNamePrefixPropertyDefinition

        public StringPropertyDefinition getLogFileNamePrefixPropertyDefinition()
        Get the "log-file-name-prefix" property definition.

        File name prefix (without extension) for CSV and JSON file based access log publishers.

        Returns:
        Returns the "log-file-name-prefix" property definition.
      • getRetentionPolicyPropertyDefinition

        public AggregationPropertyDefinition<LogRetentionPolicyCfgClient,​LogRetentionPolicyCfg> getRetentionPolicyPropertyDefinition()
        Get the "retention-policy" property definition.

        The retention policy to use for the CSV File 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 "retention-policy" property definition.
      • getRotationPolicyPropertyDefinition

        public AggregationPropertyDefinition<LogRotationPolicyCfgClient,​LogRotationPolicyCfg> getRotationPolicyPropertyDefinition()
        Get the "rotation-policy" property definition.

        The rotation policy to use for the CSV File HTTP Access Log Publisher .

        When multiple policies are used, rotation will occur if any policy's conditions are met.

        Returns:
        Returns the "rotation-policy" property definition.
      • getSignatureTimeIntervalPropertyDefinition

        public DurationPropertyDefinition getSignatureTimeIntervalPropertyDefinition()
        Get the "signature-time-interval" property definition.

        Specifies the interval at which to sign the log file when secure option is enabled.

        Returns:
        Returns the "signature-time-interval" property definition.
      • getTamperEvidentPropertyDefinition

        public BooleanPropertyDefinition getTamperEvidentPropertyDefinition()
        Get the "tamper-evident" property definition.

        Specifies whether the log should be signed in order to detect tampering.

        Every log record will be signed, making it possible to verify that the log has not been tampered with. This feature has a significative impact on performance of the server.

        Returns:
        Returns the "tamper-evident" property definition.