public ProxyDirContext(Hashtable env,
    DirContext dirContext) 
{
    // ----------------------------------------------------------- Constructors
        this.env = env;
        this.dirContext = dirContext;
        if (dirContext instanceof BaseDirContext) {
            // Initialize parameters based on the associated dir context, like
            // the caching policy.
            BaseDirContext baseDirContext = (BaseDirContext) dirContext;
            if (baseDirContext.isCached()) {
                try {
                    cache = (ResourceCache) 
                        Class.forName(cacheClassName).newInstance();
                } catch (Exception e) {
                    //FIXME
                    e.printStackTrace();
                }
                cache.setCacheMaxSize(baseDirContext.getCacheMaxSize());
                cacheTTL = baseDirContext.getCacheTTL();
                cacheObjectMaxSize = baseDirContext.getCacheMaxSize() / 20;
            }
        }
        hostName = (String) env.get(HOST);
        contextName = (String) env.get(CONTEXT);
}

Builds a proxy directory context using the given environment.

 public Object addToEnvironment(String propName,
    Object propVal) throws NamingException 
{
        return dirContext.addToEnvironment(propName, propVal);
}

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

 public  void bind(Name name,
    Object obj) throws NamingException 
{
        dirContext.bind(parseName(name), obj);
        cacheUnload(name.toString());
}

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.

 public  void bind(String name,
    Object obj) throws NamingException 
{
        dirContext.bind(parseName(name), obj);
        cacheUnload(name);
}

Binds a name to an object.

 public  void bind(Name name,
    Object obj,
    Attributes attrs) throws NamingException 
{
        dirContext.bind(parseName(name), obj, attrs);
        cacheUnload(name.toString());
}

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.

 public  void bind(String name,
    Object obj,
    Attributes attrs) throws NamingException 
{
        dirContext.bind(parseName(name), obj, attrs);
        cacheUnload(name);
}

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

 protected  void cacheLoad(CacheEntry entry) 
{
        String name = entry.name;
        // Retrieve missing info
        boolean exists = true;
        // Retrieving attributes
        if (entry.attributes == null) {
            try {
                Attributes attributes = dirContext.getAttributes(entry.name);
                if (!(attributes instanceof ResourceAttributes)) {
                    entry.attributes = 
                        new ResourceAttributes(attributes);
                } else {
                    entry.attributes = (ResourceAttributes) attributes;
                }
            } catch (NamingException e) {
                exists = false;
            }
        }
        // Retriving object
        if ((exists) && (entry.resource == null) && (entry.context == null)) {
            try {
                Object object = dirContext.lookup(name);
                if (object instanceof InputStream) {
                    entry.resource = new Resource((InputStream) object);
                } else if (object instanceof DirContext) {
                    entry.context = (DirContext) object;
                } else if (object instanceof Resource) {
                    entry.resource = (Resource) object;
                } else {
                    entry.resource = new Resource(new ByteArrayInputStream
                        (object.toString().getBytes()));
                }
            } catch (NamingException e) {
                exists = false;
            }
        }
        // Load object content
        if ((exists) && (entry.resource != null) 
            && (entry.resource.getContent() == null) 
            && (entry.attributes.getContentLength()  >= 0)
            && (entry.attributes.getContentLength() <  
                (cacheObjectMaxSize * 1024))) {
            int length = (int) entry.attributes.getContentLength();
            // The entry size is 1 + the resource size in KB, if it will be 
            // cached
            entry.size += (entry.attributes.getContentLength() / 1024);
            InputStream is = null;
            try {
                is = entry.resource.streamContent();
                int pos = 0;
                byte[] b = new byte[length];
                while (pos <  length) {
                    int n = is.read(b, pos, length - pos);
                    if (n <  0)
                        break;
                    pos = pos + n;
                }
                entry.resource.setContent(b);
            } catch (IOException e) {
                ; // Ignore
            } finally {
                try {
                    if (is != null)
                        is.close();
                } catch (IOException e) {
                    ; // Ignore
                }
            }
        }
        // Set existence flag
        entry.exists = exists;
        // Set timestamp
        entry.timestamp = System.currentTimeMillis() + cacheTTL;
        // Add new entry to cache
        synchronized (cache) {
            // Check cache size, and remove elements if too big
            if ((cache.lookup(name) == null) && cache.allocate(entry.size)) {
                cache.load(entry);
            }
        }
}

