directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r1021797 - in /directory: apacheds-manuals/trunk/src/basic-user-guide/ apacheds/trunk/core/src/main/java/org/apache/directory/server/core/changelog/ apacheds/trunk/server-config/src/main/java/org/apache/directory/server/config/
Date Tue, 12 Oct 2010 15:22:52 GMT
Author: elecharny
Date: Tue Oct 12 15:22:51 2010
New Revision: 1021797

URL: http://svn.apache.org/viewvc?rev=1021797&view=rev
Log:
Updated the doco with the ChangeLog part
Fixed some typoes in code

Modified:
    directory/apacheds-manuals/trunk/src/basic-user-guide/chapter-configuring-apacheds.xml
    directory/apacheds/trunk/core/src/main/java/org/apache/directory/server/core/changelog/DefaultChangeLog.java
    directory/apacheds/trunk/server-config/src/main/java/org/apache/directory/server/config/ConfigPartitionReader.java

Modified: directory/apacheds-manuals/trunk/src/basic-user-guide/chapter-configuring-apacheds.xml
URL: http://svn.apache.org/viewvc/directory/apacheds-manuals/trunk/src/basic-user-guide/chapter-configuring-apacheds.xml?rev=1021797&r1=1021796&r2=1021797&view=diff
==============================================================================
--- directory/apacheds-manuals/trunk/src/basic-user-guide/chapter-configuring-apacheds.xml
(original)
+++ directory/apacheds-manuals/trunk/src/basic-user-guide/chapter-configuring-apacheds.xml
Tue Oct 12 15:22:51 2010
@@ -15,6 +15,7 @@
   xmlns:ns4="http://www.w3.org/1998/Math/MathML"
   xmlns:ns3="http://www.w3.org/1999/xhtml"
   xml:lang="en">
+  
   <title>Apache Directory Server Configuration</title>
   <section
     id="Introduction">
@@ -22,6 +23,7 @@
     <para>This section describes all the configuration options available for the Apache
Directory Server.
     It covers the Ldap server, but also the Kerberos server and all the other servers built
on top of
     a DirectorySevice</para>
+    
     <itemizedlist>
       <listitem>
         <para>
@@ -29,36 +31,42 @@
             linkend="DirectoryService configuration" />
         </para>
       </listitem>
+      
       <listitem>
         <para>
           <xref
             linkend="Transports configuration" />
         </para>
       </listitem>
+      
       <listitem>
         <para>
           <xref
             linkend="Ldap Server configuration" />
         </para>
       </listitem>
+      
       <listitem>
         <para>
           <xref
             linkend="Kerberos Server configuration" />
         </para>
       </listitem>
+      
       <listitem>
         <para>
           <xref
             linkend="Ntp Server configuration" />
         </para>
       </listitem>
+      
       <listitem>
         <para>
           <xref
             linkend="Dns Server configuration" />
         </para>
       </listitem>
+      
       <listitem>
         <para>
           <xref
@@ -66,14 +74,15 @@
         </para>
       </listitem>
     </itemizedlist>
-    <section
-      id="DirectoryService configuration">
+    
+    <section id="DirectoryService configuration" xreflabel="DirectoryService configuration">
       <title>DirectoryService configuration</title>
       <para>
         The <emphasis role="bold">DirectoryService</emphasis> component is the
base for every server
         requiring some data to be stored in a backend. It also defines the way the LdapServer
will
         process incoming requests. The following components are configurable :
       </para>
+      
       <itemizedlist>
         <listitem>
           <para>
@@ -81,24 +90,28 @@
               linkend="Interceptors configuration" />
           </para>
         </listitem>
+        
         <listitem>
           <para>
             <xref
               linkend="PasswordPolicy configuration" />
           </para>
         </listitem>
+        
         <listitem>
           <para>
             <xref
               linkend="Partitions configuration" />
           </para>
         </listitem>
+        
         <listitem>
           <para>
             <xref
               linkend="ChangeLog configuration" />
           </para>
         </listitem>
+        
         <listitem>
           <para>
             <xref
@@ -106,6 +119,7 @@
           </para>
         </listitem>
       </itemizedlist>
+      
       <para>All of those elements will be described in the following sections.</para>
       <para>Some parameters are directly associated with the <emphasis role="bold">DirectoryService</emphasis>
:</para>
       
@@ -367,8 +381,9 @@
         </itemizedlist>
       </section>
       
-      <section id="PasswordPolicy configuration">
+      <section id="PasswordPolicy configuration" xreflabel="PasswordPolicy configuration">
       </section>
+      
       <section id="Partitions configuration" xreflabel="Partitions configuration">
         <title>Partitions configuration</title>
         <para>The DirectoryService is associated with a set of Partitions, which have
