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/02/03 09:51:22 UTC
svn commit: r1240029 - in
/directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence:
./ chapter-4/
Author: elecharny
Date: Fri Feb 3 08:51:22 2012
New Revision: 1240029
URL: http://svn.apache.org/viewvc?rev=1240029&view=rev
Log:
Applied Javier modifications for DIRAPI-74
Added:
directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-6-abandoning-and-operation.confluence
- copied, changed from r1239736, directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-6-abandonning-and-operation.confluence
directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-7-server-information.confluence
- copied, changed from r1239736, directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-7-server-informations.confluence
Removed:
directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-6-abandonning-and-operation.confluence
directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-7-server-informations.confluence
Modified:
directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/book.txt
directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-1-controls.confluence
directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-2-extended-operations.confluence
directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-5-ldif-and-dsml.confluence
Modified: directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/book.txt
URL: http://svn.apache.org/viewvc/directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/book.txt?rev=1240029&r1=1240028&r2=1240029&view=diff
==============================================================================
--- directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/book.txt (original)
+++ directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/book.txt Fri Feb 3 08:51:22 2012
@@ -21,8 +21,8 @@ chapter-4/4-2-extended-operations.conflu
chapter-4/4-3-referrals.confluence
chapter-4/4-4-aliases.confluence
chapter-4/4-5-ldif-and-dsml.confluence
-chapter-4/4-6-abandonning-and-operation.confluence
-chapter-4/4-7-server-informations.confluence
+chapter-4/4-6-abandoning-and-operation.confluence
+chapter-4/4-7-server-information.confluence
5-0-schema-management.confluence
chapter-5/5-1-schemamanager.confluence
chapter-5/5-2-attribute-types.confluence
Modified: directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-1-controls.confluence
URL: http://svn.apache.org/viewvc/directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-1-controls.confluence?rev=1240029&r1=1240028&r2=1240029&view=diff
==============================================================================
--- directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-1-controls.confluence (original)
+++ directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-1-controls.confluence Fri Feb 3 08:51:22 2012
@@ -1,21 +1,21 @@
h2. Controls
-A *Control* is used to extend *LDAP* operations. They can be used for requests and responses. They basically modify the operation's semantic. For instance, when using a _DeleteTree_ *Control* within a delete operation, you will be able to delete not only the entry itself, but also all of its children. Obviously, this *Control* has a meaning for the _delete_ operation, not for any other operation.
+A *Control* is used to extend *LDAP* operations. They can be used for requests and responses. They basically modify the operation's semantics. For instance, when using a _DeleteTree_ *Control* within a delete operation, you will be able to delete not only the entry itself, but also all of its children. Obviously this *Control* has a meaning for the _delete_ operation, not for any other operation.
Each server is free to implement the *Controls* it wants, so you have to check if the *Control* you want to use is a supported one.
-h3. Control structure
+h3. Control Structure
-A *Control* contains three elements :
-* An *[DIRAPI:Oid]*, which names the control
-* A _criticality_ flag, telling if this control semantic has to be applied. It's only set for a Request.
-* A value, which is an opaque array of bytes. Each *Control* knows how to decode its value
+A *Control* contains three elements:
+* An *[DIRAPI:Oid]*, which names the control.
+* A _criticality_ flag, telling if this control semantics have to be applied. It is only set for a Request.
+* A value, which is an opaque array of bytes. Each *Control* knows how to decode its value.
-What is important is that the value has to be encoded before the control is send to the server (or back to the client, if it's a response's *Control*). If the user does not know about the *Control* semantic, then it's impossible to encode or decode this value. However, usually, the *LDAP API* provides the needed controls (or it can be extended).
+What is important is that the value has to be encoded before the control is sent to the server (or back to the client, if it is a response's *Control*). If the user does not know about the *Control* semantics, then it is impossible to encode or decode this value. However, usually the *LDAP API* provides the needed controls (or it can be extended).
-h3. Existing controls
+h3. Existing Controls
-There are a list of existing controls, defined in RFCs. Not all those controls are supported by all the *LDAP* servers, nor this is mandatory that a *Control* is to be implemented (except a very few ones).
+There is a list of existing controls defined in RFC's. Not all controls are supported by all the *LDAP* servers, nor is it mandatory that a *Control* has to be implemented (except for a very few ones).
|| OID || RFC || Description ||
| 1.2.840.113549.6.0 | [RFC2649|http://tools.ietf.org/html/rfc2649] | An LDAP Control and Schema for Holding Operation Signatures |
@@ -28,7 +28,7 @@ There are a list of existing controls, d
| 1.3.6.1.1.12 | [RFC4528|http://tools.ietf.org/html/rfc4528] | Assertion Control |
| 1.3.6.1.1.22 | [RFC6171|http://tools.ietf.org/html/rfc6171] | Don't Use Copy Control |
-h4. AD supported controls
+h4. AD Supported Controls
|| OID || Description ||
| | |
| | |
@@ -52,7 +52,7 @@ h4. ApacheDS supported controls
| 1.3.6.1.4.1.4203.1.9.1.5 | SyncModifyDn | Replication [RFC4533|http://tools.ietf.org/html/rfc4533] |
-h4. IDS supported controls
+h4. IDS Supported Controls
|| OID || Description ||
| | |
| | |
@@ -61,7 +61,7 @@ h4. IDS supported controls
| | |
(TODO)
-h4. OpenLDAP supported controls
+h4. OpenLDAP Supported Controls
|| OID || Description ||
| | |
| | |
@@ -70,7 +70,7 @@ h4. OpenLDAP supported controls
| | |
(TODO)
-h4. OpenDJ supported controls
+h4. OpenDJ Supported Controls
|| OID || Description ||
| | |
| | |
@@ -79,7 +79,7 @@ h4. OpenDJ supported controls
| | |
(TODO)
-h4. OpenDS supported controls
+h4. OpenDS Supported Controls
|| OID || Description ||
| | |
| | |
@@ -88,7 +88,7 @@ h4. OpenDS supported controls
| | |
(TODO)
-h4. SunDS supported controls
+h4. SunDS Supported Controls
|| OID || Description ||
| | |
| | |
Modified: directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-2-extended-operations.confluence
URL: http://svn.apache.org/viewvc/directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-2-extended-operations.confluence?rev=1240029&r1=1240028&r2=1240029&view=diff
==============================================================================
--- directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-2-extended-operations.confluence (original)
+++ directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-2-extended-operations.confluence Fri Feb 3 08:51:22 2012
@@ -1,3 +1,3 @@
-h2. Extended operations
+h2. Extended Operations
Modified: directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-5-ldif-and-dsml.confluence
URL: http://svn.apache.org/viewvc/directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-5-ldif-and-dsml.confluence?rev=1240029&r1=1240028&r2=1240029&view=diff
==============================================================================
--- directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-5-ldif-and-dsml.confluence (original)
+++ directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-5-ldif-and-dsml.confluence Fri Feb 3 08:51:22 2012
@@ -2,18 +2,18 @@ h2. LDIF and DSML
Entries are stored in the *LDAP* database in a format that is not readable. This is not convenient when one wants to manipulate entries as text. Hopefully, two formats have been defined that allows a user to describe an entry using a text editor.
-One small issue is that some of the attributes may be binary, thus cannot be described using a text. We also have to deal with non ASCII characters, like european accents or languages like Japanese.
+One small issue is that some of the attributes may be binary, therefore they cannot be described using a text. We also have to deal with non ASCII characters, like european accents or languages like Japanese.
We will see how those constraints can be fulfilled by the two formats, *LDIF* and *DSML*.
-h3. LDIF format
+h3. LDIF Format
-The *LDIF* format is a full ASCII text format. It can be used to describe a full entry, and thus be injected into a LDAP server, but it ca also be used to apply some modification on existing entries.
+The *LDIF* format is a full ASCII text format. It can be used to describe a full entry, and therefore can be injected into a LDAP server, but it can also be used to apply some modifications on existing entries.
It is described in the *[RFC2849|http://www.ietf.org/rfc/rfc2849.txt]*.
-The *LDAP API* has three classes that can be used to manipulate a *LDIF* entry :
-* *[DIRAPI:LdifEntry]* : contains the entry when it has been parsed, but can also be created from scotch. We can get the entry exported in the *LDIF* format.
+The *LDAP API* has three classes that can be used to manipulate a *LDIF* entry:
+* *[DIRAPI:LdifEntry]* : contains the entry when it has been parsed, but can also be created from scratch. We can get the entry exported in the *LDIF* format.
* *LdifReader* : This class is able to read a _String_ or a file which contains *LDIF* framed entries, and produces a list of *LdifEntry*.
* *LdifUtils* :
Copied: directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-6-abandoning-and-operation.confluence (from r1239736, directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-6-abandonning-and-operation.confluence)
URL: http://svn.apache.org/viewvc/directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-6-abandoning-and-operation.confluence?p2=directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-6-abandoning-and-operation.confluence&p1=directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-6-abandonning-and-operation.confluence&r1=1239736&r2=1240029&rev=1240029&view=diff
==============================================================================
--- directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-6-abandonning-and-operation.confluence (original)
+++ directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-6-abandoning-and-operation.confluence Fri Feb 3 08:51:22 2012
@@ -1,2 +1,2 @@
-h2. Abandonning an operation
+h2. Abandoning an Operation
Copied: directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-7-server-information.confluence (from r1239736, directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-7-server-informations.confluence)
URL: http://svn.apache.org/viewvc/directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-7-server-information.confluence?p2=directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-7-server-information.confluence&p1=directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-7-server-informations.confluence&r1=1239736&r2=1240029&rev=1240029&view=diff
==============================================================================
--- directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-7-server-informations.confluence (original)
+++ directory/documentation/ldap-api-manuals/trunk/src/ldap-api-user-guide-confluence/chapter-4/4-7-server-information.confluence Fri Feb 3 08:51:22 2012
@@ -1,2 +1,2 @@
-h2. Server informations
+h2. Server Information