net.shibboleth.ext.spring.velocity.VelocityEngineFactoryBean Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the University Corporation for Advanced Internet Development,
 * Inc. (UCAID) under one or more contributor license agreements.  See the
 * NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The UCAID licenses this file to You 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 net.shibboleth.ext.spring.velocity;

import java.io.IOException;

import javax.annotation.Nullable;

import org.apache.velocity.app.VelocityEngine;
import org.apache.velocity.exception.VelocityException;

import org.springframework.beans.factory.FactoryBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.context.ResourceLoaderAware;

/**
 * Factory bean that configures a VelocityEngine and provides it as bean
 * reference. This bean is intended for any kind of usage of Velocity in
 * application code, e.g. for generating email content. For web views,
 * VelocityConfigurer is used to set up a VelocityEngine for views.
 *
 * The simplest way to use this class is to specify a "resourceLoaderPath";
 * you do not need any further configuration then. For example, in a web
 * application context:
 *
 * 
 *   <bean id="velocityEngine" class="net.shibboleth.ext.spring.velocity.VelocityEngineFactoryBean">
 *   <property name="resourceLoaderPath" value="/WEB-INF/velocity/"/>
 * </bean>
 *
 * See the base class VelocityEngineFactory for configuration details.
 *
 * @author Juergen Hoeller
 * @see #setConfigLocation
 * @see #setVelocityProperties
 * @see #setResourceLoaderPath
 * @see VelocityConfigurer
 * 
 * @since 6.0.0
 */
public class VelocityEngineFactoryBean extends VelocityEngineFactory
        implements FactoryBean, InitializingBean, ResourceLoaderAware {

    /** Engine being created. */
    @Nullable private VelocityEngine velocityEngine;

    /** {@inheritDoc} */
    @Override
    public void afterPropertiesSet() throws IOException, VelocityException {
        velocityEngine = createVelocityEngine();
    }

    /** {@inheritDoc} */
    @Override
    @Nullable public VelocityEngine getObject() {
        return velocityEngine;
    }

    /** {@inheritDoc} */
    @Override
    @Nullable public Class getObjectType() {
        return VelocityEngine.class;
    }

    /** {@inheritDoc} */
    @Override
    public boolean isSingleton() {
        return true;
    }

}