com.netspective.commons.io.UriAddressableInheritableFileResource.java Source code

Introduction

Here is the source code for com.netspective.commons.io.UriAddressableInheritableFileResource.java

Source

/*
 * Copyright (c) 2000-2004 Netspective Communications LLC. All rights reserved.
 *
 * Netspective Communications LLC ("Netspective") permits redistribution, modification and use of this file in source
 * and binary form ("The Software") under the Netspective Source License ("NSL" or "The License"). The following
 * conditions are provided as a summary of the NSL but the NSL remains the canonical license and must be accepted
 * before using The Software. Any use of The Software indicates agreement with the NSL.
 *
 * 1. Each copy or derived work of The Software must preserve the copyright notice and this notice unmodified.
 *
 * 2. Redistribution of The Software is allowed in object code form only (as Java .class files or a .jar file
 *    containing the .class files) and only as part of an application that uses The Software as part of its primary
 *    functionality. No distribution of the package is allowed as part of a software development kit, other library,
 *    or development tool without written consent of Netspective. Any modified form of The Software is bound by these
 *    same restrictions.
 *
 * 3. Redistributions of The Software in any form must include an unmodified copy of The License, normally in a plain
 *    ASCII text file unless otherwise agreed to, in writing, by Netspective.
 *
 * 4. The names "Netspective", "Axiom", "Commons", "Junxion", and "Sparx" are trademarks of Netspective and may not be
 *    used to endorse or appear in products derived from The Software without written consent of Netspective.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT A WARRANTY OF ANY KIND. ALL EXPRESS OR IMPLIED REPRESENTATIONS AND
 * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT,
 * ARE HEREBY DISCLAIMED.
 *
 * NETSPECTIVE AND ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE OR ANY THIRD PARTY AS A
 * RESULT OF USING OR DISTRIBUTING THE SOFTWARE. IN NO EVENT WILL NETSPECTIVE OR ITS LICENSORS BE LIABLE FOR ANY LOST
 * REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER
 * CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR INABILITY TO USE THE SOFTWARE, EVEN
 * IF IT HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 */
package com.netspective.commons.io;

import java.io.File;
import java.io.IOException;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import com.netspective.commons.text.TextUtils;

/**
 * A {@link com.netspective.commons.io.UriAddressableFileLocator} that uses files in a specified directory as the
 * source of resource.
 */
public class UriAddressableInheritableFileResource extends UriAddressableUniqueFileLocator {
    private static final Log log = LogFactory.getLog(UriAddressableInheritableFileResource.class);
    private final Map cache = Collections.synchronizedMap(new HashMap());
    private final boolean cacheLocations;

    public UriAddressableInheritableFileResource(final String rootUrl, final File baseDir,
            final boolean cacheLocations) throws IOException {
        super(rootUrl, baseDir, cacheLocations);
        this.cacheLocations = cacheLocations;
    }

    public UriAddressableFile findUriAddressableFile(final String name) throws IOException {
        final boolean logging = log.isDebugEnabled();
        UriAddressableFile result = null;

        if (cacheLocations) {
            result = (UriAddressableFile) cache.get(name);
            if (result != null) {
                if (logging)
                    log.debug("UriAddressableInheritableFileResource cache hit for " + result);
                return result;
            }
        }

        result = super.findUriAddressableFile(name);
        if (result != null) {
            cache.put(name, result);
            return result;
        }

        String[] pathItems = TextUtils.getInstance()
                .split(SEP_IS_SLASH ? name : name.replace(File.separatorChar, '/'), "/", false);
        String justName = pathItems[pathItems.length - 1];

        // get just the name then start looking "up" the parents until we get to the base directory
        // e.g. if pathItems is /a/b/c/d.gif then we start searching at /a/b/d.gif, then /a/d.gif, then /d.gif, etc
        int pathItemToSearch = pathItems.length - 2;
        while (pathItemToSearch >= 0) {
            StringBuffer buildPath = new StringBuffer();
            for (int i = 0; i < pathItemToSearch; i++) {
                buildPath.append(pathItems[i]);
                buildPath.append('/');
            }
            buildPath.append(justName);

            result = super.findUriAddressableFile(buildPath.toString());
            if (result != null) {
                // even if we inherited the file we look for it in the cache as the original name
                if (cacheLocations)
                    cache.put(name, result);
                return result;
            }

            pathItemToSearch--;
        }

        return null;
    }
}