svn commit: r837631 - in /websites/staging/directory/trunk/content: ./ apacheds/advanced-ug/2-server-config.html apacheds/advanced-users-guide.html

[bu...@apache.org]

Author: buildbot
Date: Thu Nov  8 09:15:02 2012
New Revision: 837631

Log:
Staging update by buildbot for directory

Modified:
    websites/staging/directory/trunk/content/   (props changed)
    websites/staging/directory/trunk/content/apacheds/advanced-ug/2-server-config.html
    websites/staging/directory/trunk/content/apacheds/advanced-users-guide.html

Propchange: websites/staging/directory/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Nov  8 09:15:02 2012
@@ -1 +1 @@
-1406038
+1406975

Modified: websites/staging/directory/trunk/content/apacheds/advanced-ug/2-server-config.html
==============================================================================
--- websites/staging/directory/trunk/content/apacheds/advanced-ug/2-server-config.html (original)
+++ websites/staging/directory/trunk/content/apacheds/advanced-ug/2-server-config.html Thu Nov  8 09:15:02 2012
@@ -138,23 +138,7 @@
 </ul>
 </li>
 <li>
-<p>DirectryServiceBean -&gt; AdsBean</p>
-<ul>
-<li><em>String</em> directoryServiceId</li>
-<li><em>int</em> dsReplicaId</li>
-<li><em>boolean</em> dsAccessControlEnabled</li>
-<li><em>boolean</em> dsAllowAnonymousAccess</li>
-<li><em>boolean</em> dsDenormalizeOpAttrsEnabled</li>
-<li><em>int</em> dsMaxPDUSize</li>
-<li><em>boolean</em> dsPasswordHidden</li>
-<li><em>long</em> dsSyncPeriodMillis</li>
-<li><em>String</em> dsTestEntries</li>
-<li><em>ChangeLogBean</em></li>
-<li><em>JournalBean</em></li>
-<li><em>List<ServerBean></em></li>
-<li><em>List<InterceptorBean></em></li>
-<li><em>List<PartitionBean></em></li>
-</ul>
+<p><a href="#directory-service">DirectoryServiceBean</a> -&gt; AdsBean</p>
 </li>
 <li>
 <p>ChangeLogBean -&gt; AdsBean</p>
@@ -173,22 +157,10 @@
 </ul>
 </li>
 <li>
-<p>ServerBean -&gt; AdsBean</p>
-<ul>
-<li><em>String</em> serverId</li>
-<li><em>List<TransportBean></em></li>
-</ul>
+<p><a href="#servers">ServerBean</a> -&gt; AdsBean</p>
 </li>
 <li>
-<p>TransportBean -&gt; AdsBean</p>
-<ul>
-<li><em>String</em> transportId</li>
-<li><em>String</em> transportAddress</li>
-<li><em>int</em> systemPort</li>
-<li><em>boolean</em> transportEnableSsl</li>
-<li><em>int</em> transportNbThreads</li>
-<li><em>int</em> transportBackLog</li>
-</ul>
+<p><a href="#servers">TransportBean</a> -&gt; AdsBean</p>
 </li>
 <li>
 <p>TcpTransportBean -&gt; AdsBean</p>
@@ -259,20 +231,6 @@
 </li>
 <li>
 <p><a href="#ldap-server">LdapServerBean</a> -&gt; DSBasedServerBean</p>
-<ul>
-<li><em>boolean</em> confidentialityRequired</li>
-<li><em>int</em> maxSizeLimit</li>
-<li><em>int</em> maxTimeLimit</li>
-<li><em>int</em> saslHost</li>
-<li><em>String</em> saslPrincipal</li>
-<li><em>List<String></em> saslRealms</li>
-<li><em>String</em> keystoreFile</li>
-<li><em>String</em> certificatePassword</li>
-<li><em>String</em> replReqHandler</li>
-<li><em>List<ReplConsumerBean></em></li>
-<li><em>List<SaslMechHandlerBean></em></li>
-<li><em>List<ExtendedOpHandlerBean></em></li>
-</ul>
 </li>
 <li>
 <p>ReplConsumerBean -&gt; AdsBaseBean</p>
@@ -409,6 +367,120 @@
 </li>
 </ul>
 <p>We will now explain each one of those elements.</p>
