com.samskivert.velocity.ServletContextResourceLoader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of samskivert Show documentation
A collection of Java utilities.
There is a newer version: 1.9
//
// samskivert library - useful routines for java programs
// Copyright (C) 2001-2012 Michael Bayne, et al.
// http://github.com/samskivert/samskivert/blob/master/COPYING

package com.samskivert.velocity;

import java.io.InputStream;
import javax.servlet.ServletContext;

import org.apache.commons.collections.ExtendedProperties;
import org.apache.velocity.exception.ResourceNotFoundException;
import org.apache.velocity.runtime.resource.Resource;
import org.apache.velocity.runtime.resource.loader.ResourceLoader;

/**
 * A Velocity resource loader that loads resources from the servlet context.
 *
 * @see ServletContext#getResource
 * @see ServletContext#getResourceAsStream
 */
public class ServletContextResourceLoader extends ResourceLoader
{
    /**
     * When used with the default Velocity resource manager, we are constructed with our
     * zero-argument constructor and later initialized via {@link #init}.
     */
    public ServletContextResourceLoader ()
    {
    }

    /**
     * When used with the {@link SiteResourceManager} we are constructed with our servlet context
     * reference and not later initialized.
     */
    public ServletContextResourceLoader (ServletContext sctx)
    {
        _sctx = sctx;
    }

    /**
     * Called by Velocity to initialize this resource loader.
     */
    @Override
    public void init (ExtendedProperties config)
    {
        // the web framework was kind enough to slip this into the runtime when it started up
        _sctx = (ServletContext)rsvc.getApplicationAttribute("ServletContext");
        if (_sctx == null) {
            rsvc.getLog().warn("ServletContextResourceLoader: servlet context was not supplied " +
                               "as application context. A user of the servlet context resource " +
                               "loader must call Velocity.setApplicationAttribute(" +
                               "\"ServletContext\", getServletContext()).");
        }
    }

    /**
     * Returns the input stream that can be used to load the named
     * resource.
     *
     * @param path the path (relative to the webapp root) of resource to
     * get.
     *
     * @return an input stream that can be used to read the resource.
     *
     * @exception ResourceNotFoundException if the resource was not found.
     */
    @Override
    public InputStream getResourceStream (String path)
        throws ResourceNotFoundException
    {
        // make sure we were properly initialized
        if (_sctx == null) {
            String errmsg = "ServletContextResourceLoader not properly " +
                "initialized. Can't load resources.";
            throw new ResourceNotFoundException(errmsg);
        }

        // load it on up
        InputStream stream = _sctx.getResourceAsStream(path);
        if (stream == null) {
            String errmsg = "Unable to load resource via servlet context " +
                "[path=" + path + "].";
            throw new ResourceNotFoundException(errmsg);
        }
        return stream;
    }

    /**
     * Things won't ever be modified when loaded from the servlet context
     * because they came from the webapp .war file and if that is
     * reloaded, everything will be thrown away and started afresh.
     */
    @Override
    public boolean isSourceModified (Resource resource)
    {
        return false;
    }

    /**
     * Things won't ever be modified when loaded from the servlet context
     * because they came from the webapp .war file and if that is
     * reloaded, everything will be thrown away and started afresh. So we
     * can punt here and return zero.
     */
    @Override
    public long getLastModified (Resource resource)
    {
        return 0;
    }

    /** A reference to the servlet context through which we'll load
     * things. */
    protected ServletContext _sctx;
}