Mailing-List: contact directory-cvs-help@incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: directory-dev@incubator.apache.org
Date: 29 Sep 2004 07:31:50 -0000
Message-ID: <20040929073150.17746.qmail@minotaur.apache.org>
From: akarasulu@apache.org
To: directory-cvs@incubator.apache.org
Subject: svn commit: rev 47472 - in
 incubator/directory/eve/trunk/backend/core/src/java/org/apache/eve: . db jndi

Author: akarasulu
Date: Wed Sep 29 00:31:50 2004
New Revision: 47472

Added:
   incubator/directory/eve/trunk/backend/core/src/java/org/apache/eve/AbstractBackingStore.java
      - copied, changed from rev 47436, incubator/directory/eve/trunk/backend/sandbox/backend-api/src/java/org/apache/ldap/server/backend/AbstractBackend.java
   incubator/directory/eve/trunk/backend/core/src/java/org/apache/eve/db/
   incubator/directory/eve/trunk/backend/core/src/java/org/apache/eve/jndi/
Log:
preping other pkgs

Copied: incubator/directory/eve/trunk/backend/core/src/java/org/apache/eve/AbstractBackingStore.java (from rev 47436, incubator/directory/eve/trunk/backend/sandbox/backend-api/src/java/org/apache/ldap/server/backend/AbstractBackend.java)
==============================================================================
--- incubator/directory/eve/trunk/backend/sandbox/backend-api/src/java/org/apache/ldap/server/backend/AbstractBackend.java	(original)
+++ incubator/directory/eve/trunk/backend/core/src/java/org/apache/eve/AbstractBackingStore.java	Wed Sep 29 00:31:50 2004
@@ -1,260 +1,60 @@
-/*
- *                                 Apache License
- *                           Version 2.0, January 2004
- *                        http://www.apache.org/licenses/
- *
- *   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
- *
- *   1. Definitions.
- *
- *      "License" shall mean the terms and conditions for use, reproduction,
- *      and distribution as defined by Sections 1 through 9 of this document.
- *
- *      "Licensor" shall mean the copyright owner or entity authorized by
- *      the copyright owner that is granting the License.
- *
- *      "Legal Entity" shall mean the union of the acting entity and all
- *      other entities that control, are controlled by, or are under common
- *      control with that entity. For the purposes of this definition,
- *      "control" means (i) the power, direct or indirect, to cause the
- *      direction or management of such entity, whether by contract or
- *      otherwise, or (ii) ownership of fifty percent (50%) or more of the
- *      outstanding shares, or (iii) beneficial ownership of such entity.
- *
- *      "You" (or "Your") shall mean an individual or Legal Entity
- *      exercising permissions granted by this License.
- *
- *      "Source" form shall mean the preferred form for making modifications,
- *      including but not limited to software source code, documentation
- *      source, and configuration files.
- *
- *      "Object" form shall mean any form resulting from mechanical
- *      transformation or translation of a Source form, including but
- *      not limited to compiled object code, generated documentation,
- *      and conversions to other media types.
- *
- *      "Work" shall mean the work of authorship, whether in Source or
- *      Object form, made available under the License, as indicated by a
- *      copyright notice that is included in or attached to the work
- *      (an example is provided in the Appendix below).
- *
- *      "Derivative Works" shall mean any work, whether in Source or Object
- *      form, that is based on (or derived from) the Work and for which the
- *      editorial revisions, annotations, elaborations, or other modifications
- *      represent, as a whole, an original work of authorship. For the purposes
- *      of this License, Derivative Works shall not include works that remain
- *      separable from, or merely link (or bind by name) to the interfaces of,
- *      the Work and Derivative Works thereof.
- *
- *      "Contribution" shall mean any work of authorship, including
- *      the original version of the Work and any modifications or additions
- *      to that Work or Derivative Works thereof, that is intentionally
- *      submitted to Licensor for inclusion in the Work by the copyright owner
- *      or by an individual or Legal Entity authorized to submit on behalf of
- *      the copyright owner. For the purposes of this definition, "submitted"
- *      means any form of electronic, verbal, or written communication sent
- *      to the Licensor or its representatives, including but not limited to
- *      communication on electronic mailing lists, source code control systems,
- *      and issue tracking systems that are managed by, or on behalf of, the
- *      Licensor for the purpose of discussing and improving the Work, but
- *      excluding communication that is conspicuously marked or otherwise
- *      designated in writing by the copyright owner as "Not a Contribution."
- *
- *      "Contributor" shall mean Licensor and any individual or Legal Entity
- *      on behalf of whom a Contribution has been received by Licensor and
- *      subsequently incorporated within the Work.
- *
- *   2. Grant of Copyright License. Subject to the terms and conditions of
- *      this License, each Contributor hereby grants to You a perpetual,
- *      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- *      copyright license to reproduce, prepare Derivative Works of,
- *      publicly display, publicly perform, sublicense, and distribute the
- *      Work and such Derivative Works in Source or Object form.
- *
- *   3. Grant of Patent License. Subject to the terms and conditions of
- *      this License, each Contributor hereby grants to You a perpetual,
- *      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- *      (except as stated in this section) patent license to make, have made,
- *      use, offer to sell, sell, import, and otherwise transfer the Work,
- *      where such license applies only to those patent claims licensable
- *      by such Contributor that are necessarily infringed by their
- *      Contribution(s) alone or by combination of their Contribution(s)
- *      with the Work to which such Contribution(s) was submitted. If You
- *      institute patent litigation against any entity (including a
- *      cross-claim or counterclaim in a lawsuit) alleging that the Work
- *      or a Contribution incorporated within the Work constitutes direct
- *      or contributory patent infringement, then any patent licenses
- *      granted to You under this License for that Work shall terminate
- *      as of the date such litigation is filed.
- *
- *   4. Redistribution. You may reproduce and distribute copies of the
- *      Work or Derivative Works thereof in any medium, with or without
- *      modifications, and in Source or Object form, provided that You
- *      meet the following conditions:
- *
- *      (a) You must give any other recipients of the Work or
- *          Derivative Works a copy of this License; and
- *
- *      (b) You must cause any modified files to carry prominent notices
- *          stating that You changed the files; and
- *
- *      (c) You must retain, in the Source form of any Derivative Works
- *          that You distribute, all copyright, patent, trademark, and
- *          attribution notices from the Source form of the Work,
- *          excluding those notices that do not pertain to any part of
- *          the Derivative Works; and
- *
- *      (d) If the Work includes a "NOTICE" text file as part of its
- *          distribution, then any Derivative Works that You distribute must
- *          include a readable copy of the attribution notices contained
- *          within such NOTICE file, excluding those notices that do not
- *          pertain to any part of the Derivative Works, in at least one
- *          of the following places: within a NOTICE text file distributed
- *          as part of the Derivative Works; within the Source form or
- *          documentation, if provided along with the Derivative Works; or,
- *          within a display generated by the Derivative Works, if and
- *          wherever such third-party notices normally appear. The contents
- *          of the NOTICE file are for informational purposes only and
- *          do not modify the License. You may add Your own attribution
- *          notices within Derivative Works that You distribute, alongside
- *          or as an addendum to the NOTICE text from the Work, provided
- *          that such additional attribution notices cannot be construed
- *          as modifying the License.
- *
- *      You may add Your own copyright statement to Your modifications and
- *      may provide additional or different license terms and conditions
- *      for use, reproduction, or distribution of Your modifications, or
- *      for any such Derivative Works as a whole, provided Your use,
- *      reproduction, and distribution of the Work otherwise complies with
- *      the conditions stated in this License.
- *
- *   5. Submission of Contributions. Unless You explicitly state otherwise,
- *      any Contribution intentionally submitted for inclusion in the Work
- *      by You to the Licensor shall be under the terms and conditions of
- *      this License, without any additional terms or conditions.
- *      Notwithstanding the above, nothing herein shall supersede or modify
- *      the terms of any separate license agreement you may have executed
- *      with Licensor regarding such Contributions.
- *
- *   6. Trademarks. This License does not grant permission to use the trade
- *      names, trademarks, service marks, or product names of the Licensor,
- *      except as required for reasonable and customary use in describing the
- *      origin of the Work and reproducing the content of the NOTICE file.
- *
- *   7. Disclaimer of Warranty. Unless required by applicable law or
- *      agreed to in writing, Licensor provides the Work (and each
- *      Contributor provides its Contributions) on an "AS IS" BASIS,
- *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- *      implied, including, without limitation, any warranties or conditions
- *      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- *      PARTICULAR PURPOSE. You are solely responsible for determining the
- *      appropriateness of using or redistributing the Work and assume any
- *      risks associated with Your exercise of permissions under this License.
- *
- *   8. Limitation of Liability. In no event and under no legal theory,
- *      whether in tort (including negligence), contract, or otherwise,
- *      unless required by applicable law (such as deliberate and grossly
- *      negligent acts) or agreed to in writing, shall any Contributor be
- *      liable to You for damages, including any direct, indirect, special,
- *      incidental, or consequential damages of any character arising as a
- *      result of this License or out of the use or inability to use the
- *      Work (including but not limited to damages for loss of goodwill,
- *      work stoppage, computer failure or malfunction, or any and all
- *      other commercial damages or losses), even if such Contributor
- *      has been advised of the possibility of such damages.
- *
- *   9. Accepting Warranty or Additional Liability. While redistributing
- *      the Work or Derivative Works thereof, You may choose to offer,
- *      and charge a fee for, acceptance of support, warranty, indemnity,
- *      or other liability obligations and/or rights consistent with this
- *      License. However, in accepting such obligations, You may act only
- *      on Your own behalf and on Your sole responsibility, not on behalf
- *      of any other Contributor, and only if You agree to indemnify,
- *      defend, and hold each Contributor harmless for any liability
- *      incurred by, or claims asserted against, such Contributor by reason
- *      of your accepting any such warranty or additional liability.
- *
- *   END OF TERMS AND CONDITIONS
- *
- *   APPENDIX: How to apply the Apache License to your work.
- *
- *      To apply the Apache License to your work, attach the following
- *      boilerplate notice, with the fields enclosed by brackets "[]"
- *      replaced with your own identifying information. (Don't include
- *      the brackets!)  The text should be enclosed in the appropriate
- *      comment syntax for the file format. We also recommend that a
- *      file or class name and description of purpose be included on the
- *      same "printed page" as the copyright notice for easier
- *      identification within third-party archives.
- *
- *   Copyright [yyyy] [name of copyright owner]
- *
- *   Licensed under the Apache License, Version 2.0 (the "License");
- *   you may not use this file except in compliance with the License.
- *   You may obtain a copy of the License at
- *
- *       http://www.apache.org/licenses/LICENSE-2.0
- *
- *   Unless required by applicable law or agreed to in writing, software
- *   distributed under the License is distributed on an "AS IS" BASIS,
- *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *   See the License for the specific language governing permissions and
- *   limitations under the License.
- *
- */
-
 /*
- * $Id: AbstractBackend.java,v 1.9 2003/10/17 04:42:38 akarasulu Exp $
+ *   Copyright 2004 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.
+ *   You may obtain a copy of the License at
  *
- * -- (c) LDAPd Group                                                    --
- * -- Please refer to the LICENSE.txt file in the root directory of      --
- * -- any LDAPd project for copyright and distribution information.      --
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
  *
- * Created on Aug 15, 2003
  */
