<?xml version="1.0" encoding="utf-8"?>

<adm:managed-object name="file-based-debug-log-publisher"

plural-name="file-based-debug-log-publishers"

package="org.forgerock.opendj.server.config" extends="debug-log-publisher"

xmlns:adm="http://opendj.forgerock.org/admin"

xmlns:ldap="http://opendj.forgerock.org/admin-ldap">

<adm:synopsis>

<adm:user-friendly-plural-name />

publish debug messages to the file system.

</adm:synopsis>

<adm:profile name="ldap">

<ldap:object-class>

<ldap:name>ds-cfg-file-based-debug-log-publisher</ldap:name>

<ldap:superior>ds-cfg-debug-log-publisher</ldap:superior>

</ldap:object-class>

</adm:profile>

<adm:property-override name="java-class" advanced="true">

<adm:default-behavior>

<adm:defined>

<adm:value>

org.opends.server.loggers.debug.TextDebugLogPublisher

</adm:value>

</adm:defined>

</adm:default-behavior>

</adm:property-override>

<adm:property name="asynchronous" mandatory="true" advanced="true">

<adm:synopsis>

Indicates whether the

<adm:user-friendly-name />

will publish records asynchronously.

</adm:synopsis>

<adm:default-behavior>

<adm:defined>

<adm:value>false</adm:value>

</adm:defined>

</adm:default-behavior>

<adm:syntax>

<adm:boolean />

</adm:syntax>

<adm:profile name="ldap">

<ldap:attribute>

<ldap:name>ds-cfg-asynchronous</ldap:name>

</ldap:attribute>

</adm:profile>

</adm:property>

<adm:property name="queue-size" advanced="true">

<adm:synopsis>

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

asynchronous queue.

</adm:synopsis>

<adm:default-behavior>

<adm:defined>

<adm:value>5000</adm:value>

</adm:defined>

</adm:default-behavior>

<adm:syntax>

<adm:integer lower-limit="1" />

</adm:syntax>

<adm:profile name="ldap">

<ldap:attribute>

<ldap:name>ds-cfg-queue-size</ldap:name>

</ldap:attribute>

</adm:profile>

</adm:property>

<adm:property name="log-file" mandatory="true">

<adm:synopsis>

The file name to use for the log files generated by the

<adm:user-friendly-name />

.

</adm:synopsis>

<adm:description>

The path to the file is relative to the server root.

</adm:description>

<adm:requires-admin-action>

<adm:component-restart />

</adm:requires-admin-action>

<adm:syntax>

<adm:string />

</adm:syntax>

<adm:profile name="ldap">

<ldap:attribute>

<ldap:name>ds-cfg-log-file</ldap:name>

</ldap:attribute>

</adm:profile>

</adm:property>

<adm:property name="log-file-permissions" mandatory="true">

<adm:synopsis>

The UNIX permissions of the log files created by this

<adm:user-friendly-name />

.

</adm:synopsis>

<adm:default-behavior>

<adm:defined>

<adm:value>640</adm:value>

</adm:defined>

</adm:default-behavior>

<adm:syntax>

<adm:string>

<adm:pattern>

<adm:regex>^([0-7][0-7][0-7])$</adm:regex>

<adm:usage>MODE</adm:usage>

<adm:synopsis>

A valid UNIX mode string. The mode string must contain

three digits between zero and seven.

</adm:synopsis>

</adm:pattern>

</adm:string>

</adm:syntax>

<adm:profile name="ldap">

<ldap:attribute>

<ldap:name>ds-cfg-log-file-permissions</ldap:name>

</ldap:attribute>

</adm:profile>

</adm:property>

<adm:property name="time-interval" advanced="true">

<adm:synopsis>

Specifies the interval at which to check whether the log files

need to be rotated.

</adm:synopsis>

<adm:default-behavior>

<adm:defined>

<adm:value>5s</adm:value>

</adm:defined>

</adm:default-behavior>

<adm:syntax>

<adm:duration base-unit="ms" lower-limit="1" />

</adm:syntax>

<adm:profile name="ldap">

<ldap:attribute>

<ldap:name>ds-cfg-time-interval</ldap:name>

</ldap:attribute>

</adm:profile>

</adm:property>

<adm:property name="buffer-size" advanced="true">

<adm:synopsis>Specifies the log file buffer size.</adm:synopsis>

<adm:default-behavior>

<adm:defined>

<adm:value>64kb</adm:value>

</adm:defined>

</adm:default-behavior>

<adm:syntax>

<adm:size lower-limit="1" />

</adm:syntax>

<adm:profile name="ldap">

<ldap:attribute>

<ldap:name>ds-cfg-buffer-size</ldap:name>

</ldap:attribute>

</adm:profile>

</adm:property>

<adm:property name="auto-flush" advanced="true">

<adm:synopsis>

Specifies whether to flush the writer after every log record.

</adm:synopsis>

<adm:description>

If the asynchronous writes option is used, the writer is

flushed after all the log records in the queue are written.

</adm:description>

<adm:default-behavior>

<adm:defined>

<adm:value>true</adm:value>

</adm:defined>

</adm:default-behavior>

<adm:syntax>

<adm:boolean />

</adm:syntax>

<adm:profile name="ldap">

<ldap:attribute>

<ldap:name>ds-cfg-auto-flush</ldap:name>

</ldap:attribute>

</adm:profile>

</adm:property>

<adm:property name="append">

<adm:synopsis>

Specifies whether to append to existing log files.

</adm:synopsis>

<adm:default-behavior>

<adm:defined>

<adm:value>true</adm:value>

</adm:defined>

</adm:default-behavior>

<adm:syntax>

<adm:boolean />

</adm:syntax>

<adm:profile name="ldap">

<ldap:attribute>

<ldap:name>ds-cfg-append</ldap:name>

</ldap:attribute>

</adm:profile>

</adm:property>

<adm:property name="rotation-policy" multi-valued="true">

<adm:synopsis>

The rotation policy to use for the

<adm:user-friendly-name />

.

</adm:synopsis>

<adm:description>

When multiple policies are used, rotation will occur if any

policy's conditions are met.

</adm:description>

<adm:default-behavior>

<adm:alias>

<adm:synopsis>

No rotation policy is used and log rotation will not occur.

</adm:synopsis>

</adm:alias>

</adm:default-behavior>

<adm:syntax>

<adm:aggregation parent-path="/"

relation-name="log-rotation-policy" />

</adm:syntax>

<adm:profile name="ldap">

<ldap:attribute>

<ldap:name>ds-cfg-rotation-policy</ldap:name>

</ldap:attribute>

</adm:profile>

</adm:property>

<adm:property name="retention-policy" multi-valued="true">

<adm:synopsis>

The retention policy to use for the

<adm:user-friendly-name />

.

</adm:synopsis>

<adm:description>

When multiple policies are used, log files are cleaned when

any of the policy's conditions are met.

</adm:description>

<adm:default-behavior>

<adm:alias>

<adm:synopsis>

No retention policy is used and log files are never

cleaned.

</adm:synopsis>

</adm:alias>

</adm:default-behavior>

<adm:syntax>

<adm:aggregation parent-path="/"

relation-name="log-retention-policy" />

</adm:syntax>

<adm:profile name="ldap">

<ldap:attribute>

<ldap:name>ds-cfg-retention-policy</ldap:name>

</ldap:attribute>

</adm:profile>

</adm:property>

</adm:managed-object>