directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r1003844 - in /websites/staging/directory/trunk/content: ./ api/user-guide/
Date Sat, 31 Dec 2016 17:32:52 GMT
Author: buildbot
Date: Sat Dec 31 17:32:52 2016
New Revision: 1003844

Log:
Staging update by buildbot for directory

Modified:
    websites/staging/directory/trunk/content/   (props changed)
    websites/staging/directory/trunk/content/api/user-guide/6.12-entry.html
    websites/staging/directory/trunk/content/api/user-guide/6.27-oid.html
    websites/staging/directory/trunk/content/api/user-guide/6.35-value.html
    websites/staging/directory/trunk/content/api/user-guide/7-requests-responses.html
    websites/staging/directory/trunk/content/api/user-guide/7.1-abandon-request.html
    websites/staging/directory/trunk/content/api/user-guide/8-ldap-rfcs.html

Propchange: websites/staging/directory/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Sat Dec 31 17:32:52 2016
@@ -1 +1 @@
-1776801
+1776803

Modified: websites/staging/directory/trunk/content/api/user-guide/6.12-entry.html
==============================================================================
--- websites/staging/directory/trunk/content/api/user-guide/6.12-entry.html (original)
+++ websites/staging/directory/trunk/content/api/user-guide/6.12-entry.html Sat Dec 31 17:32:52
2016
@@ -184,14 +184,14 @@
 }
 h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover
> .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink
{ visibility: visible }</style>
 <h1 id="612-entry">6.12 - Entry<a class="headerlink" href="#612-entry" title="Permanent
link">&para;</a></h1>
-<p>The <em>Entry</em> class is one of the most important one in the <em>API</em>.
It describes the base element stored into a <em>LDAP</em> server, and it associates
a <em>Dn</em> and some <em>Attributes</em>.</p>
+<p>The <em>Entry</em> class is one of the most important ones in the <em>API</em>.
It describes the base element stored into a <em>LDAP</em> server, and it associates
a <em>Dn</em> and some <em>Attributes</em>.</p>
 <p>We have two kinds of <em>Entry</em> in the <em>API</em>,
depending on the presence of a <em>SchemaManager</em> in the <em>Entry</em>,
or not.</p>
 <p>We also provide a few extended classes, like the <em>ImmutableEntry</em>,
an immutable version of the <em>Entry</em>.</p>
-<h2 id="what-is-an-entry">What is an entry ?<a class="headerlink" href="#what-is-an-entry"
title="Permanent link">&para;</a></h2>
-<p>An entry is an object containing a <em>Dn</em> and some <em>Attributes</em>.
The following schema shows what's inside an <em>entry</em> :</p>
+<h2 id="what-an-entry">What an entry?<a class="headerlink" href="#what-an-entry"
title="Permanent link">&para;</a></h2>
+<p>An entry is an object containing a <em>Dn</em> and some <em>Attributes</em>.
The following schema shows what's inside an <em>entry</em>:</p>
 <p><img alt="" src="images/entry.png" /></p>
 <h2 id="creating-an-entry">Creating an Entry<a class="headerlink" href="#creating-an-entry"
title="Permanent link">&para;</a></h2>
-<p>We have many ways to create an <em>Entry</em>. Basically, an <em>Entry</em>
has a <em>Dn</em> and some <em>Attributes</em>. It can be schema aware,
or not. We provide constructors to allow a user to create the kind of <em>Entry</em>
he wants.</p>
+<p>We have many ways to create an <em>Entry</em>. Basically, an <em>Entry</em>
has a <em>Dn</em> and some <em>Attributes</em>. It can be schema aware,
or not. We provide constructors to allow a user to create the kind of <em>Entry</em>
wanted.</p>
 <p>The simplest way to create an <em>Entry</em> is to call the default
