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

[bu...@apache.org]

Author: buildbot
Date: Mon Nov  5 15:20:06 2012
New Revision: 837345

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 Mon Nov  5 15:20:06 2012
@@ -1 +1 @@
-1405769
+1405831

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 Mon Nov  5 15:20:06 2012
@@ -128,66 +128,66 @@
 <h1 id="2-server-configuraion">2 - Server Configuraion</h1>
 <p>We will now describe the server configuration. Usually, all the configuration is done using Apache Directory Studio, which offers a pretty GUI. One can also configure the server using LDAP request, as the configuration is stored in teh <strong>DIT</strong>. Otherwise, all the configuration modifications won't be applied on a started server : usually, you will have to restart the server in order to get those modifications applied.</p>
 <h2 id="configurable-elements">Configurable elements</h2>
-<p>Here is the list of elements that can be configuraed :</p>
+<p>First, here is the list of elements that can be configured :</p>
 <ul>
 <li>
 <p>AdsBean</p>
 <ul>
-<li>boolean enabled</li>
-<li>String description</li>
+<li><em>boolean</em> enabled</li>
+<li><em>String</em> description</li>
 </ul>
 </li>
 <li>
 <p>DirectryServiceBean -&gt; AdsBean</p>
 <ul>
-<li>String directoryServiceId</li>
-<li>int dsReplicaId</li>
-<li>boolean dsAccessControlEnabled</li>
-<li>boolean dsAllowAnonymousAccess</li>
-<li>boolean dsDenormalizeOpAttrsEnabled</li>
-<li>int dsMaxPDUSize</li>
-<li>boolean dsPasswordHidden</li>
-<li>long dsSyncPeriodMillis</li>
-<li>String dsTestEntries</li>
-<li>ChangeLogBean</li>
-<li>JournalBean</li>
-<li>List<ServerBean></li>
-<li>List<InterceptorBean></li>
-<li>List<PartitionBean></li>
+<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>
 </li>
 <li>
 <p>ChangeLogBean -&gt; AdsBean</p>
 <ul>
-<li>String changeLogId</li>
-<li>boolean changeLogExposed</li>
+<li><em>String</em> changeLogId</li>
+<li><em>boolean</em> changeLogExposed</li>
 </ul>
 </li>
 <li>
 <p>JournalBean -&gt; AdsBean</p>
 <ul>
-<li>String journalId</li>
-<li>String journalFileName</li>
-<li>String journalWorkingDir</li>
-<li>int journalRotation</li>
+<li><em>String</em> journalId</li>
+<li><em>String</em> journalFileName</li>
+<li><em>String</em> journalWorkingDir</li>
+<li><em>int</em> journalRotation</li>
 </ul>
 </li>
 <li>
 <p>ServerBean -&gt; AdsBean</p>
 <ul>
-<li>String serverId</li>
-<li>List<TransportBean></li>
+<li><em>String</em> serverId</li>
+<li><em>List<TransportBean></em></li>
 </ul>
 </li>
 <li>
 <p>TransportBean -&gt; AdsBean</p>
 <ul>
-<li>String transportId</li>
-<li>String transportAddress</li>
-<li>int systemPort</li>
-<li>boolean transportEnableSsl</li>
-<li>int transportNbThreads</li>
-<li>int transportBackLog</li>
+<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>
 </li>
 <li>
@@ -202,35 +202,35 @@
 <li>
 <p>HttpServerBean -&gt; ServerBean</p>
 <ul>
-<li>String httpConfFile</li>
-<li>List<HttpWebAppBean></li>
+<li><em>String</em> httpConfFile</li>
+<li><em>List<HttpWebAppBean></em></li>
 </ul>
 </li>
 <li>
 <p>HttpWebAppBean -&gt; AdsBaseBean</p>
 <ul>
-<li>String id</li>
-<li>String httpAppCtxPath</li>
-<li>String httpWarFile</li>
+<li><em>String</em> id</li>
+<li><em>String</em> httpAppCtxPath</li>
+<li><em>String</em> httpWarFile</li>
 </ul>
 </li>
 <li>
 <p>DSBasedServerBean -&gt; ServerBean</p>
 <ul>
-<li>Dn searchBaseDn</li>
+<li><em>Dn</em> searchBaseDn</li>
 </ul>
 </li>
 <li>
 <p>ChangePasswordServerBean -&gt; DSBasedServerBean</p>
 <ul>