-package org.apache.ldap.server.backend ;
+package org.apache.eve;
+
 
+import java.util.Map;
+import java.math.BigInteger;
 
-import java.util.Hashtable ;
-import java.math.BigInteger ;
+import javax.naming.Name;
+import javax.naming.NamingException;
+import javax.naming.NamingEnumeration;
+import javax.naming.directory.Attributes;
+import javax.naming.directory.SearchControls;
+import javax.naming.ContextNotEmptyException;
+import javax.naming.directory.ModificationItem;
 
-import javax.naming.Name ;
-import javax.naming.ldap.Control ;
-import javax.naming.NamingException ;
-import javax.naming.NamingEnumeration ;
-import javax.naming.directory.Attributes ;
-import javax.naming.directory.SearchControls ;
-import javax.naming.ContextNotEmptyException ;
-import javax.naming.directory.ModificationItem ;
-
-import org.apache.ldap.common.filter.ExprNode ;
-import org.apache.ldap.server.backend.db.Database ;
-import org.apache.ldap.server.backend.db.search.SearchEngine ;
-import org.apache.ldap.server.backend.db.search.SearchResultEnumeration ;
+import org.apache.ldap.common.filter.ExprNode;
+
+import org.apache.eve.db.Database;
+import org.apache.eve.db.search.SearchEngine;
+import org.apache.eve.db.search.SearchResultEnumeration;
 
 
 /**
- * Abstract backend using a database and a search engine.  All the common code
- * between the SystemBackend and the DefaultBackend will be added to this super
- * class.
+ * An Abstract BackingStore using a formal database and a search engine.  All
+ * the common code between a SystemBackingStore and a DefaultBackingStore
+ * will be added to this super class.
  *
- * @author <a href="mailto:aok123@bellsouth.net">Alex Karasulu</a>
- * @author $Author: akarasulu $
- * @version $Revision: 1.9 $
+ * @author <a href="mailto:directory-dev@incubator.apache.org">Apache Directory Project</a>
+ * @version $Rev$
  */
