com.epimorphics.server.templates

Class VelocityRender

java.lang.Object

com.epimorphics.server.core.ServiceBase

com.epimorphics.server.templates.VelocityRender

All Implemented Interfaces:

Service

public class VelocityRender
extends ServiceBase
implements Service

Service to provide velocity-based HTML rendering. Can be used from Jersey restlets to format returned results. Can also be installed as a filter to render requests directly.

Configuration parameters:

• templates - root directory where velocity templates are located, if it contains a file velocity.properties then that will be used to configure velocity, if it contains a file macros.vm then that will be used to define static global macros
• root - URL, relative to the webapp, where the velocity filter should be installed (so that a request {root}/foo will test for a file foo.vm in the templates directory and render that, otherwise will forward the filter down the chain)
• production - optional property, if set to true then run in production model with full caching

The velocity templates are run in a context with the following variables set.

• request - the servlet request object
• response - the servlet response object
• root - the root context path for the servlet
• lib - a java utility library
• dataset - wrapper version of the default store
• model - wrapper version of the union model of the default store
• all request parameter names bound to their values in the request
• all registered services available bound to their names
• call-specific bindings which may replace any of the above

Author:

Dave Reynolds

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_FILENAME
static String	FILTER_NAME
protected boolean	isProduction
static String	MACRO_FILE
static String	MANUAL_PARAM
static String	PLUGIN_PARAM
protected com.hp.hpl.jena.shared.PrefixMapping	prefixes
static String	PREFIXES_FILE
static String	PRODUCTION_PARAM
static String	ROOT_PARAM
protected String	rootURI
protected File	templateDir
static String	TEMPLATES_PARAM
protected org.apache.velocity.app.VelocityEngine	ve

Fields inherited from class com.epimorphics.server.core.ServiceBase

config

Constructor Summary

Constructors

Constructor and Description
VelocityRender()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.velocity.VelocityContext	buildContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,Object> env)
com.hp.hpl.jena.shared.PrefixMapping	getPrefixes()
void	init(Map<String,String> config, javax.servlet.ServletContext context)
void	postInit()
boolean	render(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,Object> env) Find velocity template that matches the request path.
void	render(String templateName, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,Object> env) Render the given template,
javax.ws.rs.core.StreamingOutput	render(String templateName, String requestURI, javax.servlet.ServletContext context, javax.ws.rs.core.MultivaluedMap<String,String> parameters, Object... args) Variant of render suitable for use from jax-rs implementations.
void	setPrefixes(com.hp.hpl.jena.shared.PrefixMapping pm)

Methods inherited from class com.epimorphics.server.core.ServiceBase

getFileParam, getNamedService, getRequiredFileParam, getRequiredIntParam, getRequiredParam, postPostInit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.epimorphics.server.core.Service

postPostInit

Field Detail

TEMPLATES_PARAM

public static final String TEMPLATES_PARAM

See Also:

Constant Field Values

ROOT_PARAM

public static final String ROOT_PARAM

See Also:

Constant Field Values

PRODUCTION_PARAM

public static final String PRODUCTION_PARAM

See Also:

Constant Field Values

CONFIG_FILENAME

public static final String CONFIG_FILENAME

See Also:

Constant Field Values

PREFIXES_FILE

public static final String PREFIXES_FILE

See Also:

Constant Field Values

MACRO_FILE

public static final String MACRO_FILE

See Also:

Constant Field Values

FILTER_NAME

public static final String FILTER_NAME

See Also:

Constant Field Values

PLUGIN_PARAM

public static final String PLUGIN_PARAM

See Also:

Constant Field Values

MANUAL_PARAM

public static final String MANUAL_PARAM

See Also:

Constant Field Values

ve

protected org.apache.velocity.app.VelocityEngine ve

isProduction

protected boolean isProduction

templateDir

protected File templateDir

rootURI

protected String rootURI

prefixes

protected com.hp.hpl.jena.shared.PrefixMapping prefixes

Constructor Detail

VelocityRender

public VelocityRender()

Method Detail

init

public void init(Map<String,String> config,
        javax.servlet.ServletContext context)

Specified by:

init in interface Service

Overrides:

init in class ServiceBase

postInit

public void postInit()

Specified by:

postInit in interface Service

Overrides:

postInit in class ServiceBase

render

public boolean render(javax.servlet.http.HttpServletRequest request,
             javax.servlet.http.HttpServletResponse response,
             Map<String,Object> env)

Find velocity template that matches the request path. If one exists render it and return true, otherwise return false.

render

public void render(String templateName,
          javax.servlet.http.HttpServletRequest request,
          javax.servlet.http.HttpServletResponse response,
          Map<String,Object> env)
            throws org.apache.velocity.exception.ResourceNotFoundException,
                   IOException

Render the given template,

Throws:

org.apache.velocity.exception.ResourceNotFoundException

IOException

render

public javax.ws.rs.core.StreamingOutput render(String templateName,
                                      String requestURI,
                                      javax.servlet.ServletContext context,
                                      javax.ws.rs.core.MultivaluedMap<String,String> parameters,
                                      Object... args)

Variant of render suitable for use from jax-rs implementations. The environment will include the library (lib), the request URI (uri), the root context for the container (root), and the set of configured services and the supplied list of bindings.

Parameters:

templateName - the template to render

args - an alternative sequence of names and java objects to inject into the environment

Returns:

setPrefixes

public void setPrefixes(com.hp.hpl.jena.shared.PrefixMapping pm)

getPrefixes

public com.hp.hpl.jena.shared.PrefixMapping getPrefixes()

buildContext

protected org.apache.velocity.VelocityContext buildContext(javax.servlet.http.HttpServletRequest request,
                                               javax.servlet.http.HttpServletResponse response,
                                               Map<String,Object> env)