directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r1704247 - /directory/site/trunk/content/api/user-guide/
Date Mon, 21 Sep 2015 10:02:16 GMT
Author: elecharny
Date: Mon Sep 21 10:02:02 2015
New Revision: 1704247

URL: http://svn.apache.org/viewvc?rev=1704247&view=rev
Log:
Some page additions, renaming and changes

Added:
    directory/site/trunk/content/api/user-guide/4.1-schema.mdtext
    directory/site/trunk/content/api/user-guide/4.2-schema-manager.mdtext
      - copied, changed from r1703910, directory/site/trunk/content/api/user-guide/4.1-schema-manager.mdtext
    directory/site/trunk/content/api/user-guide/4.2.1-schema-objects.mdtext
      - copied, changed from r1703910, directory/site/trunk/content/api/user-guide/4.1.1-schema-objects.mdtext
    directory/site/trunk/content/api/user-guide/4.2.1.1-attribute-types.mdtext
      - copied, changed from r1703910, directory/site/trunk/content/api/user-guide/4.1.1.1-attribute-types.mdtext
    directory/site/trunk/content/api/user-guide/4.2.1.2-object-classes.mdtext
      - copied, changed from r1703910, directory/site/trunk/content/api/user-guide/4.1.1.2-object-classes.mdtext
    directory/site/trunk/content/api/user-guide/4.2.1.3-syntaxes.mdtext
      - copied, changed from r1703910, directory/site/trunk/content/api/user-guide/4.1.1.3-syntaxes.mdtext
    directory/site/trunk/content/api/user-guide/4.2.1.4-matching-rules.mdtext
      - copied, changed from r1703910, directory/site/trunk/content/api/user-guide/4.1.1.4-matching-rules.mdtext
    directory/site/trunk/content/api/user-guide/4.2.1.5-dit-content-rules.mdtext
      - copied, changed from r1703910, directory/site/trunk/content/api/user-guide/4.1.1.5-dit-content-rules.mdtext
    directory/site/trunk/content/api/user-guide/4.2.1.6-dit-structure-rules.mdtext
      - copied, changed from r1703910, directory/site/trunk/content/api/user-guide/4.1.1.6-dit-structure-rules.mdtext
    directory/site/trunk/content/api/user-guide/4.2.1.7-matching-rule-uses.mdtext
      - copied, changed from r1703910, directory/site/trunk/content/api/user-guide/4.1.1.7-matching-rule-uses.mdtext
    directory/site/trunk/content/api/user-guide/4.2.1.8-name-forms.mdtext
      - copied, changed from r1703910, directory/site/trunk/content/api/user-guide/4.1.1.8-name-forms.mdtext
    directory/site/trunk/content/api/user-guide/4.2.1.9-apacheds-schema-elements.mdtext
      - copied, changed from r1703910, directory/site/trunk/content/api/user-guide/4.1.1.9-apacheds-schema-elements.mdtext
    directory/site/trunk/content/api/user-guide/4.2.2-registries.mdtext
      - copied, changed from r1703910, directory/site/trunk/content/api/user-guide/4.1.2-registries.mdtext
    directory/site/trunk/content/api/user-guide/4.2.3-schema-loader.mdtext
      - copied, changed from r1703910, directory/site/trunk/content/api/user-guide/4.1.3-schema-loader.mdtext
Removed:
    directory/site/trunk/content/api/user-guide/4.1-schema-manager.mdtext
    directory/site/trunk/content/api/user-guide/4.1.1-schema-manager-introduction.mdtext
    directory/site/trunk/content/api/user-guide/4.1.1-schema-objects.mdtext
    directory/site/trunk/content/api/user-guide/4.1.1.1-attribute-types.mdtext
    directory/site/trunk/content/api/user-guide/4.1.1.2-object-classes.mdtext
    directory/site/trunk/content/api/user-guide/4.1.1.3-syntaxes.mdtext
    directory/site/trunk/content/api/user-guide/4.1.1.4-matching-rules.mdtext
    directory/site/trunk/content/api/user-guide/4.1.1.5-dit-content-rules.mdtext
    directory/site/trunk/content/api/user-guide/4.1.1.6-dit-structure-rules.mdtext
    directory/site/trunk/content/api/user-guide/4.1.1.7-matching-rule-uses.mdtext
    directory/site/trunk/content/api/user-guide/4.1.1.8-name-forms.mdtext
    directory/site/trunk/content/api/user-guide/4.1.1.9-apacheds-schema-elements.mdtext
    directory/site/trunk/content/api/user-guide/4.1.2-registries.mdtext
    directory/site/trunk/content/api/user-guide/4.1.3-schema-loader.mdtext