-<li>long krbAllowableClockSkew</li>
-<li>boolean krbEmptyAddressesAllowed</li>
-<li>List<String> krbEncryptionTypes</li>
-<li>String krbPrimaryRealm</li>
-<li>int chgPwdPolicyCategoryCount</li>
-<li>int chgPwdPolicyPasswordLength</li>
-<li>int chgPwdPolicyTokenSize</li>
-<li>String chgPwdServicePrincipal</li>
+<li><em>long</em> krbAllowableClockSkew</li>
+<li><em>boolean</em> krbEmptyAddressesAllowed</li>
+<li><em>List<String></em> krbEncryptionTypes</li>
+<li><em>String</em> krbPrimaryRealm</li>
+<li><em>int</em> chgPwdPolicyCategoryCount</li>
+<li><em>int</em> chgPwdPolicyPasswordLength</li>
+<li><em>int</em> chgPwdPolicyTokenSize</li>
+<li><em>String</em> chgPwdServicePrincipal</li>
 </ul>
 </li>
 <li>
@@ -242,83 +242,83 @@
 <li>
 <p>KdcServerBean -&gt; DSBasedServerBean</p>
 <ul>
-<li>long krbAllowableClockSkew</li>
-<li>boolean krbEmptyAddressesAllowed</li>
-<li>boolean krbForwardableAllowed</li>
-<li>boolean krbPAEncTimestampRequired</li>
-<li>boolean krbPostdatedAllowed</li>
-<li>boolean krbProxiableAllowed</li>
-<li>boolean krbRenewableAllowed</li>
-<li>long krbMaximumRenewableLifetime</li>
-<li>long krbMaximumTicketLifetime</li>
-<li>String krbPrimaryRealm</li>
-<li>boolean krbBodyChecksumVerified</li>
-<li>List<String> krbEncryptionTypes</li>
-<li>String krbKdcPrincipal</li>
+<li><em>long</em> krbAllowableClockSkew</li>
+<li><em>boolean</em> krbEmptyAddressesAllowed</li>
+<li><em>boolean</em> krbForwardableAllowed</li>
+<li><em>boolean</em> krbPAEncTimestampRequired</li>
+<li><em>boolean</em> krbPostdatedAllowed</li>
+<li><em>boolean</em> krbProxiableAllowed</li>
+<li><em>boolean</em> krbRenewableAllowed</li>
+<li><em>long</em> krbMaximumRenewableLifetime</li>
+<li><em>long</em> krbMaximumTicketLifetime</li>
+<li><em>String</em> krbPrimaryRealm</li>
+<li><em>boolean</em> krbBodyChecksumVerified</li>
+<li><em>List<String></em> krbEncryptionTypes</li>
+<li><em>String</em> krbKdcPrincipal</li>
 </ul>
 </li>
 <li>
 <p>LdapServerBean -&gt; DSBasedServerBean</p>
 <ul>
-<li>boolean confidentialityRequired</li>
-<li>int maxSizeLimit</li>
-<li>int maxTimeLimit</li>
-<li>int saslHost</li>
-<li>String saslPrincipal</li>
-<li>List<String> saslRealms</li>
-<li>String keystoreFile</li>
-<li>String certificatePassword</li>
-<li>String replReqHandler</li>
-<li>List<ReplConsumerBean></li>
-<li>List<SaslMechHandlerBean></li>
-<li>List<ExtendedOpHandlerBean></li>
+<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>
 <ul>
-<li>String replConsumerId</li>
-<li>String searchBaseDn</li>
-<li>String replProvHostName</li>
-<li>int replProvPort</li>
-<li>String replAliasDerefMode</li>
-<li>List<String> replAttributes</li>
-<li>long replRefreshInterval</li>
-<li>boolean replRefreshNPersist</li>
-<li>String replSearchScope</li>
-<li>String replSearchFilter</li>
-<li>int replSearchSizeLimit</li>
-<li>int replSearchTimeout</li>
-<li>String replUserDn</li>
-<li>byte[] replUserPassword</li>
-<li>String replCookie</li>
-<li>boolean replUseTls</li>
-<li>boolean replStrictCertValidation</li>
-<li>byte[] replPeerCertificate</li>
-<li>String replConsumerImpl</li>
+<li><em>String</em> replConsumerId</li>
+<li><em>String</em> searchBaseDn</li>
+<li><em>String</em> replProvHostName</li>
+<li><em>int</em> replProvPort</li>
+<li><em>String</em> replAliasDerefMode</li>
+<li><em>List<String></em> replAttributes</li>
+<li><em>long</em> replRefreshInterval</li>
+<li><em>boolean</em> replRefreshNPersist</li>
+<li><em>String</em> replSearchScope</li>
+<li><em>String</em> replSearchFilter</li>
+<li><em>int</em> replSearchSizeLimit</li>
+<li><em>int</em> replSearchTimeout</li>
+<li><em>String</em> replUserDn</li>
+<li><em>byte[]</em> replUserPassword</li>
+<li><em>String</em> replCookie</li>
+<li><em>boolean</em> replUseTls</li>
+<li><em>boolean</em> replStrictCertValidation</li>
+<li><em>byte[]</em> replPeerCertificate</li>
+<li><em>String</em> replConsumerImpl</li>
 </ul>
 </li>
 <li>
 <p>SaslMechHandlerBean -&gt; AdsBaseBean</p>
 <ul>
