Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   /*
    * JBoss, Home of Professional Open Source.
    * Copyright 2012 Red Hat, Inc., and individual contributors
    * as indicated by the @author tags.
    *
    * 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.
   */
  
  package org.apache.naming.resources;
  
  import java.util.HashMap;
  
  import javax.naming.Name;
  
Proxy Directory Context implementation. This implementation looks up the resources from a main DirContext, with secondary DirContext allowed to provide overlays for the main one, when caching is enabled.

Author(s):
Remy Maucherat
Version:
$Revision: 1914 $ $Date: 2012-01-06 11:24:41 +0100 (Fri, 06 Jan 2012) $
  
  
  public class ProxyDirContext implements DirContext {
  
  
      // -------------------------------------------------------------- Constants
  
  
      public static final String CONTEXT = "context";
      public static final String HOST = "host";
  
  
      // ----------------------------------------------------------- Constructors
  

    
Builds a proxy directory context using the given environment.
  
      public ProxyDirContext(Hashtable<StringObjectenvDirContext dirContext) {
          this. = env;
          this. = dirContext;
          if (dirContext instanceof BaseDirContext) {
              // Initialize parameters based on the associated dir context, like
              // the caching policy.
              BaseDirContext baseDirContext = (BaseDirContextdirContext;
              if (baseDirContext.isCached()) {
                  if ( != null) {
                      try {
                           = (ResourceCache
                          Class.forName().newInstance();
                      } catch (Exception e) {
                          throw new IllegalArgumentException(e);
                      }
                  } else {
                       = new ResourceCache();
                  }
                  .setCacheMaxSize(baseDirContext.getCacheMaxSize());
                  .setSpareNotFoundEntries(baseDirContext.getCacheMaxSize()/8);
                   = baseDirContext.getCacheTTL();
                   = baseDirContext.getCacheObjectMaxSize();
                  // cacheObjectMaxSize must be less than cacheMaxSize
                  // Set a sensible limit
                  if ( > baseDirContext.getCacheMaxSize()/32) {
                      = baseDirContext.getCacheMaxSize()/32;
                 }
             }
         }
          = (Stringenv.get();
          = (Stringenv.get();
     }
 
 
     // ----------------------------------------------------- Instance Variables
 

    
Environment.
 
     protected Hashtable<StringObjectenv;


    
Associated DirContext.
 
     protected DirContext dirContext;


    
Overlay DirContexts.
 
     protected DirContext[] overlays = null;


    
Host name.
 
     protected String hostName;


    
Context name.
 
     protected String contextName;


    
Cache class.
 
     protected String cacheClassName = 
         "org.apache.naming.resources.ResourceCache";


    
Cache.
 
     protected ResourceCache cache = null;


    
Cache TTL.
 
     protected int cacheTTL = 5000; // 5s
 

    
Max size of resources which will have their content cached.
 
     protected int cacheObjectMaxSize = 512; // 512 KB
 

    
Immutable name not found exception.
 
         new ImmutableNameNotFoundException();


    
Non cacheable resources.
 
     protected String[] nonCacheable = { "/WEB-INF/lib/""/WEB-INF/classes/" };
 
 
     // --------------------------------------------------------- Public Methods
 

    
Get the cache used for this context.
 
     public ResourceCache getCache() {
         return ;
     }


    
Return the actual directory context we are wrapping.
 
     public DirContext getDirContext() {
         return this.;
     }


    
Return the document root for this component.
 
     public String getDocBase() {
         if ( instanceof BaseDirContext)
             return ((BaseDirContext).getDocBase();
         else
             return "";
     }


    
Return the host name.
 
     public String getHostName() {
         return this.;
     }


    
Return the context name.
 
     public String getContextName() {
         return this.;
     }

    
    
Add overlay.
 
     public void addOverlay(DirContext overlay) {
         if (overlay == null) {
             throw new IllegalArgumentException("Overlay cannot be null");
         }
         if ( == null) {
              = new DirContext[0];
         }
         DirContext[] result = new DirContext[. + 1];
         System.arraycopy(, 0, result, 0, .);
         result[.] = overlay;
          = result;
     }
     
 
     // -------------------------------------------------------- Context Methods
 

    
Retrieves the named object. If name is empty, returns a new instance of this context (which represents the same naming context as this context, but its environment may be modified independently and it may be accessed concurrently).

Parameters:
name the name of the object to look up
Returns:
the object bound to name
Throws:
javax.naming.NamingException if a naming exception is encountered
 
     public Object lookup(Name name)
         throws NamingException {
         CacheEntry entry = cacheLookup(name.toString());
         if (entry != null) {
             if (!entry.exists) {
                 throw ;
             }
             if (entry.resource != null) {
                 // Check content caching.
                 return entry.resource;
             } else {
                 return entry.context;
             }
         }
         Object object = .lookup(parseName(name));
         if (object instanceof InputStream)
             return new Resource((InputStreamobject);
         else
             return object;
     }


    
Retrieves the named object.

Parameters:
name the name of the object to look up
Returns:
the object bound to name
Throws:
javax.naming.NamingException if a naming exception is encountered
 
     public Object lookup(String name)
         throws NamingException {
         CacheEntry entry = cacheLookup(name);
         if (entry != null) {
             if (!entry.exists) {
                 throw ;
             }
             if (entry.resource != null) {
                 return entry.resource;
             } else {
                 return entry.context;
             }
         }
         Object object = .lookup(parseName(name));
         if (object instanceof InputStream) {
             return new Resource((InputStreamobject);
         } else if (object instanceof DirContext) {
             return object;
         } else if (object instanceof Resource) {
             return object;
         } else {
             return new Resource(new ByteArrayInputStream
                 (object.toString().getBytes()));
         }
     }


    
Binds a name to an object. All intermediate contexts and the target context (that named by all but terminal atomic component of the name) must already exist.

Parameters:
name the name to bind; may not be empty
obj the object to bind; possibly null
Throws:
javax.naming.NameAlreadyBoundException if name is already bound
javax.naming.directory.InvalidAttributesException if object did not supply all mandatory attributes
javax.naming.NamingException if a naming exception is encountered
 
     public void bind(Name nameObject obj)
         throws NamingException {
         .bind(parseName(name), obj);
         cacheUnload(name.toString());
     }


    
Binds a name to an object.

Parameters:
name the name to bind; may not be empty
obj the object to bind; possibly null
Throws:
javax.naming.NameAlreadyBoundException if name is already bound
javax.naming.directory.InvalidAttributesException if object did not supply all mandatory attributes
javax.naming.NamingException if a naming exception is encountered
 
     public void bind(String nameObject obj)
         throws NamingException {
         .bind(parseName(name), obj);
         cacheUnload(name);
     }


    
Binds a name to an object, overwriting any existing binding. All intermediate contexts and the target context (that named by all but terminal atomic component of the name) must already exist.

If the object is a DirContext, any existing attributes associated with the name are replaced with those of the object. Otherwise, any existing attributes associated with the name remain unchanged.

Parameters:
name the name to bind; may not be empty
obj the object to bind; possibly null
Throws:
javax.naming.directory.InvalidAttributesException if object did not supply all mandatory attributes
javax.naming.NamingException if a naming exception is encountered
 
     public void rebind(Name nameObject obj)
         throws NamingException {
         .rebind(parseName(name), obj);
         cacheUnload(name.toString());
     }


    
Binds a name to an object, overwriting any existing binding.

Parameters:
name the name to bind; may not be empty
obj the object to bind; possibly null
Throws:
javax.naming.directory.InvalidAttributesException if object did not supply all mandatory attributes
javax.naming.NamingException if a naming exception is encountered
 
     public void rebind(String nameObject obj)
         throws NamingException {
         .rebind(parseName(name), obj);
         cacheUnload(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.

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.

Parameters:
name the name to bind; may not be empty
Throws:
javax.naming.NameNotFoundException if an intermediate context does not exist
javax.naming.NamingException if a naming exception is encountered
 
     public void unbind(Name name)
         throws NamingException {
         .unbind(parseName(name));
         cacheUnload(name.toString());
     }


    
Unbinds the named object.

Parameters:
name the name to bind; may not be empty
Throws:
javax.naming.NameNotFoundException if an intermediate context does not exist
javax.naming.NamingException if a naming exception is encountered
 
     public void unbind(String name)
         throws NamingException {
         .unbind(parseName(name));
         cacheUnload(name);
     }


    
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.

Parameters:
oldName the name of the existing binding; may not be empty
newName the name of the new binding; may not be empty
Throws:
javax.naming.NameAlreadyBoundException if newName is already bound
javax.naming.NamingException if a naming exception is encountered
 
     public void rename(Name oldNameName newName)
         throws NamingException {
         .rename(parseName(oldName), parseName(newName));
         cacheUnload(oldName.toString());
     }


    
Binds a new name to the object bound to an old name, and unbinds the old name.

Parameters:
oldName the name of the existing binding; may not be empty
newName the name of the new binding; may not be empty
Throws:
javax.naming.NameAlreadyBoundException if newName is already bound
javax.naming.NamingException if a naming exception is encountered
 
     public void rename(String oldNameString newName)
         throws NamingException {
         .rename(parseName(oldName), parseName(newName));
         cacheUnload(oldName);
     }


    
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.

If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.

Parameters:
name the name of the context to list
Returns:
an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.
Throws:
javax.naming.NamingException if a naming exception is encountered
 
     public NamingEnumeration<NameClassPairlist(Name name)
         throws NamingException {
         if ( == null) {
             return .list(parseName(name));
         } else {
             NamingException notFound = null;
             HashMap<StringNameClassPairmerged = null;
             NamingEnumeration<NameClassPairmain = null;
             try {
                 main = .list(parseName(name));
             } catch (NamingException e) {
                 notFound = e;
             }
             for (int i = 0; i < .i++) {
                 NamingEnumeration<NameClassPairoverlay = null;
                 try {
                     overlay = [i].list(parseName(name));
                     if (main == null) {
                         main = overlay;
                     } else {
                         // Merge that into the merged set
                         if (merged == null) {
                             merged = new HashMap<StringNameClassPair>();
                             while (main.hasMore()) {
                                 NameClassPair pair = main.next();
                                 merged.put(pair.getName(), pair);
                             }
                         }
                         while (overlay.hasMore()) {
                             NameClassPair pair = overlay.next();
                             if (merged.get(pair.getName()) == null) {
                                 merged.put(pair.getName(), pair);
                             }
                         }
                     }
                 } catch (NamingException e) {
                     // Ignore
                 }
             }
             if (main == null && merged == null) {
                 throw notFound;
             } else if (merged != null) {
                 return new NamingEnumerationImpl<NameClassPair>(merged.values());
             } else {
                 return main;
             }
         }
     }


    
Enumerates the names bound in the named context, along with the class names of objects bound to them.

Parameters:
name the name of the context to list
Returns:
an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.
Throws:
javax.naming.NamingException if a naming exception is encountered
 
     public NamingEnumeration<NameClassPairlist(String name)
         throws NamingException {
         if ( == null) {
             return .list(parseName(name));
         } else {
             NamingException notFound = null;
             HashMap<StringNameClassPairmerged = null;
             NamingEnumeration<NameClassPairmain = null;
             try {
                 main = .list(parseName(name));
             } catch (NamingException e) {
                 notFound = e;
             }
             for (int i = 0; i < .i++) {
                 NamingEnumeration<NameClassPairoverlay = null;
                 try {
                     overlay = [i].list(parseName(name));
                     if (main == null) {
                         main = overlay;
                     } else {
                         // Merge that into the merged set
                         if (merged == null) {
                             merged = new HashMap<StringNameClassPair>();
                             while (main.hasMore()) {
                                 NameClassPair pair = main.next();
                                 merged.put(pair.getName(), pair);
                             }
                         }
                         while (overlay.hasMore()) {
                             NameClassPair pair = overlay.next();
                             if (merged.get(pair.getName()) == null) {
                                 merged.put(pair.getName(), pair);
                             }
                         }
                     }
                 } catch (NamingException e) {
                     // Ignore
                 }
             }
             if (main == null && merged == null) {
                 throw notFound;
             } else if (merged != null) {
                 return new NamingEnumerationImpl<NameClassPair>(merged.values());
             } else {
                 return main;
             }
         }
     }


    
Enumerates the names bound in the named context, along with the objects bound to them. The contents of any subcontexts are not included.

If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.

Parameters:
name the name of the context to list
Returns:
an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.
Throws:
javax.naming.NamingException if a naming exception is encountered
 
     public NamingEnumeration<BindinglistBindings(Name name)
         throws NamingException {
         if ( == null) {
             return .listBindings(parseName(name));
         } else {
             NamingException notFound = null;
             HashMap<StringBindingmerged = null;
             NamingEnumeration<Bindingmain = null;
             try {
                 main = .listBindings(parseName(name));
             } catch (NamingException e) {
                 notFound = e;
             }
             for (int i = 0; i < .i++) {
                 NamingEnumeration<Bindingoverlay = null;
                 try {
                     overlay = [i].listBindings(parseName(name));
                     if (main == null) {
                         main = overlay;
                     } else {
                         // Merge that into the merged set
                         if (merged == null) {
                             merged = new HashMap<StringBinding>();
                             while (main.hasMore()) {
                                 Binding pair = main.next();
                                 merged.put(pair.getName(), pair);
                             }
                         }
                         while (overlay.hasMore()) {
                             Binding pair = overlay.next();
                             if (merged.get(pair.getName()) == null) {
                                 merged.put(pair.getName(), pair);
                             }
                         }
                     }
                 } catch (NamingException e) {
                     // Ignore
                 }
             }
             if (main == null && merged == null) {
                 throw notFound;
             } else if (merged != null) {
                 return new NamingEnumerationImpl<Binding>(merged.values());
             } else {
                 return main;
             }
         }
     }


    
Enumerates the names bound in the named context, along with the objects bound to them.

Parameters:
name the name of the context to list
Returns:
an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.
Throws:
javax.naming.NamingException if a naming exception is encountered
 
     public NamingEnumeration<BindinglistBindings(String name)
         throws NamingException {
         if ( == null) {
             return .listBindings(parseName(name));
         } else {
             NamingException notFound = null;
             HashMap<StringBindingmerged = null;
             NamingEnumeration<Bindingmain = null;
             try {
                 main = .listBindings(parseName(name));
             } catch (NamingException e) {
                 notFound = e;
             }
             for (int i = 0; i < .i++) {
                 NamingEnumeration<Bindingoverlay = null;
                 try {
                     overlay = [i].listBindings(parseName(name));
                     if (main == null) {
                         main = overlay;
                     } else {
                         // Merge that into the merged set
                         if (merged == null) {
                             merged = new HashMap<StringBinding>();
                             while (main.hasMore()) {
                                 Binding pair = main.next();
                                 merged.put(pair.getName(), pair);
                             }
                         }
                         while (overlay.hasMore()) {
                             Binding pair = overlay.next();
                             if (merged.get(pair.getName()) == null) {
                                 merged.put(pair.getName(), pair);
                             }
                         }
                     }
                 } catch (NamingException e) {
                     // Ignore
                 }
             }
             if (main == null && merged == null) {
                 throw notFound;
             } else if (merged != null) {
                 return new NamingEnumerationImpl<Binding>(merged.values());
             } else {
                 return main;
             }
         }
     }


    
Destroys the named context and removes it from the namespace. Any attributes associated with the name are also removed. Intermediate contexts are not destroyed.

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.

Parameters:
name the name of the context to be destroyed; may not be empty
Throws:
javax.naming.NameNotFoundException if an intermediate context does not exist
javax.naming.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(Name name)
         throws NamingException {
         .destroySubcontext(parseName(name));
         cacheUnload(name.toString());
     }


    
Destroys the named context and removes it from the namespace.

Parameters:
name the name of the context to be destroyed; may not be empty
Throws:
javax.naming.NameNotFoundException if an intermediate context does not exist
javax.naming.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 {
         .destroySubcontext(parseName(name));
         cacheUnload(name);
     }


    
Creates and binds a new context. Creates a new context with the given name and binds it in the target context (that named by all but terminal atomic component of the name). All intermediate contexts and the target context must already exist.

Parameters:
name the name of the context to create; may not be empty
Returns:
the newly created context
Throws:
javax.naming.NameAlreadyBoundException if name is already bound
javax.naming.directory.InvalidAttributesException if creation of the subcontext requires specification of mandatory attributes
javax.naming.NamingException if a naming exception is encountered
 
     public Context createSubcontext(Name name)
         throws NamingException {
         Context context = .createSubcontext(parseName(name));
         cacheUnload(name.toString());
         return context;
     }


    
Creates and binds a new context.

Parameters:
name the name of the context to create; may not be empty
Returns:
the newly created context
Throws:
javax.naming.NameAlreadyBoundException if name is already bound
javax.naming.directory.InvalidAttributesException if creation of the subcontext requires specification of mandatory attributes
javax.naming.NamingException if a naming exception is encountered
 
     public Context createSubcontext(String name)
         throws NamingException {
         Context context = .createSubcontext(parseName(name));
         cacheUnload(name);
         return context;
     }


    
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.

Parameters:
name the name of the object to look up
Returns:
the object bound to name, not following the terminal link (if any).
Throws:
javax.naming.NamingException if a naming exception is encountered
 
     public Object lookupLink(Name name)
         throws NamingException {
         return .lookupLink(parseName(name));
     }


    
Retrieves the named object, following links except for the terminal atomic component of the name.

Parameters:
name the name of the object to look up
Returns:
the object bound to name, not following the terminal link (if any).
Throws:
javax.naming.NamingException if a naming exception is encountered
 
     public Object lookupLink(String name)
         throws NamingException {
         return .lookupLink(parseName(name));
     }


    
Retrieves the parser associated with the named context. In a federation of namespaces, different naming systems will parse names differently. This method allows an application to get a parser for parsing names into their atomic components using the naming convention of a particular naming system. Within any single naming system, NameParser objects returned by this method must be equal (using the equals() test).

Parameters:
name the name of the context from which to get the parser
Returns:
a name parser that can parse compound names into their atomic components
Throws:
javax.naming.NamingException if a naming exception is encountered
 
     public NameParser getNameParser(Name name)
         throws NamingException {
         return .getNameParser(parseName(name));
     }


    
Retrieves the parser associated with the named context.

Parameters:
name the name of the context from which to get the parser
Returns:
a name parser that can parse compound names into their atomic components
Throws:
javax.naming.NamingException if a naming exception is encountered
 
     public NameParser getNameParser(String name)
         throws NamingException {
         return .getNameParser(parseName(name));
     }


    
Composes the name of this context with a name relative to this context.

Given a name (name) relative to this context, and the name (prefix) of this context relative to one of its ancestors, this method returns the composition of the two names using the syntax appropriate for the naming system(s) involved. That is, if name names an object relative to this context, the result is the name of the same object, but relative to the ancestor context. None of the names may be null.

Parameters:
name a name relative to this context
prefix the name of this context relative to one of its ancestors
Returns:
the composition of prefix and name
Throws:
javax.naming.NamingException if a naming exception is encountered
 
     public Name composeName(Name nameName prefix)
         throws NamingException {
         prefix = (Nameprefix.clone();
         return prefix.addAll(name);
     }


    
Composes the name of this context with a name relative to this context.

Parameters:
name a name relative to this context
prefix the name of this context relative to one of its ancestors
Returns:
the composition of prefix and name
Throws:
javax.naming.NamingException if a naming exception is encountered
 
     public String composeName(String nameString prefix)
         throws NamingException {
         return prefix + "/" + name;
     }


    
Adds a new environment property to the environment of this context. If the property already exists, its value is overwritten.

Parameters:
propName the name of the environment property to add; may not be null
propVal the value of the property to add; may not be null
Throws:
javax.naming.NamingException if a naming exception is encountered
 
     public Object addToEnvironment(String propNameObject propVal)
         throws NamingException {
         return .addToEnvironment(propNamepropVal);
     }


    
Removes an environment property from the environment of this context.

Parameters:
propName the name of the environment property to remove; may not be null
Throws:
javax.naming.NamingException if a naming exception is encountered
 
     public Object removeFromEnvironment(String propName)
         throws NamingException {
         return .removeFromEnvironment(propName);
     }


    
Retrieves the environment in effect for this context. See class description for more details on environment properties. The caller should not make any changes to the object returned: their effect on the context is undefined. The environment of this context may be changed using addToEnvironment() and removeFromEnvironment().

Returns:
the environment of this context; never null
Throws:
javax.naming.NamingException if a naming exception is encountered
 
     public Hashtable<?,?> getEnvironment()
         throws NamingException {
         return .getEnvironment();
     }


    
Closes this context. This method releases this context's resources immediately, instead of waiting for them to be released automatically by the garbage collector. This method is idempotent: invoking it on a context that has already been closed has no effect. Invoking any other method on a closed context is not allowed, and results in undefined behaviour.

Throws:
javax.naming.NamingException if a naming exception is encountered
 
     public void close()
         throws NamingException {
         .close();
     }


    
Retrieves the full name of this context within its own namespace.

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.

Returns:
this context's name in its own namespace; never null
Throws:
javax.naming.OperationNotSupportedException if the naming system does not have the notion of a full name
javax.naming.NamingException if a naming exception is encountered
 
     public String getNameInNamespace()
         throws NamingException {
         return .getNameInNamespace();
     }
 
 
     // ----------------------------------------------------- DirContext Methods
 

    
Retrieves all of the attributes associated with a named object.

Parameters:
name the name of the object from which to retrieve attributes
Returns:
the set of attributes associated with name. Returns an empty attribute set if name has no attributes; never null.
Throws:
javax.naming.NamingException if a naming exception is encountered
 
     public Attributes getAttributes(Name name)
         throws NamingException {
         CacheEntry entry = cacheLookup(name.toString());
         if (entry != null) {
             if (!entry.exists) {
                 throw ;
             }
             return entry.attributes;
         }
         Attributes attributes = .getAttributes(parseName(name));
         if (!(attributes instanceof ResourceAttributes)) {
             attributes = new ResourceAttributes(attributes);
         }
         return attributes;
     }


    
Retrieves all of the attributes associated with a named object.

Parameters:
name the name of the object from which to retrieve attributes
Returns:
the set of attributes associated with name
Throws:
javax.naming.NamingException if a naming exception is encountered
    public Attributes getAttributes(String name)
        throws NamingException {
        CacheEntry entry = cacheLookup(name);
        if (entry != null) {
            if (!entry.exists) {
                throw ;
            }
            return entry.attributes;
        }
        Attributes attributes = .getAttributes(parseName(name));
        if (!(attributes instanceof ResourceAttributes)) {
            attributes = new ResourceAttributes(attributes);
        }
        return attributes;
    }


    
Retrieves selected attributes associated with a named object. See the class description regarding attribute models, attribute type names, and operational attributes.

Parameters:
name the name of the object from which to retrieve attributes
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
Returns:
the requested attributes; never null
Throws:
javax.naming.NamingException if a naming exception is encountered
    public Attributes getAttributes(Name nameString[] attrIds)
        throws NamingException {
        Attributes attributes = 
            .getAttributes(parseName(name), attrIds);
        if (!(attributes instanceof ResourceAttributes)) {
            attributes = new ResourceAttributes(attributes);
        }
        return attributes;
    }


    
Retrieves selected attributes associated with a named object.

Parameters:
name the name of the object from which to retrieve attributes
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
Returns:
the requested attributes; never null
Throws:
javax.naming.NamingException if a naming exception is encountered
     public Attributes getAttributes(String nameString[] attrIds)
         throws NamingException {
        Attributes attributes = 
            .getAttributes(parseName(name), attrIds);
        if (!(attributes instanceof ResourceAttributes)) {
            attributes = new ResourceAttributes(attributes);
        }
        return attributes;
     }


    
Modifies the attributes associated with a named object. The order of the modifications is not specified. Where possible, the modifications are performed atomically.

Parameters:
name the name of the object whose attributes will be updated
mod_op the modification operation, one of: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTE
attrs the attributes to be used for the modification; may not be null
Throws:
javax.naming.directory.AttributeModificationException if the modification cannot be completed successfully
javax.naming.NamingException if a naming exception is encountered
    public void modifyAttributes(Name nameint mod_opAttributes attrs)
        throws NamingException {
        .modifyAttributes(parseName(name), mod_opattrs);
        cacheUnload(name.toString());
    }


    
Modifies the attributes associated with a named object.

Parameters:
name the name of the object whose attributes will be updated
mod_op the modification operation, one of: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTE
attrs the attributes to be used for the modification; may not be null
Throws:
javax.naming.directory.AttributeModificationException if the modification cannot be completed successfully
javax.naming.NamingException if a naming exception is encountered
    public void modifyAttributes(String nameint mod_opAttributes attrs)
        throws NamingException {
        .modifyAttributes(parseName(name), mod_opattrs);
        cacheUnload(name);
    }


    
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.

Parameters:
name the name of the object whose attributes will be updated
mods an ordered sequence of modifications to be performed; may not be null
Throws:
javax.naming.directory.AttributeModificationException if the modification cannot be completed successfully
javax.naming.NamingException if a naming exception is encountered
    public void modifyAttributes(Name nameModificationItem[] mods)
        throws NamingException {
        .modifyAttributes(parseName(name), mods);
        cacheUnload(name.toString());
    }


    
Modifies the attributes associated with a named object using an an ordered list of modifications.

Parameters:
name the name of the object whose attributes will be updated
mods an ordered sequence of modifications to be performed; may not be null
Throws:
javax.naming.directory.AttributeModificationException if the modification cannot be completed successfully
javax.naming.NamingException if a naming exception is encountered
    public void modifyAttributes(String nameModificationItem[] mods)
        throws NamingException {
        .modifyAttributes(parseName(name), mods);
        cacheUnload(name);
    }


    
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.

Parameters:
name the name to bind; may not be empty
obj the object to bind; possibly null
attrs the attributes to associate with the binding
Throws:
javax.naming.NameAlreadyBoundException if name is already bound
javax.naming.directory.InvalidAttributesException if some "mandatory" attributes of the binding are not supplied
javax.naming.NamingException if a naming exception is encountered
    public void bind(Name nameObject objAttributes attrs)
        throws NamingException {
        .bind(parseName(name), objattrs);
        cacheUnload(name.toString());
    }


    
Binds a name to an object, along with associated attributes.

Parameters:
name the name to bind; may not be empty
obj the object to bind; possibly null
attrs the attributes to associate with the binding
Throws:
javax.naming.NameAlreadyBoundException if name is already bound
javax.naming.directory.InvalidAttributesException if some "mandatory" attributes of the binding are not supplied
javax.naming.NamingException if a naming exception is encountered
    public void bind(String nameObject objAttributes attrs)
        throws NamingException {
        .bind(parseName(name), objattrs);
        cacheUnload(name);
    }


    
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.

Parameters:
name the name to bind; may not be empty
obj the object to bind; possibly null
attrs the attributes to associate with the binding
Throws:
javax.naming.directory.InvalidAttributesException if some "mandatory" attributes of the binding are not supplied
javax.naming.NamingException if a naming exception is encountered
    public void rebind(Name nameObject objAttributes attrs)
        throws NamingException {
        .rebind(parseName(name), objattrs);
        cacheUnload(name.toString());
    }


    
Binds a name to an object, along with associated attributes, overwriting any existing binding.

Parameters:
name the name to bind; may not be empty
obj the object to bind; possibly null
attrs the attributes to associate with the binding
Throws:
javax.naming.directory.InvalidAttributesException if some "mandatory" attributes of the binding are not supplied
javax.naming.NamingException if a naming exception is encountered
    public void rebind(String nameObject objAttributes attrs)
        throws NamingException {
        .rebind(parseName(name), objattrs);
        cacheUnload(name);
    }


    
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().

Parameters:
name the name of the context to create; may not be empty
attrs the attributes to associate with the newly created context
Returns:
the newly created context
Throws:
javax.naming.NameAlreadyBoundException if the name is already bound
javax.naming.directory.InvalidAttributesException if attrs does not contain all the mandatory attributes required for creation
javax.naming.NamingException if a naming exception is encountered
    public DirContext createSubcontext(Name nameAttributes attrs)
        throws NamingException {
        DirContext context = 
            .createSubcontext(parseName(name), attrs);
        cacheUnload(name.toString());
        return context;
    }


    
Creates and binds a new context, along with associated attributes.

Parameters:
name the name of the context to create; may not be empty
attrs the attributes to associate with the newly created context
Returns:
the newly created context
Throws:
javax.naming.NameAlreadyBoundException if the name is already bound
javax.naming.directory.InvalidAttributesException if attrs does not contain all the mandatory attributes required for creation
javax.naming.NamingException if a naming exception is encountered
    public DirContext createSubcontext(String nameAttributes attrs)
        throws NamingException {
        DirContext context = 
            .createSubcontext(parseName(name), attrs);
        cacheUnload(name);
        return context;
    }


    
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.

Parameters:
name the name of the object whose schema is to be retrieved
Returns:
the schema associated with the context; never null
Throws:
javax.naming.OperationNotSupportedException if schema not supported
javax.naming.NamingException if a naming exception is encountered
    public DirContext getSchema(Name name)
        throws NamingException {
        return .getSchema(parseName(name));
    }


    
Retrieves the schema associated with the named object.

Parameters:
name the name of the object whose schema is to be retrieved
Returns:
the schema associated with the context; never null
Throws:
javax.naming.OperationNotSupportedException if schema not supported
javax.naming.NamingException if a naming exception is encountered
    public DirContext getSchema(String name)
        throws NamingException {
        return .getSchema(parseName(name));
    }


    
Retrieves a context containing the schema objects of the named object's class definitions.

Parameters:
name the name of the object whose object class definition is to be retrieved
Returns:
the DirContext containing the named object's class definitions; never null
Throws:
javax.naming.OperationNotSupportedException if schema not supported
javax.naming.NamingException if a naming exception is encountered
        throws NamingException {
        return .getSchemaClassDefinition(parseName(name));
    }


    
Retrieves a context containing the schema objects of the named object's class definitions.

Parameters:
name the name of the object whose object class definition is to be retrieved
Returns:
the DirContext containing the named object's class definitions; never null
Throws:
javax.naming.OperationNotSupportedException if schema not supported
javax.naming.NamingException if a naming exception is encountered
        throws NamingException {
        return .getSchemaClassDefinition(parseName(name));
    }


    
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.

Parameters:
name the name of the context to search
matchingAttributes the attributes to search for. If empty or null, all objects in the target context are returned.
attributesToReturn the attributes to return. null indicates that all attributes are to be returned; an empty array indicates that none are to be returned.
Returns:
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.
Throws:
javax.naming.NamingException if a naming exception is encountered
    public NamingEnumeration<SearchResultsearch(Name nameAttributes matchingAttributes,
                                    String[] attributesToReturn)
        throws NamingException {
        return .search(parseName(name), matchingAttributes
                                 attributesToReturn);
    }


    
Searches in a single context for objects that contain a specified set of attributes, and retrieves selected attributes.

Parameters:
name the name of the context to search
matchingAttributes the attributes to search for. If empty or null, all objects in the target context are returned.
attributesToReturn the attributes to return. null indicates that all attributes are to be returned; an empty array indicates that none are to be returned.
Returns:
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.
Throws:
javax.naming.NamingException if a naming exception is encountered
    public NamingEnumeration<SearchResultsearch(String nameAttributes matchingAttributes,
                                    String[] attributesToReturn)
        throws NamingException {
        return .search(parseName(name), matchingAttributes
                                 attributesToReturn);
    }


    
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[]).

Parameters:
name the name of the context to search
matchingAttributes the attributes to search for. If empty or null, all objects in the target context are returned.
Returns:
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.
Throws:
javax.naming.NamingException if a naming exception is encountered
    public NamingEnumeration<SearchResultsearch(Name nameAttributes matchingAttributes)
        throws NamingException {
        return .search(parseName(name), matchingAttributes);
    }


    
Searches in a single context for objects that contain a specified set of attributes.

Parameters:
name the name of the context to search
matchingAttributes the attributes to search for. If empty or null, all objects in the target context are returned.
Returns:
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.
Throws:
javax.naming.NamingException if a naming exception is encountered
    public NamingEnumeration<SearchResultsearch(String nameAttributes matchingAttributes)
        throws NamingException {
        return .search(parseName(name), matchingAttributes);
    }


    
Searches in the named context or object for entries that satisfy the given search filter. Performs the search as specified by the search controls.

Parameters:
name the name of the context or object to search
filter the filter expression to use for the search; may not be null
cons the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())).
Returns:
an enumeration of SearchResults of the objects that satisfy the filter; never null
Throws:
javax.naming.directory.InvalidSearchFilterException if the search filter specified is not supported or understood by the underlying directory
javax.naming.directory.InvalidSearchControlsException if the search controls contain invalid settings
javax.naming.NamingException if a naming exception is encountered
    public NamingEnumeration<SearchResultsearch(Name nameString filter
                                    SearchControls cons)
        throws NamingException {
        return .search(parseName(name), filtercons);
    }


    
Searches in the named context or object for entries that satisfy the given search filter. Performs the search as specified by the search controls.

Parameters:
name the name of the context or object to search
filter the filter expression to use for the search; may not be null
cons the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())).
Returns:
an enumeration of SearchResults of the objects that satisfy the filter; never null
Throws:
javax.naming.directory.InvalidSearchFilterException if the search filter specified is not supported or understood by the underlying directory
javax.naming.directory.InvalidSearchControlsException if the search controls contain invalid settings
javax.naming.NamingException if a naming exception is encountered
    public NamingEnumeration<SearchResultsearch(String nameString filter
                                    SearchControls cons)
        throws NamingException {
        return .search(parseName(name), filtercons);
    }


    
Searches in the named context or object for entries that satisfy the given search filter. Performs the search as specified by the search controls.

Parameters:
name the name of the context or object to search
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.
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.
cons the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())).
Returns:
an enumeration of SearchResults of the objects that satisy the filter; never null
Throws:
java.lang.ArrayIndexOutOfBoundsException if filterExpr contains {i} expressions where i is outside the bounds of the array filterArgs
javax.naming.directory.InvalidSearchControlsException if cons contains invalid settings
javax.naming.directory.InvalidSearchFilterException if filterExpr with filterArgs represents an invalid search filter
javax.naming.NamingException if a naming exception is encountered
    public NamingEnumeration<SearchResultsearch(Name nameString filterExpr,
                                    Object[] filterArgsSearchControls cons)
        throws NamingException {
        return .search(parseName(name), filterExprfilterArgs
                                 cons);
    }


    
Searches in the named context or object for entries that satisfy the given search filter. Performs the search as specified by the search controls.

Parameters:
name the name of the context or object to search
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.
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.
cons the search controls that control the search. If null, the default search controls are used (equivalent to (new SearchControls())).
Returns:
an enumeration of SearchResults of the objects that satisy the filter; never null
Throws:
java.lang.ArrayIndexOutOfBoundsException if filterExpr contains {i} expressions where i is outside the bounds of the array filterArgs
javax.naming.directory.InvalidSearchControlsException if cons contains invalid settings
javax.naming.directory.InvalidSearchFilterException if filterExpr with filterArgs represents an invalid search filter
javax.naming.NamingException if a naming exception is encountered
    public NamingEnumeration<SearchResultsearch(String nameString filterExpr,
                                    Object[] filterArgsSearchControls cons)
        throws NamingException {
        return .search(parseName(name), filterExprfilterArgs
                                 cons);
    }
    // --------------------------------------------------------- Public Methods


    
Retrieves the named object as a cache entry, without any exception.

Parameters:
name the name of the object to look up
Returns:
the cache entry bound to name
    public CacheEntry lookupCache(String name) {
        CacheEntry entry = cacheLookup(name);
        if (entry == null) {
            entry = new CacheEntry();
            entry.name = name;
            try {
                Object object = .lookup(parseName(name));
                if (object instanceof InputStream) {
                    entry.resource = new Resource((InputStreamobject);
                } else if (object instanceof DirContext) {
                    entry.context = (DirContextobject;
                } else if (object instanceof Resource) {
                    entry.resource = (Resourceobject;
                } else {
                    entry.resource = new Resource(new ByteArrayInputStream
                        (object.toString().getBytes()));
                }
                Attributes attributes = .getAttributes(parseName(name));
                if (!(attributes instanceof ResourceAttributes)) {
                    attributes = new ResourceAttributes(attributes);
                }
                entry.attributes = (ResourceAttributesattributes;
            } catch (NamingException e) {
                entry.exists = false;
            }
        }
        return entry;
    }
    // ------------------------------------------------------ Protected Methods


    
Parses a name.

Returns:
the parsed name
    protected String parseName(String name
        throws NamingException {
        return name;
    }


    
Parses a name.

Returns:
the parsed name
    protected Name parseName(Name name
        throws NamingException {
        return name;
    }


    
Lookup in cache.
    protected CacheEntry cacheLookup(String name) {
        if ( == null)
            return (null);
        if (name == null)
            name = "";
        for (int i = 0; i < .i++) {
            if (name.startsWith([i])) {
                return (null);
            }
        }
        CacheEntry cacheEntry = .lookup(name);
        if (cacheEntry == null) {
            cacheEntry = new CacheEntry();
            cacheEntry.name = name;
            // Load entry
            cacheLoad(cacheEntry);
        } else {
            if (!validate(cacheEntry)) {
                if (!revalidate(cacheEntry)) {
                    cacheUnload(cacheEntry.name);
                    return (null);
                } else {
                    cacheEntry.timestamp = 
                        System.currentTimeMillis() + ;
                }
            }
            cacheEntry.accessCount++;
        }
        return (cacheEntry);
    }


    
Validate entry.
    protected boolean validate(CacheEntry entry) {
        if (((!entry.exists)
             || (entry.context != null)
             || ((entry.resource != null
                 && (entry.resource.getContent() != null || entry.timestamp == .)))
            && (System.currentTimeMillis() < entry.timestamp)) {
            return true;
        }
        return false;
    }


    
Revalidate entry.
    protected boolean revalidate(CacheEntry entry) {
        // Get the attributes at the given path, and check the last 
        // modification date
        if (!entry.exists)
            return false;
        if (entry.attributes == null)
            return false;
        long lastModified = entry.attributes.getLastModified();
        long contentLength = entry.attributes.getContentLength();
        if (lastModified <= 0)
            return false;
        try {
            Attributes tempAttributes = .getAttributes(entry.name);
            ResourceAttributes attributes = null;
            if (!(tempAttributes instanceof ResourceAttributes)) {
                attributes = new ResourceAttributes(tempAttributes);
            } else {
                attributes = (ResourceAttributestempAttributes;
            }
            long lastModified2 = attributes.getLastModified();
            long contentLength2 = attributes.getContentLength();
            return (lastModified == lastModified2
                && (contentLength == contentLength2);
        } catch (NamingException e) {
            return false;
        }
    }


    
Load entry into cache.
    protected void cacheLoad(CacheEntry entry) {
        String name = entry.name;
        DirContext currentContext = ;
        // Retrieve missing info
        boolean exists = true;
        // Retrieving attributes
        if (entry.attributes == null) {
            try {
                Attributes attributes = currentContext.getAttributes(entry.name);
                if (!(attributes instanceof ResourceAttributes)) {
                    entry.attributes = 
                        new ResourceAttributes(attributes);
                } else {
                    entry.attributes = (ResourceAttributesattributes;
                }
            } catch (NamingException e) {
                exists = false;
            }
        }
        
        // Check overlays
        if ( != null) {
            for (int i = 0; (i < .) && !existsi++) {
                try {
                    Attributes attributes = [i].getAttributes(entry.name);
                    if (!(attributes instanceof ResourceAttributes)) {
                        entry.attributes = 
                            new ResourceAttributes(attributes);
                    } else {
                        entry.attributes = (ResourceAttributesattributes;
                    }
                    currentContext = [i];
                    exists = true;
                } catch (NamingException e) {