You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by er...@apache.org on 2006/08/14 00:51:21 UTC
svn commit: r431266 -
/directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/
Author: ersiner
Date: Sun Aug 13 15:51:21 2006
New Revision: 431266
URL: http://svn.apache.org/viewvc?rev=431266&view=rev
Log:
Fixed javadocs and whitepaces.
Modified:
directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/AttributeType.java
directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/DITStructureRule.java
directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/MatchingRule.java
directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/MatchingRuleUse.java
directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/NameForm.java
directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/ObjectClass.java
directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/Syntax.java
Modified: directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/AttributeType.java
URL: http://svn.apache.org/viewvc/directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/AttributeType.java?rev=431266&r1=431265&r2=431266&view=diff
==============================================================================
--- directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/AttributeType.java (original)
+++ directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/AttributeType.java Sun Aug 13 15:51:21 2006
@@ -1,5 +1,5 @@
/*
- * Copyright 2004 The Apache Software Foundation
+ * Copyright 2006 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -29,10 +29,8 @@
* </p>
*
* <pre>
- * 4.1.2. Attribute Types
- *
* Attribute Type definitions are written according to the ABNF:
- *
+ *
* AttributeTypeDescription = LPAREN WSP
* numericoid ; object identifier
* [ SP "NAME" SP qdescrs ] ; short names (descriptors)
@@ -48,12 +46,12 @@
* [ SP "NO-USER-MODIFICATION" ] ; not user modifiable
* [ SP "USAGE" SP usage ] ; usage
* extensions WSP RPAREN ; extensions
- *
+ *
* usage = "userApplications" / ; user
* "directoryOperation" / ; directory operational
* "distributedOperation" / ; DSA-shared operational
* "dSAOperation" ; DSA-specific operational
- *
+ *
* where:
* <numericoid> is object identifier assigned to this attribute type;
* NAME <qdescrs> are short names (descriptors) identifying this
@@ -73,45 +71,45 @@
* modifiable;
* USAGE indicates the application of this attribute type; and
* <extensions> describe extensions.
- *
+ *
* Each attribute type description must contain at least one of the SUP
* or SYNTAX fields. If no SYNTAX field is provided, the attribute type
* description takes its value from the supertype.
- *
+ *
* If SUP field is provided, the EQUALITY, ORDERING, and SUBSTRING
* fields, if not specified, take their value from the supertype.
- *
+ *
* Usage of userApplications, the default, indicates that attributes of
* this type represent user information. That is, they are user
* attributes.
- *
+ *
* A usage of directoryOperation, distributedOperation, or dSAOperation
* indicates that attributes of this type represent operational and/or
* administrative information. That is, they are operational
* attributes.
- *
+ *
* directoryOperation usage indicates that the attribute of this type is
* a directory operational attribute. distributedOperation usage
* indicates that the attribute of this type is a DSA-shared usage
* operational attribute. dSAOperation usage indicates that the
* attribute of this type is a DSA-specific operational attribute.
- *
+ *
* COLLECTIVE requires usage userApplications. Use of collective
* attribute types in LDAP is discussed in [RFC3671].
- *
+ *
* NO-USER-MODIFICATION requires an operational usage.
- *
+ *
* Note that the <AttributeTypeDescription> does not list the matching
* rules that can be used with that attribute type in an extensibleMatch
* search filter [RFC4511]. This is done using the 'matchingRuleUse'
* attribute described in Section 4.1.4.
- *
+ *
* This document refines the schema description of X.501 by requiring
* that the SYNTAX field in an <AttributeTypeDescription> be a string
* representation of an object identifier for the LDAP string syntax
* definition, with an optional indication of the suggested minimum
* bound of a value of this attribute.
- *
+ *
* A suggested minimum upper bound on the number of characters in a
* value with a string-based syntax, or the number of bytes in a value
* for all other syntaxes, may be indicated by appending this bound
@@ -122,13 +120,9 @@
* long, although they may allow longer strings. Note that a single
* character of the Directory String syntax may be encoded in more than
* one octet since UTF-8 [RFC3629] is a variable-length encoding.
- *
* </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">
- * ldapbis [MODELS]</a>
+ * @see <a href="http://www.faqs.org/rfcs/rfc4512.html">RFC 4512 Section 4.1.2</a>
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
* @version $Rev: 379008 $
*/
Modified: directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/DITStructureRule.java
URL: http://svn.apache.org/viewvc/directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/DITStructureRule.java?rev=431266&r1=431265&r2=431266&view=diff
==============================================================================
--- directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/DITStructureRule.java (original)
+++ directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/DITStructureRule.java Sun Aug 13 15:51:21 2006
@@ -1,5 +1,5 @@
/*
- * Copyright 2004 The Apache Software Foundation
+ * Copyright 2006 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Modified: directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/MatchingRule.java
URL: http://svn.apache.org/viewvc/directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/MatchingRule.java?rev=431266&r1=431265&r2=431266&view=diff
==============================================================================
--- directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/MatchingRule.java (original)
+++ directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/MatchingRule.java Sun Aug 13 15:51:21 2006
@@ -27,40 +27,38 @@
* attribute values. MatchingRules are associated with a specific Syntax for the
* purpose of resolving a normalized form and for comparisons.
* <p>
- * According to RFC 4512:
+ * According to section 4.1.3 of RFC 4512:
* </p>
*
* <pre>
- * 4.1.3. Matching Rules
- *
- * Matching rules are used in performance of attribute value assertions,
- * such as in performance of a Compare operation. They are also used in
- * evaluating search filters, determining which individual values are to
- * be added or deleted during performance of a Modify operation, and in
- * comparing distinguished names.
- *
- * Each matching rule is identified by an object identifier (OID) and,
- * optionally, one or more short names (descriptors).
+ * Matching rules are used in performance of attribute value assertions,
+ * such as in performance of a Compare operation. They are also used in
+ * evaluating search filters, determining which individual values are to
+ * be added or deleted during performance of a Modify operation, and in
+ * comparing distinguished names.
*
- * Matching rule definitions are written according to the ABNF:
+ * Each matching rule is identified by an object identifier (OID) and,
+ * optionally, one or more short names (descriptors).
*
- * MatchingRuleDescription = LPAREN WSP
- * numericoid ; object identifier
- * [ SP "NAME" SP qdescrs ] ; short names (descriptors)
- * [ SP "DESC" SP qdstring ] ; description
- * [ SP "OBSOLETE" ] ; not active
- * SP "SYNTAX" SP numericoid ; assertion syntax
- * extensions WSP RPAREN ; extensions
- *
- * where:
- * <numericoid> is object identifier assigned to this matching rule;
- * NAME <qdescrs> are short names (descriptors) identifying this
- * matching rule;
- * DESC <qdstring> is a short descriptive string;
- * OBSOLETE indicates this matching rule is not active;
- * SYNTAX identifies the assertion syntax (the syntax of the assertion
- * value) by object identifier; and
- * <extensions> describe extensions. *
+ * Matching rule definitions are written according to the ABNF:
+ *
+ * MatchingRuleDescription = LPAREN WSP
+ * numericoid ; object identifier
+ * [ SP "NAME" SP qdescrs ] ; short names (descriptors)
+ * [ SP "DESC" SP qdstring ] ; description
+ * [ SP "OBSOLETE" ] ; not active
+ * SP "SYNTAX" SP numericoid ; assertion syntax
+ * extensions WSP RPAREN ; extensions
+ *
+ * where:
+ * <numericoid> is object identifier assigned to this matching rule;
+ * NAME <qdescrs> are short names (descriptors) identifying this
+ * matching rule;
+ * DESC <qdstring> is a short descriptive string;
+ * OBSOLETE indicates this matching rule is not active;
+ * SYNTAX identifies the assertion syntax (the syntax of the assertion
+ * value) by object identifier; and
+ * <extensions> describe extensions.
* </pre>
*
* @see <a href="http://www.faqs.org/rfcs/rfc4512.html">RFC 4512 Section 4.1.3</a>
Modified: directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/MatchingRuleUse.java
URL: http://svn.apache.org/viewvc/directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/MatchingRuleUse.java?rev=431266&r1=431265&r2=431266&view=diff
==============================================================================
--- directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/MatchingRuleUse.java (original)
+++ directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/MatchingRuleUse.java Sun Aug 13 15:51:21 2006
@@ -25,35 +25,33 @@
/**
* Represents an LDAP MatchingRuleUseDescription defined in RFC 4512.
* <p>
- * According to section 4.1.4 of the RFC:
+ * According to section 4.1.4 of RFC 4512:
* </p>
*
* <pre>
- * A matching rule use lists the attribute types that are suitable for
- * use with an extensibleMatch search filter.
+ * A matching rule use lists the attribute types that are suitable for
+ * use with an extensibleMatch search filter.
*
- * Matching rule use descriptions are written according to the following
- * ABNF:
- *
- * MatchingRuleUseDescription = LPAREN WSP
- * numericoid ; object identifier
- * [ SP "NAME" SP qdescrs ] ; short names (descriptors)
- * [ SP "DESC" SP qdstring ] ; description
- * [ SP "OBSOLETE" ] ; not active
- * SP "APPLIES" SP oids ; attribute types
- * extensions WSP RPAREN ; extensions
+ * Matching rule use descriptions are written according to the following
+ * ABNF:
*
- * where:
- * <numericoid> is the object identifier of the matching rule
- * associated with this matching rule use description;
- * NAME <qdescrs> are short names (descriptors) identifying this
- * matching rule use;
- * DESC <qdstring> is a short descriptive string;
- * OBSOLETE indicates this matching rule use is not active;
- * APPLIES provides a list of attribute types the matching rule
- * applies to; and
- * <extensions> describe extensions.
- *
+ * MatchingRuleUseDescription = LPAREN WSP
+ * numericoid ; object identifier
+ * [ SP "NAME" SP qdescrs ] ; short names (descriptors)
+ * [ SP "DESC" SP qdstring ] ; description
+ * [ SP "OBSOLETE" ] ; not active
+ * SP "APPLIES" SP oids ; attribute types
+ * extensions WSP RPAREN ; extensions
+ * where:
+ * <numericoid> is the object identifier of the matching rule
+ * associated with this matching rule use description;
+ * NAME <qdescrs> are short names (descriptors) identifying this
+ * matching rule use;
+ * DESC <qdstring> is a short descriptive string;
+ * OBSOLETE indicates this matching rule use is not active;
+ * APPLIES provides a list of attribute types the matching rule
+ * applies to; and
+ * <extensions> describe extensions.
* </pre>
*
* DO NOT POPULATE OID REGISTRY USING THESE OBJECTS!!!
Modified: directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/NameForm.java
URL: http://svn.apache.org/viewvc/directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/NameForm.java?rev=431266&r1=431265&r2=431266&view=diff
==============================================================================
--- directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/NameForm.java (original)
+++ directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/NameForm.java Sun Aug 13 15:51:21 2006
@@ -1,5 +1,5 @@
/*
- * Copyright 2004 The Apache Software Foundation
+ * Copyright 2006 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Modified: directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/ObjectClass.java
URL: http://svn.apache.org/viewvc/directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/ObjectClass.java?rev=431266&r1=431265&r2=431266&view=diff
==============================================================================
--- directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/ObjectClass.java (original)
+++ directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/ObjectClass.java Sun Aug 13 15:51:21 2006
@@ -1,5 +1,5 @@
/*
- * Copyright 2004 The Apache Software Foundation
+ * Copyright 2006 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Modified: directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/Syntax.java
URL: http://svn.apache.org/viewvc/directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/Syntax.java?rev=431266&r1=431265&r2=431266&view=diff
==============================================================================
--- directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/Syntax.java (original)
+++ directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/Syntax.java Sun Aug 13 15:51:21 2006
@@ -25,31 +25,29 @@
* syntax (i.e. data type) which constrains the structure and format of its
* values.
* <p>
- * According to RFC 4512:
+ * According to section 4.1.5 of RFC 4512:
* </p>
*
* <pre>
- * 4.1.5. LDAP Syntaxes
-
- * LDAP Syntaxes of (attribute and assertion) values are described in
- * terms of ASN.1 [X.6 80] and, optionally, have an octet string encoding
- * known as the LDAP-specific encoding. Commonly, the LDAP-specific
- * encoding is constrained to a string of Unicode [Unicode] characters
- * in UTF-8 [RFC3629] form.
- *
- * Each LDAP syntax is identified by an object identifier (OID).
- *
- * LDAP syntax definitions are written according to the ABNF:
- *
- * SyntaxDescription = LPAREN WSP
- * numericoid ; object identifier
- * [ SP "DESC" SP qdstring ] ; description
- * extensions WSP RPAREN ; extensions
- *
- * where:
- * <numericoid> is the object identifier assigned to this LDAP syntax;
- * DESC <qdstring> is a short descriptive string; and
- * <extensions> describe extensions.
+ * LDAP Syntaxes of (attribute and assertion) values are described in
+ * terms of ASN.1 [X.680] and, optionally, have an octet string encoding
+ * known as the LDAP-specific encoding. Commonly, the LDAP-specific
+ * encoding is constrained to a string of Unicode [Unicode] characters
+ * in UTF-8 [RFC3629] form.
+ *
+ * Each LDAP syntax is identified by an object identifier (OID).
+ *
+ * LDAP syntax definitions are written according to the ABNF:
+ *
+ * SyntaxDescription = LPAREN WSP
+ * numericoid ; object identifier
+ * [ SP "DESC" SP qdstring ] ; description
+ * extensions WSP RPAREN ; extensions
+ *
+ * where:
+ * <numericoid> is the object identifier assigned to this LDAP syntax;
+ * DESC <qdstring> is a short descriptive string; and
+ * <extensions> describe extensions.
* </pre>
*
* @see <a href="http://www.faqs.org/rfcs/rfc4512.html">RFC 4512 Section 4.1.5</a>