You are viewing a plain text version of this content. The canonical link for it is here.
Posted to slide-dev@jakarta.apache.org by re...@apache.org on 2001/06/13 06:38:46 UTC

cvs commit: jakarta-slide/src/wrappers/jndi SlideDirContext.java

remm        01/06/12 21:38:46

  Added:       src/wrappers/jndi SlideDirContext.java
  Log:
  - Add a new alternative API to Slide : a JNDI directory context.
    It provides only read only access to the Slide namespace, only in guest
    mode.
    The dir context can be used for any purpose, but the main one is to provide
    a clean integration with Catalina (aka the servlet container in Tomcat 4).
    Some small improvements will be added later : for example, it could use the
    filesPath attrbute as the root for browsing the namespace, since it is
    supposed to provide a user view of the namespace.
  
  Revision  Changes    Path
  1.1                  jakarta-slide/src/wrappers/jndi/SlideDirContext.java
  
  Index: SlideDirContext.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-slide/src/wrappers/jndi/SlideDirContext.java,v 1.1 2001/06/13 04:38:45 remm Exp $
   * $Revision: 1.1 $
   * $Date: 2001/06/13 04:38:45 $
   *
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999 The Apache Software Foundation.  All rights 
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, 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 acknowlegement:  
   *       "This product includes software developed by the 
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Tomcat", 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 names without prior written
   *    permission of the Apache Group.
   *
   * 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 (INCLUDING, 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/>.
   *
   * [Additional notices, if required by prior licensing conditions]
   *
   */ 
  
  
  package wrappers.jndi;
  
  import java.util.Hashtable;
  import java.util.Vector;
  import java.util.Enumeration;
  import java.util.Date;
  import java.io.InputStream;
  import java.io.OutputStream;
  import java.io.IOException;
  import java.security.Principal;
  import javax.naming.Context;
  import javax.naming.Name;
  import javax.naming.NameParser;
  import javax.naming.NamingEnumeration;
  import javax.naming.NamingException;
  import javax.naming.CompositeName;
  import javax.naming.NameParser;
  import javax.naming.OperationNotSupportedException;
  import javax.naming.NameAlreadyBoundException;
  import javax.naming.directory.DirContext;
  import javax.naming.directory.Attributes;
  import javax.naming.directory.Attribute;
  import javax.naming.directory.ModificationItem;
  import javax.naming.directory.SearchControls;
  import org.apache.naming.StringManager;
  import org.apache.naming.NameParserImpl;
  import org.apache.naming.NamingEntry;
  import org.apache.naming.NamingContextBindingsEnumeration;
  import org.apache.naming.NamingContextEnumeration;
  import org.apache.naming.resources.BaseDirContext;
  import org.apache.naming.resources.Resource;
  import org.apache.naming.resources.ResourceAttributes;
  
  import org.apache.slide.structure.*;
  import org.apache.slide.content.*;
  import org.apache.slide.common.*;
  import org.apache.slide.lock.*;
  import org.apache.slide.security.*;
  import org.apache.slide.authenticate.CredentialsToken;
  import org.apache.slide.authenticate.SecurityToken;
  
  /**
   * Slide Directory Context implementation helper class.
   *
   * @author Remy Maucherat
   * @version $Revision: 1.1 $ $Date: 2001/06/13 04:38:45 $
   */
  
  public class SlideDirContext extends BaseDirContext {
  
  
      // -------------------------------------------------------------- Constants
  
  
      /**
       * The descriptive information string for this implementation.
       */
      protected static final int BUFFER_SIZE = 2048;
  
  
      // ----------------------------------------------------------- Constructors
  
  
      /**
       * Builds a file directory context using the given environment.
       */
      public SlideDirContext() {
          super();
      }
  
  
      /**
       * Builds a file directory context using the given environment.
       */
      public SlideDirContext(Hashtable env) {
          super(env);
      }
  
  
      /**
       * Builds a file directory context using the given environment.
       */
      protected SlideDirContext(Hashtable env, String namespaceName, 
                                String vPath) {
          super(env);
          
          setNamespaceName(namespaceName);
          this.vPath = vPath;
      }
  
  
      // ----------------------------------------------------- Instance Variables
  
  
      /**
       * Namespace token.
       */
      protected NamespaceAccessToken token = null;
  
  
      /**
       * Principal which will be used to access the namespace.
       */
      protected Principal principal = null;
  
  
      /**
       * Slide token.
       */
      protected SlideToken slideToken = null;
      
      
      /**
       * Virtual path.
       */
      protected String vPath = "";
      
      
      /**
       * Structure helper.
       */
      protected Structure structure = null;
      
      
      /**
       * Content helper.
       */
      protected Content content = null;
      
      
      /**
       * Namespace name. Is almost the same as docBase, but it is much simpler
       * to handle it this way.
       */
      protected String namespaceName = null;
      
      
      // ------------------------------------------------------------- Properties
  
  
      /**
       * Set namespace name.
       */
      public void setNamespaceName(String namespaceName) {
  
          this.namespaceName = namespaceName;
  
          token = Domain.accessNamespace(new SecurityToken(this), namespaceName);
  
          CredentialsToken credToken = null;
  
          if (principal == null) {
              credToken = new CredentialsToken("");
          } else {
              credToken = new CredentialsToken(principal);
          }
  
          this.slideToken = new SlideToken(credToken);
          this.slideToken.setEnforceLockTokens(false);
  
          this.structure = token.getStructureHelper();
          this.content = token.getContentHelper();
  
      }
  
  
      /**
       * Get namespace name.
       */
      public String getNamespaceName() {
          return namespaceName;
      }
  
  
      // --------------------------------------------------------- Public Methods
  
  
      // -------------------------------------------------------- Context Methods
  
  
      /**
       * Retrieves the named object.
       * 
       * @param name the name of the object to look up
       * @return the object bound to name
       * @exception NamingException if a naming exception is encountered
       */
      public Object lookup(String name)
          throws NamingException {
          
          try {
  
              NodeRevisionDescriptors revisionDescriptors =
                  content.retrieve(slideToken, getUri(name));
  
              if (revisionDescriptors.hasRevisions()) {
                  
                  // Retrieve latest revision descriptor
                  NodeRevisionDescriptor revisionDescriptor =
                      content.retrieve(slideToken, revisionDescriptors);
                  
                  if (!isCollection(revisionDescriptor)) {
                      return new SlideResource(revisionDescriptors, 
                                               revisionDescriptor);
                  }
                  
              }
  
          } catch (SlideException e) {
              throw new NamingException
                  (sm.getString("resources.notFound", name));
          }
          
          return new SlideDirContext(env, getNamespaceName(), getUri(name));
          
      }
  
  
      /**
       * Unbinds the named object. Removes the terminal atomic name in name 
       * from the target context--that named by all but the terminal atomic 
       * part of name.
       * <p>
       * This method is idempotent. It succeeds even if the terminal atomic 
       * name is not bound in the target context, but throws 
       * NameNotFoundException if any of the intermediate contexts do not exist. 
       * 
       * @param name the name to bind; may not be empty
       * @exception NameNotFoundException if an intermediate context does not 
       * exist
       * @exception NamingException if a naming exception is encountered
       */
      public void unbind(String name)
          throws NamingException {
  
          // FIXME ?
          throw new OperationNotSupportedException();
  
      }
  
  
      /**
       * Binds a new name to the object bound to an old name, and unbinds the 
       * old name. Both names are relative to this context. Any attributes 
       * associated with the old name become associated with the new name. 
       * Intermediate contexts of the old name are not changed.
       * 
       * @param oldName the name of the existing binding; may not be empty
       * @param newName the name of the new binding; may not be empty
       * @exception NameAlreadyBoundException if newName is already bound
       * @exception NamingException if a naming exception is encountered
       */
      public void rename(String oldName, String newName)
          throws NamingException {
  
          // FIXME ?
          throw new OperationNotSupportedException();
          
      }
  
  
      /**
       * Enumerates the names bound in the named context, along with the class 
       * names of objects bound to them. The contents of any subcontexts are 
       * not included.
       * <p>
       * If a binding is added to or removed from this context, its effect on 
       * an enumeration previously returned is undefined.
       * 
       * @param name the name of the context to list
       * @return an enumeration of the names and class names of the bindings in 
       * this context. Each element of the enumeration is of type NameClassPair.
       * @exception NamingException if a naming exception is encountered
       */
      public NamingEnumeration list(String name)
          throws NamingException {
  
          ObjectNode object = null;
  
          try {
              object = structure.retrieve(slideToken, getUri(name));
          } catch (SlideException e) {
              throw new NamingException
                  (sm.getString("resources.notFound", name));
          }
          
          Vector entries = list(object);
  
          return new NamingContextEnumeration(entries);
  
      }
  
  
      /**
       * Enumerates the names bound in the named context, along with the 
       * objects bound to them. The contents of any subcontexts are not 
       * included.
       * <p>
       * If a binding is added to or removed from this context, its effect on 
       * an enumeration previously returned is undefined.
       * 
       * @param name the name of the context to list
       * @return an enumeration of the bindings in this context. 
       * Each element of the enumeration is of type Binding.
       * @exception NamingException if a naming exception is encountered
       */
      public NamingEnumeration listBindings(String name)
          throws NamingException {
  
          ObjectNode object = null;
  
          try {
              object = structure.retrieve(slideToken, getUri(name));
          } catch (SlideException e) {
              throw new NamingException
                  (sm.getString("resources.notFound", name));
          }
          
          Vector entries = list(object);
  
          return new NamingContextBindingsEnumeration(entries);
  
      }
  
  
      /**
       * Destroys the named context and removes it from the namespace. Any 
       * attributes associated with the name are also removed. Intermediate 
       * contexts are not destroyed.
       * <p>
       * This method is idempotent. It succeeds even if the terminal atomic 
       * name is not bound in the target context, but throws 
       * NameNotFoundException if any of the intermediate contexts do not exist. 
       * 
       * In a federated naming system, a context from one naming system may be 
       * bound to a name in another. One can subsequently look up and perform 
       * operations on the foreign context using a composite name. However, an 
       * attempt destroy the context using this composite name will fail with 
       * NotContextException, because the foreign context is not a "subcontext" 
       * of the context in which it is bound. Instead, use unbind() to remove 
       * the binding of the foreign context. Destroying the foreign context 
       * requires that the destroySubcontext() be performed on a context from 
       * the foreign context's "native" naming system.
       * 
       * @param name the name of the context to be destroyed; may not be empty
       * @exception NameNotFoundException if an intermediate context does not 
       * exist
       * @exception NotContextException if the name is bound but does not name 
       * a context, or does not name a context of the appropriate type
       */
      public void destroySubcontext(String name)
          throws NamingException {
          unbind(name);
      }
  
  
      /**
       * Retrieves the named object, following links except for the terminal 
       * atomic component of the name. If the object bound to name is not a 
       * link, returns the object itself.
       * 
       * @param name the name of the object to look up
       * @return the object bound to name, not following the terminal link 
       * (if any).
       * @exception NamingException if a naming exception is encountered
       */
      public Object lookupLink(String name)
          throws NamingException {
          // Note : Links are not supported
          return lookup(name);
      }
  
  
      /**
       * Retrieves the full name of this context within its own namespace.
       * <p>
       * Many naming services have a notion of a "full name" for objects in 
       * their respective namespaces. For example, an LDAP entry has a 
       * distinguished name, and a DNS record has a fully qualified name. This 
       * method allows the client application to retrieve this name. The string 
       * returned by this method is not a JNDI composite name and should not be 
       * passed directly to context methods. In naming systems for which the 
       * notion of full name does not make sense, 
       * OperationNotSupportedException is thrown.
       * 
       * @return this context's name in its own namespace; never null
       * @exception OperationNotSupportedException if the naming system does 
       * not have the notion of a full name
       * @exception NamingException if a naming exception is encountered
       */
      public String getNameInNamespace()
          throws NamingException {
          return docBase;
      }
  
  
      // ----------------------------------------------------- DirContext Methods
  
  
      /**
       * Retrieves selected attributes associated with a named object. 
       * See the class description regarding attribute models, attribute type 
       * names, and operational attributes.
       * 
       * @return the requested attributes; never null
       * @param name the name of the object from which to retrieve attributes
       * @param attrIds the identifiers of the attributes to retrieve. null 
       * indicates that all attributes should be retrieved; an empty array 
       * indicates that none should be retrieved
       * @exception NamingException if a naming exception is encountered
       */
      public Attributes getAttributes(String name, String[] attrIds)
          throws NamingException {
  
          NodeRevisionDescriptor revisionDescriptor = null;
  
          try {
  
              NodeRevisionDescriptors revisionDescriptors =
                  content.retrieve(slideToken, getUri(name));
              
              if (revisionDescriptors.hasRevisions()) {
                  // Retrieve latest revision descriptor
                  revisionDescriptor = 
                      content.retrieve(slideToken, revisionDescriptors);
              } else {
                  revisionDescriptor = new NodeRevisionDescriptor();
              }
  
          } catch (SlideException e) {
              throw new NamingException
                  (sm.getString("resources.notFound", name));
          }
          
          // Return all the attributes all the time
          ResourceAttributes attrs = new ResourceAttributes();
          attrs.setCreationDate(revisionDescriptor.getCreationDateAsDate());
          attrs.setName(getRelativeName(name));
          if (!isCollection(revisionDescriptor))
              attrs.setResourceType("");
          attrs.setContentLength(revisionDescriptor.getContentLength());
          attrs.setLastModified(revisionDescriptor.getLastModifiedAsDate());
          return attrs;
  
      }
  
  
      /**
       * Modifies the attributes associated with a named object. The order of 
       * the modifications is not specified. Where possible, the modifications 
       * are performed atomically.
       * 
       * @param name the name of the object whose attributes will be updated
       * @param mod_op the modification operation, one of: ADD_ATTRIBUTE, 
       * REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTE
       * @param attrs the attributes to be used for the modification; may not 
       * be null
       * @exception AttributeModificationException if the modification cannot be
       * completed successfully
       * @exception NamingException if a naming exception is encountered
       */
      public void modifyAttributes(String name, int mod_op, Attributes attrs)
          throws NamingException {
          
          // FIXME ?
          throw new OperationNotSupportedException();
          
      }
  
  
      /**
       * Modifies the attributes associated with a named object using an an 
       * ordered list of modifications. The modifications are performed in the 
       * order specified. Each modification specifies a modification operation 
       * code and an attribute on which to operate. Where possible, the 
       * modifications are performed atomically.
       * 
       * @param name the name of the object whose attributes will be updated
       * @param mods an ordered sequence of modifications to be performed; may 
       * not be null
       * @exception AttributeModificationException if the modification cannot be
       * completed successfully
       * @exception NamingException if a naming exception is encountered
       */
      public void modifyAttributes(String name, ModificationItem[] mods)
          throws NamingException {
          
          // FIXME ?
          throw new OperationNotSupportedException();
          
      }
  
  
      /**
       * Binds a name to an object, along with associated attributes. If attrs 
       * is null, the resulting binding will have the attributes associated 
       * with obj if obj is a DirContext, and no attributes otherwise. If attrs 
       * is non-null, the resulting binding will have attrs as its attributes; 
       * any attributes associated with obj are ignored.
       * 
       * @param name the name to bind; may not be empty
       * @param obj the object to bind; possibly null
       * @param attrs the attributes to associate with the binding
       * @exception NameAlreadyBoundException if name is already bound
       * @exception InvalidAttributesException if some "mandatory" attributes 
       * of the binding are not supplied
       * @exception NamingException if a naming exception is encountered
       */
      public void bind(String name, Object obj, Attributes attrs)
          throws NamingException {
          
          // FIXME ?
          throw new OperationNotSupportedException();
          
      }
  
  
      /**
       * Binds a name to an object, along with associated attributes, 
       * overwriting any existing binding. If attrs is null and obj is a 
       * DirContext, the attributes from obj are used. If attrs is null and obj 
       * is not a DirContext, any existing attributes associated with the object
       * already bound in the directory remain unchanged. If attrs is non-null, 
       * any existing attributes associated with the object already bound in 
       * the directory are removed and attrs is associated with the named 
       * object. If obj is a DirContext and attrs is non-null, the attributes 
       * of obj are ignored.
       * 
       * @param name the name to bind; may not be empty
       * @param obj the object to bind; possibly null
       * @param attrs the attributes to associate with the binding
       * @exception InvalidAttributesException if some "mandatory" attributes 
       * of the binding are not supplied
       * @exception NamingException if a naming exception is encountered
       */
      public void rebind(String name, Object obj, Attributes attrs)
          throws NamingException {
          
          // FIXME ?
          throw new OperationNotSupportedException();
          
      }
  
  
      /**
       * Creates and binds a new context, along with associated attributes. 
       * This method creates a new subcontext with the given name, binds it in 
       * the target context (that named by all but terminal atomic component of 
       * the name), and associates the supplied attributes with the newly 
       * created object. All intermediate and target contexts must already 
       * exist. If attrs is null, this method is equivalent to 
       * Context.createSubcontext().
       * 
       * @param name the name of the context to create; may not be empty
       * @param attrs the attributes to associate with the newly created context
       * @return the newly created context
       * @exception NameAlreadyBoundException if the name is already bound
       * @exception InvalidAttributesException if attrs does not contain all 
       * the mandatory attributes required for creation
       * @exception NamingException if a naming exception is encountered
       */
      public DirContext createSubcontext(String name, Attributes attrs)
          throws NamingException {
          
          // FIXME ?
          throw new OperationNotSupportedException();
          
      }
  
  
      /**
       * Retrieves the schema associated with the named object. The schema 
       * describes rules regarding the structure of the namespace and the 
       * attributes stored within it. The schema specifies what types of 
       * objects can be added to the directory and where they can be added; 
       * what mandatory and optional attributes an object can have. The range 
       * of support for schemas is directory-specific.
       * 
       * @param name the name of the object whose schema is to be retrieved
       * @return the schema associated with the context; never null
       * @exception OperationNotSupportedException if schema not supported
       * @exception NamingException if a naming exception is encountered
       */
      public DirContext getSchema(String name)
          throws NamingException {
          throw new OperationNotSupportedException();
      }
  
  
      /**
       * Retrieves a context containing the schema objects of the named 
       * object's class definitions.
       * 
       * @param name the name of the object whose object class definition is to 
       * be retrieved
       * @return the DirContext containing the named object's class 
       * definitions; never null
       * @exception OperationNotSupportedException if schema not supported
       * @exception NamingException if a naming exception is encountered
       */
      public DirContext getSchemaClassDefinition(String name)
          throws NamingException {
          throw new OperationNotSupportedException();
      }
  
  
      /**
       * Searches in a single context for objects that contain a specified set 
       * of attributes, and retrieves selected attributes. The search is 
       * performed using the default SearchControls settings.
       * 
       * @param name the name of the context to search
       * @param matchingAttributes the attributes to search for. If empty or 
       * null, all objects in the target context are returned.
       * @param attributesToReturn the attributes to return. null indicates 
       * that all attributes are to be returned; an empty array indicates that 
       * none are to be returned.
       * @return a non-null enumeration of SearchResult objects. Each 
       * SearchResult contains the attributes identified by attributesToReturn 
       * and the name of the corresponding object, named relative to the 
       * context named by name.
       * @exception NamingException if a naming exception is encountered
       */
      public NamingEnumeration search(String name, Attributes matchingAttributes,
                                      String[] attributesToReturn)
          throws NamingException {
          return null;
      }
  
  
      /**
       * Searches in a single context for objects that contain a specified set 
       * of attributes. This method returns all the attributes of such objects. 
       * It is equivalent to supplying null as the atributesToReturn parameter 
       * to the method search(Name, Attributes, String[]).
       * 
       * @param name the name of the context to search
       * @param matchingAttributes the attributes to search for. If empty or 
       * null, all objects in the target context are returned.
       * @return a non-null enumeration of SearchResult objects. Each 
       * SearchResult contains the attributes identified by attributesToReturn 
       * and the name of the corresponding object, named relative to the 
       * context named by name.
       * @exception NamingException if a naming exception is encountered
       */
      public NamingEnumeration search(String name, Attributes matchingAttributes)
          throws NamingException {
          return null;
      }
  
  
      /**
       * Searches in the named context or object for entries that satisfy the 
       * given search filter. Performs the search as specified by the search 
       * controls.
       * 
       * @param name the name of the context or object to search
       * @param filter the filter expression to use for the search; may not be 
       * null
       * @param cons the search controls that control the search. If null, 
       * the default search controls are used (equivalent to 
       * (new SearchControls())).
       * @return an enumeration of SearchResults of the objects that satisfy 
       * the filter; never null
       * @exception InvalidSearchFilterException if the search filter specified 
       * is not supported or understood by the underlying directory
       * @exception InvalidSearchControlsException if the search controls 
       * contain invalid settings
       * @exception NamingException if a naming exception is encountered
       */
      public NamingEnumeration search(String name, String filter, 
                                      SearchControls cons)
          throws NamingException {
          return null;
      }
  
  
      /**
       * Searches in the named context or object for entries that satisfy the 
       * given search filter. Performs the search as specified by the search 
       * controls.
       * 
       * @param name the name of the context or object to search
       * @param filterExpr the filter expression to use for the search. 
       * The expression may contain variables of the form "{i}" where i is a 
       * nonnegative integer. May not be null.
       * @param filterArgs the array of arguments to substitute for the 
       * variables in filterExpr. The value of filterArgs[i] will replace each 
       * occurrence of "{i}". If null, equivalent to an empty array.
       * @param cons the search controls that control the search. If null, the 
       * default search controls are used (equivalent to (new SearchControls())).
       * @return an enumeration of SearchResults of the objects that satisy the 
       * filter; never null
       * @exception ArrayIndexOutOfBoundsException if filterExpr contains {i} 
       * expressions where i is outside the bounds of the array filterArgs
       * @exception InvalidSearchControlsException if cons contains invalid 
       * settings
       * @exception InvalidSearchFilterException if filterExpr with filterArgs 
       * represents an invalid search filter
       * @exception NamingException if a naming exception is encountered
       */
      public NamingEnumeration search(String name, String filterExpr, 
                                      Object[] filterArgs, SearchControls cons)
          throws NamingException {
          return null;
      }
  
  
      // ------------------------------------------------------ Protected Methods
  
  
      /**
       * Get the complete URI.
       */
      protected String getUri(String name) {
          return vPath + name;
      }
  
  
      /**
       * Get relative name.
       */
      protected String getRelativeName(String name) {
          String result = name;
          while (result.endsWith("/")) {
              result = result.substring(0, result.length() - 1);
          }
          int i = result.lastIndexOf('/');
          if (i != -1)
              result = result.substring(i + 1);
          return result;
      }
  
  
      /**
       * Tests if a resource is a collection.
       */
      protected boolean isCollection(NodeRevisionDescriptor revisionDescriptor) {
          
          boolean result = false;
          
          if (revisionDescriptor == null)
              return true;
          
          NodeProperty property = revisionDescriptor.getProperty("resourcetype");
          
          if ((property != null)
              && (property.getValue().equals("<collection/>"))) {
              result = true;
          }
          
          return result;
          
      }
  
  
      /**
       * List the resources which are members of a collection.
       * 
       * @param file Collection
       * @return Vector containg NamingEntry objects
       */
      protected Vector list(ObjectNode objectNode) {
  
          Vector entries = new Vector();
  
          Enumeration childrenNames = objectNode.enumerateChildren();
  
          NamingEntry entry = null;
  
          while (childrenNames.hasMoreElements()) {
  
              String childName = (String) childrenNames.nextElement();
              
              int length = objectNode.getUri().length();
              if (!objectNode.getUri().equals("/"))
                  length += 1;
              String childObjectName = childName.substring(length);
  
              Object object = null;
  
              try {
                  
                  NodeRevisionDescriptors revisionDescriptors =
                      content.retrieve(slideToken, childName);
                  
                  if (revisionDescriptors.hasRevisions()) {
                      
                      // Retrieve latest revision descriptor
                      NodeRevisionDescriptor revisionDescriptor =
                          content.retrieve(slideToken, revisionDescriptors);
                      
                      if (!isCollection(revisionDescriptor)) {
                          object = new SlideResource(revisionDescriptors, 
                                                     revisionDescriptor);
                      }
                      
                  }
  
                  if (object == null) {
                      object = new SlideDirContext(env, getNamespaceName(), 
                                                   childName);
                  }
                  
              } catch (SlideException e) {
              }
              
              if (object != null) {
                  entry = new NamingEntry(childObjectName, object, 
                                          NamingEntry.ENTRY);
                  entries.addElement(entry);
              }
  
          }
  
          return entries;
  
      }
  
  
      // ----------------------------------------------- FileResource Inner Class
  
  
      /**
       * This specialized resource implementation avoids opening the IputStream
       * to the file right away (which would put a lock on the file).
       */
      protected class SlideResource extends Resource {
          
          
          // -------------------------------------------------------- Constructor
          
          
          public SlideResource(NodeRevisionDescriptors rds, 
                               NodeRevisionDescriptor rd) {
              this.rds = rds;
              this.rd = rd;
          }
          
          
          // --------------------------------------------------- Member Variables
          
          
          protected NodeRevisionDescriptors rds;
          protected NodeRevisionDescriptor rd;
          
          
          // ----------------------------------------------------- Public Methods
          
          
          /**
           * Content accessor.
           * 
           * @return InputStream
           */
          public InputStream streamContent()
              throws IOException {
              if (binaryContent == null) {
                  try {
                      NodeRevisionContent rc = 
                          content.retrieve(slideToken, rds, rd);
                      inputStream = rc.streamContent();
                  } catch (SlideException e) {
                      throw new IOException(e.getMessage());
                  }
              }
              return super.streamContent();
          }
          
          
      }
  
  
  }