You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by jm...@apache.org on 2004/02/11 22:30:30 UTC

svn commit: rev 6627 - incubator/directory/ldap/trunk/xdocs

Author: jmachols
Date: Wed Feb 11 13:30:29 2004
New Revision: 6627

Modified:
   incubator/directory/ldap/trunk/xdocs/client.xml
   incubator/directory/ldap/trunk/xdocs/common.xml
Log:
Added some overview infomation on the common and client
sitedocs portion of the LDAP section.

Modified: incubator/directory/ldap/trunk/xdocs/client.xml
==============================================================================
--- incubator/directory/ldap/trunk/xdocs/client.xml	(original)
+++ incubator/directory/ldap/trunk/xdocs/client.xml	Wed Feb 11 13:30:29 2004
@@ -7,9 +7,39 @@
   
   <body>
     <section name="Overview">
-      <p>LDAP Clients</p>
-      <p> 
-      Add stand alone client and lib instructions     
+      <p>
+        The goal of the LDAP Client package is to provide access to any
+        LDAP server "over-the-wire".  These clients will perform the following
+        operations:
+        <ul>
+          <li>Bind</li>
+          <li>Add</li>
+          <li>Delete</li>
+          <li>Modify</li>
+          <li>ModifyDN</li>
+          <li>Search</li>
+        </ul>
+      </p>
+    </section>
+    
+    <section name="Command Line Clients">
+      <p>
+        There will be a traditional command line set of clients.  These are Java 
+        so will be platform independant.  The command line clients will also come 
+        with a set of wrappers for Unix/Linux and Windows so the Java specific paths
+        and arguments will be abstracted away.  The users will only need to provide
+        the command line arguments specific to the LDAP operation.   
+      </p>
+    </section>
+    
+    <section name="Client Libraries">
+      <p>
+        The client package will also include a set of library methods to embed
+        LDAP clients into an application.  Each of the operations in the command
+        line will be able to be performed in the library.  This will be used for
+        application that wish to connect over the wire to an LDAP server.  Many
+        of the LDAP specific details, such as parsing LDIF's have been handled.  
+        The application will not have to worry about dealing with LDAP specifics.
       </p>
     </section>
   </body>

Modified: incubator/directory/ldap/trunk/xdocs/common.xml
==============================================================================
--- incubator/directory/ldap/trunk/xdocs/common.xml	(original)
+++ incubator/directory/ldap/trunk/xdocs/common.xml	Wed Feb 11 13:30:29 2004
@@ -36,8 +36,27 @@
           parsing and management without becomming an expert on the RFC.
           Addition details about LDIF can be obtained from the 
           <a href="http://www.ietf.org/rfc/rfc2849.txt">LDIF RFC</a>
+        </p>        
+      </subsection>
+      
+      <subsection name="Message">
+      	<p>
+          The LDAP Common Messaging package provides a framework for
+          all LDAP request and response messages.  Each of the reponses
+          and requests have an implementation.
+      	</p>
+      </subsection>
+      
+      <subsection name="Name">
+        <p>
+          This package provides LDAP distinguished name creation and 
+          normalization.  This provides a common method for ensuring 
+          you are creating the entry DN correctly.  Failure to properly
+          create and normalize the DN of an entry will result in unpredicatble
+          results when operations are performed on the entry.  
         </p>
       </subsection>
+      
     </section>
   </body>
 </document>