You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by bu...@apache.org on 2016/12/31 17:09:13 UTC
svn commit: r1003842 - in /websites/staging/directory/trunk/content: ./
api/user-guide/
Author: buildbot
Date: Sat Dec 31 17:09:13 2016
New Revision: 1003842
Log:
Staging update by buildbot for directory
Modified:
websites/staging/directory/trunk/content/ (props changed)
websites/staging/directory/trunk/content/api/user-guide/4.2.1.9-apacheds-schema-elements.html
websites/staging/directory/trunk/content/api/user-guide/4.2.2-registries.html
websites/staging/directory/trunk/content/api/user-guide/4.2.3-schema-loader.html
websites/staging/directory/trunk/content/api/user-guide/6.1-administrative-point.html
websites/staging/directory/trunk/content/api/user-guide/6.2-administrative-role.html
websites/staging/directory/trunk/content/api/user-guide/6.3-attribute.html
websites/staging/directory/trunk/content/api/user-guide/6.4-attribute-type.html
websites/staging/directory/trunk/content/api/user-guide/6.5-ava.html
Propchange: websites/staging/directory/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Sat Dec 31 17:09:13 2016
@@ -1 +1 @@
-1776795
+1776801
Modified: websites/staging/directory/trunk/content/api/user-guide/4.2.1.9-apacheds-schema-elements.html
==============================================================================
--- websites/staging/directory/trunk/content/api/user-guide/4.2.1.9-apacheds-schema-elements.html (original)
+++ websites/staging/directory/trunk/content/api/user-guide/4.2.1.9-apacheds-schema-elements.html Sat Dec 31 17:09:13 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="4219-apacheds-schema-element">4.2.1.9 - ApacheDS Schema Element<a class="headerlink" href="#4219-apacheds-schema-element" title="Permanent link">¶</a></h1>
-<p>We have defined 3 more schema elements that are needed to use the <strong>SchemaManager</strong> :
-<em> SyntaxChecker : used to check a valu's syntax
+<p>We have defined 3 more schema elements that are needed to use the <strong>SchemaManager</strong>:
+<em> SyntaxChecker : used to check a value's syntax
</em> Normalizer : used to normalize a value before a comparison
-* LdapComparator : yed to compare two values for a given syntax</p>
+* LdapComparator : used to compare two values for a given syntax</p>
<h2 id="syntaxchecker">SyntaxChecker<a class="headerlink" href="#syntaxchecker" title="Permanent link">¶</a></h2>
-<p>This class expose this method :</p>
+<p>This class exposes this method:</p>
<ul>
-<li>isValidSyntax(Object) : tells if the value is correct</li>
+<li>isValidSyntax(Object): tells if the value is correct</li>
</ul>
<h2 id="normalizer">Normalizer<a class="headerlink" href="#normalizer" title="Permanent link">¶</a></h2>
-<p>This class is used to normalize values to a canonical form. This is a process exposed in [RFC4518|https://tools.ietf.org/html/rfc4518]. Basically, each String is passed trhough a 6 steps process :</p>
+<p>This class is used to normalize values into a canonical form. This is a process exposed in [RFC4518|https://tools.ietf.org/html/rfc4518]. Basically, each String is passed trhough a 6-step process:</p>
<ul>
<li>Transcode</li>
<li>Map</li>
@@ -203,20 +203,20 @@ h2:hover > .headerlink, h3:hover > .head
<li>Check Bidi (Bidirectional)</li>
<li>Insignificant Character Handling</li>
</ul>
-<p>This can be done using one of those two methods :</p>
+<p>This can be done using one of these two methods:</p>
<ul>
<li>normalize(String) : normalize a String</li>
<li>normalize(Value<?>) : normalize a Value, which can be a String or a byte[]</li>
</ul>
-<p>This class is used internally when comparing two values, you should not need to use it.</p>
+<p>This class is used internally when comparing two values, but you should not need it.</p>
<h2 id="ldapcomparator">LdapComparator<a class="headerlink" href="#ldapcomparator" title="Permanent link">¶</a></h2>
-<p>This class is used to compare two values which syntax are the same. The methods that does that is :</p>
+<p>This class is used to compare two values whenever their syntax are the same. Here is the method that does it:</p>
<ul>
<li>equals(Object) : says if a value is equal to another one.</li>
</ul>
-<p>Note that has the <strong>LdapComparator</strong> class implements the <strong>Comparator</strong> interface, one can compare two values using the following method :</p>
+<p>Note because the <strong>LdapComparator</strong> class implements the <strong>Comparator</strong> interface, one can compare two values using the following method:</p>
<ul>
-<li>compare( v1, v2 ) : compares two values</li>
+<li>compare( v1, v2 ): compares two values</li>
</ul>
Modified: websites/staging/directory/trunk/content/api/user-guide/4.2.2-registries.html
==============================================================================
--- websites/staging/directory/trunk/content/api/user-guide/4.2.2-registries.html (original)
+++ websites/staging/directory/trunk/content/api/user-guide/4.2.2-registries.html Sat Dec 31 17:09:13 2016
@@ -184,8 +184,8 @@
}
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="422-registries">4.2.2 - Registries<a class="headerlink" href="#422-registries" title="Permanent link">¶</a></h1>
-<p>The <strong>Registries</strong> are the place where all the <strong>SchemaObject</strong>s are stored and retrieved from. It contains a registry per <strong>SchemaObject</strong>, plus a global registry which is used to retreive a <strong>SchemaObject</strong> from its OID (the OID is unique), and a list of the loaded schemas.</p>
-<p>Basically, it's the data center of teh <strong>SchemaManager</strong>. When you call <strong>SchemaManager.getAttributeType( String )</strong>, the <strong>SchemaManager</strong> will look into the <strong>AttributeTypeRegistry</strong> for the <strong>AttributeType</strong> instance associated with the name or OID.</p>
+<p>The <strong>Registries</strong> are the place where all <strong>SchemaObject</strong>s are stored and retrieved from. It contains a registry per <strong>SchemaObject</strong>, plus a global registry which is used to retreive a <strong>SchemaObject</strong> from its OID (the OID is unique), and a list of the loaded schemas.</p>
+<p>Basically, it's the data center of the <strong>SchemaManager</strong>. When you call <strong>SchemaManager.getAttributeType( String )</strong>, the <strong>SchemaManager</strong> will look into the <strong>AttributeTypeRegistry</strong> for the <strong>AttributeType</strong> instance associated with the name or OID.</p>
<p>You usually won't need to manipulate this class at all.</p>
Modified: websites/staging/directory/trunk/content/api/user-guide/4.2.3-schema-loader.html
==============================================================================
--- websites/staging/directory/trunk/content/api/user-guide/4.2.3-schema-loader.html (original)
+++ websites/staging/directory/trunk/content/api/user-guide/4.2.3-schema-loader.html Sat Dec 31 17:09:13 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="423-schemaloader">4.2.3 - SchemaLoader<a class="headerlink" href="#423-schemaloader" title="Permanent link">¶</a></h1>
-<p>The <strong>SchemaLoader</strong> is an utility class used to load a <strong>Schema</strong> into teh <strong>SchemaManager</strong>. It comes in many flavors, depending on the source containing the <strong>Schema</strong>.</p>
+<p>The <strong>SchemaLoader</strong> is a utility class that loads a <strong>Schema</strong> into the <strong>SchemaManager</strong>. It comes in many flavors, depending on the source containing the <strong>Schema</strong>.</p>
<div class="nav">
Modified: websites/staging/directory/trunk/content/api/user-guide/6.1-administrative-point.html
==============================================================================
--- websites/staging/directory/trunk/content/api/user-guide/6.1-administrative-point.html (original)
+++ websites/staging/directory/trunk/content/api/user-guide/6.1-administrative-point.html Sat Dec 31 17:09:13 2016
@@ -185,23 +185,23 @@
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="61-administrativepoint">6.1 - AdministrativePoint<a class="headerlink" href="#61-administrativepoint" title="Permanent link">¶</a></h1>
<DIV class="note" markdown="1">
-Those classes are currently only used by the server. It will be available on the client side later on.
+These classes are currently only used by the server. It will be available on the client side later on.
</DIV>
-<p>An <em>AdministrativePoint</em> is an <em>entry</em> in the <em>DIT</em> which is associated with some <em>AdministrativeArea</em>. In <strong>ApacheDS</strong> we support 4 different kind of roles :</p>
+<p>An <em>AdministrativePoint</em> is an <em>entry</em> in the <em>DIT</em> which is associated with some <em>AdministrativeArea</em>. In <strong>ApacheDS</strong> we support 4 different kind of roles:</p>
<ul>
<li>ACI</li>
<li>Collective Attributes</li>
<li>SubSchema</li>
<li>Triggers</li>
</ul>
-<p>We also have three different kind of <em>AdministrativePoint</em> :</p>
+<p>We also have three different types of _AdministrativePoint_s:</p>
<ul>
<li>Autonomous AdministrativePoint (AAP)</li>
<li>Specific AdministrativePoint (SAP)</li>
<li>Inner AdministrativePoint (IAP)</li>
</ul>
-<p>Each of the roles will come in one of the 3 'flavors' (except the SubSchema whch has only 2 flavors). So we have the following classes :</p>
+<p>Each of the roles comes in one of 3 'flavors' (except the SubSchema whch has only 2 flavors). So we have the following classes:</p>
<ul>
<li>AccessControl<ul>
<li>AccessControlAAP</li>
@@ -227,7 +227,7 @@ Those classes are currently only used by
</ul>
</li>
</ul>
-<p>Any of those classes stores the following informations :</p>
+<p>These classes stores the following information:</p>
<ul>
<li>dn : The DN of the root entry for this administration point.</li>
<li>uuid : The associated entryUUID</li>
Modified: websites/staging/directory/trunk/content/api/user-guide/6.2-administrative-role.html
==============================================================================
--- websites/staging/directory/trunk/content/api/user-guide/6.2-administrative-role.html (original)
+++ websites/staging/directory/trunk/content/api/user-guide/6.2-administrative-role.html Sat Dec 31 17:09:13 2016
@@ -185,17 +185,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="62-administrativerole">6.2 - AdministrativeRole<a class="headerlink" href="#62-administrativerole" title="Permanent link">¶</a></h1>
<DIV class="note" markdown="1">
-Those classes are currently only used by the server. It will be available on the client side later on.
+These classes are currently only used by the server. It will be available on the client side later on.
</DIV>
-<p>The <em>AdministrativeRole</em> structure is a <strong>enum</strong> listing the possible roles we can select for an <em>AdministrativePoint</em>. We currently support 4 different roles :</p>
+<p>The <em>AdministrativeRole</em> structure is a <strong>enum</strong> listing the possible roles we can select for an <em>AdministrativePoint</em>. We currently support 4 different roles:</p>
<ul>
<li>Access Control</li>
<li>Collective Attributes</li>
<li>SubSchema</li>
<li>Triggers</li>
</ul>
-<p>And each of those roles can be combine with their scope :</p>
+<p>And each of those roles can be combine with their scope:</p>
<ul>
<li>AutonomousArea</li>
<li>AccessControlSpecificArea</li>
Modified: websites/staging/directory/trunk/content/api/user-guide/6.3-attribute.html
==============================================================================
--- websites/staging/directory/trunk/content/api/user-guide/6.3-attribute.html (original)
+++ websites/staging/directory/trunk/content/api/user-guide/6.3-attribute.html Sat Dec 31 17:09:13 2016
@@ -184,23 +184,23 @@
}
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="63-attribute">6.3 - Attribute<a class="headerlink" href="#63-attribute" title="Permanent link">¶</a></h1>
-<p>The <em>Attribute</em> class is used to store values associated to an <em>AttributeType</em>. An <em>Entry</em> can contain many <em>Attribute{s</em>, but only one of them is mandatory : the <em>ObjectClass</em> <em>Attribute</em>.</p>
+<p>The <em>Attribute</em> class is used to store values associated with an <em>AttributeType</em>. An <em>Entry</em> can contain many <em>Attribute{s</em>, but only one of them is mandatory: the <em>ObjectClass</em> <em>Attribute</em>.</p>
<p>An <em>Attribute</em> can store zero, one or N values, accordingly to its associated <em>AttributeType</em>, which may allow null values, and which also can forbid muli-values.</p>
-<p>The <em>Attribute</em> has a interned <em>AttributeType</em> which is usually defined using its name. This name is case insensitive, and we can also use the <em>AttributeType</em> <em>OID</em>.</p>
+<p>The <em>Attribute</em> has a internal <em>AttributeType</em> which is usually defined using its name. This name is case insensitive, and we can also use the <em>AttributeType</em> <em>OID</em>.</p>
<h2 id="creating-an-attribute">Creating an Attribute<a class="headerlink" href="#creating-an-attribute" title="Permanent link">¶</a></h2>
-<p>Creating an <em>Attribute</em> is not really a complex operation. Again, we split the API into two categories:</p>
+<p>Creating an <em>Attribute</em> is not complex. Again, we split the API into two categories:</p>
<ul>
<li>the schema agnostic <em>Attributes</em></li>
<li>the schema aware <em>Attributes</em></li>
</ul>
<h3 id="schema-agnostic-attribute">Schema agnostic Attribute<a class="headerlink" href="#schema-agnostic-attribute" title="Permanent link">¶</a></h3>
-<p>If we don't inject a <em>SchemaManager</em> in the constructor, then the <em>Attribute</em> will have no way to control that the <em>AttributeType</em> exists, nor that the <em>Values</em> are valid.</p>
-<p>Let's see how we can create <em>Attributes</em>. Basically, all what you need is to provide the <em>AttributeType</em> as a String, and some <em>Values</em> (it's optional). Here is an example:</p>
+<p>If we don't inject a <em>SchemaManager</em> into the constructor, then the <em>Attribute</em> will have no way to control whether its <em>AttributeType</em> exists, nor that its <em>Values</em> are valid.</p>
+<p>Let's see how we can create <em>Attributes</em>. Basically, all what that needed is to provide the <em>AttributeType</em> as a String, and some <em>Values</em> (that are optional). Here is an example:</p>
<div class="codehilite"><pre><span class="n">Attribute</span> <span class="n">attribute</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DefaultAttribute</span><span class="o">(</span> <span class="s">" CN "</span> <span class="o">);</span>
</pre></div>
-<p>Here, we created an empty <em>Attribute</em>. Note that <em>cn</em> does not allow empty values, but it's not controlled. Also note that the <em>AttributeType</em> is lower cased and trimmed internally.</p>
+<p>Here, we created an empty <em>Attribute</em>. Note that <em>cn</em> does not allow empty values, but it's not enforced. Also note that the <em>AttributeType</em> is lowercase and trimmed internally.</p>
<p>Let's see another example, with some values:</p>
<div class="codehilite"><pre><span class="n">Attribute</span> <span class="n">attribute</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DefaultAttribute</span><span class="o">(</span> <span class="s">" CN "</span><span class="o">,</span> <span class="s">"test"</span><span class="o">,</span> <span class="s">"Test"</span><span class="o">,</span> <span class="s">" test "</span><span class="o">,</span> <span class="s">"test"</span> <span class="o">);</span>
</pre></div>
@@ -217,8 +217,8 @@ h2:hover > .headerlink, h3:hover > .head
</pre></div>
-<p>Same here : values are not duplicated.</p>
-<p>Note that it's not allowed to store a mix of binary and String values in an <em>Attribute</em>:</p>
+<p>Same here: values are not duplicated.</p>
+<p>Note that it's not allowed to store a mix of binary and String values into an <em>Attribute</em>:</p>
<div class="codehilite"><pre><span class="kt">byte</span><span class="o">[]</span> <span class="n">bytes1</span> <span class="o">=</span> <span class="k">new</span> <span class="kt">byte</span><span class="o">[]{</span><span class="mh">0x01</span><span class="o">,</span> <span class="mh">0x02</span><span class="o">};</span>
<span class="n">Attribute</span> <span class="n">attribute</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DefaultAttribute</span><span class="o">(</span> <span class="s">" JpegPhoto "</span><span class="o">,</span> <span class="s">"test"</span><span class="o">,</span> <span class="n">bytes1</span> <span class="o">);</span> <span class="c1">// Does not compile</span>
@@ -226,7 +226,7 @@ h2:hover > .headerlink, h3:hover > .head
<h3 id="schema-aware-attribute">Schema aware Attribute<a class="headerlink" href="#schema-aware-attribute" title="Permanent link">¶</a></h3>
-<p>We can inject a <em>SchemaManager</em> into the <em>Attribute</em> which will allow more control on the values stored into the <em>Attribute</em>. Let's see with some example how it works:</p>
+<p>We can inject a <em>SchemaManager</em> into the <em>Attribute</em> which will allow more control over the values stored within the <em>Attribute</em>. Let's see an example of how this works:</p>
<div class="codehilite"><pre><span class="n">Attribute</span> <span class="n">attribute</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DefaultAttribute</span><span class="o">(</span> <span class="n">atCn</span> <span class="o">);</span>
</pre></div>
@@ -236,11 +236,11 @@ h2:hover > .headerlink, h3:hover > .head
</pre></div>
-<p>The important point here is that the values are all considered equals. The <em>contains</em> method also use the schema to compare the given value with the interned values. Here, with the <em>cn</em> <em>AttributeType</em>, the value is not case sensitive, so <em>"TEST"</em> is considered as an existing value, even if we injected <em>"test"</em>.</p>
+<p>The important point here is that the values are all considered equal. The <em>contains</em> method also uses the schema to compare its given value with the interned values. Here, with the <em>cn</em> <em>AttributeType</em>, the value is not case sensitive, so <em>"TEST"</em> is considered as an existing value, even if we injected <em>"test"</em>.</p>
<h2 id="modifying-an-attribute">Modifying an Attribute<a class="headerlink" href="#modifying-an-attribute" title="Permanent link">¶</a></h2>
-<p>Now that we created an <em>Attribute</em> we would like to add or remove values from it. This is quite easy. We have a set of methods to add or remove values, and depending on the fact the <em>Attribute</em> is schema aware or not, the added values will be checked. </p>
+<p>Now that we created an <em>Attribute</em> we would like to add or remove values from it. This is quite easy. We have a set of methods to add or remove values, and depending on whether the <em>Attribute</em> is schema aware or not, the added values will be checked. </p>
<h3 id="adding-some-value">Adding some value<a class="headerlink" href="#adding-some-value" title="Permanent link">¶</a></h3>
-<p>Here is an example of some value addition into a schema agnostic <em>Attribute</em>, then the same operation into a schema aware <em>Attribute</em>:</p>
+<p>Here is an example of a value addition into a schema agnostic <em>Attribute</em>, then the same operation into a schema aware <em>Attribute</em>:</p>
<div class="codehilite"><pre><span class="n">Attribute</span> <span class="n">attribute</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DefaultAttribute</span><span class="o">(</span> <span class="s">" CN "</span> <span class="o">);</span>
<span class="n">Attribute</span> <span class="n">attributeSA</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DefaultAttribute</span><span class="o">(</span> <span class="n">atCn</span> <span class="o">);</span>
@@ -253,7 +253,7 @@ h2:hover > .headerlink, h3:hover > .head
<p>We can see that the schema aware <em>Attribute</em> just contains only one value after the operation, as the <em>cn</em> attribute type does not allow empty strings.</p>
-<p>There is one important point to understand : when a schema agnostic <em>Attribute</em> is created, it knows nothing about the type of values it will store. Once the first value is added, the <em>Attribute</em> will be typed accordingly to the first value added. Then, we can't anymore add values if it has not the same type. </p>
+<p>There is one important point to understand -- whenever a schema agnostic <em>Attribute</em> is created, it knows nothing about the type of values it will store. Once the first value is added, the <em>Attribute</em> will be typed accordingly to the first value added. Then we can no longer add values that are not of the same type. </p>
<p>If the <em>Attribute</em> is schema aware, it's quite obvious. You won't be able to add a binary value into a Human Readable <em>Attribute</em>.
The following test shows that:</p>
<div class="codehilite"><pre><span class="n">Attribute</span> <span class="n">attribute</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DefaultAttribute</span><span class="o">(</span> <span class="s">" CN "</span> <span class="o">);</span>
@@ -325,9 +325,9 @@ The following test shows that:</p>
<h3 id="getattributetype">getAttributeType()<a class="headerlink" href="#getattributetype" title="Permanent link">¶</a></h3>
<p>Returns the internal <em>AttributeType</em>, if the <em>Attribute</em> is schema aware.</p>
<h3 id="getbytes">getBytes()<a class="headerlink" href="#getbytes" title="Permanent link">¶</a></h3>
-<p>Returns the first value as a <em>byte[]</em>, if the <em>Attribute</em> is not human readable. The user <strong>must</strong> know that the <em>Attribute</em> contains binary values, otherwise he will get an <em>LdapInvalidAttributeValueException</em>.</p>
+<p>Returns the first value as a <em>byte[]</em>, if the <em>Attribute</em> is not human readable. The user <strong>must</strong> know that the <em>Attribute</em> contains binary values, otherwise they will get an <em>LdapInvalidAttributeValueException</em>.</p>
<h3 id="getstring">getString()<a class="headerlink" href="#getstring" title="Permanent link">¶</a></h3>
-<p>Returns the first value as a <em>String</em>, if the <em>Attribute</em> is human readable. The user <strong>must</strong> know that the <em>Attribute</em> contains String values, otherwise he will get an <em>LdapInvalidAttributeValueException</em>.</p>
+<p>Returns the first value as a <em>String</em>, if the <em>Attribute</em> is human readable. The user <strong>must</strong> know that the <em>Attribute</em> contains String values, otherwise they will get an <em>LdapInvalidAttributeValueException</em>.</p>
<h3 id="getid">getId()<a class="headerlink" href="#getid" title="Permanent link">¶</a></h3>
<p>Returns the <em>AttributeType</em> normalized ID. If the <em>Attribute</em> is schema agnostic, it will be the trimmed and lower cased user provided ID, otherwise it will be the <em>AttributeType</em> OID (not the name).</p>
<h3 id="getupid">getUpId()<a class="headerlink" href="#getupid" title="Permanent link">¶</a></h3>
@@ -363,9 +363,9 @@ The following test shows that:</p>
<h3 id="clone">clone()<a class="headerlink" href="#clone" title="Permanent link">¶</a></h3>
-<p>This method create a new instance of an existing attribute. All the values and the attribute type are cloned too and distinct from the original attribute.</p>
+<p>This method creates a new instance of an existing attribute. All of the attribute values along with its attribute type are cloned and distinct from the original attribute.</p>
<h3 id="equals-object">equals( Object )<a class="headerlink" href="#equals-object" title="Permanent link">¶</a></h3>
-<p>Compares two <em>Attributes</em>. All the values are compared and should be present in both attributes. If you compare a schema aware <em>Attribute</em> with a schema agnostic <em>Attribute</em>, they won't be equal.</p>
+<p>Compares two <em>Attributes</em>. All of its values are compared and should be present in both attributes. If you compare a schema aware <em>Attribute</em> with a schema agnostic <em>Attribute</em>, they won't be equal.</p>
<p>Here is a snippet of code demonstrating the <em>equals</em> method:</p>
<div class="codehilite"><pre><span class="n">Attribute</span> <span class="n">attribute1</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DefaultAttribute</span><span class="o">(</span> <span class="n">atCn</span><span class="o">,</span> <span class="s">"test 1"</span><span class="o">,</span> <span class="s">"test 2"</span><span class="o">,</span> <span class="s">"test 3"</span> <span class="o">);</span>
<span class="n">Attribute</span> <span class="n">attribute2</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DefaultAttribute</span><span class="o">(</span> <span class="n">atCn</span><span class="o">,</span> <span class="s">"Test 3"</span><span class="o">,</span> <span class="s">"Test 2 "</span><span class="o">,</span> <span class="s">"Test 1"</span> <span class="o">);</span>
@@ -391,7 +391,7 @@ The following test shows that:</p>
<h3 id="isinstanceof-attributetype">isInstanceOf( AttributeType )<a class="headerlink" href="#isinstanceof-attributetype" title="Permanent link">¶</a></h3>
-<p>Tells if an <em>Attribute</em> derives from a given <em>AttributeType</em>. It can be useful if you have some schema aware <em>Attribute</em> and if you want to know if its attribute type inherit from an other one. Here is an example of usage:</p>
+<p>Tells if an <em>Attribute</em> derives from a given <em>AttributeType</em>. It can be useful if you have a schema aware <em>Attribute</em> and want to know if its attribute type inherits from another one. Here is an example of usage:</p>
<div class="codehilite"><pre><span class="n">Attribute</span> <span class="n">attribute</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DefaultAttribute</span><span class="o">(</span> <span class="n">atCn</span><span class="o">,</span> <span class="s">"test 1"</span><span class="o">,</span> <span class="s">"test 2"</span><span class="o">,</span> <span class="s">"test 3"</span> <span class="o">);</span>
<span class="c1">// Should be true</span>
@@ -425,7 +425,7 @@ The following test shows that:</p>
<h3 id="iterator">iterator()<a class="headerlink" href="#iterator" title="Permanent link">¶</a></h3>
-<p>A convenient way to iterate on all the <em>Attribute</em> values. It makes it possible to use a <em>for ( Value<?> value : attribute )</em> construct. Here is an example using the iterator:</p>
+<p>A convenient way to iterate over all of the <em>Attribute</em> values. It enables the <em>for ( Value<?> value : attribute )</em> construct. Here is an example using the iterator:</p>
<div class="codehilite"><pre><span class="n">Attribute</span> <span class="n">attribute</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DefaultAttribute</span><span class="o">(</span> <span class="n">atCn</span><span class="o">,</span> <span class="s">"test 1"</span><span class="o">,</span> <span class="s">"test 2"</span><span class="o">,</span> <span class="s">"test 3"</span> <span class="o">);</span>
<span class="k">for</span> <span class="o">(</span> <span class="n">Value</span><span class="o"><?></span> <span class="n">value</span> <span class="o">:</span> <span class="n">attribute</span> <span class="o">)</span>
Modified: websites/staging/directory/trunk/content/api/user-guide/6.4-attribute-type.html
==============================================================================
--- websites/staging/directory/trunk/content/api/user-guide/6.4-attribute-type.html (original)
+++ websites/staging/directory/trunk/content/api/user-guide/6.4-attribute-type.html Sat Dec 31 17:09:13 2016
@@ -184,11 +184,11 @@
}
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="64-attributetype">6.4 - AttributeType<a class="headerlink" href="#64-attributetype" title="Permanent link">¶</a></h1>
-<p>The <em>AttributeType</em> is one of the most important schema element. It describes what can be stored into an <em>Entry</em>, its syntax, and the various rules that are to be followed when searching for an associated value.</p>
+<p>The <em>AttributeType</em> is one of the most important schema elements. It describes what can be stored into an <em>Entry</em>, its syntax, and the various rules that are to be followed whenever searching for an associated value.</p>
<p><em>AttributeType</em> are immutable objects, created from the schema, and never changed. One can add a new <em>AttributeType</em>, or delete itfrom the schema, but once it's added to the schema, it can't be modified.</p>
<p>Usually, we just use them. </p>
<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
-<p>An <em>AttributeType</em> contains the following informations :</p>
+<p>An <em>AttributeType</em> contains the following informations:</p>
<table class="table">
<thead>
<tr>
@@ -271,7 +271,7 @@ h2:hover > .headerlink, h3:hover > .head
</tbody>
</table>
<p>An <em>AttributeType</em> has some default elements : it's not OBSOLETE, has no SUP, is not SINGLE-VALUE, is not COLLECTIVE, can be modified by the user, and has an <em>userApplications</em> USAGE.</p>
-<p>You can check some of those elements using the following methods :</p>
+<p>You can check some of those elements using the following methods:</p>
<ul>
<li>isAncestorOf( AttrbuteType ) : tells if the current <em>AttributeType</em> is the ancestor of another one</li>
<li>isCollective() : tells if the current <em>AttributeType</em> is a collective attribute</li>
Modified: websites/staging/directory/trunk/content/api/user-guide/6.5-ava.html
==============================================================================
--- websites/staging/directory/trunk/content/api/user-guide/6.5-ava.html (original)
+++ websites/staging/directory/trunk/content/api/user-guide/6.5-ava.html Sat Dec 31 17:09:13 2016
@@ -165,7 +165,7 @@
</div>
<div class="nav_next">
- <a href="6.6-control.html">6.6 - Control</a>
+ <a href="6.6-csn.html">6.6 - Csn</a>
</div>
<div class="clearfix"></div>
@@ -185,19 +185,19 @@
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="65-ava">6.5 - Ava<a class="headerlink" href="#65-ava" title="Permanent link">¶</a></h1>
<p>An <em>Ava</em> is used to store an <em>Attribute</em> value associated to an <em>AttributeType</em>. </p>
-<p>It describes a container holding an <em>AttributeType</em> associated with a <em>Value</em> in a <em>Rdn</em>. An example would be :</p>
+<p>It describes a container holding an <em>AttributeType</em> associated with a <em>Value</em> in a <em>Rdn</em>. An example would be:</p>
<div class="codehilite"><pre><span class="n">dc</span><span class="o">=</span><span class="n">example</span>
</pre></div>
-<p>where 'dc' is the <em>AttributeType</em> and 'example' the associated value.</p>
+<p>where 'dc' is the <em>AttributeType</em> and 'example' its associated value.</p>
<p>The value can be a binary or a String value, depending on the <em>AttributeType</em>.</p>
-<p>We can create schema aware <em>Ava</em>, or just plain <em>Ava</em>. Having a schema aware <em>Ava</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>Most of the time, one will not have to create or manipulate an <em>Ava</em>, as it's an internal element of a <em>Rdn</em>.</p>
+<p>We can create a schema aware <em>Ava</em>, or just a plain <em>Ava</em>. Having a schema aware <em>Ava</em> allows further controls to be made on the value we inject. Is syntax will be checked against the <em>AttributeType</em> syntax.</p>
+<p>Most of the time, one will not need to create or manipulate an <em>Ava</em>, as it's an internal element of a <em>Rdn</em>.</p>
<p><em>Ava</em> is also a <em>Externalizable</em> class.</p>
<p><em>Ava</em> instances are immutable.</p>
<h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">¶</a></h2>
-<p>As for the <em>Dn</em> and <em>Rdn</em> classes, we have to hold two representation for the interned <em>AttributeType</em> and <em>Value</em> : the User Provided form, and the escaped form (which is used in filters). If the <em>AVA</em> is schema aware, the escaped form will be computed, otherwise we store the user provided form instead. Let's see some examples.</p>
+<p>As for the <em>Dn</em> and <em>Rdn</em> classes, we have to hold two representations of its internal <em>AttributeType</em> and <em>Value</em>. The User Provided form, and the escaped form (which are used inside filters). If the <em>AVA</em> is schema aware, the escaped form will be computed, otherwise we store the user provided form. Let's see some examples.</p>
<h3 id="schema-aware-ava">Schema Aware Ava<a class="headerlink" href="#schema-aware-ava" title="Permanent link">¶</a></h3>
<p>Here we will create an <em>AVA</em> and check that the user provided values are preserved. The <em>getName()</em> and <em>getString()</em> methods will give back this user provided form, in a form that allows it to be used in a Filter.</p>
<div class="codehilite"><pre><span class="n">Ava</span> <span class="n">atav</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Ava</span><span class="o">(</span> <span class="n">schemaManager</span><span class="o">,</span> <span class="s">" CommonName "</span><span class="o">,</span> <span class="s">" This is a TEST "</span> <span class="o">);</span>
@@ -215,7 +215,7 @@ h2:hover > .headerlink, h3:hover > .head
<p><em>{+}Not Schema Aware{+}</em></p>
-<p>The biggest difference in this case is that the <em>AttributeType</em> will not be replaced by its <em>Oid</em>, but instead by a lower cased form of the provided ID. We also escape the leading and trailing spaces in the value.</p>
+<p>The biggest difference in this case is that the <em>AttributeType</em> will not be replaced by its <em>Oid</em>, but instead by a lowercase form of the provided ID. We also escape the leading and trailing spaces in the value.</p>
<p code="code">{code}
public void testAvaSimpleNorm() throws LdapException
{
@@ -239,7 +239,7 @@ public void testAvaSimpleNorm() throws L
</div>
<div class="nav_next">
- <a href="6.6-control.html">6.6 - Control</a>
+ <a href="6.6-csn.html">6.6 - Csn</a>
</div>
<div class="clearfix"></div>