Modified:
    directory/site/trunk/content/api/user-guide/4-schema-management.mdtext

Modified: directory/site/trunk/content/api/user-guide/4-schema-management.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/4-schema-management.mdtext?rev=1704247&r1=1704246&r2=1704247&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/4-schema-management.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/4-schema-management.mdtext Mon Sep 21 10:02:02
2015
@@ -30,16 +30,17 @@ A LDAP Schema is a complex combinaison o
 
 ## Contents
 
-* [SchemaManager](4.1-schema-manager.html)
-    * [SchemaObjects](4.1.1-schema-objects.html)
-        * [AttributeTypes](4.1.1.1-attribute-types.html)
-        * [ObjectClasses](4.1.1.2-object-classes.html)
-        * [Syntaxes](4.1.1.3-syntaxes.html)
-        * [MatchingRules](4.1.1.4-matching-rules.html)
-        * [DITContentRules](4.1.1.5-dit-content-rules.html)
-        * [DITStructureRules](4.1.1.6-dit-structure-rules.html)
-        * [MatchingRuleUses](4.1.1.7-matching-rule-uses.html)
-        * [NameForms](4.1.1.8-name-forms.html)
-        * [ApacheDS Schema Elements](4.1.1.9-apacheds-schema-elements.html)
-    * [Registries](4.1.2-registries.html)
-    * [SchemaLoader](4.1.3-schema-loader.html)
+* [Schema](4.1-schema.html)
+* [SchemaManager](4.2-schema-manager.html)
+    * [SchemaObjects](4.2.1-schema-objects.html)
+        * [AttributeTypes](4.2.1.1-attribute-types.html)
+        * [ObjectClasses](4.2.1.2-object-classes.html)
+        * [Syntaxes](4.2.1.3-syntaxes.html)
+        * [MatchingRules](4.2.1.4-matching-rules.html)
+        * [DITContentRules](4.2.1.5-dit-content-rules.html)
+        * [DITStructureRules](4.2.1.6-dit-structure-rules.html)
+        * [MatchingRuleUses](4.2.1.7-matching-rule-uses.html)
+        * [NameForms](4.2.1.8-name-forms.html)
+        * [ApacheDS Schema Elements](4.2.1.9-apacheds-schema-elements.html)
+    * [Registries](4.2.2-registries.html)
+    * [SchemaLoader](4.2.3-schema-loader.html)

Added: directory/site/trunk/content/api/user-guide/4.1-schema.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/4.1-schema.mdtext?rev=1704247&view=auto
==============================================================================
--- directory/site/trunk/content/api/user-guide/4.1-schema.mdtext (added)
+++ directory/site/trunk/content/api/user-guide/4.1-schema.mdtext Mon Sep 21 10:02:02 2015
@@ -0,0 +1,27 @@
+Title: 4.1 - Schema
+NavPrev: 4-schema.html
+NavPrevText: 4 - Schema Management
+NavUp: 4-schema-management.html
+NavUpText: 4 - Schema Management
+NavNext: 5-ldap-security.html
+NavNextText: 5 - LDAP Security
+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
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+    .
+    http://www.apache.org/licenses/LICENSE-2.0
+    .
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+# 4 - Schema
+
+TODO...
\ No newline at end of file

Copied: directory/site/trunk/content/api/user-guide/4.2-schema-manager.mdtext (from r1703910,
directory/site/trunk/content/api/user-guide/4.1-schema-manager.mdtext)
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/4.2-schema-manager.mdtext?p2=directory/site/trunk/content/api/user-guide/4.2-schema-manager.mdtext&p1=directory/site/trunk/content/api/user-guide/4.1-schema-manager.mdtext&r1=1703910&r2=1704247&rev=1704247&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/4.1-schema-manager.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/4.2-schema-manager.mdtext Mon Sep 21 10:02:02
2015
@@ -1,6 +1,6 @@
-Title: 4.1 - Schema Manager
-NavPrev: 4-schema-management.html
-NavPrevText: 4 - Schema Management
+Title: 4.2 - Schema Manager
+NavPrev: 4.1-schema.html
+NavPrevText: 4.1 - Schema
 NavUp: 4-schema-management.html
 NavUpText: 4 - Schema Management
 NavNext: 5-ldap-security.html
@@ -22,25 +22,25 @@ Notice: Licensed to the Apache Software
     specific language governing permissions and limitations
     under the License.
 
-# 4.1 - Schema Manager
+# 4.2 - Schema Manager
 
 The API and the ApacheDS server have to keep the schema elements available. This is done
through what we call the **SchemaManager**. It hides all the internal structure from the users.
 
 
 ## Contents
 
