directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From akaras...@apache.org
Subject svn commit: rev 55064 - incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema
Date Tue, 19 Oct 2004 14:11:16 GMT
Author: akarasulu
Date: Tue Oct 19 07:11:15 2004
New Revision: 55064

Added:
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/AbstractAttributeType.java
      - copied, changed from rev 55043, incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/BaseAttributeType.java
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/AbstractMatchingRule.java
      - copied, changed from rev 55043, incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/BaseMatchingRule.java
Removed:
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/BaseAttributeType.java
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/BaseMatchingRule.java
Modified:
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/AbstractSchemaObject.java
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/AttributeType.java
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/DITContentRule.java
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/DITStructureRule.java
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/DescriptionUtils.java
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/MatchingRule.java
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/MatchingRuleUse.java
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/NameForm.java
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/ObjectClass.java
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/Syntax.java
   incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/package.html
Log:
Commit changes ...

 o finished off changes to follow abstract hierarchy
 o correced javadocs
 o fixed compiler errors due to changes
 o renamed 'Base'XYZ classes to 'Abstract'XYZ classes which are now totally 
   abstract



Copied: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/AbstractAttributeType.java
(from rev 55043, incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/BaseAttributeType.java)
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/BaseAttributeType.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/AbstractAttributeType.java
Tue Oct 19 07:11:15 2004
@@ -27,22 +27,14 @@
  * @author <a href="mailto:directory-dev@incubator.apache.org">Apache Directory Project</a>
  * @version $Rev$
  */
