directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From akaras...@apache.org
Subject svn commit: rev 6217 - in incubator/directory/ldap/trunk/eve/backend/schema/matching: . api api/src api/src/java api/src/java/org api/src/java/org/apache api/src/java/org/apache/eve api/src/java/org/apache/eve/schema
Date Mon, 19 Jan 2004 00:44:35 GMT
Author: akarasulu
Date: Sun Jan 18 16:44:34 2004
New Revision: 6217

Added:
   incubator/directory/ldap/trunk/eve/backend/schema/matching/
   incubator/directory/ldap/trunk/eve/backend/schema/matching/api/   (props changed)
   incubator/directory/ldap/trunk/eve/backend/schema/matching/api/project.properties
   incubator/directory/ldap/trunk/eve/backend/schema/matching/api/project.xml
   incubator/directory/ldap/trunk/eve/backend/schema/matching/api/src/
   incubator/directory/ldap/trunk/eve/backend/schema/matching/api/src/java/
   incubator/directory/ldap/trunk/eve/backend/schema/matching/api/src/java/org/
   incubator/directory/ldap/trunk/eve/backend/schema/matching/api/src/java/org/apache/
   incubator/directory/ldap/trunk/eve/backend/schema/matching/api/src/java/org/apache/eve/
   incubator/directory/ldap/trunk/eve/backend/schema/matching/api/src/java/org/apache/eve/schema/
   incubator/directory/ldap/trunk/eve/backend/schema/matching/api/src/java/org/apache/eve/schema/MatchingRuleRegistry.java
   incubator/directory/ldap/trunk/eve/backend/schema/matching/api/src/java/org/apache/eve/schema/MatchingRuleRegistryMonitor.java
   incubator/directory/ldap/trunk/eve/backend/schema/matching/api/src/java/org/apache/eve/schema/MatchingRuleRegistryMonitorAdapter.java
Log:
Adding matchingRule registry component APIs

Added: incubator/directory/ldap/trunk/eve/backend/schema/matching/api/project.properties
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/matching/api/project.properties	Sun
Jan 18 16:44:34 2004
@@ -0,0 +1,14 @@
+maven.javadoc.private=true
+maven.javadoc.overview=src/java/org/apache/eve/schema/overview.html
+maven.javadoc.customtags=tag1 tag2
+
+tag1.name=todo
+tag1.description=To Do:
+tag1.enabled=true
+tag1.scope=all
+
+tag2.name=task
+tag2.description=Task:
+tag2.enabled=false
+tag2.scope=all
+

Added: incubator/directory/ldap/trunk/eve/backend/schema/matching/api/project.xml
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/matching/api/project.xml	Sun Jan 18
16:44:34 2004
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<project>
+    <extend>${basedir}/../../../../project.xml</extend>
+    <groupId>directory</groupId>
+    <id>eve-backend-schema-matching-api</id>
+  
+    <name>Eve Backend Schema's MatchingRule Registry API</name>
+    <package>org.apache.eve.schema</package>
+    <currentVersion>SNAPSHOT</currentVersion>
+    <inceptionYear>2002</inceptionYear>
+      
+    <shortDescription>Eve Backend Schema's MatchingRule Registry API</shortDescription>
+
+    <description>
+        Eve's backend subsystem contains several components to manage schema
+        objects.  One of those components is a OID to MatchingRule registry.  
+        The registry has methods for looking up matchingRules based on an OID 
+        and methods for registering matchingRules with their IANA assigned OID 
+        numbers.
+    </description>
+    
+    <dependencies>
+      <dependency>
+        <groupId>directory</groupId>
+        <artifactId>eve-backend-schema-common-api</artifactId>
+        <version>SNAPSHOT</version>
+        <url>http://directory.apache.org/eve/backend/schema/common/api</url>
+      </dependency>
+    </dependencies>
+</project>
+

Added: incubator/directory/ldap/trunk/eve/backend/schema/matching/api/src/java/org/apache/eve/schema/MatchingRuleRegistry.java
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/matching/api/src/java/org/apache/eve/schema/MatchingRuleRegistry.java
Sun Jan 18 16:44:34 2004
@@ -0,0 +1,97 @@
+/*
+
+ ============================================================================
+                   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 ;
+
+
+import javax.naming.NamingException ;
+
+
+/**
+ * A registry used to track system matchingRules.
+ *
+ * @author <a href="mailto:akarasulu@apache.org">Alex Karasulu</a>
+ * @author $LastChangedBy$
+ * @version $LastChangedRevision$
+ */
+public interface MatchingRuleRegistry
+{
+    /** Avalon service role */
+    String ROLE = MatchingRuleRegistry.class.getName() ;
+    
+    
+    /**
+     * Registers a MatchingRule with this registry.
+     * 
+     * @param a_matchingRule the MatchingRule to register
+     * @throws NamingException if the matchingRule is already registered or the 
+     * registration operation is not supported
+     */
+    void register( MatchingRule a_matchingRule ) throws NamingException ;
+    
+    /**
+     * Looks up a MatchingRule by its unique Object Identifier.
+     * 
+     * @param a_oid the object identifier
+     * @return the MatchingRule for the oid
+     * @throws NamingException if there is a backing store failure or the 
+     * MatchingRule does not exist.
+     */
+    MatchingRule lookup( String a_oid ) throws NamingException ;
+
+    /**
+     * Checks to see if a MatchingRule exists.  Backing store failures simply 
+     * return false.
+     * 
+     * @param a_oid the object identifier
+     * @return true if a MatchingRule definition exists for the oid, false 
+     * otherwise
+     */
+    boolean hasMatchingRule( String a_oid ) ;
+}

