com.liferay.portal.velocity.LiferayResourceLoader.java Source code

Introduction

Here is the source code for com.liferay.portal.velocity.LiferayResourceLoader.java

Source

/**
 * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.portal.velocity;

import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.util.PropsValues;

import java.io.IOException;
import java.io.InputStream;

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;

/**
 * @author Brian Wing Shun Chan
 * @author Shuyang Zhou
 */
public class LiferayResourceLoader extends ResourceLoader {

    public static void setVelocityResourceListeners(String[] velocityResourceListeners) {

        _velocityResourceListeners = new VelocityResourceListener[velocityResourceListeners.length];

        for (int i = 0; i < velocityResourceListeners.length; i++) {
            try {
                Class<?> clazz = Class.forName(velocityResourceListeners[i]);

                _velocityResourceListeners[i] = (VelocityResourceListener) clazz.newInstance();
            } catch (Exception e) {
                _log.error(e);

                _velocityResourceListeners[i] = null;
            }
        }
    }

    @Override
    public long getLastModified(Resource resource) {
        if (_log.isDebugEnabled()) {
            _log.debug("Get last modified for " + resource.getName());
        }

        return 0;
    }

    @Override
    public InputStream getResourceStream(String source) throws ResourceNotFoundException {

        InputStream is = doGetResourceStream(source);

        if (is == null) {
            if (_log.isDebugEnabled()) {
                _log.debug("Could not find " + source);
            }

            throw new ResourceNotFoundException(source);
        }

        if (_log.isDebugEnabled()) {
            _log.debug("Successfully got " + source);
        }

        return is;
    }

    @Override
    public void init(ExtendedProperties props) {
        setModificationCheckInterval(PropsValues.VELOCITY_ENGINE_RESOURCE_MANAGER_MODIFICATION_CHECK_INTERVAL);
    }

    @Override
    public boolean isSourceModified(Resource resource) {
        if (_log.isDebugEnabled()) {
            _log.debug("Check modified status for " + resource.getName());
        }

        return false;
    }

    @Override
    public boolean resourceExists(String resourceName) {
        InputStream is = doGetResourceStream(resourceName);

        try {
            if (is != null) {
                is.close();
            }
        } catch (IOException ioe) {
        }

        if (is != null) {
            return true;
        } else {
            return false;
        }
    }

    protected InputStream doGetResourceStream(String source) throws ResourceNotFoundException {

        if (_log.isDebugEnabled()) {
            _log.debug("Get resource for " + source);
        }

        InputStream is = null;

        for (int i = 0; (is == null) && (i < _velocityResourceListeners.length); i++) {

            VelocityResourceListener velocityResourceListener = _velocityResourceListeners[i];

            if (velocityResourceListener != null) {
                is = velocityResourceListener.getResourceStream(source);
            }
        }

        return is;
    }

    private static VelocityResourceListener[] _velocityResourceListeners = new VelocityResourceListener[0];

    private static Log _log = LogFactoryUtil.getLog(LiferayResourceLoader.class);

}