-<li>String saslMechName</li>
-<li>String saslMechClassName</li>
-<li>String ntlmMechProvider</li>
+<li><em>String</em> saslMechName</li>
+<li><em>String</em> saslMechClassName</li>
+<li><em>String</em> ntlmMechProvider</li>
 </ul>
 </li>
 <li>
 <p>ExtendedOpHandlerBean -&gt; AdsBaseBean</p>
 <ul>
-<li>String extendedOpId</li>
-<li>String extendedOpHandlerClass</li>
+<li><em>String</em> extendedOpId</li>
+<li><em>String</em> extendedOpHandlerClass</li>
 </ul>
 </li>
 <li>
 <p>InterceptorBean -&gt; AdsBean</p>
 <ul>
-<li>String interceptorId</li>
-<li>String interceptorClassName</li>
-<li>int interceptorOrder</li>
+<li><em>String</em> _int_erceptorId</li>
+<li><em>String</em> _int_erceptorClassName</li>
+<li><em>int</em> _int_erceptorOrder</li>
 </ul>
 </li>
 <li>
@@ -331,82 +331,196 @@
 <li>
 <p>AuthenticatorBean -&gt; AdsBean</p>
 <ul>
-<li>String authenticatorId</li>
+<li><em>String</em> authenticatorId</li>
 </ul>
 </li>
 <li>
 <p>AuthenticatorImplBean -&gt; AuthenticatorBean</p>
 <ul>
-<li>String authenticatorClass</li>
+<li><em>String</em> authenticatorClass</li>
 </ul>
 </li>
 <li>
 <p>DelegatingAuthenticatorBean -&gt; AuthenticatorBean</p>
 <ul>
-<li>String delegateHost</li>
-<li>int delegatePort</li>
+<li><em>String</em> delegateHost</li>
+<li><em>int</em> delegatePort</li>
 </ul>
 </li>
 <li>
 <p>PasswordPolicyBean -&gt; AdsBean</p>
 <ul>
-<li>String pwdId</li>
-<li>String pwdAttribute</li>
-<li>int pwdMinAge</li>
-<li>int pwdMaxAge</li>
-<li>int pwdInHistory</li>
-<li>int pwdCheckQuality</li>
-<li>int pwdMinLength</li>
-<li>int pwdMaxLength</li>
-<li>int pwdExpireWarning</li>
-<li>int pwdGraceAuthNLimit</li>
-<li>int pwdGraceExpire</li>
-<li>boolean pwdLockout</li>
-<li>int pwdLockoutDuration</li>
-<li>int pwdMaxFailure</li>
-<li>int pwdFailureCountInterval</li>
-<li>boolean pwdMustChange</li>
-<li>boolean pwdAllowUserChange</li>
-<li>boolean pwdSafeModify</li>
-<li>int pwdMinDelay</li>
-<li>int pwdMaxDelay</li>
-<li>int pwdMaxIdle</li>
+<li><em>String</em> pwdId</li>
+<li><em>String</em> pwdAttribute</li>
+<li><em>int</em> pwdMinAge</li>
+<li><em>int</em> pwdMaxAge</li>
+<li><em>int</em> pwdInHistory</li>
+<li><em>int</em> pwdCheckQuality</li>
+<li><em>int</em> pwdMinLength</li>
+<li><em>int</em> pwdMaxLength</li>
+<li><em>int</em> pwdExpireWarning</li>
+<li><em>int</em> pwdGraceAuthNLimit</li>
+<li><em>int</em> pwdGraceExpire</li>
+<li><em>boolean</em> pwdLockout</li>
+<li><em>int</em> pwdLockoutDuration</li>
+<li><em>int</em> pwdMaxFailure</li>
+<li><em>int</em> pwdFailureCountInterval</li>
+<li><em>boolean</em> pwdMustChange</li>
+<li><em>boolean</em> pwdAllowUserChange</li>
+<li><em>boolean</em> pwdSafeModify</li>
+<li><em>int</em> pwdMinDelay</li>
+<li><em>int</em> pwdMaxDelay</li>
+<li><em>int</em> pwdMaxIdle</li>
 </ul>
 </li>
 <li>
 <p>PartitionBean -&gt; AdsBean</p>
 <ul>