to be configured.</para>
@@ -465,12 +480,37 @@
           </section>
         </section>
       </section>
-      <section id="ChangeLog configuration">
+      
+      <section id="ChangeLog configuration" xreflabel="ChangeLog configuration">
+        <title>ChangeLog configuration</title>
+        <para>The ChangeLog Interceptor is used to store all the modifications done
in teh DIT, in a way
+        we can revert them on demand, à la SVN. Each modification has a revision number,
and it's possible
+        to ask the server to move backward to a specific revision. Here is the possible configuration
for
+        this service.
+        </para>
+        
+        <simplesect>
+          <title>changeLogEnabled</title>
+          <para><emphasis role="bold">Name : </emphasis> <emphasis>ads-changeLogEnabled</emphasis></para>
+          <para><emphasis role="bold">Type : </emphasis> <emphasis>Boolean</emphasis></para>
+          <para><emphasis role="bold">Default value : </emphasis> <emphasis>false</emphasis></para>
+          <para><emphasis role="bold">Description : </emphasis> <emphasis>Tells
the server if the ChangeLog system is enabled.</emphasis></para>
+        </simplesect>
+        
+        <simplesect>
+          <title>changeLogExposed</title>
+          <para><emphasis role="bold">Name : </emphasis> <emphasis>ads-changeLogExposed</emphasis></para>
+          <para><emphasis role="bold">Type : </emphasis> <emphasis>Boolean</emphasis></para>
+          <para><emphasis role="bold">Default value : </emphasis> <emphasis>false</emphasis></para>
+          <para><emphasis role="bold">Description : </emphasis> <emphasis>Tells
the server if the changeLog data are visible.</emphasis></para>
+        </simplesect>
       </section>
-      <section id="Journal configuration">
+      
+      <section id="Journal configuration" xreflabel="Journal configuration">
         <title>Journal configuration</title>
         <para>The Journal is used to store every modification done on the server, in
order to be
         able to restore the server if it crashes. The list of parameters that can be configured
is given below</para>
+        
         <simplesect>
           <title>journalFileName</title>
           <para><emphasis role="bold">Name : </emphasis> <emphasis>ads-journalFileName</emphasis></para>
@@ -478,6 +518,7 @@
           <para><emphasis role="bold">Default value : </emphasis> <emphasis>journal.ldif</emphasis></para>
           <para><emphasis role="bold">Description : </emphasis> <emphasis>The
name of the file contaning the journal.</emphasis></para>
         </simplesect>
+
         <simplesect>
           <title>journalWorkingDir</title>
           <para><emphasis role="bold">Name : </emphasis> <emphasis>ads-journalWorkingDir</emphasis></para>

Modified: directory/apacheds/trunk/core/src/main/java/org/apache/directory/server/core/changelog/DefaultChangeLog.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/core/src/main/java/org/apache/directory/server/core/changelog/DefaultChangeLog.java?rev=1021797&r1=1021796&r2=1021797&view=diff
==============================================================================
--- directory/apacheds/trunk/core/src/main/java/org/apache/directory/server/core/changelog/DefaultChangeLog.java
(original)
+++ directory/apacheds/trunk/core/src/main/java/org/apache/directory/server/core/changelog/DefaultChangeLog.java
Tue Oct 12 15:22:51 2010
@@ -67,7 +67,7 @@ public class DefaultChangeLog implements
     /** A volatile flag used to avoid store switching when in use */
     private volatile boolean storeInitialized = false;
 
-    /** A flag used to tell if the changeLog system is vivible by the clients */
+    /** A flag used to tell if the changeLog system is visible by the clients */
     private boolean exposed;
 
     // default values for ChangeLogStorePartition containers

Modified: directory/apacheds/trunk/server-config/src/main/java/org/apache/directory/server/config/ConfigPartitionReader.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/server-config/src/main/java/org/apache/directory/server/config/ConfigPartitionReader.java?rev=1021797&r1=1021796&r2=1021797&view=diff
==============================================================================
--- directory/apacheds/trunk/server-config/src/main/java/org/apache/directory/server/config/ConfigPartitionReader.java
(original)
+++ directory/apacheds/trunk/server-config/src/main/java/org/apache/directory/server/config/ConfigPartitionReader.java
Tue Oct 12 15:22:51 2010
@@ -1834,7 +1834,7 @@ public class ConfigPartitionReader
     /**
      * Read the ChangeLog configuration
      * 
-     * @param changelogDN The DN in teh DIT for the ChangeLog configuration
+     * @param changelogDN The DN in the DIT for the ChangeLog configuration
      * @return The instanciated bean containing the ChangeLog configuration
      * @throws Exception If the configuration can't be read
      */



Mime
View raw message