Added: incubator/directory/ldap/trunk/eve/backend/schema/matching/api/src/java/org/apache/eve/schema/MatchingRuleRegistryMonitor.java
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/matching/api/src/java/org/apache/eve/schema/MatchingRuleRegistryMonitor.java
Sun Jan 18 16:44:34 2004
@@ -0,0 +1,95 @@
+/*
+
+ ============================================================================
+                   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;
+
+
+import javax.naming.NamingException ;
+
+
+/**
+ * Monitor interface for a MatchingRuleRegistry.
+ *
+ * @author <a href="mailto:akarasulu@apache.org">Alex Karasulu</a>
+ * @author $Author$
+ * @version $Rev$
+ */
+public interface MatchingRuleRegistryMonitor
+{
+    /**
+     * Monitors when a MatchingRule is registered successfully.
+     * 
+     * @param a_matchingRule the MatchingRule registered
+     */
+    void registered( MatchingRule a_matchingRule ) ;
+
+    /**
+     * Monitors when a MatchingRule is successfully looked up.
+     * 
+     * @param a_matchingRule the MatchingRule looked up
+     */
+    void lookedUp( MatchingRule a_matchingRule ) ;
+
+    /**
+     * Monitors when a lookup attempt fails.
+     * 
+     * @param a_oid the OID for the MatchingRule to lookup
+     * @param a_fault the exception to be thrown for the fault
+     */
+    void lookupFailed( String a_oid, NamingException a_fault ) ;
+    
+    /**
+     * Monitors when a registration attempt fails.
+     * 
+     * @param a_matchingRule the MatchingRule which failed registration
+     * @param a_fault the exception to be thrown for the fault
+     */
+    void registerFailed( MatchingRule a_matchingRule, 
+                         NamingException a_fault ) ; 
+}

Added: incubator/directory/ldap/trunk/eve/backend/schema/matching/api/src/java/org/apache/eve/schema/MatchingRuleRegistryMonitorAdapter.java
==============================================================================
--- (empty file)
+++ incubator/directory/ldap/trunk/eve/backend/schema/matching/api/src/java/org/apache/eve/schema/MatchingRuleRegistryMonitorAdapter.java
Sun Jan 18 16:44:34 2004
@@ -0,0 +1,100 @@
+/*
+
+ ============================================================================
+                   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 ;
+
+
+import javax.naming.NamingException ;
+
+
+/**
+ * An adapter for a MatchingRuleRegistryMonitor.
+ *
+ * @author <a href="mailto:akarasulu@apache.org">Alex Karasulu</a>
+ * @author $LastChangedBy$
+ * @version $LastChangedRevision$
+ */
+public class MatchingRuleRegistryMonitorAdapter
+    implements MatchingRuleRegistryMonitor
+{
+    /**
+     * @see org.apache.eve.schema.MatchingRuleRegistryMonitor#registered(
+     * org.apache.eve.schema.MatchingRule)
+     */
+    public void registered( MatchingRule a_rule )
+    {
+    }
+    
+
+    /**
+     * @see org.apache.eve.schema.MatchingRuleRegistryMonitor#lookedUp(
+     * org.apache.eve.schema.MatchingRule)
+     */
+    public void lookedUp( MatchingRule a_rule )
+    {
+    }
+
+    
+    /**
+     * @see org.apache.eve.schema.MatchingRuleRegistryMonitor#lookupFailed(
+     * java.lang.String, javax.naming.NamingException)
+     */
+    public void lookupFailed( String a_oid, NamingException a_fault )
+    {
+    }
+
+    
+    /**
+     * @see org.apache.eve.schema.MatchingRuleRegistryMonitor#registerFailed(
+     * org.apache.eve.schema.MatchingRule, javax.naming.NamingException)
+     */
+    public void registerFailed( MatchingRule a_rule, NamingException a_fault )
+    {
+    }
+}

Mime
View raw message