6230N/A<?
xml version="1.0" encoding="utf-8"?>
6230N/A ! The contents of this file are subject to the terms of the 6230N/A ! Common Development and Distribution License, Version 1.0 only 6230N/A ! (the "License"). You may not use this file except in compliance 6230N/A ! You can obtain a copy of the license at 6230N/A ! See the License for the specific language governing permissions 6230N/A ! and limitations under the License. 6230N/A ! When distributing Covered Code, include this CDDL HEADER in each 6230N/A ! file and include the License file at 6230N/A ! add the following below this CDDL HEADER, with the fields enclosed 6230N/A ! by brackets "[]" replaced with your own identifying information: 6230N/A ! Portions Copyright [yyyy] [name of copyright owner] 6230N/A ! Copyright 2013 ForgeRock AS 6230N/A<
adm:
managed-
object name="file-based-http-access-log-publisher" 6230N/A plural-
name="file-based-http-access-log-publishers" 6230N/A <
adm:
user-
friendly-
plural-
name />
6230N/A publish HTTP access messages to the file system.
6230N/A <
ldap:
name>ds-cfg-file-based-http-access-log-publisher</
ldap:
name>
6230N/A <
ldap:
superior>ds-cfg-http-access-log-publisher</
ldap:
superior>
6230N/A <
adm:
property-
override name="java-class" advanced="true">
6230N/A <
adm:
property name="asynchronous" mandatory="true" advanced="true">
6230N/A will publish records asynchronously.
6230N/A <
adm:
value>true</
adm:
value>
6230N/A <
ldap:
name>ds-cfg-asynchronous</
ldap:
name>
6230N/A <
adm:
property name="queue-size" advanced="true">
6230N/A The maximum number of log records that can be stored in the
6230N/A Setting the queue size to zero activates parallel log writer
6230N/A implementation which has no queue size limit and as such the
6230N/A parallel log writer should only be used on a very well tuned
6230N/A server configuration to avoid potential out of memory errors.
6230N/A <
adm:
requires-
admin-
action>
6230N/A The <
adm:
user-
friendly-
name /> must be restarted if this property
6230N/A is changed and the asynchronous property is set to true.
6230N/A </
adm:
requires-
admin-
action>
6230N/A <
adm:
value>5000</
adm:
value>
6230N/A <
adm:
integer lower-
limit="0" />
6230N/A <
ldap:
name>ds-cfg-queue-size</
ldap:
name>
6230N/A <
adm:
property name="log-file" mandatory="true">
6230N/A The file name to use for the log files generated by the
6230N/A <
adm:
user-
friendly-
name />.
6230N/A The path to the file is relative to the server root.
6230N/A <
adm:
requires-
admin-
action>
6230N/A </
adm:
requires-
admin-
action>
6230N/A <
adm:
usage>FILE</
adm:
usage>
6230N/A A path to an existing file that is readable by the server.
6230N/A <
ldap:
name>ds-cfg-log-file</
ldap:
name>
6230N/A <
adm:
property name="log-file-permissions" mandatory="true">
6230N/A The UNIX permissions of the log files created by this
6230N/A <
adm:
user-
friendly-
name />.
6230N/A <
adm:
regex>^([0-7][0-7][0-7])$</
adm:
regex>
6230N/A <
adm:
usage>MODE</
adm:
usage>
6230N/A A valid UNIX mode string. The mode string must contain
6230N/A three digits between zero and seven.
6230N/A <
ldap:
name>ds-cfg-log-file-permissions</
ldap:
name>
6230N/A <
adm:
property name="time-interval" advanced="true">
6230N/A Specifies the interval at which to check whether the log files
6230N/A <
adm:
duration base-
unit="ms" lower-
limit="1" />
6230N/A <
ldap:
name>ds-cfg-time-interval</
ldap:
name>
6230N/A <
adm:
property name="buffer-size" advanced="true">
6230N/A <
adm:
synopsis>Specifies the log file buffer size.</
adm:
synopsis>
6230N/A <
adm:
value>64kb</
adm:
value>
6230N/A <
adm:
size lower-
limit="1" />
6230N/A <
ldap:
name>ds-cfg-buffer-size</
ldap:
name>
6230N/A <
adm:
property name="auto-flush" advanced="true">
6230N/A Specifies whether to flush the writer after every log record.
6230N/A If the asynchronous writes option is used, the writer is
6230N/A flushed after all the log records in the queue are written.
6230N/A <
adm:
value>true</
adm:
value>
6230N/A <
ldap:
name>ds-cfg-auto-flush</
ldap:
name>
6230N/A <
adm:
property name="append">
6230N/A Specifies whether to append to existing log files.
6230N/A <
adm:
value>true</
adm:
value>
6230N/A <
ldap:
name>ds-cfg-append</
ldap:
name>
6230N/A <
adm:
property name="rotation-policy" multi-
valued="true">
6230N/A The rotation policy to use for the
6230N/A When multiple policies are used, rotation will occur if any
6230N/A policy's conditions are met.
6230N/A No rotation policy is used and log rotation will not occur.
6230N/A <
adm:
aggregation parent-
path="/" 6230N/A relation-
name="log-rotation-policy" />
6230N/A <
ldap:
name>ds-cfg-rotation-policy</
ldap:
name>
6230N/A <
adm:
property name="retention-policy" multi-
valued="true">
6230N/A The retention policy to use for the
6230N/A When multiple policies are used, log files are cleaned when
6230N/A any of the policy's conditions are met.
6230N/A No retention policy is used and log files are never cleaned.
6230N/A <
adm:
aggregation parent-
path="/" 6230N/A relation-
name="log-retention-policy" />
6230N/A <
ldap:
name>ds-cfg-retention-policy</
ldap:
name>
6242N/A <
adm:
property name="log-format">
6242N/A Specifies how log records should be formatted and written to the HTTP
6261N/A <
adm:
value>cs-host c-ip cs-username x-datetime cs-method cs-uri-query
6261N/A cs-version sc-status cs(User-Agent) x-connection-id x-etime</
adm:
value>
6242N/A <
adm:
regex>[a-zA-Z0-9-()]+( [a-zA-Z0-9-()]+)*</
adm:
regex>
6242N/A <
adm:
usage>FORMAT</
adm:
usage>
6261N/A A space separated list of fields describing the extended log format
6261N/A to be used for logging HTTP accesses. Available values are listed on
6261N/A OpenDJ supports the following standard fields: "c-ip", "c-port",
6261N/A "cs-host", "cs-method", "cs-uri-query", "cs(User-Agent)",
6261N/A "cs-username", "cs-version", "s-computername", "s-ip", "s-port",
6261N/A OpenDJ supports the following application specific field extensions:
6261N/A "x-connection-id" displays the internal connection ID assigned to
6261N/A the HTTP client connection, "x-datetime" displays the completion
6261N/A date and time for the logged HTTP request and its ouput is
6261N/A controlled by the "ds-cfg-log-record-time-format" property,
6261N/A "x-etime" displays the total execution time for the logged HTTP
6242N/A <
ldap:
name>ds-cfg-log-format</
ldap:
name>
6230N/A <
adm:
property name="log-record-time-format">
6230N/A Specifies the format string that is used to generate log record
6230N/A <
adm:
usage>STRING</
adm:
usage>
6230N/A Any valid format string that can be used with the
6230N/A <
ldap:
name>ds-cfg-log-record-time-format</
ldap:
name>