You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by el...@apache.org on 2012/11/08 10:14:56 UTC

svn commit: r1406975 - in /directory/site/trunk/content/apacheds: advanced-ug/2-server-config.mdtext advanced-users-guide.mdtext

Author: elecharny
Date: Thu Nov  8 09:14:56 2012
New Revision: 1406975

URL: http://svn.apache.org/viewvc?rev=1406975&view=rev
Log:
Reorganized the main TOC, added some content

Modified:
    directory/site/trunk/content/apacheds/advanced-ug/2-server-config.mdtext
    directory/site/trunk/content/apacheds/advanced-users-guide.mdtext

Modified: directory/site/trunk/content/apacheds/advanced-ug/2-server-config.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/advanced-ug/2-server-config.mdtext?rev=1406975&r1=1406974&r2=1406975&view=diff
==============================================================================
--- directory/site/trunk/content/apacheds/advanced-ug/2-server-config.mdtext (original)
+++ directory/site/trunk/content/apacheds/advanced-ug/2-server-config.mdtext Thu Nov  8 09:14:56 2012
@@ -34,21 +34,7 @@ First, here is the list of elements that
 	* _boolean_ enabled
 	* _String_ description
 
-* DirectryServiceBean -> AdsBean
-	* _String_ directoryServiceId
-	* _int_ dsReplicaId
-	* _boolean_ dsAccessControlEnabled
-	* _boolean_ dsAllowAnonymousAccess
-	* _boolean_ dsDenormalizeOpAttrsEnabled
-	* _int_ dsMaxPDUSize
-	* _boolean_ dsPasswordHidden
-	* _long_ dsSyncPeriodMillis
-	* _String_ dsTestEntries
-	* _ChangeLogBean_
-	* _JournalBean_
-	* _List<ServerBean>_
-	* _List<InterceptorBean>_
-	* _List<PartitionBean>_
+* [DirectoryServiceBean](#directory-service) -> AdsBean
 		
 * ChangeLogBean -> AdsBean
 	* _String_ changeLogId
@@ -60,17 +46,9 @@ First, here is the list of elements that
 	* _String_ journalWorkingDir
 	* _int_ journalRotation
 	
-* ServerBean -> AdsBean
-	* _String_ serverId
-	* _List<TransportBean>_
-	
-* TransportBean -> AdsBean
-	* _String_ transportId
-	* _String_ transportAddress
-	* _int_ systemPort
-	* _boolean_ transportEnableSsl
-	* _int_ transportNbThreads
-	* _int_ transportBackLog
+* [ServerBean](#servers) -> AdsBean
+	
+* [TransportBean](#servers) -> AdsBean
 	
 * TcpTransportBean -> AdsBean
 
@@ -120,18 +98,6 @@ First, here is the list of elements that
 	* _String_ krbKdcPrincipal
 	
 * [LdapServerBean](#ldap-server) -> DSBasedServerBean
-	* _boolean_ confidentialityRequired
-	* _int_ maxSizeLimit
-	* _int_ maxTimeLimit
-	* _int_ saslHost
-	* _String_ saslPrincipal
-	* _List<String>_ saslRealms
-	* _String_ keystoreFile
-	* _String_ certificatePassword
-	* _String_ replReqHandler
-	* _List<ReplConsumerBean>_
-	* _List<SaslMechHandlerBean>_
-	* _List<ExtendedOpHandlerBean>_
 	
 * ReplConsumerBean -> AdsBaseBean
 	* _String_ replConsumerId
@@ -229,6 +195,29 @@ First, here is the list of elements that
 
 We will now explain each one of those elements.
 
+### Directory Service
+
+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 _DirectoryService_. This compoent itself refers to the servers that will be started, plus the backends it will depends on.
+
+Here are the configuration parameters for this components :
+
+| Parameter | AttributeType | type | default value | Description |
+|---|---|---|---|---|
+| directoryServiceId | ads-directoryServiceId | _String_ |  | The unique identifier for the service |
+| dsReplicaId | ads-dsReplicaId | _int_ |  | The replication identifier |
+| dsAccessControlEnabled | ads-dsAccessControlEnabled | _boolean_  | true | Tells if the Access Control interceptor is active |
+| dsAllowAnonymousAccess | ads-dsAllowAnonymousAccess | _boolean_  | false | Tells if the service allow anonymous access |
+| dsDenormalizeOpAttrsEnabled | ads-dsDenormalizeOpAttrsEnabled | _boolean_  | true | Tells if the service should denormalize operatonal attributes |
+| dsMaxPDUSize | ads-dsMaxPDUSize | _int_  | 2048 | The maximum size of an incomming PDU (not used) |
+| dsPasswordHidden | ads-dsPasswordHidden | _boolean_  | true | Tells if the passwords should be encrypted (not used) |
+| dsSyncPeriodMillis | ads-dsSyncPeriodMillis | _long_  | 15000 | The delai in milliseconds before we flush data on disk |
+| dsTestEntries | | _String_  |  | Not used |
+| changeLog | | _ChangeLogBean_ | N/A | The interceptor that stores the reverted modifications |
+| journal | | _JournalBean_ | N/A | The interceptor that record every modifcation |
+| servers | ads-servers | _List<ServerBean>_ | N/A | The list of started servers |
+| interceptors | ads-interceptors | _List<InterceptorBean>_ | N/A | The list of interceptors |
+| partitions | ads-partitions | _List<PartitionBean>_ | N/A | The list of existing partitions |
+
 ### Servers
 
 As we can see, we can start more than one server. We have :
@@ -243,7 +232,7 @@ As we can see, we can start more than on
 
 There is a distinction though between the servers backed by a Directory Service, and those that aren't (like the HTTP and NTP servers). 
 
-All the servers share some common parameters, which are exposed in the following tables :
+All the servers share some common parameters, which are exposed in the following table :
 
 | Parameter | AttributeType | type | default value | Description |
 |---|---|---|---|---|

Modified: directory/site/trunk/content/apacheds/advanced-users-guide.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/advanced-users-guide.mdtext?rev=1406975&r1=1406974&r2=1406975&view=diff
==============================================================================
--- directory/site/trunk/content/apacheds/advanced-users-guide.mdtext (original)
+++ directory/site/trunk/content/apacheds/advanced-users-guide.mdtext Thu Nov  8 09:14:56 2012
@@ -36,20 +36,30 @@ This guide get you a deep further into A
 	* [3.1 - Administration Point]()
 	* [3.2 - roles]()
 	* [3.3 - subtree]()
-* [3 - Authentication]()
-	* [3.1. SASL Authentication to ApacheDS]()
-	* [3.2. HOWTO do SASL GSSAPI Authentication to ApacheDS]()
-	* [3.3 Certificates]()
-* [4 - Authorization]()
-    * [ACAreas]()
-    * [AllowSelfPasswordModify]()
-    * [EnableSearchForAllUsers]()
-    * [UserClasses]()
-* [5 - Security]()
+* [4 - Security]
 	* [5.1 - Start TLS with ApacheDS]()
-* [5. Attributes, Entries & Schemas]()
+	* [3 - Authentication]()
+		* [3.1. SASL Authentication to ApacheDS]()
+		* [3.2. HOWTO do SASL GSSAPI Authentication to ApacheDS]()
+		* [3.3 Certificates]()
+	* [4 - Authorization]()
+		* [ACAreas]()
+    	* [AllowSelfPasswordModify]()
+		* [EnableSearchForAllUsers]()
+		* [UserClasses]()
+* [5. The Schema]()
     * [3.1. Add your first elements to the schema]()
     * [3.2. Collective Attributes]()
+* [6 - Indexes]()
+* [7. Partitioning & Replication]()
+    * [7.1. Referrals]()
+    * [7.2. Replication]()
+* [ 8 - Administration]()
+	* [8-1 - Logs]()
+	* [8-2 - Backup & Recovery]()
+	* [8-3 - Migration]()
+	* [8-4 - Tuning]()
+	* [8-5 - JMX]()
 * [4. Embedding ApacheDS]()
     * [4.1. Embedding ApacheDS into an application]()
     * [4.2. Using ApacheDS for unit tests]()
@@ -78,9 +88,6 @@ This guide get you a deep further into A
 	* [6.2 - Adding an Interceptor]()
 	* [6.3 - Adding a schema Matching Rule or Syntax]()
     * [2.4. Writing a custom authenticator]()
-* [7. Partitioning & Replication]()
-    * [7.1. Referrals]()
-    * [7.2. Replication]()
 * [8. Triggers & Stored Procedures]()
     * [8.1. Stored Procedures]()
     * [8.2. LDAP Triggers]()