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

Interface CsvFileHTTPAccessLogPublisherCfgClient

    • Method Detail

      • isAsynchronous

        boolean isAsynchronous()
        Gets the "asynchronous" property.

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

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

      • setAsynchronous

        void setAsynchronous​(boolean value)
              throws PropertyException
        Sets the "asynchronous" property.

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

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

      • isAutoFlush

        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.

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

      • setAutoFlush

        void setAutoFlush​(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

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

        The delimiter character to use when writing in CSV format.

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

      • setCsvDelimiterChar

        void setCsvDelimiterChar​(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

        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​(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

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

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

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

      • setCsvQuoteChar

        void setCsvQuoteChar​(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

        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.

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

      • setKeyStoreFile

        void setKeyStoreFile​(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.

      • getKeyStorePinFile

        String getKeyStorePinFile()
        Gets the "key-store-pin-file" property.

        Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the Csv File HTTP Access Log Publisher .

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

      • setKeyStorePinFile

        void setKeyStorePinFile​(String value)
                 throws PropertyException
        Sets the "key-store-pin-file" property.

        Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the Csv File HTTP Access Log Publisher .

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

      • getLogDirectory

        String getLogDirectory()
        Gets the "log-directory" property.

        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 value of the "log-directory" property.

      • setLogDirectory

        void setLogDirectory​(String value)
              throws PropertyException
        Sets the "log-directory" property.

        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.

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

      • getRetentionPolicy

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

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

      • setRetentionPolicy

        void setRetentionPolicy​(Collection<String> values)
                 throws PropertyException
        Sets the "retention-policy" property.

        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.

        Parameters:
        values - The values of the "retention-policy" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getRotationPolicy

        SortedSet<String> getRotationPolicy()
        Gets the "rotation-policy" property.

        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 values of the "rotation-policy" property.

      • setRotationPolicy

        void setRotationPolicy​(Collection<String> values)
                throws PropertyException
        Sets the "rotation-policy" property.

        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.

        Parameters:
        values - The values of the "rotation-policy" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getSignatureTimeInterval

        long getSignatureTimeInterval()
        Gets the "signature-time-interval" property.

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

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

      • setSignatureTimeInterval

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

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

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

      • isTamperEvident

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

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

      • setTamperEvident

        void setTamperEvident​(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 significative impact on performance of the server.

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