You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by sm...@apache.org on 2016/12/31 17:09:06 UTC
svn commit: r1776801 - /directory/site/trunk/content/api/user-guide/
Author: smckinney
Date: Sat Dec 31 17:09:06 2016
New Revision: 1776801
URL: http://svn.apache.org/viewvc?rev=1776801&view=rev
Log:
and more
Modified:
directory/site/trunk/content/api/user-guide/4.2.1.9-apacheds-schema-elements.mdtext
directory/site/trunk/content/api/user-guide/4.2.2-registries.mdtext
directory/site/trunk/content/api/user-guide/4.2.3-schema-loader.mdtext
directory/site/trunk/content/api/user-guide/6.1-administrative-point.mdtext
directory/site/trunk/content/api/user-guide/6.2-administrative-role.mdtext
directory/site/trunk/content/api/user-guide/6.3-attribute.mdtext
directory/site/trunk/content/api/user-guide/6.4-attribute-type.mdtext
directory/site/trunk/content/api/user-guide/6.5-ava.mdtext
Modified: directory/site/trunk/content/api/user-guide/4.2.1.9-apacheds-schema-elements.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/4.2.1.9-apacheds-schema-elements.mdtext?rev=1776801&r1=1776800&r2=1776801&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/4.2.1.9-apacheds-schema-elements.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/4.2.1.9-apacheds-schema-elements.mdtext Sat Dec 31 17:09:06 2016
@@ -24,20 +24,20 @@ Notice: Licensed to the Apache Software
# 4.2.1.9 - ApacheDS Schema Element
-We have defined 3 more schema elements that are needed to use the **SchemaManager** :
-* SyntaxChecker : used to check a valu's syntax
+We have defined 3 more schema elements that are needed to use the **SchemaManager**:
+* SyntaxChecker : used to check a value's syntax
* Normalizer : used to normalize a value before a comparison
-* LdapComparator : yed to compare two values for a given syntax
+* LdapComparator : used to compare two values for a given syntax
## SyntaxChecker
-This class expose this method :
+This class exposes this method:
-* isValidSyntax(Object) : tells if the value is correct
+* isValidSyntax(Object): tells if the value is correct
## Normalizer
-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 :
+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:
* Transcode
* Map
@@ -46,19 +46,19 @@ This class is used to normalize values t
* Check Bidi (Bidirectional)
* Insignificant Character Handling
-This can be done using one of those two methods :
+This can be done using one of these two methods:
* normalize(String) : normalize a String
* normalize(Value<?>) : normalize a Value, which can be a String or a byte[]
-This class is used internally when comparing two values, you should not need to use it.
+This class is used internally when comparing two values, but you should not need it.
## LdapComparator
-This class is used to compare two values which syntax are the same. The methods that does that is :
+This class is used to compare two values whenever their syntax are the same. Here is the method that does it:
* equals(Object) : says if a value is equal to another one.
-Note that has the **LdapComparator** class implements the **Comparator** interface, one can compare two values using the following method :
+Note because the **LdapComparator** class implements the **Comparator** interface, one can compare two values using the following method:
-* compare( v1, v2 ) : compares two values
\ No newline at end of file
+* compare( v1, v2 ): compares two values
Modified: directory/site/trunk/content/api/user-guide/4.2.2-registries.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/4.2.2-registries.mdtext?rev=1776801&r1=1776800&r2=1776801&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/4.2.2-registries.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/4.2.2-registries.mdtext Sat Dec 31 17:09:06 2016
@@ -24,8 +24,8 @@ Notice: Licensed to the Apache Software
# 4.2.2 - Registries
-The **Registries** are the place where all the **SchemaObject**s are stored and retrieved from. It contains a registry per **SchemaObject**, plus a global registry which is used to retreive a **SchemaObject** from its OID (the OID is unique), and a list of the loaded schemas.
+The **Registries** are the place where all **SchemaObject**s are stored and retrieved from. It contains a registry per **SchemaObject**, plus a global registry which is used to retreive a **SchemaObject** from its OID (the OID is unique), and a list of the loaded schemas.
-Basically, it's the data center of teh **SchemaManager**. When you call **SchemaManager.getAttributeType( String )**, the **SchemaManager** will look into the **AttributeTypeRegistry** for the **AttributeType** instance associated with the name or OID.
+Basically, it's the data center of the **SchemaManager**. When you call **SchemaManager.getAttributeType( String )**, the **SchemaManager** will look into the **AttributeTypeRegistry** for the **AttributeType** instance associated with the name or OID.
-You usually won't need to manipulate this class at all.
\ No newline at end of file
+You usually won't need to manipulate this class at all.
Modified: directory/site/trunk/content/api/user-guide/4.2.3-schema-loader.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/4.2.3-schema-loader.mdtext?rev=1776801&r1=1776800&r2=1776801&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/4.2.3-schema-loader.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/4.2.3-schema-loader.mdtext Sat Dec 31 17:09:06 2016
@@ -24,4 +24,4 @@ Notice: Licensed to the Apache Software
# 4.2.3 - SchemaLoader
-The **SchemaLoader** is an utility class used to load a **Schema** into teh **SchemaManager**. It comes in many flavors, depending on the source containing the **Schema**.
\ No newline at end of file
+The **SchemaLoader** is a utility class that loads a **Schema** into the **SchemaManager**. It comes in many flavors, depending on the source containing the **Schema**.
Modified: directory/site/trunk/content/api/user-guide/6.1-administrative-point.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/6.1-administrative-point.mdtext?rev=1776801&r1=1776800&r2=1776801&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/6.1-administrative-point.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/6.1-administrative-point.mdtext Sat Dec 31 17:09:06 2016
@@ -25,23 +25,23 @@ Notice: Licensed to the Apache Software
# 6.1 - AdministrativePoint
<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>
-An _AdministrativePoint_ is an _entry_ in the _DIT_ which is associated with some _AdministrativeArea_. In **ApacheDS** we support 4 different kind of roles :
+An _AdministrativePoint_ is an _entry_ in the _DIT_ which is associated with some _AdministrativeArea_. In **ApacheDS** we support 4 different kind of roles:
* ACI
* Collective Attributes
* SubSchema
* Triggers
-We also have three different kind of _AdministrativePoint_ :
+We also have three different types of _AdministrativePoint_s:
* Autonomous AdministrativePoint (AAP)
* Specific AdministrativePoint (SAP)
* Inner AdministrativePoint (IAP)
-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 :
+Each of the roles comes in one of 3 'flavors' (except the SubSchema whch has only 2 flavors). So we have the following classes:
* AccessControl
* AccessControlAAP
@@ -59,7 +59,7 @@ Each of the roles will come in one of th
* TriggerExecutionSAP
* TriggerExecutionIAP
-Any of those classes stores the following informations :
+These classes stores the following information:
* dn : The DN of the root entry for this administration point.
* uuid : The associated entryUUID
Modified: directory/site/trunk/content/api/user-guide/6.2-administrative-role.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/6.2-administrative-role.mdtext?rev=1776801&r1=1776800&r2=1776801&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/6.2-administrative-role.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/6.2-administrative-role.mdtext Sat Dec 31 17:09:06 2016
@@ -25,17 +25,17 @@ Notice: Licensed to the Apache Software
# 6.2 - AdministrativeRole
<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>
-The _AdministrativeRole_ structure is a **enum** listing the possible roles we can select for an _AdministrativePoint_. We currently support 4 different roles :
+The _AdministrativeRole_ structure is a **enum** listing the possible roles we can select for an _AdministrativePoint_. We currently support 4 different roles:
* Access Control
* Collective Attributes
* SubSchema
* Triggers
-And each of those roles can be combine with their scope :
+And each of those roles can be combine with their scope:
* AutonomousArea
* AccessControlSpecificArea
Modified: directory/site/trunk/content/api/user-guide/6.3-attribute.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/6.3-attribute.mdtext?rev=1776801&r1=1776800&r2=1776801&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/6.3-attribute.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/6.3-attribute.mdtext Sat Dec 31 17:09:06 2016
@@ -24,29 +24,29 @@ Notice: Licensed to the Apache Software
# 6.3 - Attribute
-The _Attribute_ class is used to store values associated to an _AttributeType_. An _Entry_ can contain many _Attribute{s_, but only one of them is mandatory : the _ObjectClass_ _Attribute_.
+The _Attribute_ class is used to store values associated with an _AttributeType_. An _Entry_ can contain many _Attribute{s_, but only one of them is mandatory: the _ObjectClass_ _Attribute_.
An _Attribute_ can store zero, one or N values, accordingly to its associated _AttributeType_, which may allow null values, and which also can forbid muli-values.
-The _Attribute_ has a interned _AttributeType_ which is usually defined using its name. This name is case insensitive, and we can also use the _AttributeType_ _OID_.
+The _Attribute_ has a internal _AttributeType_ which is usually defined using its name. This name is case insensitive, and we can also use the _AttributeType_ _OID_.
## Creating an Attribute
-Creating an _Attribute_ is not really a complex operation. Again, we split the API into two categories:
+Creating an _Attribute_ is not complex. Again, we split the API into two categories:
* the schema agnostic _Attributes_
* the schema aware _Attributes_
### Schema agnostic Attribute
-If we don't inject a _SchemaManager_ in the constructor, then the _Attribute_ will have no way to control that the _AttributeType_ exists, nor that the _Values_ are valid.
+If we don't inject a _SchemaManager_ into the constructor, then the _Attribute_ will have no way to control whether its _AttributeType_ exists, nor that its _Values_ are valid.
-Let's see how we can create _Attributes_. Basically, all what you need is to provide the _AttributeType_ as a String, and some _Values_ (it's optional). Here is an example:
+Let's see how we can create _Attributes_. Basically, all what that needed is to provide the _AttributeType_ as a String, and some _Values_ (that are optional). Here is an example:
:::Java
Attribute attribute = new DefaultAttribute( " CN " );
-Here, we created an empty _Attribute_. Note that _cn_ does not allow empty values, but it's not controlled. Also note that the _AttributeType_ is lower cased and trimmed internally.
+Here, we created an empty _Attribute_. Note that _cn_ does not allow empty values, but it's not enforced. Also note that the _AttributeType_ is lowercase and trimmed internally.
Let's see another example, with some values:
@@ -66,9 +66,9 @@ It's possible to store binary values int
Attribute attribute = new DefaultAttribute( " JpegPhoto ", bytes1, bytes2, bytes3 );
-Same here : values are not duplicated.
+Same here: values are not duplicated.
-Note that it's not allowed to store a mix of binary and String values in an _Attribute_:
+Note that it's not allowed to store a mix of binary and String values into an _Attribute_:
:::Java
byte[] bytes1 = new byte[]{0x01, 0x02};
@@ -77,7 +77,7 @@ Note that it's not allowed to store a mi
### Schema aware Attribute
-We can inject a _SchemaManager_ into the _Attribute_ which will allow more control on the values stored into the _Attribute_. Let's see with some example how it works:
+We can inject a _SchemaManager_ into the _Attribute_ which will allow more control over the values stored within the _Attribute_. Let's see an example of how this works:
:::Java
Attribute attribute = new DefaultAttribute( atCn );
@@ -87,15 +87,15 @@ Here, we created an _Attribute_ with a s
:::Java
Attribute attribute = new DefaultAttribute( atCn, "test", "Test", " test " );
-The important point here is that the values are all considered equals. The _contains_ method also use the schema to compare the given value with the interned values. Here, with the _cn_ _AttributeType_, the value is not case sensitive, so _"TEST"_ is considered as an existing value, even if we injected _"test"_.
+The important point here is that the values are all considered equal. The _contains_ method also uses the schema to compare its given value with the interned values. Here, with the _cn_ _AttributeType_, the value is not case sensitive, so _"TEST"_ is considered as an existing value, even if we injected _"test"_.
## Modifying an Attribute
-Now that we created an _Attribute_ 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 _Attribute_ is schema aware or not, the added values will be checked.
+Now that we created an _Attribute_ 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 _Attribute_ is schema aware or not, the added values will be checked.
### Adding some value
-Here is an example of some value addition into a schema agnostic _Attribute_, then the same operation into a schema aware _Attribute_:
+Here is an example of a value addition into a schema agnostic _Attribute_, then the same operation into a schema aware _Attribute_:
:::Java
Attribute attribute = new DefaultAttribute( " CN " );
@@ -110,7 +110,7 @@ Here is an example of some value additio
We can see that the schema aware _Attribute_ just contains only one value after the operation, as the _cn_ attribute type does not allow empty strings.
-There is one important point to understand : when a schema agnostic _Attribute_ is created, it knows nothing about the type of values it will store. Once the first value is added, the _Attribute_ will be typed accordingly to the first value added. Then, we can't anymore add values if it has not the same type.
+There is one important point to understand -- whenever a schema agnostic _Attribute_ is created, it knows nothing about the type of values it will store. Once the first value is added, the _Attribute_ will be typed accordingly to the first value added. Then we can no longer add values that are not of the same type.
If the _Attribute_ is schema aware, it's quite obvious. You won't be able to add a binary value into a Human Readable _Attribute_.
The following test shows that:
@@ -195,11 +195,11 @@ Returns the internal _AttributeType_, if
### getBytes()
-Returns the first value as a _byte[]_, if the _Attribute_ is not human readable. The user **must** know that the _Attribute_ contains binary values, otherwise he will get an _LdapInvalidAttributeValueException_.
+Returns the first value as a _byte[]_, if the _Attribute_ is not human readable. The user **must** know that the _Attribute_ contains binary values, otherwise they will get an _LdapInvalidAttributeValueException_.
### getString()
-Returns the first value as a _String_, if the _Attribute_ is human readable. The user **must** know that the _Attribute_ contains String values, otherwise he will get an _LdapInvalidAttributeValueException_.
+Returns the first value as a _String_, if the _Attribute_ is human readable. The user **must** know that the _Attribute_ contains String values, otherwise they will get an _LdapInvalidAttributeValueException_.
### getId()
@@ -249,11 +249,11 @@ This method removes all the values from
### clone()
-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.
+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.
### equals( Object )
-Compares two _Attributes_. All the values are compared and should be present in both attributes. If you compare a schema aware _Attribute_ with a schema agnostic _Attribute_, they won't be equal.
+Compares two _Attributes_. All of its values are compared and should be present in both attributes. If you compare a schema aware _Attribute_ with a schema agnostic _Attribute_, they won't be equal.
Here is a snippet of code demonstrating the _equals_ method:
@@ -282,7 +282,7 @@ Here is a snippet of code demonstrating
### isInstanceOf( AttributeType )
-Tells if an _Attribute_ derives from a given _AttributeType_. It can be useful if you have some schema aware _Attribute_ and if you want to know if its attribute type inherit from an other one. Here is an example of usage:
+Tells if an _Attribute_ derives from a given _AttributeType_. It can be useful if you have a schema aware _Attribute_ and want to know if its attribute type inherits from another one. Here is an example of usage:
:::Java
Attribute attribute = new DefaultAttribute( atCn, "test 1", "test 2", "test 3" );
@@ -319,7 +319,7 @@ Here is some code that test the differen
### iterator()
-A convenient way to iterate on all the _Attribute_ values. It makes it possible to use a _for ( Value<?> value : attribute )_ construct. Here is an example using the iterator:
+A convenient way to iterate over all of the _Attribute_ values. It enables the _for ( Value<?> value : attribute )_ construct. Here is an example using the iterator:
:::Java
Attribute attribute = new DefaultAttribute( atCn, "test 1", "test 2", "test 3" );
Modified: directory/site/trunk/content/api/user-guide/6.4-attribute-type.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/6.4-attribute-type.mdtext?rev=1776801&r1=1776800&r2=1776801&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/6.4-attribute-type.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/6.4-attribute-type.mdtext Sat Dec 31 17:09:06 2016
@@ -24,7 +24,7 @@ Notice: Licensed to the Apache Software
# 6.4 - AttributeType
-The _AttributeType_ is one of the most important schema element. It describes what can be stored into an _Entry_, its syntax, and the various rules that are to be followed when searching for an associated value.
+The _AttributeType_ is one of the most important schema elements. It describes what can be stored into an _Entry_, its syntax, and the various rules that are to be followed whenever searching for an associated value.
_AttributeType_ are immutable objects, created from the schema, and never changed. One can add a new _AttributeType_, or delete itfrom the schema, but once it's added to the schema, it can't be modified.
@@ -32,7 +32,7 @@ Usually, we just use them.
## Description
-An _AttributeType_ contains the following informations :
+An _AttributeType_ contains the following informations:
| Value | Description | optional |
|---|---|---|
@@ -53,7 +53,7 @@ An _AttributeType_ contains the followin
An _AttributeType_ 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 _userApplications_ USAGE.
-You can check some of those elements using the following methods :
+You can check some of those elements using the following methods:
* isAncestorOf( AttrbuteType ) : tells if the current _AttributeType_ is the ancestor of another one
* isCollective() : tells if the current _AttributeType_ is a collective attribute
Modified: directory/site/trunk/content/api/user-guide/6.5-ava.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/6.5-ava.mdtext?rev=1776801&r1=1776800&r2=1776801&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/6.5-ava.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/6.5-ava.mdtext Sat Dec 31 17:09:06 2016
@@ -3,8 +3,8 @@ NavPrev: 6.4-attribute-type.html
NavPrevText: 6.4 - AttributeType
NavUp: 6-ldap-data-structures.html
NavUpText: 6 - LDAP data structures
-NavNext: 6.6-control.html
-NavNextText: 6.6 - Control
+NavNext: 6.6-csn.html
+NavNextText: 6.6 - Csn
Notice: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -26,18 +26,18 @@ Notice: Licensed to the Apache Software
An _Ava_ is used to store an _Attribute_ value associated to an _AttributeType_.
-It describes a container holding an _AttributeType_ associated with a _Value_ in a _Rdn_. An example would be :
+It describes a container holding an _AttributeType_ associated with a _Value_ in a _Rdn_. An example would be:
:::Java
dc=example
-where 'dc' is the _AttributeType_ and 'example' the associated value.
+where 'dc' is the _AttributeType_ and 'example' its associated value.
The value can be a binary or a String value, depending on the _AttributeType_.
-We can create schema aware _Ava_, or just plain _Ava_. Having a schema aware _Ava_ allows further controls to be made on the value we inject : its syntax will be checked against the _AttributeType_ syntax.
+We can create a schema aware _Ava_, or just a plain _Ava_. Having a schema aware _Ava_ allows further controls to be made on the value we inject. Is syntax will be checked against the _AttributeType_ syntax.
-Most of the time, one will not have to create or manipulate an _Ava_, as it's an internal element of a _Rdn_.
+Most of the time, one will not need to create or manipulate an _Ava_, as it's an internal element of a _Rdn_.
_Ava_ is also a _Externalizable_ class.
@@ -46,7 +46,7 @@ _Ava_ instances are immutable.
## Usage
-As for the _Dn_ and _Rdn_ classes, we have to hold two representation for the interned _AttributeType_ and _Value_ : the User Provided form, and the escaped form (which is used in filters). If the _AVA_ is schema aware, the escaped form will be computed, otherwise we store the user provided form instead. Let's see some examples.
+As for the _Dn_ and _Rdn_ classes, we have to hold two representations of its internal _AttributeType_ and _Value_. The User Provided form, and the escaped form (which are used inside filters). If the _AVA_ is schema aware, the escaped form will be computed, otherwise we store the user provided form. Let's see some examples.
### Schema Aware Ava
@@ -69,7 +69,7 @@ will produce :
*{+}Not Schema Aware{+}*
-The biggest difference in this case is that the _AttributeType_ will not be replaced by its _Oid_, but instead by a lower cased form of the provided ID. We also escape the leading and trailing spaces in the value.
+The biggest difference in this case is that the _AttributeType_ will not be replaced by its _Oid_, but instead by a lowercase form of the provided ID. We also escape the leading and trailing spaces in the value.
{code}
public void testAvaSimpleNorm() throws LdapException
@@ -79,4 +79,4 @@ public void testAvaSimpleNorm() throws L
assertEquals( "commonname=\\ This is a TEST\\ ", atav.getNormName() );
assertEquals( " CommonName = This is a TEST ", atav.getUpName() );
}
-{code}
\ No newline at end of file
+{code}