-* [SchemaObjects](4.1.1-schema-objects.html)
-    * [AttributeTypes](4.1.1.1-attribute-types.html)
-    * [ObjectClasses](4.1.1.2-object-classes.html)
-    * [Syntaxes](4.1.1.3-syntaxes.html)
-    * [MatchingRules](4.1.1.4-matching-rules.html)
-    * [DITContentRules](4.1.1.5-dit-content-rules.html)
-    * [DITStructureRules](4.1.1.6-dit-structure-rules.html)
-    * [MatchingRuleUses](4.1.1.7-matching-rule-uses.html)
-    * [NameForms](4.1.1.8-name-forms.html)
-    * [ApacheDS Schema Elements](4.1.1.9-apacheds-schema-elements.html)
-* [Registries](4.1.2-registries.html)
-* [SchemaLoader](4.1.43-schema-loader.html)
+* [SchemaObjects](4.2.1-schema-objects.html)
+    * [AttributeTypes](4.2.1.1-attribute-types.html)
+    * [ObjectClasses](4.2.1.2-object-classes.html)
+    * [Syntaxes](4.2.1.3-syntaxes.html)
+    * [MatchingRules](4.2.1.4-matching-rules.html)
+    * [DITContentRules](4.2.1.5-dit-content-rules.html)
+    * [DITStructureRules](4.2.1.6-dit-structure-rules.html)
+    * [MatchingRuleUses](4.2.1.7-matching-rule-uses.html)
+    * [NameForms](4.2.1.8-name-forms.html)
+    * [ApacheDS Schema Elements](4.2.1.9-apacheds-schema-elements.html)
+* [Registries](4.2.2-registries.html)
+* [SchemaLoader](4.2.43-schema-loader.html)
 
 ## Introduction
 

Copied: directory/site/trunk/content/api/user-guide/4.2.1-schema-objects.mdtext (from r1703910,
directory/site/trunk/content/api/user-guide/4.1.1-schema-objects.mdtext)
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/4.2.1-schema-objects.mdtext?p2=directory/site/trunk/content/api/user-guide/4.2.1-schema-objects.mdtext&p1=directory/site/trunk/content/api/user-guide/4.1.1-schema-objects.mdtext&r1=1703910&r2=1704247&rev=1704247&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/4.1.1-schema-objects.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/4.2.1-schema-objects.mdtext Mon Sep 21 10:02:02
2015
@@ -1,10 +1,10 @@
-Title: 4.1.1 - Schema Objects
-NavPrev: 4.1-schema-manager.html
-NavPrevText: 4.1 - Schema Manager
-NavUp: 4.1-schema-manager.html
-NavUpText: 4.1 - Schema Manager
-NavNext: 4.1.2-registries.html
-NavNextText: 4.1.2 - Registries
+Title: 4.2.1 - Schema Objects
+NavPrev: 4.2-schema-manager.html
+NavPrevText: 4.2 - Schema Manager
+NavUp: 4.2-schema-manager.html
+NavUpText: 4.2 - Schema Manager
+NavNext: 4.2.2-registries.html
+NavNextText: 4.2.2 - Registries
 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
@@ -22,19 +22,19 @@ Notice: Licensed to the Apache Software
     specific language governing permissions and limitations
     under the License.
 
-# 4.1.2 - Schema Objects
+# 4.2.2 - Schema Objects
 
 ## Content
 
-* [AttributeTypes](4.1.1.1-attribute-types.html)
-* [ObjectClasses](4.1.1.2-object-classes.html)
-* [Syntaxes](4.1.1.3-syntaxes.html)
-* [MatchingRules](4.1.1.4-matching-rules.html)
-* [DITContentRules](4.1.1.5-dit-content-rules.html)
-* [DITStructureRules](4.1.1.6-dit-structure-rules.html)
-* [MatchingRuleUses](4.1.1.7-matching-rule-uses.html)
-* [NameForms](4.1.1.8-name-forms.html)
-* [ApacheDS Schema Elements](4.1.1.9-apacheds-schema-elements.html)
+* [AttributeTypes](4.2.1.1-attribute-types.html)
+* [ObjectClasses](4.2.1.2-object-classes.html)
+* [Syntaxes](4.2.1.3-syntaxes.html)
+* [MatchingRules](4.2.1.4-matching-rules.html)
+* [DITContentRules](4.2.1.5-dit-content-rules.html)
+* [DITStructureRules](4.2.1.6-dit-structure-rules.html)
+* [MatchingRuleUses](4.2.1.7-matching-rule-uses.html)
+* [NameForms](4.2.1.8-name-forms.html)
+* [ApacheDS Schema Elements](4.2.1.9-apacheds-schema-elements.html)
 
 # Introduction
 

