svn commit: rev 6113 - incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema

[ak...@apache.org]

Author: akarasulu
Date: Wed Jan  7 21:22:06 2004
New Revision: 6113

Added:
   incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/MatchingRuleUse.java   (contents, props changed)
Log:
matching rule use description interface required for evaluation of
extensible match assertions.


Added: incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/MatchingRuleUse.java
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/MatchingRuleUse.java	Wed Jan  7 21:22:06 2004
@@ -0,0 +1,104 @@
+/*
+
+ ============================================================================
+                   The Apache Software License, Version 1.1
+ ============================================================================
+
+ Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without modifica-
+ tion, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of  source code must  retain the above copyright  notice,
+    this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+
+ 3. The end-user documentation included with the redistribution, if any, must
+    include  the following  acknowledgment:  "This product includes  software
+    developed  by the  Apache Software Foundation  (http://www.apache.org/)."
+    Alternately, this  acknowledgment may  appear in the software itself,  if
+    and wherever such third-party acknowledgments normally appear.
+
+ 4. The names "Eve Directory Server", "Apache Directory Project", "Apache Eve" 
+    and "Apache Software Foundation"  must not be used to endorse or promote
+    products derived  from this  software without  prior written
+    permission. For written permission, please contact apache@apache.org.
+
+ 5. Products  derived from this software may not  be called "Apache", nor may
+    "Apache" appear  in their name,  without prior written permission  of the
+    Apache Software Foundation.
+
+ THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
+ INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ FITNESS  FOR A PARTICULAR  PURPOSE ARE  DISCLAIMED.  IN NO  EVENT SHALL  THE
+ APACHE SOFTWARE  FOUNDATION  OR ITS CONTRIBUTORS  BE LIABLE FOR  ANY DIRECT,
+ INDIRECT, INCIDENTAL, SPECIAL,  EXEMPLARY, OR CONSEQUENTIAL  DAMAGES (INCLU-
+ DING, BUT NOT LIMITED TO, PROCUREMENT  OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ OF USE, DATA, OR  PROFITS; OR BUSINESS  INTERRUPTION)  HOWEVER CAUSED AND ON
+ ANY  THEORY OF LIABILITY,  WHETHER  IN CONTRACT,  STRICT LIABILITY,  OR TORT
+ (INCLUDING  NEGLIGENCE OR  OTHERWISE) ARISING IN  ANY WAY OUT OF THE  USE OF
+ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+ This software  consists of voluntary contributions made  by many individuals
+ on  behalf of the Apache Software  Foundation. For more  information on the
+ Apache Software Foundation, please see <http://www.apache.org/>.
+
+*/
+package org.apache.eve.schema ;
+
+
+/**
+ * Represents an LDAP MatchingRuleUseDescription defined in RFC 2252.  The 
+ * MatchingRuleUseDescription syntax (1.3.6.1.4.1.1466.115.121.1.31) is defined
+ * therein as follows:
+ * 
+ * <pre>
+ * Values of the matchingRuleUse list the attributes which are suitable
+ * for use with an extensible matching rule.
+ *   MatchingRuleUseDescription = "(" whsp
+ *       numericoid whsp  ; MatchingRule identifier
+ *       [ "NAME" qdescrs ]
+ *       [ "DESC" qdstring ]
+ *       [ "OBSOLETE" ]
+ *      "APPLIES" oids    ; AttributeType identifiers
+ *   whsp ")"
+ * </pre>
+ * 
+ * The matchingRule within the MatchingRuleUse definition can be used by an
+ * extensible match assertion if the assertion is based on the attributes 
+ * listed within the MatchingRuleUse definition.  If an extensible match 
+ * assertion is based on attributes other than those listed within the 
+ * MatchingRuleUse definition then the assertion is deemed undefined.
+ * 
+ * Also according to 3.3.20 of [SYNTAXES] (ldapbis working group):
+ * 
+ * A value of the Matching Rule Use Description syntax indicates the
+ * attribute types to which a matching rule may be applied in an
+ * extensibleMatch search filter [PROT].  The LDAP-specific encoding of
+ * a value of this syntax is defined by the <MatchingRuleUseDescription>
+ * rule in [MODELS].
+ * 
+ * @author <a href="mailto:akarasulu@apache.org">Alex Karasulu</a>
+ * @author $Author$
+ * @version $Rev$
+ */
+public interface MatchingRuleUse
+{
+    /**
+     * Gets the matchingRule this MatchingRuleUse definition applies to. 
+     * 
+     * @return the matchingRule
+     */
+    public MatchingRule getMatchingRule() ;
+    
+    /**
+     * Gets the the attributes which can be used with the matching rule in an 
+     * extensible match assertion.
+     * 
+     * @return the applicable attributes
+     */
+    public AttributeType [] getApplicableAttributes() ;
+}