directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r843998 - in /websites/staging/directory/trunk/content: ./ apacheds/advanced-ug/2-server-config.html
Date Thu, 27 Dec 2012 17:06:32 GMT
Author: buildbot
Date: Thu Dec 27 17:06:31 2012
New Revision: 843998

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

Propchange: websites/staging/directory/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Dec 27 17:06:31 2012
@@ -1 +1 @@
-1425986
+1426256

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
Dec 27 17:06:31 2012
@@ -314,13 +314,313 @@ Note that bold attributes are mandatory
 </tbody>
 </table>
 <h3 id="journal">Journal</h3>
+<p>The <em>Journal</em> system logs every modification on the file system.
It's intended to be used if the <em>DirectoryService</em> crashes, as we can reapply
the journal starting from a date in the past where we know that the underlying database is
correct.</p>
+<p>The configuration elements for the <em>Journal</em> are :</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><strong>journalId</strong></td>
+<td>ads-journalId</td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>The unique identifier for the Journal</td>
+</tr>
+<tr>
+<td>enabled</td>
+<td>ads-enabled</td>
+<td><em>boolean</em></td>
+<td>false</td>
+<td>Tells if the Journal system is enabled</td>
+</tr>
+<tr>
+<td>description</td>
+<td>description</td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>A short optional description</td>
+</tr>
+<tr>
+<td><strong>journalWorkingDir</strong></td>
+<td>ads-journalWorkingDir</td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>The working directory the Journal will be stored in</td>
+</tr>
+<tr>
+<td><strong>journalRotation</strong></td>
+<td>ads-journalRotation</td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>The number of operation stored befoe the journal is rotated</td>
+</tr>
+<tr>
+<td><strong>journalFileName</strong></td>
+<td>ads-journalFileName</td>
+<td><em>String</em></td>
+<td>journal.txt</td>
+<td>The file contaning the Journal</td>
+</tr>
+</tbody>
+</table>
 <h3 id="interceptors">Interceptors</h3>
+<p>The <em>Interceptors</em> are generally not configurable. You don't
want to change their order, nor remove or add some. The fact that they appear in the configuration
is because we use this to initialize the server.</p>
+<p>However, at least one <em>Interceptor</em> can be confiured : the <em>authenticationInterceptor</em>.
</p>
+<p>In the case where one would like to add an interceptor, it's enough to add the associated
entry containing the interceptor identifier, under the <em>ou=interceptors</em>
entry. It must have an order. Here are the elements taht can be configured in such a case
:</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><strong>interceptorId</strong></td>
+<td>ads-interceptorid</td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>The unique identifier for this Interceptor</td>
+</tr>
+<tr>
+<td>enabled</td>
+<td>ads-enabled</td>
+<td><em>boolean</em></td>
+<td>false</td>
+<td>Tells if the Interceptor is enabled</td>
+</tr>
+<tr>
+<td>description</td>
+<td>description</td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>A short optional description</td>
+</tr>
+<tr>
+<td>interceptorOrder</td>
+<td>ads-interceptororder</td>
+<td><em>int</em></td>
+<td>N/A</td>
+<td>The position in the chain for this interceptor</td>
+</tr>
+<tr>
+<td>interceptorClassName</td>
+<td>ads-interceptorclassname</td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>The class implementing this interceptor</td>
+</tr>
+</tbody>
+</table>
 <h3 id="authentication-interceptor">Authentication Interceptor</h3>
-<h3 id="authenticators">Authenticators)</h3>
+<p>This <em>Interceptor</em> is in charge of managing the users authentication.
It is associated with <em><a href="#authenticators">Authenticators</a></em>,
and with <em><a href="#password-policies">Password Policies</a></em>.</p>
+<h3 id="authenticators">Authenticators</h3>
+<p>We may have various <em>Authenticator</em> declared for a given server.
The default server has three different <em>Authenticators</em>, which are :
+<em> anonymousAuthenticator : used for anonymous requests
+</em> simpleAuthenticator : handle simple authentication, based on a password
+* strongAuthenticator : handle SASL authentication.</p>
+<p>One can add a new <em>Authenticator</em>, </p>
 <h3 id="password-policies">Password Policies</h3>
 <h3 id="partitions">Partitions</h3>
+<p>The <em>Partition</em> is the part of the server storing your data.
There are many parts that need to be configured in order to obtain the best performances out
of the server. It's also the part of the configuraton you are the more likely to modify, adding
new <em>Partitions</em> or adding new <em>Indexes</em>.</p>
+<p>A <em>Partition</em> have the following configurable elements :</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><strong>partitionId</strong></td>
+<td>ads-partitionid</td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>The unique identifier for this Partition</td>
+</tr>
+<tr>
+<td>enabled</td>
+<td>ads-enabled</td>
+<td><em>boolean</em></td>
+<td>false</td>
+<td>Tells if the Partition is enabled</td>
+</tr>
+<tr>
+<td>description</td>
+<td>description</td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>A short optional description</td>
+</tr>
+<tr>
+<td><strong>suffix</strong></td>
+<td>ads-partitionsuffix</td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>The partition DN</td>
+</tr>
+<tr>
+<td>contextEntry</td>
+<td>ads-contextEntry</td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>The entry associated with the suffix (in LDIF format)</td>
+</tr>
+<tr>
+<td>partitionSyncOnWrite</td>
+<td>ads-partitionSyncOnWrite</td>
+<td><em>boolean</em></td>
+<td>true</td>
+<td>Tells the server to flush on disk on each write</td>
+</tr>
+</tbody>
+</table>
+<p>Once those elements have been configured, the <em>Partition</em> is
available. You still have to create some mandatory indexes though.</p>
 <h3 id="indexes">Indexes</h3>