+<h3 id="directory-service">Directory Service</h3>
+<p>This is the key of the whole server : the place where we store the data. Most of the servers are depending on this component. You maye have more than one server, but only one <em>DirectoryService</em>. This compoent itself refers to the servers that will be started, plus the backends it will depends on.</p>
+<p>Here are the configuration parameters for this components :</p>
+<table>
+<thead>
+<tr>
+<th>Parameter</th>
+<th>AttributeType</th>
+<th>type</th>
+<th>default value</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>directoryServiceId</td>
+<td>ads-directoryServiceId</td>
+<td><em>String</em></td>
+<td></td>
+<td>The unique identifier for the service</td>
+</tr>
+<tr>
+<td>dsReplicaId</td>
+<td>ads-dsReplicaId</td>
+<td><em>int</em></td>
+<td></td>
+<td>The replication identifier</td>
+</tr>
+<tr>
+<td>dsAccessControlEnabled</td>
+<td>ads-dsAccessControlEnabled</td>
+<td><em>boolean</em></td>
+<td>true</td>
+<td>Tells if the Access Control interceptor is active</td>
+</tr>
+<tr>
+<td>dsAllowAnonymousAccess</td>
+<td>ads-dsAllowAnonymousAccess</td>
+<td><em>boolean</em></td>
+<td>false</td>
+<td>Tells if the service allow anonymous access</td>
+</tr>
+<tr>
+<td>dsDenormalizeOpAttrsEnabled</td>
+<td>ads-dsDenormalizeOpAttrsEnabled</td>
+<td><em>boolean</em></td>
+<td>true</td>
+<td>Tells if the service should denormalize operatonal attributes</td>
+</tr>
+<tr>
+<td>dsMaxPDUSize</td>
+<td>ads-dsMaxPDUSize</td>
+<td><em>int</em></td>
+<td>2048</td>
+<td>The maximum size of an incomming PDU (not used)</td>
+</tr>
+<tr>
+<td>dsPasswordHidden</td>
+<td>ads-dsPasswordHidden</td>
+<td><em>boolean</em></td>
+<td>true</td>
+<td>Tells if the passwords should be encrypted (not used)</td>
+</tr>
+<tr>
+<td>dsSyncPeriodMillis</td>
+<td>ads-dsSyncPeriodMillis</td>
+<td><em>long</em></td>
+<td>15000</td>
+<td>The delai in milliseconds before we flush data on disk</td>
+</tr>
+<tr>
+<td>dsTestEntries</td>
+<td></td>
+<td><em>String</em></td>
+<td></td>
+<td>Not used</td>
+</tr>
+<tr>
+<td>changeLog</td>
+<td></td>
+<td><em>ChangeLogBean</em></td>
+<td>N/A</td>
+<td>The interceptor that stores the reverted modifications</td>
+</tr>
+<tr>
+<td>journal</td>
+<td></td>
+<td><em>JournalBean</em></td>
+<td>N/A</td>
+<td>The interceptor that record every modifcation</td>
+</tr>
+<tr>
+<td>servers</td>
+<td>ads-servers</td>
+<td><em>List<ServerBean></em></td>
+<td>N/A</td>
+<td>The list of started servers</td>
+</tr>
+<tr>
+<td>interceptors</td>
+<td>ads-interceptors</td>
+<td><em>List<InterceptorBean></em></td>
+<td>N/A</td>
+<td>The list of interceptors</td>
+</tr>
+<tr>
+<td>partitions</td>
+<td>ads-partitions</td>
+<td><em>List<PartitionBean></em></td>
+<td>N/A</td>
+<td>The list of existing partitions</td>
+</tr>
+</tbody>
+</table>
 <h3 id="servers">Servers</h3>
 <p>As we can see, we can start more than one server. We have :</p>
 <ul>
@@ -421,7 +493,7 @@
 <li>a DNS server</li>
 </ul>
 <p>There is a distinction though between the servers backed by a Directory Service, and those that aren't (like the HTTP and NTP servers). </p>
-<p>All the servers share some common parameters, which are exposed in the following tables :</p>
+<p>All the servers share some common parameters, which are exposed in the following table :</p>
 <table>
 <thead>
 <tr>

Modified: websites/staging/directory/trunk/content/apacheds/advanced-users-guide.html
==============================================================================
--- websites/staging/directory/trunk/content/apacheds/advanced-users-guide.html (original)
+++ websites/staging/directory/trunk/content/apacheds/advanced-users-guide.html Thu Nov  8 09:15:02 2012
@@ -131,6 +131,8 @@
 <li><a href="">3.3 - subtree</a></li>
 </ul>
 </li>
+<li>[4 - Security]<ul>
+<li><a href="">5.1 - Start TLS with ApacheDS</a></li>
 <li><a href="">3 - Authentication</a><ul>
 <li><a href="">3.1. SASL Authentication to ApacheDS</a></li>
 <li><a href="">3.2. HOWTO do SASL GSSAPI Authentication to ApacheDS</a></li>
@@ -144,15 +146,27 @@
 <li><a href="">UserClasses</a></li>
 </ul>
 </li>
-<li><a href="">5 - Security</a><ul>
-<li><a href="">5.1 - Start TLS with ApacheDS</a></li>
 </ul>
 </li>
-<li><a href="">5. Attributes, Entries &amp; Schemas</a><ul>
+<li><a href="">5. The Schema</a><ul>
 <li><a href="">3.1. Add your first elements to the schema</a></li>
 <li><a href="">3.2. Collective Attributes</a></li>
 </ul>
 </li>
+<li><a href="">6 - Indexes</a></li>
+<li><a href="">7. Partitioning &amp; Replication</a><ul>
+<li><a href="">7.1. Referrals</a></li>
+<li><a href="">7.2. Replication</a></li>
+</ul>
+</li>
+<li><a href=""> 8 - Administration</a><ul>
+<li><a href="">8-1 - Logs</a></li>
+<li><a href="">8-2 - Backup &amp; Recovery</a></li>
+<li><a href="">8-3 - Migration</a></li>
+<li><a href="">8-4 - Tuning</a></li>
+<li><a href="">8-5 - JMX</a></li>
+</ul>
+</li>
 <li><a href="">4. Embedding ApacheDS</a><ul>
 <li><a href="">4.1. Embedding ApacheDS into an application</a></li>
 <li><a href="">4.2. Using ApacheDS for unit tests</a></li>
@@ -199,11 +213,6 @@
 <li><a href="">2.4. Writing a custom authenticator</a></li>
 </ul>
 </li>
-<li><a href="">7. Partitioning &amp; Replication</a><ul>
-<li><a href="">7.1. Referrals</a></li>
-<li><a href="">7.2. Replication</a></li>
-</ul>
-</li>
 <li><a href="">8. Triggers &amp; Stored Procedures</a><ul>
 <li><a href="">8.1. Stored Procedures</a></li>
 <li><a href="">8.2. LDAP Triggers</a><ul>