-public class BaseAttributeType extends AbstractSchemaObject implements Serializable, AttributeType
+public abstract class AbstractAttributeType
+    extends AbstractSchemaObject
+    implements Serializable, AttributeType
 {
     // ------------------------------------------------------------------------
     // Specification Attributes 
     // ------------------------------------------------------------------------
 
-    /** the optional superior attributeType */
-    private AttributeType superior;
-    /** the equality matching rule for this attributeType */
-    private MatchingRule equality;
-    /** the substring matching rule for this attributeType */
-    private MatchingRule substr;
-    /** the ordering matching rule for this attributeType */
-    private MatchingRule ordering;
-    /** the syntax for this attributeType */
-    private Syntax syntax;
     /** whether or not this type is single valued */
     private boolean isSingleValue = false;
     /** whether or not this type is a collective attribute */
@@ -65,7 +57,7 @@
      *
      * @param oid the IANA OID number for the attributeType
      */
-    protected BaseAttributeType( String oid )
+    protected AbstractAttributeType( String oid )
     {
         super( oid );
     }
@@ -76,77 +68,45 @@
     // ------------------------------------------------------------------------
 
 
-    public String getOid()
-    {
-        return oid;
-    }
-
-
-    public boolean isObsolete()
-    {
-        return isObsolete;
-    }
-
-
-    public String getSyntaxOid()
-    {
-        return syntax.getOid();
-    }
-
-
+    /**
+     * @see AttributeType#isSingleValue()
+     */
     public boolean isSingleValue()
     {
         return isSingleValue;
     }
 
 
+    /**
+     * @see AttributeType#isCollective()
+     */
     public boolean isCollective()
     {
         return isCollective;
     }
 
+
+    /**
+     * @see AttributeType#isCanUserModify()
+     */
     public boolean isCanUserModify()
     {
         return canUserModify;
     }
 
 
+    /**
+     * @see AttributeType#getUsage()
+     */
     public UsageEnum getUsage()
     {
         return usage;
     }
 
 
-    public AttributeType getSuperior()
-    {
-        return superior;
-    }
-
-
-    public MatchingRule getEquality()
-    {
-        return equality;
-    }
-
-
-    public MatchingRule getOrdering()
-    {
-        return ordering;
-    }
-
-
-    public MatchingRule getSubstr()
-    {
-        return substr;
-    }
-
-
-    public Syntax getSyntax()
-    {
-        return syntax;
-    }
-
-
+    /**
+     * @see AttributeType#getLength()
+     */
     public int getLength()
     {
         return length;
@@ -158,66 +118,58 @@
     // ------------------------------------------------------------------------
 
 
-    protected void setSuperior( AttributeType superior )
-    {
-        this.superior = superior;
-    }
-
-
-    protected void setEquality( MatchingRule equality )
-    {
-        this.equality = equality;
-    }
-
-
-    protected void setSubstr( MatchingRule substr )
-    {
-        this.substr = substr;
-    }
-
-
-    protected void setOrdering( MatchingRule ordering )
-    {
-        this.ordering = ordering;
-    }
-
-
-    protected void setSyntax( Syntax syntax )
-    {
-        this.syntax = syntax;
-    }
-
-
+    /**
+     * Sets whether or not an attribute of this AttributeType single valued or
+     * multi-valued.
+     *
+     * @param singleValue true if its is single valued, false if multi-valued
+     */
     protected void setSingleValue( boolean singleValue )
     {
         isSingleValue = singleValue;
     }
 
 
+    /**
+     * Sets whether or not an attribute of this AttributeType is a collective.
+     *
+     * @param collective true if it is collective, false otherwise
+     */
     protected void setCollective( boolean collective )
     {
         isCollective = collective;
     }
 
 
+    /**
+     * Sets whether or not an attribute of this AttributeType can be modified
+     * by directory users.
+     *
+     * @param canUserModify true if directory users can modify, false otherwise
+     */
     protected void setCanUserModify( boolean canUserModify )
     {
         this.canUserModify = canUserModify;
     }
 
 
-    protected void setObsolete( boolean obsolete )
-    {
-        isObsolete = obsolete;
-    }
-
-
+    /**
+     * The usage class for this attributeType.
+     *
+     * @param usage the way attributes of this AttributeType are used in the DSA
+     */
     protected void setUsage( UsageEnum usage )
     {
         this.usage = usage;
     }
 
 
+    /**
+     * Sets the length limit of this AttributeType based on its associated
+     * syntax.
+     *
+     * @param length the new length to set
+     */
     protected void setLength( int length )
     {
         this.length = length;

Copied: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/AbstractMatchingRule.java
(from rev 55043, incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/BaseMatchingRule.java)
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/BaseMatchingRule.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/AbstractMatchingRule.java
Tue Oct 19 07:11:15 2004
@@ -17,25 +17,16 @@
 package org.apache.ldap.common.schema;
 
 
-import java.util.Comparator;
-
-
 /**
  * The default MatchingRule implementation.
  *
  * @author <a href="mailto:directory-dev@incubator.apache.org">Apache Directory Project</a>
  * @version $Rev$
  */
-public class BaseMatchingRule extends AbstractSchemaObject implements MatchingRule
+public abstract class AbstractMatchingRule extends AbstractSchemaObject
+    implements MatchingRule
 {
-    /** the syntax this matching rule can be applied to */
-    private Syntax syntax;
-    /** comparator used to compare and match values of the associated syntax */
-    private Comparator comparator;
-    /** normalizer used to transform values to a canonical form */
-    private Normalizer normalizer;
 
-    
     // ------------------------------------------------------------------------
     // C O N S T R U C T O R S
     // ------------------------------------------------------------------------
@@ -46,81 +37,8 @@
      * 
      * @param oid the object identifier for this matching rule
      */
-    public BaseMatchingRule( String oid )
+    protected AbstractMatchingRule( String oid )
     {
         super( oid );
-    }
-
-
-    // ------------------------------------------------------------------------
-    // P U B L I C   A C C E S S O R S 
-    // ------------------------------------------------------------------------
-
-    
-    /**
-     * @see org.apache.ldap.common.schema.MatchingRule#getSyntax()
-     */
-    public Syntax getSyntax()
-    {
-        return syntax;
-    }
-
-
-    /**
-     * @see org.apache.ldap.common.schema.MatchingRule#getComparator()
-     */
-    public Comparator getComparator()
-    {
-        return comparator;
-    }
-
-    
-    /**
-     * @see org.apache.ldap.common.schema.MatchingRule#getNormalizer()
-     */
-    public Normalizer getNormalizer()
-    {
-        return normalizer;
-    }
-
-
-    // ------------------------------------------------------------------------
-    // P R O T E C T E D   M U T A T O R S
-    // ------------------------------------------------------------------------
-
-    
-    /**
-     * Sets the syntax this matching rule works with.
-     *
-     * @param syntax the syntax this matching rule is applicable to
-     */
-    protected void setSyntax( Syntax syntax )
-    {
-        this.syntax = syntax;
-    }
-
-
-    /**
-     * Sets the Comparator this MatchingRule uses for values of the associated
-     * Syntax.
-     *
-     * @param comparator the comparator used by this matching rule to compare
-     *      and match values of the associated syntax
-     */
-    protected void setComparator( Comparator comparator )
-    {
-        this.comparator = comparator;
-    }
-
-
-    /**
-     * Sets the Normalizer used to transform Syntax values to a canonimcal form.
-     *
-     * @param normalizer the normalizer used to transform syntax values to a
-     *      canonical form.
-     */
-    protected void setNormalizer( Normalizer normalizer )
-    {
-        this.normalizer = normalizer;
     }
 }

Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/AbstractSchemaObject.java
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/AbstractSchemaObject.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/AbstractSchemaObject.java
Tue Oct 19 07:11:15 2004
@@ -26,7 +26,7 @@
  * @author <a href="mailto:directory-dev@incubator.apache.org">Apache Directory Project</a>
  * @version $Rev$
  */
-public class AbstractSchemaObject implements SchemaObject
+public abstract class AbstractSchemaObject implements SchemaObject
 {
     /** a numeric object identifier */
     protected final String oid;

Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/AttributeType.java
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/AttributeType.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/AttributeType.java
Tue Oct 19 07:11:15 2004
@@ -16,6 +16,8 @@
  */
 package org.apache.ldap.common.schema;
 
+import javax.naming.NamingException;
+
 
 /**
  * An attributeType specification.  attributeType specifications describe the
@@ -115,8 +117,7 @@
  * </pre>
  * 
  * @see <a href="http://www.faqs.org/rfcs/rfc2252.html">RFC 2252 Section 4.2</a>
- * @see <a href=
- *     "http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-11.txt">
+ * @see <a href="http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-11.txt">
  *     ldapbis [MODELS]</a>
  * @see DescriptionUtils#getDescription(AttributeType)
  *
@@ -156,16 +157,18 @@
     /**
      * Gets the name of the superior class for this AttributeType.
      *
-     * @return the super class for this AttributeType 
+     * @return the super class for this AttributeType
+     * @throws NamingException if there is a failure to resolve the superior
      */
-    AttributeType getSuperior();
+    AttributeType getSuperior() throws NamingException;
 
     /**
      * The Syntax for this AttributeType's values.
      *
      * @return the value syntax
+     * @throws NamingException if there is a failure to resolve the syntax
      */
-    Syntax getSyntax();
+    Syntax getSyntax() throws NamingException;
 
     /**
      * Gets a length limit for this AttributeType.
@@ -178,20 +181,23 @@
      * Gets the MatchingRule for this AttributeType used for equality matching.
      *
      * @return the equality matching rule
+     * @throws NamingException if there is a failure to resolve the matchingRule
      */
-    MatchingRule getEquality();
+    MatchingRule getEquality() throws NamingException;
 
     /**
      * Gets the MatchingRule for this AttributeType used for ordering.
      *
      * @return the ordering matching rule
+     * @throws NamingException if there is a failure to resolve the matchingRule
      */
-    MatchingRule getOrdering();
+    MatchingRule getOrdering() throws NamingException;
 
     /**
      * Gets the MatchingRule for this AttributeType used for substring matching.
      *
      * @return the substring matching rule
+     * @throws NamingException if there is a failure to resolve the matchingRule
      */
-    MatchingRule getSubstr();
+    MatchingRule getSubstr() throws NamingException;
 }

Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/DITContentRule.java
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/DITContentRule.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/DITContentRule.java
Tue Oct 19 07:11:15 2004
@@ -17,6 +17,9 @@
 package org.apache.ldap.common.schema;
 
 
+import javax.naming.NamingException;
+
+
 /**
  * A ditContentRule specification.  ditContentRules identify the content of 
  * entries of a particular structural objectClass.  They specify the AUXILIARY
@@ -94,11 +97,8 @@
  *     [extensions] describe extensions.
  * </pre>
  * 
- * @see <a href="http://www.faqs.org/rfcs/rfc2252.html">RFC 2252 Section 5.4.3
- * </a>
- * @see <a href=
- *     "http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-09.txt">
- *     ldapbis [MODELS]</a>
+ * @see <a href="http://www.faqs.org/rfcs/rfc2252.html">RFC 2252 Section 5.4.3</a>
+ * @see <a href="http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-11.txt">ldapbis
[MODELS]</a>
  * @see DescriptionUtils#getDescription(DITContentRule)
  * 
  * @author <a href="mailto:directory-dev@incubator.apache.org">Apache Directory Project</a>
@@ -107,56 +107,47 @@
 public interface DITContentRule extends SchemaObject
 {
     /**
-     * Gets the oid for this DITContentRule.
-     *
-     * @return the object identifier
-     */
-    String getOid();
-
-    /**
-     * Gets whether or not this DITContentRule is obsolete.
-     *
-     * @return true if obsolete, false if not.
-     */
-    boolean isObsolete();
-
-    /**
      * Gets the STRUCTURAL ObjectClass this DITContentRule specifies attributes 
      * for.
      *
      * @return the ObjectClass this DITContentRule specifies attributes for
+     * @throws NamingException if there is a failure resolving the object
      */
-    ObjectClass getObjectClass();
+    ObjectClass getObjectClass() throws NamingException;
 
     /**
      * Gets all the AUXILIARY ObjectClasses this DITContentRule specifies for the
      * given STRUCTURAL objectClass.
      *
      * @return the extra AUXILIARY ObjectClasses
+     * @throws NamingException if there is a failure resolving the object
      */
-    ObjectClass[] getAuxObjectClasses();
+    ObjectClass[] getAuxObjectClasses() throws NamingException;
 
     /**
      * Gets all the AttributeTypes of the "must" attribute names this 
      * DITContentRule specifies for the given STRUCTURAL objectClass.
      *
      * @return the AttributeTypes of attributes that must be included in entries
+     * @throws NamingException if there is a failure resolving the object
      */
-    AttributeType[] getMustNames();
+    AttributeType[] getMustNames() throws NamingException;
 
     /**
      * Gets all the AttributeTypes of the "may" attribute names this DITContentRule
      * specifies for the given STRUCTURAL objectClass.
      *
      * @return the AttributeTypes of attributes that may be included in entries
+     * @throws NamingException if there is a failure resolving the object
      */
-    AttributeType[] getMayNames();
+    AttributeType[] getMayNames() throws NamingException;
 
     /**
      * Gets all the AttributeTypes of the "not" attribute names this DITContentRule
      * specifies for the given STRUCTURAL objectClass.
      *
      * @return the AttributeTypes of attributes that are excluded in entries
+     * @throws NamingException if there is a failure resolving the object
      */
-    AttributeType[] getNotNames();
+    AttributeType[] getNotNames() throws NamingException;
 }

Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/DITStructureRule.java
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/DITStructureRule.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/DITStructureRule.java
Tue Oct 19 07:11:15 2004
@@ -16,6 +16,8 @@
  */
 package org.apache.ldap.common.schema;
 
+import javax.naming.NamingException;
+
 
 /**
  * A dITStructureRule definition.  A dITStructureRules is a rule governing the 
@@ -64,9 +66,7 @@
  * </pre>
  * 
  * @see <a href="http://www.faqs.org/rfcs/rfc2252.html">RFC2252 Section 6.33</a>
- * @see <a href=
- *     "http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-09.txt">
- *     ldapbis [MODELS]</a>
+ * @see <a href="http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-11.txt">ldapbis
[MODELS]</a>
  * @see DescriptionUtils#getDescription(DITStructureRule)
  * 
  * @author <a href="mailto:directory-dev@incubator.apache.org">Apache Directory Project</a>
@@ -75,26 +75,13 @@
 public interface DITStructureRule extends SchemaObject
 {
     /**
-     * Gets the oid for this DITStructureRule.
-     *
-     * @return the object identifier
-     */
-    String getOid();
-
-    /**
-     * Gets whether or not this DITStructureRule is obsolete.
-     *
-     * @return true if obsolete, false if not.
-     */
-    boolean isObsolete();
-
-    /**
      * The nameForm associating this ditStructureRule with a structural 
      * objectClass.
      *
      * @return the nameForm for the structural objectClass
+     * @throws NamingException if there is a failure resolving the object
      */
-    NameForm getNameForm();
+    NameForm getNameForm() throws NamingException;
 
     /**
      * Gets a collection of all the superior StructureRules. The difference 
@@ -102,6 +89,7 @@
      * class chain.
      *
      * @return the chain of StructureRules 
+     * @throws NamingException if there is a failure resolving the object
      */
-    DITStructureRule [] getSuperClasses();
+    DITStructureRule [] getSuperClasses() throws NamingException;
 }

Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/DescriptionUtils.java
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/DescriptionUtils.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/DescriptionUtils.java
Tue Oct 19 07:11:15 2004
@@ -16,6 +16,8 @@
  */
 package org.apache.ldap.common.schema;
 
+import javax.naming.NamingException;
+
 
 /**
  * Utility class used to generate schema object specifications.  Some of the 
@@ -65,7 +67,7 @@
      * @return the AttributeTypeDescription Syntax for the attributeType in a
      * pretty formated string
      */
-    public static String getDescription( AttributeType attributeType )
+    public static String getDescription( AttributeType attributeType ) throws NamingException
     {
         StringBuffer buf = new StringBuffer( "( " );
         buf.append( attributeType.getOid() );
@@ -163,6 +165,7 @@
      * syntax 
      */
     public static String getDescription( DITContentRule dITContentRule )
+        throws NamingException
     {
         StringBuffer buf = new StringBuffer( "( " );
         buf.append( dITContentRule.getOid() );
@@ -256,7 +259,7 @@
      * @param matchingRule the MatchingRule to generate the description for
      * @return the MatchingRuleDescription string
      */
-    public static String getDescription( MatchingRule matchingRule )
+    public static String getDescription( MatchingRule matchingRule ) throws NamingException
     {
         StringBuffer buf = new StringBuffer( "( " );
         buf.append( matchingRule.getOid() );
@@ -315,6 +318,7 @@
      * @return
      */
     public static String getDescription( MatchingRuleUse matchingRuleUse )
+        throws NamingException
     {
         StringBuffer buf = new StringBuffer( "( " );
         buf.append( matchingRuleUse.getMatchingRule().getOid() );
@@ -380,7 +384,7 @@
      * @param nameForm the NameForm to generate the description for
      * @return the NameFormDescription string
      */
-    public static String getDescription( NameForm nameForm )
+    public static String getDescription( NameForm nameForm ) throws NamingException
     {
         StringBuffer buf = new StringBuffer( "( " );
         buf.append( nameForm.getOid() );
@@ -454,7 +458,7 @@
      * @param objectClass the ObjectClass to generate a description for
      * @return the description in the ObjectClassDescription syntax
      */
-    public static String getDescription( ObjectClass objectClass )
+    public static String getDescription( ObjectClass objectClass ) throws NamingException
     {
         StringBuffer buf = new StringBuffer( "( " );
         buf.append( objectClass.getOid() );
@@ -544,6 +548,7 @@
      * @return the description in the DITStructureRuleDescription syntax
      */
     public static String getDescription( DITStructureRule dITStructureRule )
+        throws NamingException
     {
         StringBuffer buf = new StringBuffer( "( " );
         buf.append( dITStructureRule.getOid() );

Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/MatchingRule.java
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/MatchingRule.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/MatchingRule.java
Tue Oct 19 07:11:15 2004
@@ -17,6 +17,7 @@
 package org.apache.ldap.common.schema;
 
 
+import javax.naming.NamingException;
 import java.util.Comparator;
 
 
@@ -63,9 +64,7 @@
  * </pre>
  *
  * @see <a href="http://www.faqs.org/rfcs/rfc2252.html">RFC 2252 Section 4.5</a>
- * @see <a href=
- *     "http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-09.txt">
- *     ldapbis [MODELS]</a>
+ * @see <a href="http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-11.txt">ldapbis
[MODELS]</a>
  * @see DescriptionUtils#getDescription(MatchingRule)
  * 
  * @author <a href="mailto:directory-dev@incubator.apache.org">Apache Directory Project</a>
@@ -77,22 +76,25 @@
      * Gets the SyntaxImpl used by this MatchingRule.
      * 
      * @return the SyntaxImpl of this MatchingRule
+     * @throws NamingException if there is a failure resolving the object
      */
-    Syntax getSyntax();
+    Syntax getSyntax() throws NamingException;
 
     /**
      * Gets the Comparator enabling the use of this MatchingRule for ORDERING
      * and sorted indexing. 
      * 
      * @return the ordering Comparator 
+     * @throws NamingException if there is a failure resolving the object
      */
-    Comparator getComparator();
+    Comparator getComparator() throws NamingException;
 
     /**
      * Gets the Normalizer enabling the use of this MatchingRule for EQUALITY
      * matching and indexing. 
      * 
      * @return the ordering Comparator 
+     * @throws NamingException if there is a failure resolving the object
      */
-    Normalizer getNormalizer();
+    Normalizer getNormalizer() throws NamingException;
 }

Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/MatchingRuleUse.java
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/MatchingRuleUse.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/MatchingRuleUse.java
Tue Oct 19 07:11:15 2004
@@ -16,6 +16,8 @@
  */
 package org.apache.ldap.common.schema;
 
+import javax.naming.NamingException;
+
 
 /**
  * Represents an LDAP MatchingRuleUseDescription defined in RFC 2252.
@@ -63,12 +65,8 @@
  * rule in [MODELS] above.
  * </pre>
  * 
- * @see <a href=
- *     "http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-09.txt">
- *     ldapbis [MODELS]</a>
- * @see <a href=
- *     "http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-syntaxes-07.txt">
- *     ldapbis [SYNTAXES]</a>
+ * @see <a href="http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-11.txt">ldapbis
[MODELS]</a>
+ * @see <a href="http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-syntaxes-09.txt">ldapbis
[SYNTAXES]</a>
  * 
  * @author <a href="mailto:directory-dev@incubator.apache.org">Apache Directory Project</a>
  * @version $Rev$
@@ -79,14 +77,16 @@
      * Gets the matchingRule this MatchingRuleUse definition applies to. 
      * 
      * @return the matchingRule
+     * @throws NamingException if there is a failure resolving the object
      */
-    public MatchingRule getMatchingRule();
+    public MatchingRule getMatchingRule() throws NamingException;
     
     /**
      * Gets the the attributes which can be used with the matching rule in an 
      * extensible match assertion.
      * 
      * @return the applicable attributes
+     * @throws NamingException if there is a failure resolving the object
      */
-    public AttributeType[] getApplicableAttributes();
+    public AttributeType[] getApplicableAttributes() throws NamingException;
 }

Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/NameForm.java
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/NameForm.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/NameForm.java
Tue Oct 19 07:11:15 2004
@@ -16,6 +16,8 @@
  */
 package org.apache.ldap.common.schema;
 
+import javax.naming.NamingException;
+
 
 /**
  * A nameForm description.  NameForms define the relationship between a 
@@ -74,9 +76,7 @@
  * </pre>
  *
  * @see <a href="http://www.faqs.org/rfcs/rfc2252.html">RFC2252 Section 6.22</a>
- * @see <a href=
- *     "http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-09.txt">
- *     ldapbis [MODELS]</a>
+ * @see <a href="http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-11.txt">ldapbis
[MODELS]</a>
  * @see DescriptionUtils#getDescription(NameForm)
  * 
  * @author <a href="mailto:directory-dev@incubator.apache.org">Apache Directory Project</a>
@@ -85,26 +85,13 @@
 public interface NameForm extends SchemaObject
 {
     /**
-     * Gets the oid for this NameForm.
-     *
-     * @return the object identifier
-     */
-    String getOid();
-
-    /**
-     * Gets whether or not this NameForm is obsolete.
-     *
-     * @return true if obsolete, false if not.
-     */
-    boolean isObsolete();
-
-    /**
      * Gets the STRUCTURAL ObjectClass this name form specifies naming 
      * attributes for.
      *
      * @return the ObjectClass this NameForm is for
+     * @throws NamingException if there is a failure resolving the object
      */
-    ObjectClass getObjectClass();
+    ObjectClass getObjectClass() throws NamingException;
 
     /**
      * Gets all the AttributeTypes of the attributes this NameForm specifies as 
@@ -112,8 +99,9 @@
      * Rdn.
      *
      * @return the AttributeTypes of the must use attributes
+     * @throws NamingException if there is a failure resolving the object
      */
-    AttributeType [] getMustUse();
+    AttributeType[] getMustUse() throws NamingException;
     
     /**
      * Gets all the AttributeTypes of the attribute this NameForm specifies as 
@@ -121,6 +109,7 @@
      * as part of the Rdn.
      *
      * @return the AttributeTypes of the may use attributes
+     * @throws NamingException if there is a failure resolving the object
      */
-    AttributeType [] getMaytUse();
+    AttributeType[] getMaytUse() throws NamingException;
 }

Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/ObjectClass.java
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/ObjectClass.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/ObjectClass.java
Tue Oct 19 07:11:15 2004
@@ -16,6 +16,8 @@
  */
 package org.apache.ldap.common.schema;
 
+import javax.naming.NamingException;
+
 
 /**
  * An objectClass definition.  
@@ -53,9 +55,7 @@
  * </pre>
  * 
  * @see <a href="http://www.faqs.org/rfcs/rfc2252.html">RFC2252 Section 4.4</a>
- * @see <a href=
- *     "http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-09.txt">
- *     ldapbis [MODELS]</a>
+ * @see <a href="http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-11.txt">ldapbis
[MODELS]</a>
  * @see DescriptionUtils#getDescription(ObjectClass)
  * 
  * @author <a href="mailto:directory-dev@incubator.apache.org">Apache Directory Project</a>
@@ -64,25 +64,12 @@
 public interface ObjectClass extends SchemaObject
 {
     /**
-     * Gets the object identifier for this ObjectClass definition.
-     *
-     * @return the OID for this ObjectClass
-     */
-    String getOid();
-
-    /**
-     * Gets whether or not this NameForm is obsolete.
-     *
-     * @return true if obsolete, false if not.
-     */
-    boolean isObsolete();
-
-    /**
      * Gets the superclasses of this ObjectClass.
      *
      * @return the superclasses
+     * @throws NamingException if there is a failure resolving the object
      */
-    ObjectClass[] getSuperClasses();
+    ObjectClass[] getSuperClasses() throws NamingException;
 
     /**
      * Gets the type of this ObjectClass as a type safe enum.
@@ -97,8 +84,9 @@
      *
      * @return the AttributeTypes of attributes that must be within entries of
      * this ObjectClass
+     * @throws NamingException if there is a failure resolving the object
      */
-    AttributeType[] getMustList();
+    AttributeType[] getMustList() throws NamingException;
 
     /**
      * Gets the AttributeTypes whose attributes may be present within an entry
@@ -106,6 +94,7 @@
      *
      * @return the AttributeTypes of attributes that may be within entries of
      * this ObjectClass
+     * @throws NamingException if there is a failure resolving the object
      */
-    AttributeType[] getMayList();
+    AttributeType[] getMayList() throws NamingException;
 }

Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/Syntax.java
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/Syntax.java
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/Syntax.java
Tue Oct 19 07:11:15 2004
@@ -73,13 +73,6 @@
     boolean isHumanReadable();
     
     /**
-     * Gets the oid for this Syntax.
-     * 
-     * @return the object identifier
-     */
-    String getOid();
-    
-    /**
      * Gets the SyntaxChecker used to validate values in accordance with this
      * Syntax.
      * 

Modified: incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/package.html
==============================================================================
--- incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/package.html
(original)
+++ incubator/directory/ldap/trunk/common/src/java/org/apache/ldap/common/schema/package.html
Tue Oct 19 07:11:15 2004
@@ -33,7 +33,7 @@
 <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 applied.  For example a syntax exists
+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

Mime
View raw message