-<li>int  partitionId</li>
-<li>Dn partitionSuffix</li>
-<li>boolean partitionSyncOnWrite</li>
-<li>int  contextEntry</li>
-<li>List<IndexBean></li>
+<li><em>int</em>  partitionId</li>
+<li><em>Dn</em> partitionSuffix</li>
+<li><em>boolean</em> partitionSyncOnWrite</li>
+<li><em>int</em>  contextEntry</li>
+<li><em>List<IndexBean></em></li>
 </ul>
 </li>
 <li>
 <p>JdbmPartitionBean -&gt; PartitionBean</p>
 <ul>
-<li>int partitionCacheSize</li>
-<li>boolean jdbmPartitionOptimizerEnabled </li>
+<li><em>int</em> partitionCacheSize</li>
+<li><em>boolean</em> jdbmPartitionOptimizerEnabled <br />
+</li>
 </ul>
 </li>
 <li>
 <p>IndexBean -&gt; AdsBean</p>
 <ul>
-<li>int indexAttributeId</li>
-<li>boolean indexHasReverse</li>
+<li><em>int</em> indexAttributeId</li>
+<li><em>boolean</em> indexHasReverse</li>
 </ul>
 </li>
 <li>
 <p>JdbmIndexBean -&gt; IndexBean</p>
 <ul>
-<li>int indexCacheSize</li>
-<li>int indexNumDupLimit</li>
-<li>String indexFileName</li>
-<li>String indexWorkingDir</li>
-</ul>
-</li>
-</ul>
+<li><em>int</em> indexCacheSize</li>
+<li><em>int</em> indexNumDupLimit</li>
+<li><em>String</em> indexFileName</li>
+<li><em>String</em> indexWorkingDir</li>
+</ul>
+</li>
+</ul>
+<p>We will now explain each one of those elements.</p>
+<h3 id="servers">Servers</h3>
+<p>As we can see, we can start more than one server. We have :</p>
+<ul>
+<li>a LDAP server</li>
+<li>a Kerberos server</li>
+<li>a changePassword server</li>
+<li>an HTTP Server</li>
+<li>a NTP Server</li>
+<li>a DHCP server</li>
+<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>
+<h4 id="ldap-server">Ldap Server</h4>
+<p>Let's start with the main server : the LDAP one. </p>
+<p>The list of attributes that can be modified is exposed in the following table. </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>confidentialityRequired</td>
+<td>ads-confidentialityRequired</td>
+<td><em>boolean</em></td>
+<td></td>
+<td>TODO</td>
+</tr>
+<tr>
+<td>maxSizeLimit</td>
+<td>ads-maxSizeLimit</td>
+<td><em>int</em></td>
+<td>1000</td>
+<td>The maximum number of entries teh server will return</td>
+</tr>
+<tr>
+<td>maxTimeLimit</td>
+<td>ads-maxTimeLimit</td>
+<td><em>int</em></td>
+<td>1000</td>
+<td>The maimum bumber of second the server will use to process a search request</td>
+</tr>
+<tr>
+<td>saslHost</td>
+<td>ads-saslHost</td>
+<td><em>int</em></td>
+<td></td>
+<td>TODO</td>
+</tr>
+<tr>
+<td>saslPrincipal</td>
+<td>ads-saslPrincipal</td>
+<td><em>String</em></td>
+<td></td>
+<td>TODO</td>
+</tr>
+<tr>
+<td>saslRealms</td>
+<td>ads-saslRealms</td>
+<td><em>List<String></em></td>
+<td></td>
+<td>TODO</td>
+</tr>
+<tr>
+<td>keystoreFile</td>
+<td>ads-keystoreFile</td>
+<td><em>String</em></td>
+<td></td>
+<td>The place on the filesystem where the Keystore is stored</td>
+</tr>
+<tr>
+<td>certificatePassword</td>
+<td>ads-certificatePassword</td>
+<td><em>String</em></td>
+<td></td>
+<td>The certificate's password</td>
+</tr>
+<tr>
+<td>replReqHandler</td>
+<td>ads-replReqHandler</td>
+<td><em>String</em></td>
+<td></td>
+<td>TODO</td>
+</tr>
+<tr>
+<td>replConsumers</td>
+<td>ads-replConsumers</td>
+<td><em>List<ReplConsumerBean></em></td>
+<td></td>
+<td>TODO</td>
+</tr>
+<tr>
+<td>saslMechHandlers</td>
+<td>ads-saslMechHandlers</td>
+<td><em>List<SaslMechHandlerBean></em></td>
+<td></td>
+<td>The list of SASL mechanism handlers</td>
+</tr>
+<tr>
+<td>extendedOpHandlers</td>
+<td>ads-extendedOpHandlers</td>
+<td><em>List<ExtendedOpHandlerBean></em></td>
+<td></td>
+<td>The list of extended operation handlers</td>
+</tr>
+</tbody>
+</table>
 
 
     <div class="nav">