Copied: directory/site/trunk/content/api/user-guide/4.2.1.1-attribute-types.mdtext (from r1703910,
directory/site/trunk/content/api/user-guide/4.1.1.1-attribute-types.mdtext)
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/4.2.1.1-attribute-types.mdtext?p2=directory/site/trunk/content/api/user-guide/4.2.1.1-attribute-types.mdtext&p1=directory/site/trunk/content/api/user-guide/4.1.1.1-attribute-types.mdtext&r1=1703910&r2=1704247&rev=1704247&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/4.1.1.1-attribute-types.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/4.2.1.1-attribute-types.mdtext Mon Sep 21
10:02:02 2015
@@ -1,10 +1,10 @@
-Title: 4.1.1.1 - AttributeTypes
-NavPrev: 4.1.1-schema-objects.html
-NavPrevText: 4.1.1 - Schema Objects
-NavUp: 4.1.1-schema-object.html
-NavUpText: 4.1.1 - Schema Objects
-NavNext: 4.1.1.2-object-classes.html
-NavNextText: 4.1.1.2 - ObjectClasses
+Title: 4.2.1.1 - AttributeTypes
+NavPrev: 4.2.1-schema-objects.html
+NavPrevText: 4.2.1 - Schema Objects
+NavUp: 4.2.1-schema-object.html
+NavUpText: 4.2.1 - Schema Objects
+NavNext: 4.2.1.2-object-classes.html
+NavNextText: 4.2.1.2 - ObjectClasses
 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
@@ -22,7 +22,7 @@ Notice: Licensed to the Apache Software
     specific language governing permissions and limitations
     under the License.
 
-# 4.1.1.1 - AttributeTypes
+# 4.2.1.1 - AttributeTypes
 
 The **AttributeType** **SchemaObject** expose some extra parameters. Here is the description
as found in RFC 4512 :
 
@@ -77,3 +77,5 @@ The follwing methods have been added to
 * isSingleValued() : tells if the **AttributeType** only accept single values
 * isUser() : tells if the **AttributeType** is a USER_APPLICATIONS attribute
 * isUserModifiable() : tells if the **AttributeType** is modifiable or not
+
+What is important to know is that an **AttributeType** may inherit some characteristics from
a **SUP** **AttributeType**. For instance, the **Syntax**, **MatchingRules**, etc. In any
case, if you don't define the specific characteristics for a give **AttributeType**, they
will be inherited from its parent, if there is one.

Copied: directory/site/trunk/content/api/user-guide/4.2.1.2-object-classes.mdtext (from r1703910,
directory/site/trunk/content/api/user-guide/4.1.1.2-object-classes.mdtext)
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/4.2.1.2-object-classes.mdtext?p2=directory/site/trunk/content/api/user-guide/4.2.1.2-object-classes.mdtext&p1=directory/site/trunk/content/api/user-guide/4.1.1.2-object-classes.mdtext&r1=1703910&r2=1704247&rev=1704247&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/4.1.1.2-object-classes.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/4.2.1.2-object-classes.mdtext Mon Sep 21 10:02:02
2015
@@ -1,10 +1,10 @@
-Title: 4.1.1.2 - ObjectClasses
-NavPrev: 4.1.1.1-attribute-types.html
-NavPrevText: 4.1.1.1 - AttributeTypes
-NavUp: 4.1.1-schema-objects.html
-NavUpText: 4.1.1 - Schema Objects
-NavNext: 4.1.2.3-syntaxes.html
-NavNextText: 4.1.1.3 - Syntaxes
+Title: 4.2.1.2 - ObjectClasses
+NavPrev: 4.2.1.1-attribute-types.html
+NavPrevText: 4.2.1.1 - AttributeTypes
+NavUp: 4.2.1-schema-objects.html
+NavUpText: 4.2.1 - Schema Objects
+NavNext: 4.2.2.3-syntaxes.html
+NavNextText: 4.2.1.3 - Syntaxes
 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
@@ -22,4 +22,38 @@ Notice: Licensed to the Apache Software
     specific language governing permissions and limitations
     under the License.
 