constructor. The created entry will have no attributes, and no <em>Dn</em>. We
can also make it schema aware by passing a <em>SchemaManager</em>. Here is an
example:</p>
 <div class="codehilite"><pre><span class="n">Entry</span> <span
class="n">entry</span> <span class="o">=</span> <span class="k">new</span>
<span class="n">DefaultEntry</span><span class="o">();</span>
 
@@ -239,7 +239,7 @@ h2:hover > .headerlink, h3:hover > .head
 </pre></div>
 
 
-<p>Last, not least, it's possible to create an <em>Entry</em> using a list
of LDIF formated attributes. An example worth ten lines of documentation, so let's see what
it means.</p>
+<p>Last, but not least, it's possible to create an <em>Entry</em> using
a list of LDIF formated attributes. An example worth ten lines of documentation, so let's
see what it means.</p>
 <p>First, we will create a schema agnostic entry:</p>
 <div class="codehilite"><pre><span class="n">Entry</span> <span
class="n">entry</span> <span class="o">=</span> <span class="k">new</span>
<span class="n">DefaultEntry</span><span class="o">(</span> 
     <span class="s">&quot;dc=example, dc=com&quot;</span><span class="o">,</span>
@@ -288,7 +288,7 @@ h2:hover > .headerlink, h3:hover > .head
 <h2 id="modifying-an-entry">Modifying an Entry<a class="headerlink" href="#modifying-an-entry"
title="Permanent link">&para;</a></h2>
 <p>We have six methods available that modify the <em>Entry</em> content
: <em>add</em>, <em>clear</em>, <em>put</em>, <em>remove</em>,
<em>removeAttribute</em> and <em>setDn</em>. We will review six four
methods in the following paragraphs.</p>
 <h3 id="adding-attributes">Adding Attributes<a class="headerlink" href="#adding-attributes"
title="Permanent link">&para;</a></h3>
-<p>Two methods can be used to add some attribute into an <em>Entry</em>.
The first one will add a complete <em>Attribute</em>, the second one will add
some values to an existing <em>Attribute</em>.</p>
+<p>Two methods can be used to add attribute into an <em>Entry</em>. The
first one will add a completed <em>Attribute</em>, the second one will add some
values into an existing <em>Attribute</em>.</p>
 <p>In any case, we can add either an empty attribute, or an attribute with some values.
Those values can be <em>Strings</em>, <em>byte[]</em> or <em>Values</em>.
The added attributes can be schema aware, and we can also provide a user provided name for
the attribute type.</p>
 <h5 id="add-methods">add() methods<a class="headerlink" href="#add-methods" title="Permanent
link">&para;</a></h5>
 <p>The first method makes it possible to add some existing <em>Attribute</em>
to an <em>Entry</em>. Let's see how it works:</p>
@@ -348,7 +348,7 @@ h2:hover > .headerlink, h3:hover > .head
 </pre></div>
 
 
-<p>As you can see, there is no real difference between those two methods, except that
we pass the <em>schemaManager</em> in the first one.</p>
+<p>As you can see, there is no real difference between those two methods, except that
we pass the <em>schemaManager</em> into the first one.</p>
 <h5 id="put-methods">put() methods<a class="headerlink" href="#put-methods" title="Permanent
link">&para;</a></h5>
 <p>The big difference with the <em>add</em> method is that the attribute
is not added, it will replace an existing one. let's see with an example :</p>
 <div class="codehilite"><pre><span class="n">Entry</span> <span
class="n">entry</span> <span class="o">=</span> <span class="k">new</span>
<span class="n">DefaultEntry</span><span class="o">(</span> 
@@ -368,7 +368,7 @@ h2:hover > .headerlink, h3:hover > .head
 
 <h3 id="removing-attributes">Removing Attributes<a class="headerlink" href="#removing-attributes"
title="Permanent link">&para;</a></h3>
 <p>We can remove either an attribute having a specific value, or an entire attribute.
In order to remove a complete attribute, you just have to provide the attribute's name, and
use the <em>removeAttributes</em> method.</p>
-<p>Here are some example for both usages :</p>
+<p>Here are examples for both usages :</p>
 <div class="codehilite"><pre><span class="n">Entry</span> <span
class="n">entry</span> <span class="o">=</span> <span class="k">new</span>
<span class="n">DefaultEntry</span><span class="o">(</span> 
     <span class="n">schemaManager</span><span class="o">,</span>
     <span class="s">&quot;dc=example, dc=com&quot;</span><span class="o">,</span>
@@ -390,7 +390,7 @@ h2:hover > .headerlink, h3:hover > .head
 <h3 id="storing-a-dn">Storing a Dn<a class="headerlink" href="#storing-a-dn" title="Permanent
link">&para;</a></h3>
 <p>It's also possible to store a new <em>Dn</em> into the Entry, using
the <em>setDn() method. It will replace an existing _Dn</em> This method takes
either a <em>Dn</em> instance, or a <em>String</em> representing a
valid <em>Dn</em>.</p>
 <h3 id="clearing-the-entry">Clearing the Entry<a class="headerlink" href="#clearing-the-entry"
title="Permanent link">&para;</a></h3>
-<p>You can remove all the <em>Attribute</em> from the entry, using the
<em>clear()</em> method :</p>
+<p>You can remove all the <em>Attribute_s from the entry, using the _clear()</em>
method :</p>
 <div class="codehilite"><pre><span class="n">Entry</span> <span
class="n">entry</span> <span class="o">=</span> <span class="k">new</span>
<span class="n">DefaultEntry</span><span class="o">(</span> 
     <span class="n">schemaManager</span><span class="o">,</span>
     <span class="s">&quot;dc=example, dc=com&quot;</span><span class="o">,</span>
@@ -408,7 +408,7 @@ h2:hover > .headerlink, h3:hover > .head
 
 <p>The <em>Dn</em> will still be around though.</p>
 <h2 id="attribute-data-access-methods">Attribute data access methods<a class="headerlink"
href="#attribute-data-access-methods" title="Permanent link">&para;</a></h2>
-<p>The <em>API</em> provides convenient methods to access the <em>Entry</em>
content, and to check if it contains some attributes or some values. We will shortly expose
those methods in the following paragraphs.</p>
+<p>The <em>API</em> provides convenient methods to access the <em>Entry</em>
content, and to check if it contains some attributes or some values. We will show these methods
in the paragraphs that follow.</p>
 <h3 id="contains-method">Contains method<a class="headerlink" href="#contains-method"
title="Permanent link">&para;</a></h3>
 <p>The <em>contains</em> and <em>containsAttributes</em> methods
check that the <em>Entry</em> contains <em>Attributes</em> and <em>values</em>.</p>
 <p>One can check for the existence of a specific value for a given attribute, or even
for multiple values for a specific attribute. Let's see the <em>contains</em>
method in action:</p>
@@ -514,7 +514,7 @@ h2:hover > .headerlink, h3:hover > .head
 <h4 id="size">size()<a class="headerlink" href="#size" title="Permanent link">&para;</a></h4>
 <p>Returns the number of <em>Attribute</em> stored in the <em>Entry</em>.</p>
 <h4 id="equalsobject">equals(Object)<a class="headerlink" href="#equalsobject" title="Permanent
link">&para;</a></h4>
-<p>Check if two <em>Entries</em> are equal or not. It's important to understand
that depending on whether the entry is schema aware or not, the comparison will be processed
differently. Typically, the attribute's name must be equals when they have been trimmed and
lower cased if the entry is not schema aware, and we can't compare an attribute named 'cn'
with another one named '2.5.4.3' in this case (the <em>Entry</em> must be schema
aware to allow such comparison). More important, the values <em>must</em> be identical
(same casing, same spaces) in this case.
+<p>Check if two <em>Entries</em> are equal or not. It's important to understand
that depending on whether the entry is schema aware or not, the comparison will be processed
differently. Typically, the attribute's name must be equivilent after being trimmed and set
to lowercase.  If the entry is not schema aware, and we can't compare an attribute named 'cn'
with another one named '2.5.4.3' in this case (the <em>Entry</em> must be schema
aware to allow such comparison). More important, the values <em>must</em> be identical
(same casing, same spaces) in this case.
 The attribute's values order is irrelevant.</p>
 <p>Here are one example with a schema agnostic <em>Entry</em>:</p>
 <div class="codehilite"><pre><span class="n">Entry</span> <span
class="n">entry</span> <span class="o">=</span> <span class="k">new</span>
<span class="n">DefaultEntry</span><span class="o">(</span> 

Modified: websites/staging/directory/trunk/content/api/user-guide/6.27-oid.html
==============================================================================
--- websites/staging/directory/trunk/content/api/user-guide/6.27-oid.html (original)
+++ websites/staging/directory/trunk/content/api/user-guide/6.27-oid.html Sat Dec 31 17:32:52
2016
@@ -185,7 +185,7 @@
 h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover
> .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink
{ visibility: visible }</style>
 <h1 id="627-oid">6.27 - Oid<a class="headerlink" href="#627-oid" title="Permanent
link">&para;</a></h1>
 <h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent
link">&para;</a></h2>
-<p>An <em>OID</em> stands for <em>Object</em> <em>ID</em>entifier.
It's a part of the <em>ASN/1</em>  standard. Basically, it's a hierarchy, named
a 'registration tree'. It's a list of 'arcs', which values start at '0', and each arc is separated
with a dot ( '.' ).</p>
+<p>An <em>OID</em> stands for <em>Object</em> <em>ID</em>entifier.
It's part of the <em>ASN/1</em>  standard. Basically, it's a hierarchy, named
a 'registration tree'. It's a list of 'arcs', which values start at '0', and each arc is separated
with a dot ( '.' ).</p>
 <p>There are three defined root arcs :</p>
 <div class="codehilite"><pre><span class="o">*</span> <span class="n">itu</span><span
class="o">-</span><span class="n">t</span> <span class="p">(</span>0<span
class="p">)</span>
 <span class="o">*</span> <span class="n">iso</span> <span class="p">(</span>1<span
class="p">)</span>
@@ -193,20 +193,20 @@ h2:hover > .headerlink, h3:hover > .head
 </pre></div>
 
 
-<p>There is some places on the internet where one can have a look at the existing OIDs.
Here is one : <a href="http://www.oid-info.com/cgi-bin/display?tree=&amp;see=all">OID
repository</a>.</p>
+<p>There are some places on the internet where one can look at the existing OIDs. Here
is one: <a href="http://www.oid-info.com/cgi-bin/display?tree=&amp;see=all">OID
repository</a>.</p>
 <h2 id="syntax">Syntax<a class="headerlink" href="#syntax" title="Permanent link">&para;</a></h2>
-<p>The OID syntax is pretty simple : some numbers with dots between them, like 0.1.245</p>
-<p>There are a few extra rules :</p>
+<p>The OID syntax is pretty simple.  Numbers are separated with periods between them,
e.g. 0.1.245</p>
+<p>There are a few extra rules:</p>
 <div class="codehilite"><pre><span class="o">*</span> <span class="n">The</span>
<span class="n">first</span> <span class="n">number</span> <span
class="n">must</span> <span class="n">be</span> 0<span class="p">,</span>
1 <span class="n">or</span> 2
 <span class="o">*</span> <span class="n">If</span> <span class="n">it</span><span
class="o">&#39;</span><span class="n">s</span> 0 <span class="n">or</span>
1<span class="p">,</span> <span class="n">then</span> <span class="n">the</span>
<span class="n">second</span> <span class="n">number</span> <span
class="n">must</span> <span class="n">be</span> <span class="n">between</span>
0 <span class="n">and</span> 39
-<span class="o">*</span> <span class="n">A</span> <span class="nb">dot</span>
<span class="n">must</span> <span class="n">be</span> <span class="n">preceded</span>
<span class="n">and</span> <span class="n">followed</span> <span
class="n">by</span> <span class="n">a</span> <span class="n">number</span>
-<span class="o">*</span> <span class="n">A</span> 0 <span class="n">at</span>
<span class="n">first</span> <span class="n">position</span> <span
class="n">is</span> <span class="n">never</span> <span class="n">followed</span>
<span class="n">by</span> <span class="n">any</span> <span class="n">other</span>
<span class="n">digit</span>
-<span class="o">*</span> <span class="n">There</span> <span class="n">is</span>
<span class="n">no</span> <span class="n">limit</span> <span class="k">for</span>
<span class="n">the</span> <span class="n">number</span> <span
class="n">of</span> <span class="n">digits</span> <span class="k">otherwise</span>
<span class="p">:</span> 2<span class="p">.</span>25<span class="p">.</span>81407072025111374527560065493494091452
<span class="n">is</span> <span class="n">legit</span>
+<span class="o">*</span> <span class="n">A</span> <span class="n">period</span>
<span class="n">must</span> <span class="n">be</span> <span class="n">preceded</span>
<span class="n">and</span> <span class="n">followed</span> <span
class="n">by</span> <span class="n">a</span> <span class="n">number</span>
+<span class="o">*</span> <span class="n">A</span> 0 <span class="n">at</span>
<span class="n">first</span> <span class="n">position</span> <span
class="n">is</span> <span class="n">never</span> <span class="n">followed</span>
<span class="n">by</span> <span class="n">another</span> <span
class="n">digit</span>
+<span class="o">*</span> <span class="n">There</span> <span class="n">is</span>
<span class="n">no</span> <span class="n">limit</span> <span class="k">for</span>
<span class="n">the</span> <span class="n">number</span> <span
class="n">of</span> <span class="n">digits</span><span class="p">.</span>
 <span class="n">For</span> <span class="n">example</span><span
class="p">,</span> 2<span class="p">.</span>25<span class="p">.</span>81407072025111374527560065493494091452<span
class="p">,</span> <span class="n">is</span> <span class="n">a</span>
<span class="n">legitimate</span> <span class="n">OID</span> <span
class="n">value</span><span class="p">.</span>
 </pre></div>
 
 
 <h2 id="api">API<a class="headerlink" href="#api" title="Permanent link">&para;</a></h2>
-<p>The <em>Apache LDAP API</em> offers a few functions which can be used
to manipulate an OID. In any case, we don't have a constructor for an OID.</p>
+<p>The <em>Apache LDAP API</em> offers a few functions that can be used
to manipulate an OID. In any case, there is not a constructor for an OID.</p>
 <p>The class to use is <em>org.apache.directory.api.asn1.util.Oid</em>.
It creates immutable instances.</p>
 <h3 id="static-oid-frombytes-byte">static Oid fromBytes( byte[] )<a class="headerlink"
href="#static-oid-frombytes-byte" title="Permanent link">&para;</a></h3>
 <p>Returns an <em>Oid</em> instance constructed using a <em>byte[]</em>
representing an encoded OID.</p>
@@ -219,7 +219,7 @@ h2:hover > .headerlink, h3:hover > .head
 <h3 id="byte-tobytes">byte[] toBytes()<a class="headerlink" href="#byte-tobytes"
title="Permanent link">&para;</a></h3>
 <p>Return the <em>byte[]</em> representation of an <em>Oid</em>
instance.</p>
 <h2 id="oid-parsing">OID parsing<a class="headerlink" href="#oid-parsing" title="Permanent
link">&para;</a></h2>
-<p>We use a <em>FSA</em> (Finite State Automaton) to parse a String to
get an internal representation of an OID. Here is a picture showing the <em>FSA</em>
we are using :</p>
+<p>We use a <em>FSA</em> (Finite State Automaton) to parse a String to
get an internal representation of an OID. Here is a picture showing the <em>FSA</em>
we are using:</p>
 <p><img alt="OID FSA" src="images/OID-state-automaton.png" /></p>
 
 

Modified: websites/staging/directory/trunk/content/api/user-guide/6.35-value.html
==============================================================================
--- websites/staging/directory/trunk/content/api/user-guide/6.35-value.html (original)
+++ websites/staging/directory/trunk/content/api/user-guide/6.35-value.html Sat Dec 31 17:32:52
2016
@@ -184,15 +184,15 @@
 }
 h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover
> .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink
{ visibility: visible }</style>
 <h1 id="635-value">6.35 - Value<a class="headerlink" href="#635-value" title="Permanent
link">&para;</a></h1>
-<p>The <em>Value</em> class is used to store an attribute's value. Such
a value can be either a String or a byte[], depending on the nature of the AttributeType (the
default is that the <em>Value</em> is a String). Each value is associated to an
AttributeType, and is used in an Antry or a DN.</p>
-<p>We can create schema aware <em>Value</em>, or just plain <em>Value</em>.
Having a schema aware <em>Value</em> allows further controls to be made on the
value we inject : its syntax will be checked against the <em>AttributeType</em>
syntax.</p>
+<p>The <em>Value</em> class is used to store an attribute's value. Such
a value can be either a String or a byte[], depending on the nature of the AttributeType (the
default is that the <em>Value</em> is a String). Each value is associated to an
AttributeType, and is used in an Entry or a DN.</p>
+<p>We can create a schema aware <em>Value</em>, or just a plain <em>Value</em>.
Having a schema aware <em>Value</em> allows further controls to be made on the
value injected : its syntax will be checked against the <em>AttributeType</em>
syntax.</p>
 <p><em>Value</em> is also a <em>Externalizable</em> class.</p>
 <p><em>Value</em> instances are immutable.</p>
 <h2 id="creating-a-value">Creating a value<a class="headerlink" href="#creating-a-value"
title="Permanent link">&para;</a></h2>
-<p>There are two ways to create a value :
+<p>There are two ways to create a value:
 - using a constructor
 - using a static factory (useful for deserialization)</p>
-<p>You can create the value passing it an <em>AttributeType</em>, or without
it. Here are the possible constructors :</p>
+<p>You can create the value passing it an <em>AttributeType</em>, or without
it. Here are the possible constructors:</p>
 <p><CENTER>
 | With an AttributeType | Without an attributeType | Description |
 |:-:|:-:|:-:|
@@ -200,9 +200,9 @@ h2:hover > .headerlink, h3:hover > .head
 | Value( AttributeType, String upValue ) | Value( String upValue ) | Creates a Value with
a String content |
 | Value( AttributeType, Value ) | - | Create a new Value from an existing one, applying the
SchemaManager on it |
 </CENTER></p>
-<p>The third constructor is quite specific : as <em>Value</em> is immutable,
it allows you to associate a SchemaManager to a <em>Value</em> instance (creating
a new <em>Value</em> in the process). The new <em>Value</em> instance
will be schema aware.</p>
+<p>The third constructor is quite specific, as <em>Value</em> is immutable,
and it allows you to associate a SchemaManager to a <em>Value</em> instance (creating
a new <em>Value</em> in the process). The new <em>Value</em> instance
will be schema aware.</p>
 <h2 id="operations-on-a-value">Operations on a Value<a class="headerlink" href="#operations-on-a-value"
title="Permanent link">&para;</a></h2>
-<p>You mostly can consult the content of the <em>Value</em>, and its status.
Here is the list of common operations :</p>
+<p>There are ways to consult the content of the <em>Value</em>, and its
status. Here is the list of common operations:</p>
 <p><CENTER>
 | Operation | Description |
 |:-:|:-:|

Modified: websites/staging/directory/trunk/content/api/user-guide/7-requests-responses.html
==============================================================================
--- websites/staging/directory/trunk/content/api/user-guide/7-requests-responses.html (original)
+++ websites/staging/directory/trunk/content/api/user-guide/7-requests-responses.html Sat
Dec 31 17:32:52 2016
@@ -184,17 +184,17 @@
 }
 h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover
> .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink
{ visibility: visible }</style>
 <h1 id="7-requests-and-responses">7 - Requests and Responses (...)<a class="headerlink"
href="#7-requests-and-responses" title="Permanent link">&para;</a></h1>
-<p>We will describe all the Java structure we use for each LDAP message (Requests and
Responses). This can be useful when one want to send a message or process a response, using
all the possible options.</p>
+<p>Here we will describe all the Java structures used to process LDAP message (Requests
and Responses). This can be useful whenever one wants to send a message or process a response,
using all possible options.</p>
 <h2 id="inherited-classes">Inherited classes<a class="headerlink" href="#inherited-classes"
title="Permanent link">&para;</a></h2>
-<p>All the messages inherit from a few classes that are describe here. They gather
the common fields that can be used by most of the specific messages.</p>
+<p>All the messages inherit from a few classes that are described here. They gather
the common fields used across most message types.</p>
 <h3 id="the-message-interface">The Message interface<a class="headerlink" href="#the-message-interface"
title="Permanent link">&para;</a></h3>
-<p>This is the mother of all the hierarchy. A message has a few characteristics that
are available to all the inherited classes :</p>
+<p>This is the parent of the message hierarchy. Every message has a few characteristics
that are available across all of its inherited classes:</p>
 <div class="codehilite"><pre><span class="o">*</span> <span class="n">Id</span>
<span class="p">:</span> <span class="n">the</span> <span class="n">message</span>
<span class="n">ID</span> <span class="n">which</span> <span class="n">is</span>
<span class="n">generated</span> <span class="n">by</span> <span
class="n">the</span> <span class="n">server</span> <span class="n">or</span>
<span class="n">the</span> <span class="n">client</span><span class="p">.</span>
<span class="n">You</span> <span class="n">should</span> <span
class="n">never</span> <span class="n">add</span> <span class="n">it</span>
 <span class="o">*</span> <span class="n">Controls</span> <span
class="p">:</span> <span class="n">The</span> <span class="n">list</span>
<span class="n">of</span> <span class="n">controls</span> <span
class="n">you</span> <span class="n">add</span> <span class="n">to</span>
<span class="n">a</span> <span class="n">request</span> <span class="n">or</span>
<span class="n">that</span> <span class="n">get</span> <span class="n">added</span>
<span class="n">by</span> <span class="n">the</span> <span class="n">response</span>
 </pre></div>
 
 
-<p>Here is the Message interface :</p>
+<p>Here is the Message interface:</p>
 <div class="codehilite"><pre><span class="cm">/**</span>
 <span class="cm"> * Root interface for all LDAP message type interfaces.</span>
 <span class="cm"> * </span>

Modified: websites/staging/directory/trunk/content/api/user-guide/7.1-abandon-request.html
==============================================================================
--- websites/staging/directory/trunk/content/api/user-guide/7.1-abandon-request.html (original)
+++ websites/staging/directory/trunk/content/api/user-guide/7.1-abandon-request.html Sat Dec
31 17:32:52 2016
@@ -184,7 +184,7 @@
 }
 h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover
> .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink
{ visibility: visible }</style>
 <h1 id="71-abandonrequest">7.1 AbandonRequest<a class="headerlink" href="#71-abandonrequest"
title="Permanent link">&para;</a></h1>
-<p>This request is used to tell the server that a given previous request must be abandonned.
The only needed parameter is the <em>ID</em> of the request you want to stop.
</p>
+<p>This request is used to tell the server that a given request (sent previously) has
been abandoned. The only required parameter is the <em>ID</em> field of a request
you want to stop. </p>
 <div class="codehilite"><pre><span class="kd">public</span> <span
class="kd">interface</span> <span class="nc">AbandonRequest</span> <span
class="kd">extends</span> <span class="n">Request</span>
 <span class="o">{</span>
     <span class="cm">/**</span>
@@ -206,21 +206,21 @@ h2:hover > .headerlink, h3:hover > .head
 </pre></div>
 
 
-<p>There are two existing implementations you can use :</p>
+<p>There are two existing implementations that can used:</p>
 <ul>
 <li><em>AbandonRequestImpl</em> : The default implementation.</li>
 <li><em>AbandonRequestDsml</em> : An implementation used when you want
to generate a DSML request</li>
 </ul>
 <p>The <em>AbandonRequest</em> message does not have a response, the abandonned
request will just be stopped.</p>
 <h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&para;</a></h2>
-<p>It's pretty easy. You just have inject the ID of the request you want to abandon
:</p>
+<p>It's pretty easy to do. You just to inject the ID of the request you want to abandon:</p>
 <div class="codehilite"><pre><span class="n">connection</span><span
class="o">.</span><span class="na">abandon</span><span class="o">(</span>
<span class="n">messageId</span> <span class="o">);</span>
 </pre></div>
 
 
-<p>This will interrupt the request which ID is <em>messageId</em>.</p>
+<p>This will interrupt the request whose ID equals <em>messageId</em>.</p>
 <h3 id="adding-some-controls">Adding some controls<a class="headerlink" href="#adding-some-controls"
title="Permanent link">&para;</a></h3>
-<p>You can add a control in the <em>AbandonRequest</em>, as soon as you
create an instance of _AbandonRequestImpl :</p>
+<p>You can add a control in the <em>AbandonRequest</em>, once you create
an instance of _AbandonRequestImpl:</p>
 <div class="codehilite"><pre><span class="n">AbandonRequest</span>
<span class="n">abandonRequest</span> <span class="o">=</span> <span
class="k">new</span> <span class="n">AbandonRequestImpl</span><span
class="o">(</span> <span class="n">messageId</span> <span class="o">);</span>
 
 <span class="c1">// Add your control </span>

Modified: websites/staging/directory/trunk/content/api/user-guide/8-ldap-rfcs.html
==============================================================================
--- websites/staging/directory/trunk/content/api/user-guide/8-ldap-rfcs.html (original)
+++ websites/staging/directory/trunk/content/api/user-guide/8-ldap-rfcs.html Sat Dec 31 17:32:52
2016
@@ -184,7 +184,7 @@
 }
 h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover
> .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink
{ visibility: visible }</style>
 <h1 id="8-ldap-related-rfcs">8 - LDAP Related RFCs<a class="headerlink" href="#8-ldap-related-rfcs"
title="Permanent link">&para;</a></h1>
-<p><strong>LDAP</strong> and <strong>X.500</strong> are specified
through many <strong>RFCs</strong>. Here is the list of available <strong>RFCs</strong>
within some category (there are around 100 RFCs available, some of them are now deprecated,
some other are obsolete.</p>
+<p><strong>LDAP</strong> and <strong>X.500</strong> are specified
through its many <strong>RFCs</strong>. Here is the list of available <strong>RFCs</strong>
by category (there are about 100 RFCs available, some now deprecated, other obsolete.</p>
 <p>This page list all the existing <strong>RFCs</strong>, obsolete or not.</p>
 <p><img alt="" src="../../images/icons/information.gif" /> : Informational</p>
 <p><img alt="" src="../../images/icons/lightbulb.gif" /> : Historic</p>



Mime
View raw message