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

Interface CsvFileAccessLogPublisherCfgClient

    • Method Detail

      • isAsynchronous

        @MandatoryProperty
ValueOrExpression<Boolean> isAsynchronous()
        Gets the "asynchronous" property.

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

        Default value: true

        Returns:
        Returns the value of the "asynchronous" property.

      • isAutoFlush

        ValueOrExpression<Boolean> isAutoFlush()
        Gets the "auto-flush" property.

        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.

        Default value: true

        Returns:
        Returns the value of the "auto-flush" property.

      • setAutoFlush

        void setAutoFlush​(ValueOrExpression<Boolean> value)
           throws PropertyException
        Sets the "auto-flush" property.

        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.

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

      • getCsvDelimiterChar

        ValueOrExpression<String> getCsvDelimiterChar()
        Gets the "csv-delimiter-char" property.

        The delimiter character to use when writing in CSV format.

        Default value: ,

        Returns:
        Returns the value of the "csv-delimiter-char" property.

      • setCsvDelimiterChar

        void setCsvDelimiterChar​(ValueOrExpression<String> value)
                  throws PropertyException
        Sets the "csv-delimiter-char" property.

        The delimiter character to use when writing in CSV format.

        Parameters:
        value - The value of the "csv-delimiter-char" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getCsvEolSymbols

        ValueOrExpression<String> getCsvEolSymbols()
        Gets the "csv-eol-symbols" property.

        The string that marks the end of a line.

        Returns:
        Returns the value of the "csv-eol-symbols" property.

      • setCsvEolSymbols

        void setCsvEolSymbols​(ValueOrExpression<String> value)
               throws PropertyException
        Sets the "csv-eol-symbols" property.

        The string that marks the end of a line.

        Parameters:
        value - The value of the "csv-eol-symbols" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getCsvQuoteChar

        ValueOrExpression<String> getCsvQuoteChar()
        Gets the "csv-quote-char" property.

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

        Default value: \"

        Returns:
        Returns the value of the "csv-quote-char" property.

      • setCsvQuoteChar

        void setCsvQuoteChar​(ValueOrExpression<String> value)
              throws PropertyException
        Sets the "csv-quote-char" property.

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

        Parameters:
        value - The value of the "csv-quote-char" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getKeyStoreFile

        ValueOrExpression<String> getKeyStoreFile()
        Gets the "key-store-file" property.

        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.

        Default value is undefined

        Returns:
        Returns the value of the "key-store-file" property.

      • setKeyStoreFile

        void setKeyStoreFile​(ValueOrExpression<String> value)
              throws PropertyException
        Sets the "key-store-file" property.

        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.

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

      • getKeyStorePin

        ValueOrExpression<String> getKeyStorePin()
        Gets the "key-store-pin" property.

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

        Default value is undefined

        Returns:
        Returns the value of the "key-store-pin" property.

      • setKeyStorePin

        void setKeyStorePin​(ValueOrExpression<String> value)
             throws PropertyException
        Sets the "key-store-pin" property.

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

        Parameters:
        value - The value of the "key-store-pin" 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 CSV File 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 CSV File 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.

      • getRetentionPolicy

        SortedSet<ValueOrExpression<String>> getRetentionPolicy()
        Gets the "retention-policy" property.

        The retention policy to use for the CSV File 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 CSV File 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 CSV File 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 CSV File 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.

      • getSignatureTimeInterval

        ValueOrExpression<Long> getSignatureTimeInterval()
        Gets the "signature-time-interval" property.

        Specifies the interval at which to sign the log file when the tamper-evident option is enabled.

        Default value: 3s

        Returns:
        Returns the value of the "signature-time-interval" property.

      • setSignatureTimeInterval

        void setSignatureTimeInterval​(ValueOrExpression<Long> value)
                       throws PropertyException
        Sets the "signature-time-interval" property.

        Specifies the interval at which to sign the log file when the tamper-evident option is enabled.

        Parameters:
        value - The value of the "signature-time-interval" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isTamperEvident

        ValueOrExpression<Boolean> isTamperEvident()
        Gets the "tamper-evident" property.

        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 significant impact on performance of the server.

        Default value: false

        Returns:
        Returns the value of the "tamper-evident" property.

      • setTamperEvident

        void setTamperEvident​(ValueOrExpression<Boolean> value)
               throws PropertyException
        Sets the "tamper-evident" property.

        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 significant impact on performance of the server.

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