-# 4.1.1.2 - ObjectClasses
+# 4.2.1.2 - ObjectClasses
+
+The **ObjectClass** is representing thelist of mandatory and optional **AttributeType**s
+
+Here is the description as found in RFC 4512 :
+
+     ObjectClassDescription = LPAREN WSP
+         numericoid                 ; object identifier
+         [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
+         [ SP "DESC" SP qdstring ]  ; description
+         [ SP "OBSOLETE" ]          ; not active
+         [ SP "SUP" SP oids ]       ; superior object classes
+         [ SP kind ]                ; kind of class
+         [ SP "MUST" SP oids ]      ; attribute types
+         [ SP "MAY" SP oids ]       ; attribute types
+         extensions WSP RPAREN
+
+     kind = "ABSTRACT" / "STRUCTURAL" / "AUXILIARY"
+
+Each **ObjectClass** as a type (ABSTRACT, STRUCTURAL or AUXILIARY) and may inherit from another
**ObjectClass**
+
+The important part of the **ObjectClass** is the **AttributeType** definition : not only
it lists all the **AttributeTypes** defined in itself, but also all the inherited ones. Note
that you may have an optionnal **AttributeType** defined in a parent, which is made mandatory.
+
+The available methods are :
+
+* getMayAttributeTypeOids() : gets the list of optional **AttributeType**s (proper and inherited)
+* getMayAttributeTypes() : gets the list of optional **AttributeType**s' OID(proper and inherited)
+* getMustAttributeTypeOids() : gets the list of mandatory **AttributeType**s' OID (proper
and inherited)
+* getMustAttributeTypes() : gets the list of mandatory **AttributeType**s (proper and inherited)
+* getSuperiorOids() : gets the list of inherited **ObjectClass**es' OIDs (the full hierarchy)
+* getSuperiors() : gets the list of inherited **ObjectClass**es (the full hierarchy)
+* getType() : returns the **ObjectClass** type (one of ABSTRACT, AUXILIARY or STRUCTURAL)
+* isAbstract() : tells if the **ObjectClass* is ABSTRACT.
+* isAuxiliary() : tells if the **ObjectClass* is AUXILIARY.
+* isStructural() : tells if the **ObjectClass* is STRUCTURAL.

Copied: directory/site/trunk/content/api/user-guide/4.2.1.3-syntaxes.mdtext (from r1703910,
directory/site/trunk/content/api/user-guide/4.1.1.3-syntaxes.mdtext)
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/4.2.1.3-syntaxes.mdtext?p2=directory/site/trunk/content/api/user-guide/4.2.1.3-syntaxes.mdtext&p1=directory/site/trunk/content/api/user-guide/4.1.1.3-syntaxes.mdtext&r1=1703910&r2=1704247&rev=1704247&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/4.1.1.3-syntaxes.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/4.2.1.3-syntaxes.mdtext Mon Sep 21 10:02:02
2015
@@ -1,10 +1,10 @@
-Title: 4.1.1.3 - Syntaxes
-NavPrev: 4.1.1.2-object-classes.html
-NavPrevText: 4.1.1.2 - ObjectClasses
-NavUp: 4.1.1-schema-objects.html
-NavUpText: 4.1.1 - Schema Objects
-NavNext: 4.1.1.4-matching-rules.html
-NavNextText: 4.1.1.4 - MatchingRules
+Title: 4.2.1.3 - Syntaxes
+NavPrev: 4.2.1.2-object-classes.html
+NavPrevText: 4.2.1.2 - ObjectClasses
+NavUp: 4.2.1-schema-objects.html
+NavUpText: 4.2.1 - Schema Objects
+NavNext: 4.2.1.4-matching-rules.html
+NavNextText: 4.2.1.4 - MatchingRules
 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
@@ -22,7 +22,7 @@ Notice: Licensed to the Apache Software
     specific language governing permissions and limitations
     under the License.
 
-# 4.1.1.3 - Syntaxes
+# 4.2.1.3 - Syntaxes
 
 The **LdapSyntax** class implements the LDAP **Syntax**s schema objects. A **Syntax** defines
a constraints applied to the **AttributeType** value. Here is the TFC description of a **Syntax**
:
 

Copied: directory/site/trunk/content/api/user-guide/4.2.1.4-matching-rules.mdtext (from r1703910,
directory/site/trunk/content/api/user-guide/4.1.1.4-matching-rules.mdtext)
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/4.2.1.4-matching-rules.mdtext?p2=directory/site/trunk/content/api/user-guide/4.2.1.4-matching-rules.mdtext&p1=directory/site/trunk/content/api/user-guide/4.1.1.4-matching-rules.mdtext&r1=1703910&r2=1704247&rev=1704247&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/4.1.1.4-matching-rules.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/4.2.1.4-matching-rules.mdtext Mon Sep 21 10:02:02
2015
@@ -1,10 +1,10 @@
-Title: 4.1.1.4 - MatchingRules
-NavPrev: 4.1.1.3-syntaxes.html
-NavPrevText: 4.1.1.3 - Syntaxes
-NavUp: 4.1.1-schema-objects.html
-NavUpText: 4.1.1 - Schema Objects
-NavNext: 4.1.1.5-dit-content-rules.html
-NavNextText: 4.1.1.5 - DITContentRules
+Title: 4.2.1.4 - MatchingRules
+NavPrev: 4.2.1.3-syntaxes.html
+NavPrevText: 4.2.1.3 - Syntaxes
+NavUp: 4.2.1-schema-objects.html
+NavUpText: 4.2.1 - Schema Objects
+NavNext: 4.2.1.5-dit-content-rules.html
+NavNextText: 4.2.1.5 - DITContentRules
 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