+<p>Each <em>Partition</em> have indexes, some are mandatory, and others
are user provided. Here are the mandatory indexes :</p>
+<table>
+<thead>
+<tr>
+<th>Index</th>
+<th>role</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>apacheRdn</td>
+<td>Stores the RDN for the entry, and the relation to its parent's RDN</td>
+</tr>
+<tr>
+<td>apachePresence</td>
+<td>Used to index the attributeTypes used in the entry</td>
+</tr>
+<tr>
+<td>apacheOneAlias</td>
+<td>Stores the aliases one level below the current entry</td>
+</tr>
+<tr>
+<td>apacheSubAlias</td>
+<td>Stores the aliases below the current entry</td>
+</tr>
+<tr>
+<td>apacheAlias</td>
+<td>Stores the aliases</td>
+</tr>
+<tr>
+<td>objectClass</td>
+<td>Stores the relatio between an ObjectClass an the entry using it</td>
+</tr>
+<tr>
+<td>entryCSN</td>
+<td>Stores the CSN for each entry</td>
+</tr>
+<tr>
+<td>administrativeRole</td>
+<td>Stores the entries that are AdminstrativePoints</td>
+</tr>
+</tbody>
+</table>
 <h3 id="indexed-attribute">Indexed Attribute</h3>
+<p>IndexedATtributes have a type, depending on the <em>Partition</em> they
are associetd with. Currently, we have only one type, <em>JdbmIndex</em>. They
have specific configurable elements.</p>
+<p>Each index attribute have four basic elements that can be configured :</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><strong>indexAttributeId</strong></td>
+<td>ads-indexAttributeId</td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>The unique identifier for this indexedAttribute</td>
+</tr>
+<tr>
+<td>enabled</td>
+<td>ads-enabled</td>
+<td><em>boolean</em></td>
+<td>false</td>
+<td>Tells if the IntexedAttribute is enabled</td>
+</tr>
+<tr>
+<td>description</td>
+<td>description</td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>A short optional description</td>
+</tr>
+<tr>
+<td><strong>indexHasReverse</strong></td>
+<td>ads-indexHasReverse</td>
+<td><em>boolean</em></td>
+<td>false</td>
+<td>Tells if the IndexedAttribute has a reverse index</td>
+</tr>
+</tbody>
+</table>
+<p>The <em>JdbmIndex</em> type of index has some more configurable elements,
all optional :</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>indexFileName</td>
+<td>ads-indexFileName</td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>The index file name (default to the associated attributeType name)</td>
+</tr>
+<tr>
+<td>indexWorkingDir</td>
+<td>ads-indexWorkingDir</td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>The index working directory</td>
+</tr>
+<tr>
+<td>indexNumDupLimit</td>
+<td>ads-indexNumDupLimit</td>
+<td><em>int</em></td>
+<td>512</td>
+<td>The maximum number of values for a single key before we use a sub-tree</td>
+</tr>
+<tr>
+<td>indexCacheSize</td>
+<td>ads-indexCacheSize</td>
+<td><em>int</em></td>
+<td>100</td>
+<td>The numbr of cached pages for this index</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>
@@ -359,6 +659,20 @@ Note that bold attributes are mandatory
 <td>N/A</td>
 <td>The server unique name</td>
 </tr>
+<tr>
+<td>enabled</td>
+<td>ads-enabled</td>
+<td><em>boolean</em></td>
+<td>N/A</td>
+<td>Tells if the Server is enabled</td>
+</tr>
+<tr>
+<td>description</td>
+<td>description</td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>A short optional description</td>
+</tr>
 </tbody>
 </table>
 <p>A server can define more than one transports : for instance, the Kerberos server
uses UDP and TCP transports.</p>
@@ -497,6 +811,20 @@ Note that bold attributes are mandatory
 <td>The port</td>
 </tr>
 <tr>
+<td>enabled</td>
+<td>ads-enabled</td>
+<td><em>boolean</em></td>
+<td>N/A</td>
+<td>Tells if the Transport system is enabled</td>
+</tr>
+<tr>
+<td>description</td>
+<td>description</td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>A short optional description</td>
+</tr>
+<tr>
 <td>transportEnableSsl</td>
 <td>ads-transportEnableSsl</td>
 <td><em>boolean</em></td>
@@ -666,9 +994,9 @@ Note that bold attributes are mandatory
 <li>
 <p>InterceptorBean -&gt; AdsBean</p>
 <ul>
-<li><em>String</em> _int_erceptorId</li>
-<li><em>String</em> _int_erceptorClassName</li>
-<li><em>int</em> _int_erceptorOrder</li>
+<li><em>String</em> interceptorId</li>
+<li><em>String</em> interceptorClassName</li>
+<li><em>int</em> interceptorOrder</li>
 </ul>
 </li>
 <li>



Mime
View raw message