directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From akaras...@apache.org
Subject svn commit: r431264 - in /directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions: overview.html package.html
Date Sun, 13 Aug 2006 22:44:49 GMT
Author: akarasulu
Date: Sun Aug 13 15:44:49 2006
New Revision: 431264

URL: http://svn.apache.org/viewvc?rev=431264&view=rev
Log:
copying over javadocs from old setup in 1.x

Added:
    directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/overview.html
    directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/package.html

Added: directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/overview.html
URL: http://svn.apache.org/viewvc/directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/overview.html?rev=431264&view=auto
==============================================================================
--- directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/overview.html
(added)
+++ directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/overview.html
Sun Aug 13 15:44:49 2006
@@ -0,0 +1,20 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<HTML>
+<HEAD>
+	<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=windows-1252">
+	<TITLE></TITLE>
+	<META NAME="GENERATOR" CONTENT="OpenOffice.org 1.1.0  (Win32)">
+	<META NAME="AUTHOR" CONTENT="Alex Karasulu">
+	<META NAME="CREATED" CONTENT="20031214;9293611">
+	<META NAME="CHANGEDBY" CONTENT="Alex Karasulu">
+	<META NAME="CHANGED" CONTENT="20031214;9310627">
+</HEAD>
+<BODY LANG="en-US" DIR="LTR">
+<P>
+LDAP and X.500 directories contain schema information.  The classes and
+interfaces defined within this package represent the schema information used to
+constrain the values of attributes, the attributes of entries and the structure
+of the directory information tree.
+</P>
+</BODY>
+</HTML>
\ No newline at end of file

Added: directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/package.html
URL: http://svn.apache.org/viewvc/directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/package.html?rev=431264&view=auto
==============================================================================
--- directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/package.html
(added)
+++ directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/package.html
Sun Aug 13 15:44:49 2006
@@ -0,0 +1,107 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<HTML>
+<BODY LANG="en-US" DIR="LTR">
+<P>
+Contains interfaces and base classes for representing the LDAP schema domain
+model.  We model the following LDAP schema objects:
+</P>
+
+<ul>
+  <li>attributeTypes</li>
+  <li>dITContentRules</li>
+  <li>dItStructureRules</li>
+  <li>matchingRules</li>
+  <li>matchingRuleUses</li>
+  <li>nameForms</li>
+  <li>objectClasses</li>
+  <li>syntaxes</li>
+</ul>
+
+<p>
+An interface is defined for each type of schema object.  All these interfaces
+extend from a common root interface: SchemaObject.  Other interfaces have been
+added to associate some useful behavoir with these objects.  These interfaces
+are listed below:
+</p>
+
+<ul>
+  <li>Normalizer</li>
+  <li>Comparator [from SDK]</li>
+  <li>SyntaxChecker</li>
+</ul>
+
+<p>
+These interfaces are primitive constructs that help define what some schema
+objects like a syntax or a matchingRule is in terms of use.  Namely these
+constructs determine how schema objects are applied.  For example a syntax exists
+not only as an OID to be implemented internally by some directory server.  It
+exists to constrain the values of attributes which are associated with the
+syntax.  This function is defined by the SyntaxChecker interface.  All syntaxes
+have a value checker that can apply the syntax to the value to determine if the
+value is accepted by the syntax.  A SyntaxChecker is nothing but a lexical
+pattern matcher like a regular expression.
+</p>
+
+<p>
+Normalizers and Comparators play an important role in controlling matching and
+hence giving meaning to matchingRules.  They respectively define how values are
+to be reduced to a canonical form and how they are to be compared to match
+filter assertions to values while conducting a search.  This is a very important
+aspect of the directory and unfortunately it is the least understood.  These
+two interfaces give tangible meaning to what a matchingRule is about making a
+matchingRule definition more than just an OID tag or place holder but something
+that can be used.
+</p>
+
+<p>
+The extra interfaces above are not SchemaObjects although they play a critical
+role in defining how schema objects are applied.  SchemaObjects are those that
+you actually get back from a directory server and are part of the protocol.
+Within a server environment the relevant schema objects will have valid
+SyntaxCheckers, Normalizers and Comparators.  However outside of the this
+environment these properties MAY be undefined.   We hope to make it defined
+on the client side as well if desired.
+</p>
+
+
+<p>
+  Here's what the OID of each element means according to [<a href=
+  "http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-11.txt">MODELS
+  </a>]:
+</p>
+
+<table>
+  <tr><th>Schema Description</th><th>Numericoid Description</th></tr>
+  <tr><td>ObjectClass</td>
+    <td>numericoid is object identifier assigned to this object class;</td>
+  </tr>
+  <tr><td>AttributeType</td>
+    <td>numericoid is object identifier assigned to this attribute type;</td>
+  </tr>
+  <tr><td>MatchingRule</td>
+    <td>numericoid is object identifier assigned to this matching rule;</td>
+  </tr>
+  <tr><td>MatchingRuleUse</td>
+    <td>numericoid is the object identifier of the matching rule associated
+      with this matching rule use description; matching rule uses are [0-1]:[1]
+      cardinality with their respective matchingRule.
+    </td>
+  </tr>
+  <tr><td>Syntax</td>
+    <td>numericoid is object identifier assigned to this LDAP syntax;</td>
+  </tr>
+  <tr><td>DitContentRule</td>
+    <td>numericoid is the object identifier of the structural object class
+      associated with this DIT content rule;
+    </td>
+  </tr>
+  <tr><td>DitStructureRule</td>
+    <td>this now something very special and needs further investigation</td>
+  </tr>
+  <tr><td>NameForm</td>
+    <td>numericoid is object identifier which identifies this name form;</td>
+  </tr>
+</table>
+
+</BODY>
+</HTML>
\ No newline at end of file



Mime
View raw message