@@ -22,13 +22,13 @@ Notice: Licensed to the Apache Software
     specific language governing permissions and limitations
     under the License.
 
-# 4.1.1.4 - MatchingRules
+# 4.2.1.4 - MatchingRules
 
 A **MatchingRule** is used when processing a search **Filter** evaluation, or a **Compare**
or **Modify** operation. An **AttributeType** can define up to 3 types of **MatchingRule**
:
 
-* EQUALITY
-* ORDERING
-* SUBSTR
+* EQUALITY : for comparisons for equality
+* ORDERING : for comparisons involving the <= or >= operators
+* SUBSTR : for comparisons involving substrings, like '*xyz' or 'x*z'
 
 There are a few extra parameter that are defined in the **MatchingRule** class :
 
@@ -41,3 +41,5 @@ We also have 2 specific methods that are
 * getNormalizer() : gets the **Normalizer** used to normalize a value
 
 Those are convenient methods, specifically when you will need to compare two values.
+
+A **MatchingRule** instance is associated with a **LdapSyntax** and a **Normalizer** because
it may need to get information about the attribute value check and normalization. It also
contains a reference to the associated **LdapComparator**.

Copied: directory/site/trunk/content/api/user-guide/4.2.1.5-dit-content-rules.mdtext (from
r1703910, directory/site/trunk/content/api/user-guide/4.1.1.5-dit-content-rules.mdtext)
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/4.2.1.5-dit-content-rules.mdtext?p2=directory/site/trunk/content/api/user-guide/4.2.1.5-dit-content-rules.mdtext&p1=directory/site/trunk/content/api/user-guide/4.1.1.5-dit-content-rules.mdtext&r1=1703910&r2=1704247&rev=1704247&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/4.1.1.5-dit-content-rules.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/4.2.1.5-dit-content-rules.mdtext Mon Sep 21
10:02:02 2015
@@ -1,10 +1,10 @@
-Title: 4.1.1.5 - DitContentRules
-NavPrev: 4.1.1.4-matching-rules.html
-NavPrevText: 4.1.1.4 - MatchingRules
-NavUp: 4.1.1-schema-objects.html
-NavUpText: 4.1.1 - SchemaO bjects
-NavNext: 4.1.6-dit-structure-rules.html
-NavNextText: 4.1.6 - DitStructureRules
+Title: 4.2.1.5 - DitContentRules
+NavPrev: 4.2.1.4-matching-rules.html
+NavPrevText: 4.2.1.4 - MatchingRules
+NavUp: 4.2.1-schema-objects.html
+NavUpText: 4.2.1 - SchemaO bjects
+NavNext: 4.2.6-dit-structure-rules.html
+NavNextText: 4.2.6 - DitStructureRules
 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
@@ -22,4 +22,6 @@ Notice: Licensed to the Apache Software
     specific language governing permissions and limitations
     under the License.
 
-# 4.1.1.5 - DitContentRules
+# 4.2.1.5 - DitContentRules
+
+Not yet supported...
\ No newline at end of file

Copied: directory/site/trunk/content/api/user-guide/4.2.1.6-dit-structure-rules.mdtext (from
r1703910, directory/site/trunk/content/api/user-guide/4.1.1.6-dit-structure-rules.mdtext)
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/4.2.1.6-dit-structure-rules.mdtext?p2=directory/site/trunk/content/api/user-guide/4.2.1.6-dit-structure-rules.mdtext&p1=directory/site/trunk/content/api/user-guide/4.1.1.6-dit-structure-rules.mdtext&r1=1703910&r2=1704247&rev=1704247&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/4.1.1.6-dit-structure-rules.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/4.2.1.6-dit-structure-rules.mdtext Mon Sep
21 10:02:02 2015
@@ -1,10 +1,10 @@
-Title: 4.1.1.6 - DitStructureRules
-NavPrev: 4.1.1.5-dit-content-rules.html
-NavPrevText: 4.1.1.5 - DitContentRules
-NavUp: 4.1.1-schema-objects.html
-NavUpText: 4.1.1 - Schema Objects
-NavNext: 4.1.1.7-matching-rule-uses.html
-NavNextText: 4.1.1.7 - MatchingRuleUses
+Title: 4.2.1.6 - DitStructureRules
+NavPrev: 4.2.1.5-dit-content-rules.html
+NavPrevText: 4.2.1.5 - DitContentRules
+NavUp: 4.2.1-schema-objects.html
+NavUpText: 4.2.1 - Schema Objects
+NavNext: 4.2.1.7-matching-rule-uses.html
+NavNextText: 4.2.1.7 - MatchingRuleUses
 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
