You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by ak...@apache.org on 2004/09/29 09:09:57 UTC
svn commit: rev 47469 - incubator/directory/eve/trunk/backend/core/src/java/org/apache/eve
Author: akarasulu
Date: Wed Sep 29 00:09:56 2004
New Revision: 47469
Added:
incubator/directory/eve/trunk/backend/core/src/java/org/apache/eve/BackingStore.java
- copied, changed from rev 47436, incubator/directory/eve/trunk/backend/sandbox/backend-api/src/java/org/apache/ldap/server/backend/Backend.java
Log:
Commit changes ...
During the process of copying over the Backend interface we did a few things:
o renamed Backend to BackingStore; we did this because really this interface
is for managing storage operations on JNDI Attributes (entries) within
namespaces
o modified interface methods to be less LDAP specific; we would like to
minimize the LDAP specificity so this apparatus can be used for any
directory namespace not just the LDAP namespace; to acheive that we did
the following:
o removed references to LDAP specific JNDI objects like Controls from
the javax.naming.directory.ldap package; these objects will be kept
within the env used for the call
o altered the use of identifiers in javadocs and parameters; we now refer
to absolute or distinguished names as 'names' instead of an LDAP
specific identifier like 'dn'; we also refer to a relative name (rn/RN)
rather than the LDAP specific identifier 'rdn'.
o altered method names to reflect more general hierarchical namespace
operations rather than LDAP specific operations
Notes ...
o some operations like modifyRn have an LDAP centric parameter to delete
attributes associated with RN on a name change; although other namespaces
can do this as well it still stinks of LDAP; we have two options for
managing this:
o use a special property in the environment for this deleteRn parameter
o keep it in the method signature as a first class parameter
o these changes need not be considered right away; it might create too much
to deal with while pulling the code in from the sand box - this can be done
incrementally
Copied: incubator/directory/eve/trunk/backend/core/src/java/org/apache/eve/BackingStore.java (from rev 47436, incubator/directory/eve/trunk/backend/sandbox/backend-api/src/java/org/apache/ldap/server/backend/Backend.java)
==============================================================================
--- incubator/directory/eve/trunk/backend/sandbox/backend-api/src/java/org/apache/ldap/server/backend/Backend.java (original)
+++ incubator/directory/eve/trunk/backend/core/src/java/org/apache/eve/BackingStore.java Wed Sep 29 00:09:56 2004
@@ -1,275 +1,77 @@
-/*
- * 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: Backend.java,v 1.4 2003/09/21 18:12:46 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
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
*
- * -- (c) LDAPd Group --
- * -- Please refer to the LICENSE.txt file in the root directory of --
- * -- any LDAPd project for copyright and distribution information. --
+ * 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.
*
*/
+package org.apache.eve;
-package org.apache.ldap.server.backend ;
+import java.util.Map;
-import java.util.Hashtable;
+import javax.naming.Name;
+import javax.naming.NamingException;
+import javax.naming.NamingEnumeration;
-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.directory.ModificationItem;
-import javax.naming.ldap.Control ;
-import javax.naming.directory.Attributes ;
-import javax.naming.directory.SearchControls ;
-import javax.naming.directory.ModificationItem ;
-
-import org.apache.ldap.common.filter.ExprNode ;
+import org.apache.ldap.common.filter.ExprNode;
/**
- * The Backend interface represents the operations that can be performed on a
- * Directory Information Base (DIB) which stores and manages the entries in a
- * Directory Information Tree (DIT).
+ * An interface to a store for JNDI Attributes within a hierarchical namespace.
+ * Currently we only have a BackingStore designed for managing LDAP/X.500
+ * namespaces although foreseeably other hierarchical namespaces (directories)
+ * can have BackingStore's implemented for them. A BackingStore contains the
+ * set of operations that can be performed on a JNDI Attributes.
*
- * @author <a href="mailto:aok123@bellsouth.net">Alex Karasulu</a>
- * @author $Author: akarasulu $
- * @version $Revision: 1.4 $
+ * @author <a href="mailto:directory-dev@incubator.apache.org">Apache Directory Project</a>
+ * @version $Rev$
*/
-public interface Backend
+public interface BackingStore
{
/**
- * Deletes a leaf entry from this Backend: non-leaf entries cannot be
+ * Deletes a leaf entry from this BackingStore: non-leaf entries cannot be
* deleted until this operation has been applied to their children.
*
- * @param a_dn the normalized distinguished name of the entry to delete
- * from this Backend.
+ * @param name the normalized distinguished/absolute name of the entry to
+ * delete from this BackingStore.
* @throws NamingException if there are any problems
*/
- void delete( Name a_dn ) throws NamingException ;
+ void delete( Name name ) throws NamingException;
/**
- * Adds an entry to this Backend.
+ * Adds an entry to this BackingStore.
*
- * @param a_updn the user provided distinguished name of the entry
- * @param a_ndn the normalized distinguished name of the entry
- * @param an_entry the entry to add to this Backend
+ * @param upName the user provided distinguished/absolute name of the entry
+ * @param normName the normalized distinguished/absolute name of the entry
+ * @param entry the entry to add to this BackingStore
* @throws NamingException if there are any problems
*/
- void add( String a_updn, Name a_ndn, Attributes an_entry )
- throws NamingException ;
+ void add( String upName, Name normName, Attributes entry )
+ throws NamingException;
/**
* Modifies an entry by adding, removing or replacing a set of attributes.
*
- * @param a_dn the normalized distinguished name of the entry to modify.
- * @param a_modOp the modification operation to perform on the entry which
+ * @param name the normalized distinguished/absolute name of the entry to
+ * modify
+ * @param modOp the modification operation to perform on the entry which
* is one of constants specified by the DirContext interface:
- * <code>ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTE
- * </code>.
- * @param a_mods the attributes and their values used to affect the
+ * <code>ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTE</code>.
+ * @param mods the attributes and their values used to affect the
* modification with.
* @throws NamingException if there are any problems
* @see javax.naming.directory.DirContext
@@ -277,131 +79,130 @@
* @see javax.naming.directory.DirContext.REMOVE_ATTRIBUTE
* @see javax.naming.directory.DirContext.REPLACE_ATTRIBUTE
*/
- void modify( Name a_dn, int a_modOp, Attributes a_mods )
- throws NamingException ;
+ void modify( Name name, int modOp, Attributes mods ) throws NamingException;
/**
* Modifies an entry by using a combination of adds, removes or replace
* operations using a set of ModificationItems.
*
- * @param a_dn the normalized distinguished name of the entry to modify.
- * @param a_mods the ModificationItems used to affect the modification
- * with.
+ * @param name the normalized distinguished/absolute name of the entry to modify
+ * @param mods the ModificationItems used to affect the modification with
* @throws NamingException if there are any problems
- * @see javax.naming.directory.ModificationItem
+ * @see ModificationItem
*/
- void modify( Name a_dn, ModificationItem [] a_mods )
- throws NamingException ;
+ void modify( Name name, ModificationItem [] mods ) throws NamingException;
/**
* A specialized form of one level search used to return a minimal set of
- * information regarding clikd entries under a base. Convenience method
+ * information regarding child entries under a base. Convenience method
* used to optimize operations rather than conducting a full search with
* retrieval.
*
- * @param a_base the base for the search/listing
+ * @param base the base distinguished/absolute name for the search/listing
* @return a NamingEnumeration containing objects of type
* <a href="http://java.sun.com/j2se/1.4.2/docs/api/
* javax/naming/NameClassPair.html">NameClassPair</a>.
* @throws NamingException if there are any problems
*/
- NamingEnumeration list( Name a_base ) throws NamingException ;
+ NamingEnumeration list( Name base ) throws NamingException;
/**
- * Conducts a search against this Backend.
- *
- * @param a_base the normalized distinguished name of the search base
- * @param a_env the environment under which operation occurs
- * @param a_filter the root node of the filter expression tree
- * @param a_reqCtls the LDAP search request controls
- * @param a_searchCtls the search controls
+ * Conducts a search against this BackingStore. Namespace specific
+ * parameters for search are contained within the environment using
+ * namespace specific keys into the hash. For example in the LDAP namespace
+ * a BackingStore implementation may look for search Controls using a
+ * namespace specific or implementation specific key for the set of LDAP
+ * Controls.
+ *
+ * @param base the normalized distinguished/absolute name of the search base
+ * @param env the environment under which operation occurs
+ * @param filter the root node of the filter expression tree
+ * @param searchCtls the search controls
* @throws NamingException if there are any problems
* @return a NamingEnumeration containing objects of type
* <a href="http://java.sun.com/j2se/1.4.2/docs/api/
* javax/naming/directory/SearchResult.html">SearchResult</a>.
*/
- NamingEnumeration search(
- Name a_base,
- Hashtable a_env,
- ExprNode a_filter,
- Control [] a_reqCtls,
- SearchControls a_searchCtls ) throws NamingException ;
+ NamingEnumeration search( Name base, Map env, ExprNode filter,
+ SearchControls searchCtls ) throws NamingException;
/**
- * Looks up an entry by distinguished name. This is a simplified version
- * of the search operation used to point read an entry used for
+ * Looks up an entry by distinguished/absolute name. This is a simplified
+ * version of the search operation used to point read an entry used for
* convenience.
*
- * @param a_dn the normalized distinguished name of the object to lookup
+ * @param name the normalized distinguished name of the object to lookup
* @return an Attributes object representing the entry
* @throws NamingException if there are any problems
*/
- Attributes lookup( Name a_dn ) throws NamingException ;
+ Attributes lookup( Name name ) throws NamingException;
/**
* Fast operation to check and see if a particular entry exists.
*
- * @param a_dn the normalized distinguished name of the object to check for
- * existance.
- * @return true if the entry exists, false if it does not.
+ * @param name the normalized distinguished/absolute name of the object to
+ * check for existance
+ * @return true if the entry exists, false if it does not
* @throws NamingException if there are any problems
*/
- boolean hasEntry( Name a_dn ) throws NamingException ;
+ boolean hasEntry( Name name ) throws NamingException;
/**
- * Checks to see if an entry is a suffix.
+ * Checks to see if name is a context suffix.
*
- * @param a_dn the normalized distinguished name of the entry to test
- * @return true if the entry is a suffix, false if it does not.
+ * @param name the normalized distinguished/absolute name of the context
+ * @return true if the name is a context suffix, false if it is not.
* @throws NamingException if there are any problems
*/
- boolean isSuffix( Name a_dn ) throws NamingException ;
+ boolean isSuffix( Name name ) throws NamingException;
/**
- * Modifies the entry by changing its Relative Distinguished Name (RDN) and
- * optionally removing the old RDN attribute.
+ * Modifies an entry by changing its relative name. Optionally attributes
+ * associated with the old relative name can be removed from the entry.
+ * This makes sense only in certain namespaces like LDAP and will be ignored
+ * if it is irrelavent.
*
- * @param a_dn the normalized distinguished name of the entry to modify the
- * RDN of.
- * @param a_newRdn the new RDN of the entry specified as an equality
- * assertion value pair with the following syntax: <attribute> = <value>.
- * @param a_deleteOldRdn boolean flag which removes the old RDN attribute
- * from the entry if set to true, and has no affect if set to false.
+ * @param name the normalized distinguished/absolute name of the entry to
+ * modify the RN of.
+ * @param newRn the new RN of the entry specified by name
+ * @param deleteOldRn boolean flag which removes the old RN attribute
+ * from the entry if set to true, and has no affect if set to false
* @throws NamingException if there are any problems
*/
- void modifyRdn( Name a_dn, String a_newRdn, boolean a_deleteOldRdn )
- throws NamingException ;
+ void modifyRn( Name name, String newRn, boolean deleteOldRn )
+ throws NamingException;
/**
- * Transplants a child entry, to a position in the DIT under a new parent
- * entry.
+ * Transplants a child entry, to a position in the namespace under a new
+ * parent entry.
*
- * @param a_newParentDn the normalized distinguished name of the new parent
- * to move the targeted entry to.
- * @param a_oldChildDn the normalized distinguished name of the older child
- * Dn representing the child entry to move.
+ * @param newParentName the normalized distinguished/absolute name of the
+ * new parent to move the target entry to
+ * @param oriChildName the normalized distinguished/absolute name of the
+ * original child name representing the child entry to move
* @throws NamingException if there are any problems
*/
- void move( Name a_oldChildDn, Name a_newParentDn )
- throws NamingException ;
+ void move( Name oriChildName, Name newParentName ) throws NamingException;
/**
- * Transplants a child entry, to a position in the DIT under a new parent
- * entry and changes the RDN of the child entry which can optionally have
- * its old RDN attributes removed.
+ * Transplants a child entry, to a position in the namespace under a new
+ * parent entry and changes the RN of the child entry which can optionally
+ * have its old RN attributes removed. The removal of old RN attributes
+ * may not make sense in all namespaces. If the concept is undefined in a
+ * namespace this parameters is ignored. An example of a namespace where
+ * this parameter is significant is the LDAP namespace.
*
- * @param a_oldChildDn the normalized distinguished name of the old child
- * Dn representing the child entry to move.
- * @param a_newParentDn the normalized distinguished name of the new parent
- * to move the targeted entry to.
- * @param a_newRdn the new RDN of the entry specified as an equality
- * assertion value pair with the following syntax: <attribute> = <value>.
- * @param a_deleteOldRdn boolean flag which removes the old RDN attribute
- * from the entry if set to true, and has no affect if set to false.
+ * @param oriChildName the normalized distinguished/absolute name of the
+ * original child name representing the child entry to move
+ * @param newParentName the normalized distinguished/absolute name of the
+ * new parent to move the targeted entry to
+ * @param newRn the new RN of the entry
+ * @param deleteOldRn boolean flag which removes the old RN attribute
+ * from the entry if set to true, and has no affect if set to false
* @throws NamingException if there are any problems
*/
- void move( Name a_oldChildDn, Name a_newParentDn, String a_newRdn,
- boolean a_deleteOldRdn ) throws NamingException ;
+ void move( Name oriChildName, Name newParentName, String newRn,
+ boolean deleteOldRn ) throws NamingException;
}