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

Interface FileBasedAccessLogPublisherCfg

    • Method Detail

      • addFileBasedAccessChangeListener

        void addFileBasedAccessChangeListener​(ConfigurationChangeListener<FileBasedAccessLogPublisherCfg> listener)
        Register to be notified when this File Based Access Log Publisher is changed.
        Parameters:
        listener - The File Based Access Log Publisher configuration change listener.

      • removeFileBasedAccessChangeListener

        void removeFileBasedAccessChangeListener​(ConfigurationChangeListener<FileBasedAccessLogPublisherCfg> listener)
        Deregister an existing File Based Access Log Publisher configuration change listener.
        Parameters:
        listener - The File Based Access Log Publisher configuration change listener.

      • isAppend

        boolean isAppend()
        Gets the "append" property.

        Specifies whether to append to existing log files.

        Default value: true

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

      • isAsynchronous

        boolean isAsynchronous()
        Gets the "asynchronous" property.

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

        Default value: true

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

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

        Default value: true

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

      • getBufferSize

        long getBufferSize()
        Gets the "buffer-size" property.

        Specifies the log file buffer size.

        Default value: 64kb

        Returns:
        Returns the value of the "buffer-size" property.

      • getJavaClass

        String getJavaClass()
        Gets the "java-class" property.

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

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

        Specified by:
        getJavaClass in interface AccessLogPublisherCfg
        Specified by:
        getJavaClass in interface LogPublisherCfg
        Returns:
        Returns the value of the "java-class" property.

      • isLogControlOids

        boolean isLogControlOids()
        Gets the "log-control-oids" property.

        Specifies whether control OIDs will be included in operation log records.

        Default value: false

        Returns:
        Returns the value of the "log-control-oids" property.

      • getLogFile

        String getLogFile()
        Gets the "log-file" property.

        The file name to use for the log files generated by the File Based Access Log Publisher. The path to the file is relative to the server root.

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

      • getLogFilePermissions

        String getLogFilePermissions()
        Gets the "log-file-permissions" property.

        The UNIX permissions of the log files created by this File Based Access Log Publisher.

        Default value: 640

        Returns:
        Returns the value of the "log-file-permissions" property.

      • getLogFormat

        FileBasedAccessLogPublisherCfgDefn.LogFormat getLogFormat()
        Gets the "log-format" property.

        Specifies how log records should be formatted and written to the access log.

        Default value: multi-line

        Returns:
        Returns the value of the "log-format" property.

      • getLogRecordTimeFormat

        String getLogRecordTimeFormat()
        Gets the "log-record-time-format" property.

        Specifies the format string that is used to generate log record timestamps.

        Default value: dd/MMM/yyyy:HH:mm:ss Z

        Returns:
        Returns the value of the "log-record-time-format" property.

      • getQueueSize

        int getQueueSize()
        Gets the "queue-size" property.

        The maximum number of log records that can be stored in the asynchronous queue.

        Default value: 5000

        Returns:
        Returns the value of the "queue-size" property.

      • getRetentionPolicy

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

        The retention policy to use for the File Based Access Log Publisher .

        When multiple policies are used, log files are cleaned when any of the policy's conditions are met.

        Returns:
        Returns an unmodifiable set containing the values of the "retention-policy" property.

      • getRetentionPolicyDns

        SortedSet<Dn> getRetentionPolicyDns()
        Gets the "retention-policy" property as a set of DNs.

        The retention policy to use for the File Based Access Log Publisher .

        When multiple policies are used, log files are cleaned when any of the policy's conditions are met.

        Returns:
        Returns the DN values of the "retention-policy" property.

      • getRotationPolicy

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

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

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

        Returns:
        Returns an unmodifiable set containing the values of the "rotation-policy" property.

      • getRotationPolicyDns

        SortedSet<Dn> getRotationPolicyDns()
        Gets the "rotation-policy" property as a set of DNs.

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

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

        Returns:
        Returns the DN values of the "rotation-policy" property.

      • getTimeInterval

        long getTimeInterval()
        Gets the "time-interval" property.

        Specifies the interval at which to check whether the log files need to be rotated.

        Default value: 5s

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