-public abstract class AbstractBackend
-    implements AtomicBackend
+public abstract class AbstractBackingStore implements ContextPartition
 {
     /**
-     * the database used for this backend which is also initialized during
+     * the database used for this backing store which is also initialized during
      * configuration time
      */
-    private Database m_db = null ;
+    private Database db = null;
     
     /**
      * the search engine used to search the database
      */
-    private SearchEngine m_engine = null ;
+    private SearchEngine engine = null;
     
      
     // ------------------------------------------------------------------------
@@ -263,25 +63,25 @@
 
 
     /**
-     * Gets the Database used by this AtomicBackend.
+     * Gets the Database used by this ContextPartition.
      *
      * @return the database used
      */
     public Database getDb()
     {
-        return m_db ;
+        return db;
     }
 
 
     /**
-     * Gets the DefaultSearchEngine used by this AtomicBackend to search the 
+     * Gets the DefaultSearchEngine used by this ContextPartition to search the
      * Database. 
      *
      * @return the search engine
      */
     public SearchEngine getEngine()
     {
-        return m_engine ;
+        return engine;
     }
 
 
@@ -293,22 +93,22 @@
     /**
      * Sets the Database used by this AtomicBackend.
      *
-     * @param a_database the database
+     * @param database the database
      */
-    protected void setDb( Database a_database )
+    protected void setDb( Database database )
     {
-        m_db = a_database ;
+        db = database;
     }
 
 
     /**
      * Sets the search engine to be used by this Backend.
      *
-     * @param a_engine the search engine
+     * @param engine the search engine
      */
-    protected void setEngine( SearchEngine a_engine )
+    protected void setEngine( SearchEngine engine )
     {
-        m_engine = a_engine ;
+        this.engine = engine;
     }
 
 
@@ -318,134 +118,122 @@
 
 
     /**
-     * TODO Document me!
-     *
-     * @see org.apache.ldap.server.backend.Backend#delete( javax.naming.Name )
+     * @see org.apache.eve.BackingStore#delete( Name )
      */
-    public void delete( Name a_dn ) throws NamingException
+    public void delete( Name dn ) throws NamingException
     {
-        BigInteger l_id = m_db.getEntryId( a_dn.toString() ) ;
+        BigInteger id = db.getEntryId( dn.toString() );
         
-        if ( m_db.getChildCount( l_id ) > 0 )
+        if ( db.getChildCount( id ) > 0 )
         {
-            ContextNotEmptyException l_cnee = new ContextNotEmptyException(
-                "[66] Cannot delete entry " + a_dn + " it has children!" ) ;
-            l_cnee.setRemainingName( a_dn ) ;
-            throw l_cnee ;
+            ContextNotEmptyException cnee = new ContextNotEmptyException(
+                "[66] Cannot delete entry " + dn + " it has children!" );
+            cnee.setRemainingName( dn );
+            throw cnee;
         }
         
-        m_db.delete( l_id ) ;
+        db.delete( id );
     }
     
 
     /**
-     * @see org.apache.ldap.server.backend.Backend#add( javax.naming.Name,
-     *      javax.naming.directory.Attributes )
+     * @see org.apache.eve.BackingStore#add( String, Name, Attributes )
      */
-    public void add( String a_updn, Name a_dn, Attributes an_entry ) 
+    public void add( String updn, Name dn, Attributes entry )
         throws NamingException
     {
-        m_db.add( a_updn, a_dn, an_entry ) ;
+        db.add( updn, dn, entry );
     }
 
 
     /**
-     * @see org.apache.ldap.server.backend.Backend#modify( javax.naming.Name, int,
-     *      javax.naming.directory.Attributes )
+     * @see org.apache.eve.BackingStore#modify( Name, int, Attributes )
      */
-    public void modify( Name a_dn, int a_modOp, Attributes a_mods )
+    public void modify( Name dn, int modOp, Attributes mods )
         throws NamingException
     {
-        m_db.modify( a_dn, a_modOp, a_mods ) ;
+        db.modify( dn, modOp, mods );
     }
 
 
     /**
-     * @see org.apache.ldap.server.backend.Backend#modify( javax.naming.Name,
-     *      javax.naming.directory.ModificationItem[] )
+     * @see org.apache.eve.BackingStore#modify( Name,ModificationItem[] )
      */
-    public void modify( Name a_dn, ModificationItem[] a_mods )
+    public void modify( Name dn, ModificationItem[] mods )
         throws NamingException
     {
-        m_db.modify( a_dn, a_mods ) ;
+        db.modify( dn, mods );
     }
 
 
     /**
-     * @see org.apache.ldap.server.backend.Backend#list( javax.naming.Name )
+     * @see org.apache.eve.BackingStore#list( Name )
      */
-    public NamingEnumeration list( Name a_base ) throws NamingException
+    public NamingEnumeration list( Name base ) throws NamingException
     {
-        return m_db.list( m_db.getEntryId( a_base.toString() ) ) ;
+        return db.list( db.getEntryId( base.toString() ) );
     }
     
     
     /**
-     * @see org.apache.ldap.server.backend.Backend#search(javax.naming.Name, 
-     * java.util.Hashtable, org.apache.ldap.common.filter.ExprNode, 
-     * javax.naming.ldap.Control[], javax.naming.directory.SearchControls)
+     * @see org.apache.eve.BackingStore#search(Name, Map, ExprNode, SearchControls)
      */
-    public NamingEnumeration search( Name a_base, Hashtable a_env, 
-        ExprNode a_filter, Control [] a_reqCtls, SearchControls a_searchCtls ) 
+    public NamingEnumeration search( Name base, Map env, ExprNode filter,
+                                     SearchControls searchCtls )
         throws NamingException
     {
-        String [] l_attrIds = a_searchCtls.getReturningAttributes() ;
-        NamingEnumeration l_underlying = null ;
+        String [] attrIds = searchCtls.getReturningAttributes();
+        NamingEnumeration underlying = null;
         
-        l_underlying = m_engine
-            .search( a_base, a_env, a_filter, a_reqCtls, a_searchCtls ) ;
+        underlying = engine.search( base, env, filter, searchCtls );
         
-        return new SearchResultEnumeration( l_attrIds, l_underlying ) ;
+        return new SearchResultEnumeration( attrIds, underlying );
     }
 
 
     /**
-     * @see org.apache.ldap.server.backend.Backend#lookup( javax.naming.Name )
+     * @see org.apache.eve.BackingStore#lookup( Name )
      */
-    public Attributes lookup( Name a_dn ) throws NamingException
+    public Attributes lookup( Name dn ) throws NamingException
     {
-        return m_db.lookup( m_db.getEntryId( a_dn.toString() ) ) ;
+        return db.lookup( db.getEntryId( dn.toString() ) );
     }
 
 
     /**
-     * @see org.apache.ldap.server.backend.Backend#hasEntry( javax.naming.Name )
+     * @see org.apache.eve.BackingStore#hasEntry( Name )
      */
-    public boolean hasEntry( Name a_dn ) throws NamingException
+    public boolean hasEntry( Name dn ) throws NamingException
     {
-        return null != m_db.getEntryId( a_dn.toString() ) ;
+        return null != db.getEntryId( dn.toString() );
     }
 
 
     /**
-     * @see org.apache.ldap.server.backend.Backend#modifyRdn( javax.naming.Name,
-     *      java.lang.String, boolean )
+     * @see org.apache.eve.BackingStore#modifyRn( Name, String, boolean )
      */
-    public void modifyRdn( Name a_dn, String a_newRdn, boolean a_deleteOldRdn )
+    public void modifyRdn( Name dn, String newRdn, boolean deleteOldRdn )
         throws NamingException
     {
-        m_db.modifyRdn( a_dn, a_newRdn, a_deleteOldRdn ) ;
+        db.modifyRdn( dn, newRdn, deleteOldRdn );
     }
 
 
     /**
-     * @see org.apache.ldap.server.backend.Backend#move( javax.naming.Name,
-     *      javax.naming.Name )
+     * @see org.apache.eve.BackingStore#move( Name, Name )
      */
-    public void move( Name a_oldChildDn, Name a_newParentDn )
-        throws NamingException
+    public void move( Name oldChildDn, Name newParentDn ) throws NamingException
     {
-        m_db.move( a_oldChildDn, a_newParentDn ) ;
+        db.move( oldChildDn, newParentDn );
     }
     
 
     /**
-     * @see org.apache.ldap.server.backend.Backend#move( javax.naming.Name,
-     *      javax.naming.Name, java.lang.String, boolean )
+     * @see org.apache.eve.BackingStore#move( Name, Name, String, boolean )
      */
-    public void move( Name a_oldChildDn, Name a_newParentDn, String a_newRdn,
-        boolean a_deleteOldRdn ) throws NamingException
+    public void move( Name oldChildDn, Name newParentDn, String newRdn,
+        boolean deleteOldRdn ) throws NamingException
     {
-        m_db.move( a_oldChildDn, a_newParentDn, a_newRdn, a_deleteOldRdn ) ;
+        db.move( oldChildDn, newParentDn, newRdn, deleteOldRdn );
     }
-}
\ No newline at end of file
+}