directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From akaras...@apache.org
Subject svn commit: rev 1423 - incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema
Date Sun, 14 Dec 2003 20:26:54 GMT
Author: akarasulu
Date: Sun Dec 14 12:26:53 2003
New Revision: 1423

Modified:
   incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/AttributeType.java
   incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/ContentRule.java
   incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/DescriptionUtils.java
   incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/MatchingRule.java
   incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/NameForm.java
   incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/Normalizer.java
   incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/ObjectClass.java
   incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/ObjectClassTypeEnum.java
   incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/StructureRule.java
   incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/Syntax.java
   incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/overview.html
   incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/package.html
Log:
interfaces and documentation complete

Modified: incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/AttributeType.java
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/AttributeType.java
(original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/AttributeType.java
Sun Dec 14 12:26:53 2003
@@ -51,7 +51,7 @@
 
 
 /**
- * An attributeType specification.  AttributeType specifications describe the
+ * An attributeType specification.  attributeType specifications describe the
  * nature of attributes within the directory.  The attributeType specification's
  * properties are accessible through this interface.
  * 

Modified: incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/ContentRule.java
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/ContentRule.java
(original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/ContentRule.java
Sun Dec 14 12:26:53 2003
@@ -51,7 +51,7 @@
 
 
 /**
- * A DIT ContentRule specification.  DIT Content Rules identify the content of 
+ * A ditContentRule specification.  ditContentRules identify the content of 
  * entries of a particular structural objectClass.  They specify the AUXILLARY 
  * objectClasses and additional attribute types permitted to appear, or excluded
  * from appearing in entries of the indicated STRUCTURAL objectClass. 

Modified: incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/DescriptionUtils.java
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/DescriptionUtils.java
(original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/DescriptionUtils.java
Sun Dec 14 12:26:53 2003
@@ -167,4 +167,70 @@
     {
         throw new NotImplementedException( "NameFormDescription Syntax" ) ;
     }
+    
+    
+    /**
+     * Generates the ObjectClassDescription for an ObjectClass as defined by the
+     * syntax: 1.3.6.1.4.1.1466.115.121.1.37.
+     * <pre>
+     * ObjectClassDescription = "(" whsp
+     *     numericoid whsp      ; ObjectClass identifier
+     *     [ "NAME" qdescrs ]
+     *     [ "DESC" qdstring ]
+     *     [ "OBSOLETE" whsp ]
+     *     [ "SUP" oids ]       ; Superior ObjectClasses
+     *     [ ( "ABSTRACT" / "STRUCTURAL" / "AUXILIARY" ) whsp ]
+     *                          ; default structural
+     *     [ "MUST" oids ]      ; AttributeTypes
+     *     [ "MAY" oids ]       ; AttributeTypes
+     * whsp ")"
+     * </pre>
+     * @param a_objectClass the ObjectClass to generate a description for
+     * @return the description in the ObjectClassDescription syntax
+     */
+    public String getDescription( ObjectClass a_objectClass )
+    {
+        throw new NotImplementedException( "ObjectClassDescription Syntax" ) ;
+    }
+    
+    
+    /**
+     * Generates the DITStructureRuleDescription for a StructureRule as defined
+     * by the syntax: 1.3.6.1.4.1.1466.115.121.1.17.
+     * <pre>
+     * DITStructureRuleDescription = "(" whsp
+     *     ruleidentifier whsp            ; DITStructureRule identifier
+     *     [ "NAME" qdescrs ]
+     *     [ "DESC" qdstring ]
+     *     [ "OBSOLETE" whsp ]
+     *     "FORM" woid whsp               ; NameForm
+     *     [ "SUP" ruleidentifiers whsp ] ; superior DITStructureRules
+     * ")"
+     * </pre>
+     * @param a_srule the StructureRule to generate a description for
+     * @return the description in the DITStructureRuleDescription syntax
+     */
+    public String getDescription( StructureRule a_srule )
+    {
+        throw new NotImplementedException( "ObjectClassDescription Syntax" ) ;
+    }
+
+
+    /**
+     * Generates the SyntaxDescription for a Syntax as defined by the syntax:
+     * 1.3.6.1.4.1.1466.115.121.1.54.
+     * <pre>
+     * SyntaxDescription = "(" whsp
+     *     numericoid whsp
+     *     [ "DESC" qdstring ]
+     *     whsp ")"
+     * "(" whsp numericoid whsp [ "DESC" qdstring ] whsp ")"
+     * </pre>
+     * @param a_syntax the Syntax to generate a description for
+     * @return the description in the SyntaxDescription syntax
+     */
+    public String getDescription( Syntax a_syntax )
+    {
+        throw new NotImplementedException( "SyntaxDescription Syntax" ) ;
+    }
 }

