Advanced properties phase 1: tag advanced properties and perform various cl...

matthew_swift

16.47.2007 e958eb5bcfc9feccbda7c0841b05939506143ad8

 opends/src/admin/defn/org/opends/server/admin/std/FileBasedAccessLogPublisherConfiguration.xml

@@ -1,50 +1,46 @@
<?xml version="1.0" encoding="utf-8"?>
<!--
! CDDL HEADER START
!
! The contents of this file are subject to the terms of the
! Common Development and Distribution License, Version 1.0 only
! (the "License").  You may not use this file except in compliance
! with the License.
!
! You can obtain a copy of the license at
! trunk/opends/resource/legal-notices/OpenDS.LICENSE
! or https://OpenDS.dev.java.net/OpenDS.LICENSE.
! See the License for the specific language governing permissions
! and limitations under the License.
!
! When distributing Covered Code, include this CDDL HEADER in each
! file and include the License file at
! trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
! add the following below this CDDL HEADER, with the fields enclosed
! by brackets "[]" replaced with your own identifying information:
!      Portions Copyright [yyyy] [name of copyright owner]
!
! CDDL HEADER END
!
!
!      Portions Copyright 2007 Sun Microsystems, Inc.
! -->

  ! CDDL HEADER START
  !
  ! The contents of this file are subject to the terms of the
  ! Common Development and Distribution License, Version 1.0 only
  ! (the "License").  You may not use this file except in compliance
  ! with the License.
  !
  ! You can obtain a copy of the license at
  ! trunk/opends/resource/legal-notices/OpenDS.LICENSE
  ! or https://OpenDS.dev.java.net/OpenDS.LICENSE.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! When distributing Covered Code, include this CDDL HEADER in each
  ! file and include the License file at
  ! trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
  ! add the following below this CDDL HEADER, with the fields enclosed
  ! by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CDDL HEADER END
  !
  !
  !      Portions Copyright 2007 Sun Microsystems, Inc.
  ! -->
<adm:managed-object name="file-based-access-log-publisher"
  plural-name="file-based-access-log-publishers"
  package="org.opends.server.admin.std" extends="access-log-publisher"
  xmlns:adm="http://www.opends.org/admin"
  xmlns:ldap="http://www.opends.org/admin-ldap">

  <adm:synopsis>
    <adm:user-friendly-plural-name />
    publish access messages to the file system.
  </adm:synopsis>

  <adm:profile name="ldap">
    <ldap:object-class>
      <ldap:name>ds-cfg-file-based-access-log-publisher</ldap:name>
      <ldap:superior>ds-cfg-access-log-publisher</ldap:superior>
    </ldap:object-class>
  </adm:profile>

  <adm:property-override name="java-class">
  <adm:property-override name="java-class" advanced="true">
    <adm:default-behavior>
      <adm:defined>
        <adm:value>
@@ -53,13 +49,17 @@
      </adm:defined>
    </adm:default-behavior>
  </adm:property-override>

  <adm:property name="asynchronous" mandatory="true">
  <adm:property name="asynchronous" mandatory="true" advanced="true">
    <adm:synopsis>
      Indicate whether the
      <adm:user-friendly-name />
      will publish records asynchronously.
    </adm:synopsis>
    <adm:default-behavior>
      <adm:defined>
        <adm:value>true</adm:value>
      </adm:defined>
    </adm:default-behavior>
    <adm:syntax>
      <adm:boolean />
    </adm:syntax>
@@ -69,17 +69,14 @@
      </ldap:attribute>
    </adm:profile>
  </adm:property>

  <adm:property name="queue-size">
  <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:value>5000</adm:value>
      </adm:defined>
    </adm:default-behavior>
    <adm:syntax>
@@ -91,12 +88,11 @@
      </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 />. The path to the file is relative to the server
      root.
      <adm:user-friendly-name />
      . The path to the file is relative to the server root.
    </adm:synopsis>
    <adm:requires-admin-action>
      <adm:component-restart />
@@ -110,22 +106,25 @@
      </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: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:regex>^([0-7][0-7][0-7])$</adm:regex>
          <adm:usage>MODE</adm:usage>
          <adm:synopsis>
            An valid UNIX mode string. The mode string must contain three
            digits between zero and seven.
            An valid UNIX mode string. The mode string must contain
            three digits between zero and seven.
          </adm:synopsis>
        </adm:pattern>
      </adm:string>
@@ -136,21 +135,18 @@
      </ldap:attribute>
    </adm:profile>
  </adm:property>

  <adm:property name="time-interval">
  <adm:property name="time-interval" advanced="true">
    <adm:synopsis>
      This property specifies the interval to check whether
      the log files need to be rotated.
      Specifies the interval to check whether the log files need to be
      rotated.
    </adm:synopsis>
    <adm:default-behavior>
      <adm:defined>
        <adm:value>
          5s
        </adm:value>
        <adm:value>5s</adm:value>
      </adm:defined>
    </adm:default-behavior>
    <adm:syntax>
      <adm:duration base-unit="ms" lower-limit="1"/>
      <adm:duration base-unit="ms" lower-limit="1" />
    </adm:syntax>
    <adm:profile name="ldap">
      <ldap:attribute>
@@ -158,16 +154,11 @@
      </ldap:attribute>
    </adm:profile>
  </adm:property>

  <adm:property name="buffer-size">
    <adm:synopsis>
      This property specifies the log file buffer size.
    </adm:synopsis>
  <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:value>64kb</adm:value>
      </adm:defined>
    </adm:default-behavior>
    <adm:syntax>
@@ -179,18 +170,17 @@
      </ldap:attribute>
    </adm:profile>
  </adm:property>

  <adm:property name="auto-flush">
  <adm:property name="auto-flush" advanced="true">
    <adm:synopsis>
      This property specifies whether to flush the writer after every log
      record. If the asynchronous writes option is used, the writer will
      be flushed after all the log records in the queue are written.
      Specifies whether to flush the writer after every log record.
    </adm:synopsis>
    <adm:description>
      If the asynchronous writes option is used, the writer will be
      flushed after all the log records in the queue are written.
    </adm:description>
    <adm:default-behavior>
      <adm:defined>
        <adm:value>
          true
        </adm:value>
        <adm:value>true</adm:value>
      </adm:defined>
    </adm:default-behavior>
    <adm:syntax>
@@ -202,16 +192,13 @@
      </ldap:attribute>
    </adm:profile>
  </adm:property>

  <adm:property name="append">
    <adm:synopsis>
      This property specifies whether to append to existing log files.
      Specifies whether to append to existing log files.
    </adm:synopsis>
    <adm:default-behavior>
      <adm:defined>
        <adm:value>
          true
        </adm:value>
        <adm:value>true</adm:value>
      </adm:defined>
    </adm:default-behavior>
    <adm:syntax>
@@ -223,13 +210,16 @@
      </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 />. When
      multiple policies are used, rotation will occur if any policy's conditions
      are met.
      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>
@@ -247,17 +237,21 @@
      </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 />. When
      multiple policies are used, log files will be cleaned when any of the
      policy's conditions are met
      The retention policy to use for the
      <adm:user-friendly-name />
      .
    </adm:synopsis>
    <adm:description>
      When multiple policies are used, log files will be 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 will never be cleaned.
          No retention policy is used and log files will never be
          cleaned.
        </adm:synopsis>
      </adm:alias>
    </adm:default-behavior>