@@ -22,4 +22,6 @@ Notice: Licensed to the Apache Software
     specific language governing permissions and limitations
     under the License.
 
-# 4.1.1.6 - DitStructureRules
+# 4.2.1.6 - DitStructureRules
+
+Not yet supported...
\ No newline at end of file

Copied: directory/site/trunk/content/api/user-guide/4.2.1.7-matching-rule-uses.mdtext (from
r1703910, directory/site/trunk/content/api/user-guide/4.1.1.7-matching-rule-uses.mdtext)
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/4.2.1.7-matching-rule-uses.mdtext?p2=directory/site/trunk/content/api/user-guide/4.2.1.7-matching-rule-uses.mdtext&p1=directory/site/trunk/content/api/user-guide/4.1.1.7-matching-rule-uses.mdtext&r1=1703910&r2=1704247&rev=1704247&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/4.1.1.7-matching-rule-uses.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/4.2.1.7-matching-rule-uses.mdtext Mon Sep
21 10:02:02 2015
@@ -1,10 +1,10 @@
-Title: 4.1.1.7 - MatchingRuleUses
-NavPrev: 
-NavPrevText: 
-NavUp: 4.1.1-schema-objects.html
-NavUpText: 4.1.1 - Schema Objects
-NavNext: 
-NavNextText: 
+Title: 4.2.1.7 - MatchingRuleUses
+NavPrev: 4.2.1.6-dit-structure-rules.html
+NavPrevText: 4.2.1.6 - DitStructureRules
+NavUp: 4.2.1-schema-objects.html
+NavUpText: 4.2.1 - Schema Objects
+NavNext: 4.2.1.8-name-forms.html
+NavNextText: 4.2.1.8 - NameForms
 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
@@ -22,6 +22,6 @@ Notice: Licensed to the Apache Software
     specific language governing permissions and limitations
     under the License.
 
-# 4.1.1.7 - MatchingRuleUses
-
+# 4.2.1.7 - MatchingRuleUses
 
+Not yet supported...

Copied: directory/site/trunk/content/api/user-guide/4.2.1.8-name-forms.mdtext (from r1703910,
directory/site/trunk/content/api/user-guide/4.1.1.8-name-forms.mdtext)
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/4.2.1.8-name-forms.mdtext?p2=directory/site/trunk/content/api/user-guide/4.2.1.8-name-forms.mdtext&p1=directory/site/trunk/content/api/user-guide/4.1.1.8-name-forms.mdtext&r1=1703910&r2=1704247&rev=1704247&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/4.1.1.8-name-forms.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/4.2.1.8-name-forms.mdtext Mon Sep 21 10:02:02
2015
@@ -1,10 +1,10 @@
-Title: 4.1.1.8 - NameForms
-NavPrev: 4.1.1.7-matching-rule-use.html
-NavPrevText: 4.1.1.7 - Matching Rule Uses
-NavUp: 4.1.1-schema-objects.html
-NavUpText: 4.1.1 - Schema Objects
-NavNext: 4.1.1.9-apacheds-schema-eleemnts.html
-NavNextText: 4.1.1.9 - ApacheDS Schema Elements
+Title: 4.2.1.8 - NameForms
+NavPrev: 4.2.1.7-matching-rule-use.html
+NavPrevText: 4.2.1.7 - Matching Rule Uses
+NavUp: 4.2.1-schema-objects.html
+NavUpText: 4.2.1 - Schema Objects
+NavNext: 4.2.1.9-apacheds-schema-eleemnts.html
+NavNextText: 4.2.1.9 - ApacheDS Schema Elements
 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
@@ -22,4 +22,6 @@ Notice: Licensed to the Apache Software
     specific language governing permissions and limitations
     under the License.
 
-# 4.1.1.8 - NameForms
+# 4.2.1.8 - NameForms
+
+Not yet supported...
\ No newline at end of file