Modified: incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/MatchingRule.java
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/MatchingRule.java
(original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/MatchingRule.java
Sun Dec 14 12:26:53 2003
@@ -54,9 +54,9 @@
 
 
 /**
- * A matching rule definition.  Matching Rules associate a comparator and a 
+ * A matchingRule definition.  MatchingRules associate a comparator and a 
  * normalizer, forming the basic tools necessary to assert actions against 
- * attribute values.  Matching rules are associated with a specific Syntax 
+ * attribute values.  MatchingRules are associated with a specific Syntax 
  * for the purpose of resolving a normalized form and for comparisons.  
  *
  * @see <a href="http://www.faqs.org/rfcs/rfc2252.html">RFC 2252 Section 4.5</a>

Modified: incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/NameForm.java
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/NameForm.java
(original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/NameForm.java
Sun Dec 14 12:26:53 2003
@@ -51,9 +51,9 @@
 
 
 /**
- * A NameForm description interface.  NameForms define the relationship between 
- * a STRUCTURAL ObjectClass definition and the AttributeTypes allowed to be used
- * for the naming of an Entry of that ObjectClass: it defines which attributes 
+ * A nameForm description.  NameForms define the relationship between a 
+ * STRUCTURAL objectClass definition and the attributeTypes allowed to be used
+ * for the naming of an Entry of that objectClass: it defines which attributes 
  * can be used for the RDN.
  *
  * @see <a href="http://www.faqs.org/rfcs/rfc2252.html">RFC2252 Section 6.22</a>

Modified: incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/Normalizer.java
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/Normalizer.java
(original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/Normalizer.java
Sun Dec 14 12:26:53 2003
@@ -54,8 +54,7 @@
 
 
 /**
- * Normalizes attribute values according to the matching rule used to evaluate 
- * attribute value assertions.
+ * Converts attribute values to a canonical form.
  * 
  * @author <a href="mailto:akarasulu@apache.org">Alex Karasulu</a>
  * @author $LastChangedBy$

Modified: incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/ObjectClass.java
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/ObjectClass.java
(original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/ObjectClass.java
Sun Dec 14 12:26:53 2003
@@ -51,8 +51,10 @@
 
 
 /**
- * An ObjectClass definition.
+ * An objectClass definition.
  *
+ * @see <a href="http://www.faqs.org/rfcs/rfc2252.html">RFC2252 Section 4.4</a>
+ * @see DescriptionUtils#getDescription(ObjectClass)
  * @author <a href="mailto:akarasulu@apache.org">Alex Karasulu</a>
  * @author $LastChangedBy$
  * @version $LastChangedRevision$

Modified: incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/ObjectClassTypeEnum.java
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/ObjectClassTypeEnum.java
(original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/ObjectClassTypeEnum.java
Sun Dec 14 12:26:53 2003
@@ -58,7 +58,7 @@
 
 
 /**
- * Type safe enumerations for an ObjectClasses type.  An ObjectClass type can
+ * Type safe enumerations for an objectClass' type.  An ObjectClass type can
  * be one of the following types:
  * <ul>
  * <li>ABSTRACT</li>

Modified: incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/StructureRule.java
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/StructureRule.java
(original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/StructureRule.java
Sun Dec 14 12:26:53 2003
@@ -51,13 +51,16 @@
 
 
 /**
- * A DIT StructureRule definition.  DIT StructureRules are rules governing the 
+ * A dITStructureRule definition.  dITStructureRules are rules governing the 
  * structure of the DIT by specifying a permitted superior to subordinate entry 
- * relationship.  A structure rule relates a NameForm, and therefore a 
- * STRUCTURAL ObjectClass, to superior structure rules.  This permits entries of
- * the STRUCTURAL ObjectClass identified by the NameForm to exist in the DIT as 
- * subordinates to entries governed by the indicated superior structure rules.
+ * relationship.  A structure rule relates a nameForm, and therefore a 
+ * STRUCTURAL objectClass, to superior dITStructureRules.  This permits entries 
+ * of the STRUCTURAL objectClass identified by the nameForm to exist in the DIT 
+ * as subordinates to entries governed by the indicated superior 
+ * dITStructureRules.
  *
+ * @see <a href="http://www.faqs.org/rfcs/rfc2252.html">RFC2252 Section 6.33</a>
+ * @see DescriptionUtils#getDescription(StructureRule)
  * @author <a href="mailto:akarasulu@apache.org">Alex Karasulu</a>
  * @author $LastChangedBy$
  * @version $LastChangedRevision$

Modified: incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/Syntax.java
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/Syntax.java
(original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/Syntax.java
Sun Dec 14 12:26:53 2003
@@ -51,17 +51,16 @@
 
 
 /**
- * An LDAP and X.500 syntax definition interface.
- * 
- * Each attribute stored in a directory has a defined syntax (i.e. data type) 
- * which constrains the structure and format of its values.  The description 
- * of each syntax specifies how attribute or assertion values conforming to 
- * the syntax are normally represented when transferred in LDAP operations.  
- * This representation is referred to as the LDAP-specific encoding to 
- * distinguish it from other methods of encoding attribute values.
- * 
- * @see <a href="http://www.faqs.org/rfcs/rfc2252.html">RFC 2252</a>
+ * A syntax definition.  Each attribute stored in a directory has a defined 
+ * syntax (i.e. data type) which constrains the structure and format of its 
+ * values.  The description of each syntax specifies how attribute or assertion 
+ * values conforming to the syntax are normally represented when transferred 
+ * in LDAP operations.  This representation is referred to as the LDAP-specific 
+ * encoding to distinguish it from other methods of encoding attribute values.
  * 
+ * @see <a href="http://www.faqs.org/rfcs/rfc2252.html">RFC2252 Section 4.3.3
+ * </a>
+ * @see DescriptionUtils#getDescription(Syntax)
  * @author <a href="mailto:akarasulu@apache.org">Alex Karasulu</a>
  * @author $LastChangedBy$
  * @version $LastChangedRevision$
@@ -103,15 +102,4 @@
      * @return the SyntaxChecker
      */
     SyntaxChecker getSyntaxChecker() ;
-
-    /**
-     * Gets or generates the Syntax Description for this Syntax as defined by 
-     * the Syntax 1.3.6.1.4.1.1466.115.121.1.54.
-     * 
-     * <code>
-     * "(" whsp numericoid whsp [ "DESC" qdstring ] whsp ")"
-     * </code>
-     * @return the Syntax Description
-     */
-    String getSyntaxDescription() ;
 }

Modified: incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/overview.html
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/overview.html
(original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/overview.html
Sun Dec 14 12:26:53 2003
@@ -10,6 +10,11 @@
 	<META NAME="CHANGED" CONTENT="20031214;9310627">
 </HEAD>
 <BODY LANG="en-US" DIR="LTR">
-<P>LDAP and X.500 directories contain schema information.</P>
+<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>

Modified: incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/package.html
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/package.html
(original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/api/src/java/org/apache/eve/schema/package.html
Sun Dec 14 12:26:53 2003
@@ -11,7 +11,11 @@
 </HEAD>
 <BODY LANG="en-US" DIR="LTR">
 <P>
-Schema objects used by the Eve directory server. 
+Contains schema class definitions used by the Eve Directory Server.  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>

Mime
View raw message