Load entry into cache.

 protected CacheEntry cacheLookup(String name) 
{
        if (cache == null)
            return (null);
        if (name == null)
            name = "";
        for (int i = 0; i <  nonCacheable.length; i++) {
            if (name.startsWith(nonCacheable[i])) {
                return (null);
            }
        }
        CacheEntry cacheEntry = cache.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() + cacheTTL;
                }
            }
            cacheEntry.accessCount++;
        }
        return (cacheEntry);
}

Lookup in cache.

 protected boolean cacheUnload(String name) 
{
        if (cache == null)
            return false;
        synchronized (cache) {
            return cache.unload(name);
        }
}

Remove entry from cache.

 public  void close() throws NamingException 
{
        dirContext.close();
}

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.

 public Name composeName(Name name,
    Name prefix) throws NamingException 
{
        prefix = (Name) prefix.clone();
        return prefix.addAll(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.

 public String composeName(String name,
    String prefix) throws NamingException 
{
        return prefix + "/" + name;
}

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

 public Context createSubcontext(Name name) throws NamingException 
{
        Context context = dirContext.createSubcontext(parseName(name));
        cacheUnload(name.toString());
        return context;
}

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.

 public Context createSubcontext(String name) throws NamingException 
{
        Context context = dirContext.createSubcontext(parseName(name));
        cacheUnload(name);
        return context;
}

Creates and binds a new context.

 public DirContext createSubcontext(Name name,
    Attributes attrs) throws NamingException 
{
        DirContext context = 
            dirContext.createSubcontext(parseName(name), attrs);
        cacheUnload(name.toString());
        return context;
}

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

 public DirContext createSubcontext(String name,
    Attributes attrs) throws NamingException 
{
        DirContext context = 
            dirContext.createSubcontext(parseName(name), attrs);
        cacheUnload(name);
        return context;
}

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

 public  void destroySubcontext(Name name) throws NamingException 
{
        dirContext.destroySubcontext(parseName(name));
        cacheUnload(name.toString());
}

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.

 public  void destroySubcontext(String name) throws NamingException 
{
        dirContext.destroySubcontext(parseName(name));
        cacheUnload(name);
}

Destroys the named context and removes it from the namespace.

 public Attributes getAttributes(Name name) throws NamingException 
{
        CacheEntry entry = cacheLookup(name.toString());
        if (entry != null) {
            if (!entry.exists) {
                throw notFoundException;
            }
            return entry.attributes;
        }
        Attributes attributes = dirContext.getAttributes(parseName(name));
        if (!(attributes instanceof ResourceAttributes)) {
            attributes = new ResourceAttributes(attributes);
        }
        return attributes;
}

Retrieves all of the attributes associated with a named object.

 public Attributes getAttributes(String name) throws NamingException 
{
        CacheEntry entry = cacheLookup(name);
        if (entry != null) {
            if (!entry.exists) {
                throw notFoundException;
            }
            return entry.attributes;
        }
        Attributes attributes = dirContext.getAttributes(parseName(name));
        if (!(attributes instanceof ResourceAttributes)) {
            attributes = new ResourceAttributes(attributes);
        }
        return attributes;
}

Retrieves all of the attributes associated with a named object.

 public Attributes getAttributes(Name name,
    String[] attrIds) throws NamingException 
{
        Attributes attributes = 
            dirContext.getAttributes(parseName(name), attrIds);
        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.

 public Attributes getAttributes(String name,
    String[] attrIds) throws NamingException 
{
        Attributes attributes = 
            dirContext.getAttributes(parseName(name), attrIds);
        if (!(attributes instanceof ResourceAttributes)) {
            attributes = new ResourceAttributes(attributes);
        }
        return attributes;
}

Retrieves selected attributes associated with a named object.

 public ResourceCache getCache() 
{
    // --------------------------------------------------------- Public Methods
        return cache;
}

Get the cache used for this context.

 public String getContextName() 
{
        return this.contextName;
}

Return the context name.

 public DirContext getDirContext() 
{
        return this.dirContext;
}

Return the actual directory context we are wrapping.

 public String getDocBase() 
{
        if (dirContext instanceof BaseDirContext)
            return ((BaseDirContext) dirContext).getDocBase();
        else
            return "";
}

Return the document root for this component.

 public Hashtable getEnvironment() throws NamingException 
{
        return dirContext.getEnvironment();
}

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

 public String getHostName() 
{
        return this.hostName;
}

Return the host name.

 public String getNameInNamespace() throws NamingException 
{
        return dirContext.getNameInNamespace();
}

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.

 public NameParser getNameParser(Name name) throws NamingException 
{
        return dirContext.getNameParser(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).

 public NameParser getNameParser(String name) throws NamingException 
{
        return dirContext.getNameParser(parseName(name));
}

Retrieves the parser associated with the named context.

 public DirContext getSchema(Name name) throws NamingException 
{
        return dirContext.getSchema(parseName(name));
}

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.

 public DirContext getSchema(String name) throws NamingException 
{
        return dirContext.getSchema(parseName(name));
}

Retrieves the schema associated with the named object.

 public DirContext getSchemaClassDefinition(Name name) throws NamingException 
{
        return dirContext.getSchemaClassDefinition(parseName(name));
}

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

 public DirContext getSchemaClassDefinition(String name) throws NamingException 
{
        return dirContext.getSchemaClassDefinition(parseName(name));
}

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

 public NamingEnumeration list(Name name) throws NamingException 
{
        return dirContext.list(parseName(name));
}

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.

 public NamingEnumeration list(String name) throws NamingException 
{
        return dirContext.list(parseName(name));
}

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

 public NamingEnumeration listBindings(Name name) throws NamingException 
{
        return dirContext.listBindings(parseName(name));
}

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.

 public NamingEnumeration listBindings(String name) throws NamingException 
{
        return dirContext.listBindings(parseName(name));
}

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

 public Object lookup(Name name) throws NamingException 
{
        CacheEntry entry = cacheLookup(name.toString());
        if (entry != null) {
            if (!entry.exists) {
                throw notFoundException;
            }
            if (entry.resource != null) {
                // Check content caching.
                return entry.resource;
            } else {
                return entry.context;
            }
        }
        Object object = dirContext.lookup(parseName(name));
        if (object instanceof InputStream)
            return new Resource((InputStream) object);
        else
            return object;
}

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

 public Object lookup(String name) throws NamingException 
{
        CacheEntry entry = cacheLookup(name);
        if (entry != null) {
            if (!entry.exists) {
                throw notFoundException;
            }
            if (entry.resource != null) {
                return entry.resource;
            } else {
                return entry.context;
            }
        }
        Object object = dirContext.lookup(parseName(name));
        if (object instanceof InputStream) {
            return new Resource((InputStream) object);
        } else if (object instanceof DirContext) {
            return object;
        } else if (object instanceof Resource) {
            return object;
        } else {
            return new Resource(new ByteArrayInputStream
                (object.toString().getBytes()));
        }
}

Retrieves the named object.

 public CacheEntry lookupCache(String name) 
{
        CacheEntry entry = cacheLookup(name);
        if (entry == null) {
            entry = new CacheEntry();
            entry.name = name;
            try {
                Object object = dirContext.lookup(parseName(name));
                if (object instanceof InputStream) {
                    entry.resource = new Resource((InputStream) object);
                } else if (object instanceof DirContext) {
                    entry.context = (DirContext) object;
                } else if (object instanceof Resource) {
                    entry.resource = (Resource) object;
                } else {
                    entry.resource = new Resource(new ByteArrayInputStream
                        (object.toString().getBytes()));
                }
                Attributes attributes = dirContext.getAttributes(parseName(name));
                if (!(attributes instanceof ResourceAttributes)) {
                    attributes = new ResourceAttributes(attributes);
                }
                entry.attributes = (ResourceAttributes) attributes;
            } catch (NamingException e) {
                entry.exists = false;
            }
        }
        return entry;
}

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

 public Object lookupLink(Name name) throws NamingException 
{
        return dirContext.lookupLink(parseName(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.

 public Object lookupLink(String name) throws NamingException 
{
        return dirContext.lookupLink(parseName(name));
}

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

 public  void modifyAttributes(Name name,
    ModificationItem[] mods) throws NamingException 
{
        dirContext.modifyAttributes(parseName(name), mods);
        cacheUnload(name.toString());
}

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.

 public  void modifyAttributes(String name,
    ModificationItem[] mods) throws NamingException 
{
        dirContext.modifyAttributes(parseName(name), mods);
        cacheUnload(name);
}

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

 public  void modifyAttributes(Name name,
    int mod_op,
    Attributes attrs) throws NamingException 
{
        dirContext.modifyAttributes(parseName(name), mod_op, attrs);
        cacheUnload(name.toString());
}

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

 public  void modifyAttributes(String name,
    int mod_op,
    Attributes attrs) throws NamingException 
{
        dirContext.modifyAttributes(parseName(name), mod_op, attrs);
        cacheUnload(name);
}

Modifies the attributes associated with a named object.

 protected String parseName(String name) throws NamingException 
{
        return name;
}

Parses a name.

 protected Name parseName(Name name) throws NamingException 
{
        return name;
}

Parses a name.

 public  void rebind(Name name,
    Object obj) throws NamingException 
{
        dirContext.rebind(parseName(name), obj);
        cacheUnload(name.toString());
}

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.

 public  void rebind(String name,
    Object obj) throws NamingException 
{
        dirContext.rebind(parseName(name), obj);
        cacheUnload(name);
}

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

 public  void rebind(Name name,
    Object obj,
    Attributes attrs) throws NamingException 
{
        dirContext.rebind(parseName(name), obj, attrs);
        cacheUnload(name.toString());
}

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.

 public  void rebind(String name,
    Object obj,
    Attributes attrs) throws NamingException 
{
        dirContext.rebind(parseName(name), obj, attrs);
        cacheUnload(name);
}

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

 public Object removeFromEnvironment(String propName) throws NamingException 
{
        return dirContext.removeFromEnvironment(propName);
}

Removes an environment property from the environment of this context.

 public  void rename(Name oldName,
    Name newName) throws NamingException 
{
        dirContext.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. 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.

 public  void rename(String oldName,
    String newName) throws NamingException 
{
        dirContext.rename(parseName(oldName), parseName(newName));
        cacheUnload(oldName);
}

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

 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 = dirContext.getAttributes(entry.name);
            ResourceAttributes attributes = null;
            if (!(tempAttributes instanceof ResourceAttributes)) {
                attributes = new ResourceAttributes(tempAttributes);
            } else {
                attributes = (ResourceAttributes) tempAttributes;
            }
            long lastModified2 = attributes.getLastModified();
            long contentLength2 = attributes.getContentLength();
            return (lastModified == lastModified2) 
                && (contentLength == contentLength2);
        } catch (NamingException e) {
            return false;
        }
}

Revalidate entry.

 public NamingEnumeration search(Name name,
    Attributes matchingAttributes) throws NamingException 
{
        return dirContext.search(parseName(name), matchingAttributes);
}

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

 public NamingEnumeration search(String name,
    Attributes matchingAttributes) throws NamingException 
{
        return dirContext.search(parseName(name), matchingAttributes);
}

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

 public NamingEnumeration search(Name name,
    Attributes matchingAttributes,
    String[] attributesToReturn) throws NamingException 
{
        return dirContext.search(parseName(name), matchingAttributes, 
                                 attributesToReturn);
}

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.

 public NamingEnumeration search(String name,
    Attributes matchingAttributes,
    String[] attributesToReturn) throws NamingException 
{
        return dirContext.search(parseName(name), matchingAttributes, 
                                 attributesToReturn);
}

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

 public NamingEnumeration search(Name name,
    String filter,
    SearchControls cons) throws NamingException 
{
        return dirContext.search(parseName(name), filter, 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.

 public NamingEnumeration search(String name,
    String filter,
    SearchControls cons) throws NamingException 
{
        return dirContext.search(parseName(name), filter, 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.

 public NamingEnumeration search(Name name,
    String filterExpr,
    Object[] filterArgs,
    SearchControls cons) throws NamingException 
{
        return dirContext.search(parseName(name), filterExpr, filterArgs, 
                                 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.

 public NamingEnumeration search(String name,
    String filterExpr,
    Object[] filterArgs,
    SearchControls cons) throws NamingException 
{
        return dirContext.search(parseName(name), filterExpr, filterArgs, 
                                 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.

 public  void unbind(Name name) throws NamingException 
{
        dirContext.unbind(parseName(name));
        cacheUnload(name.toString());
}

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.

 public  void unbind(String name) throws NamingException 
{
        dirContext.unbind(parseName(name));
        cacheUnload(name);
}

Unbinds the named object.

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

Validate entry.