Copied: directory/site/trunk/content/api/user-guide/4.2.1.9-apacheds-schema-elements.mdtext
(from r1703910, directory/site/trunk/content/api/user-guide/4.1.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?p2=directory/site/trunk/content/api/user-guide/4.2.1.9-apacheds-schema-elements.mdtext&p1=directory/site/trunk/content/api/user-guide/4.1.1.9-apacheds-schema-elements.mdtext&r1=1703910&r2=1704247&rev=1704247&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/4.1.1.9-apacheds-schema-elements.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/4.2.1.9-apacheds-schema-elements.mdtext Mon
Sep 21 10:02:02 2015
@@ -1,10 +1,10 @@
-Title: 4.1.1.9 - ApacheDS Schema Element
-NavPrev: 4.1.1.8-name-forms.html
-NavPrevText: 4.1.1.8 - Name Forms
-NavUp: 4.1.1-schema-objects.html
-NavUpText: 4.1.1 - Schema Objects
-NavNext: 4.1.2-registries.html
-NavNextText: 4.1.2 - Registries
+Title: 4.2.1.9 - ApacheDS Schema Element
+NavPrev: 4.2.1.8-name-forms.html
+NavPrevText: 4.2.1.8 - Name Forms
+NavUp: 4.2.1-schema-objects.html
+NavUpText: 4.2.1 - Schema Objects
+NavNext: 4.2.2-registries.html
+NavNextText: 4.2.2 - Registries
 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
@@ -22,4 +22,43 @@ Notice: Licensed to the Apache Software
     specific language governing permissions and limitations
     under the License.
 
-# 4.1.1.9 - AapcheDS Schema Element
+# 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
+* Normalizer : used to normalize a value before a comparison
+* LdapComparator : yed to compare two values for a given syntax
+
+## SyntaxChecker
+
+This class expose this method :
+
+* 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 :
+
+* Transcode
+* Map
+* Normalize
+* Prohibit
+* Check Bidi (Bidirectional)
+* Insignificant Character Handling
+
+This can be done using one of those 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.
+
+## LdapComparator
+
+This class is used to compare two values which syntax are the same. The methods that does
that is :
+
+* 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 :
+
+* compare( v1, v2 ) : compares two values
\ No newline at end of file

Copied: directory/site/trunk/content/api/user-guide/4.2.2-registries.mdtext (from r1703910,
directory/site/trunk/content/api/user-guide/4.1.2-registries.mdtext)
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/4.2.2-registries.mdtext?p2=directory/site/trunk/content/api/user-guide/4.2.2-registries.mdtext&p1=directory/site/trunk/content/api/user-guide/4.1.2-registries.mdtext&r1=1703910&r2=1704247&rev=1704247&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/4.1.2-registries.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/4.2.2-registries.mdtext Mon Sep 21 10:02:02
2015
@@ -1,10 +1,10 @@
-Title: 4.1.2 - Registries
-NavPrev: 4.1.1-schema-object.html
-NavPrevText: 4.1.1 Schema Objects
-NavUp: 4.1-schema-manager.html
-NavUpText: 4.1 - Schema Manager
-NavNext: 4.1.3-schema-loader.html
-NavNextText: 4.1.3 - Schema Loader
+Title: 4.2.2 - Registries
+NavPrev: 4.2.1-schema-objects.html
+NavPrevText: 4.2.1 Schema Objects
+NavUp: 4.2-schema-manager.html
+NavUpText: 4.2 - Schema Manager
+NavNext: 4.2.3-schema-loader.html
+NavNextText: 4.2.3 - Schema Loader
 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
@@ -22,4 +22,10 @@ Notice: Licensed to the Apache Software
     specific language governing permissions and limitations
     under the License.
 
-# 4.1.2 - Registries
+# 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.
+
+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.
+
+You usually won't need to manipulate this class at all.
\ No newline at end of file

Copied: directory/site/trunk/content/api/user-guide/4.2.3-schema-loader.mdtext (from r1703910,
directory/site/trunk/content/api/user-guide/4.1.3-schema-loader.mdtext)
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/4.2.3-schema-loader.mdtext?p2=directory/site/trunk/content/api/user-guide/4.2.3-schema-loader.mdtext&p1=directory/site/trunk/content/api/user-guide/4.1.3-schema-loader.mdtext&r1=1703910&r2=1704247&rev=1704247&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/4.1.3-schema-loader.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/4.2.3-schema-loader.mdtext Mon Sep 21 10:02:02
2015
@@ -1,8 +1,8 @@
-Title: 4.1.3 - SchemaLoader
-NavPrev: 4.1.2-registries.html
-NavPrevText: 4.1.2 - Registries
-NavUp: 4.1-schema-manager.html
-NavUpText: 4.1 - Schema Manager
+Title: 4.2.3 - SchemaLoader
+NavPrev: 4.2.2-registries.html
+NavPrevText: 4.2.2 - Registries
+NavUp: 4.2-schema-manager.html
+NavUpText: 4.2 - Schema Manager
 NavNext: 5-ldap-security.html
 NavNextText: 5 - LDAP Security
 Notice: Licensed to the Apache Software Foundation (ASF) under one
@@ -22,4 +22,6 @@ Notice: Licensed to the Apache Software
     specific language governing permissions and limitations
     under the License.
 
-# 4.1.3 - SchemaLoader
+# 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



Mime
View raw message