org.xwiki.velocity.internal.VelocityExecutionContextInitializer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-velocity Show documentation
Show all versions of xwiki-commons-velocity Show documentation
APIs to evaluate content with Velocity
/*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* This 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 software 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.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.xwiki.velocity.internal;
import javax.inject.Inject;
import javax.inject.Named;
import javax.inject.Singleton;
import org.apache.velocity.VelocityContext;
import org.xwiki.component.annotation.Component;
import org.xwiki.context.ExecutionContext;
import org.xwiki.context.ExecutionContextException;
import org.xwiki.context.ExecutionContextInitializer;
import org.xwiki.velocity.VelocityContextFactory;
import org.xwiki.velocity.XWikiVelocityException;
/**
* Allow registering the Velocity Context in the Execution Context object since it's shared during the whole execution
* of the current request.
*
* @see org.xwiki.context.ExecutionContextInitializer
* @since 1.5M1
* @version $Id: a522b3a58851b2bc83b6ab858ab5c274f0086309 $
*/
@Component
@Named("velocity")
@Singleton
public class VelocityExecutionContextInitializer implements ExecutionContextInitializer
{
/**
* The id under which the Velocity Context is stored in the Execution Context.
*/
public static final String VELOCITY_CONTEXT_ID = "velocityContext";
/**
* The Velocity context factory component used for creating the Velocity Context (injected automatically by the
* Component subsystem).
*/
@Inject
private VelocityContextFactory velocityContextFactory;
@Override
public void initialize(ExecutionContext executionContext) throws ExecutionContextException
{
try {
if (!executionContext.hasProperty(VELOCITY_CONTEXT_ID)) {
VelocityContext context = this.velocityContextFactory.createContext();
executionContext.newProperty(VELOCITY_CONTEXT_ID)
.cloneValue()
.inherited()
.initial(context)
.declare();
}
} catch (XWikiVelocityException e) {
throw new ExecutionContextException("Failed to initialize Velocity Context", e);
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy