org.apache.velocity.runtime
Interface RuntimeServices

All Known Implementing Classes:

RuntimeInstance

public interface RuntimeServices

Interface for internal runtime services that are needed by the various components w/in Velocity. This was taken from the old Runtime singleton, and anything not necessary was removed. Currently implemented by RuntimeInstance.

Version:

$Id: RuntimeServices.java 191743 2005-06-21 23:22:20Z dlr $

Author:

Geir Magusson Jr.

Method Summary

void	addProperty(String key, Object value) Add a property to the configuration.
boolean	addVelocimacro(String name, String macro, String[] argArray, String sourceTemplate, int line, int column) Adds a new Velocimacro.
void	clearProperty(String key) Clear the values pertaining to a particular property.
boolean	dumpVMNamespace(String namespace) tells the vmFactory to dump the specified namespace.
Object	getApplicationAttribute(Object key) Return the specified applcation attribute.
boolean	getBoolean(String key, boolean def) Boolean property accessor method to hide the configuration implementation.
org.apache.commons.collections.ExtendedProperties	getConfiguration() Return the velocity runtime configuration object.
ContentResource	getContent(String name) Returns a static content resource from the resource manager.
ContentResource	getContent(String name, String encoding) Returns a static content resource from the resource manager.
int	getInt(String key) Int property accessor method to hide the configuration implementation.
int	getInt(String key, int defaultValue) Int property accessor method to hide the configuration implementation.
Introspector	getIntrospector() Returns the configured method introspection/reflection implemenation.
String	getLoaderNameForResource(String resourceName) Determines is a template exists, and returns name of the loader that provides it.
Object	getProperty(String key) Allows an external caller to get a property.
String	getString(String key) String property accessor method to hide the configuration implementation
String	getString(String key, String defaultValue) String property accessor method with default to hide the configuration implementation.
Template	getTemplate(String name) Returns a Template from the resource manager.
Template	getTemplate(String name, String encoding) Returns a Template from the resource manager
Uberspect	getUberspect() Returns the configured class introspection/reflection implemenation.
Directive	getVelocimacro(String vmName, String templateName) Returns the appropriate VelocimacroProxy object if strVMname is a valid current Velocimacro.
void	init()
void	init(Properties p) Initialize the Velocity Runtime with a Properties object.
void	init(String configurationFile) Initialize the Velocity Runtime with the name of ExtendedProperties object.
boolean	isVelocimacro(String vmName, String templateName) Checks to see if a VM exists
SimpleNode	parse(Reader reader, String templateName) Parse the input and return the root of AST node structure.
SimpleNode	parse(Reader reader, String templateName, boolean dumpNamespace) Parse the input and return the root of the AST node structure.
void	setConfiguration(org.apache.commons.collections.ExtendedProperties configuration) Allow an external system to set an ExtendedProperties object to use.
void	setProperty(String key, Object value) Allows an external system to set a property in the Velocity Runtime.

Method Detail

init

void init()
          throws Exception

Throws:

Exception

setProperty

void setProperty(String key,
                 Object value)

Allows an external system to set a property in the Velocity Runtime.

Parameters:

key - property key

value - property value

setConfiguration

void setConfiguration(org.apache.commons.collections.ExtendedProperties configuration)

Allow an external system to set an ExtendedProperties object to use. This is useful where the external system also uses the ExtendedProperties class and the velocity configuration is a subset of parent application's configuration. This is the case with Turbine.

Parameters:

configuration -

addProperty

void addProperty(String key,
                 Object value)

Add a property to the configuration. If it already exists then the value stated here will be added to the configuration entry. For example, if resource.loader = file is already present in the configuration and you addProperty("resource.loader", "classpath") Then you will end up with a Vector like the following: ["file", "classpath"]

Parameters:

key -

value -

clearProperty

void clearProperty(String key)

Clear the values pertaining to a particular property.

Parameters:

key - key of property to clear

getProperty

Object getProperty(String key)

Allows an external caller to get a property. The calling routine is required to know the type, as this routine will return an Object, as that is what properties can be.

Parameters:

key - property to return

init

void init(Properties p)
          throws Exception

Initialize the Velocity Runtime with a Properties object.

Parameters:

p -

Throws:

Exception

init

void init(String configurationFile)
          throws Exception

Initialize the Velocity Runtime with the name of ExtendedProperties object.

Parameters:

configurationFile -

Throws:

Exception

parse

SimpleNode parse(Reader reader,
                 String templateName)
                 throws ParseException

Parse the input and return the root of AST node structure.

In the event that it runs out of parsers in the pool, it will create and let them be GC'd dynamically, logging that it has to do that. This is considered an exceptional condition. It is expected that the user will set the PARSER_POOL_SIZE property appropriately for their application. We will revisit this.

Parameters:

reader - inputstream retrieved by a resource loader

templateName - name of the template being parsed

Throws:

ParseException

parse

SimpleNode parse(Reader reader,
                 String templateName,
                 boolean dumpNamespace)
                 throws ParseException

Parse the input and return the root of the AST node structure.

Parameters:

reader - inputstream retrieved by a resource loader

templateName - name of the template being parsed

dumpNamespace - flag to dump the Velocimacro namespace for this template

Throws:

ParseException

getTemplate

Template getTemplate(String name)
                     throws ResourceNotFoundException,
                            ParseErrorException,
                            Exception

Returns a Template from the resource manager. This method assumes that the character encoding of the template is set by the input.encoding property. The default is "ISO-8859-1"

Parameters:

name - The file name of the desired template.

Returns:

The template.

Throws:

ResourceNotFoundException - if template not found from any available source.

ParseErrorException - if template cannot be parsed due to syntax (or other) error.

Exception - if an error occurs in template initialization

getTemplate

Template getTemplate(String name,
                     String encoding)
                     throws ResourceNotFoundException,
                            ParseErrorException,
                            Exception

Returns a Template from the resource manager

Parameters:

name - The name of the desired template.

encoding - Character encoding of the template

Returns:

The template.

Throws:

ResourceNotFoundException - if template not found from any available source.

ParseErrorException - if template cannot be parsed due to syntax (or other) error.

Exception - if an error occurs in template initialization

getContent

ContentResource getContent(String name)
                           throws ResourceNotFoundException,
                                  ParseErrorException,
                                  Exception

Returns a static content resource from the resource manager. Uses the current value if INPUT_ENCODING as the character encoding.

Parameters:

name - Name of content resource to get

Returns:

parsed ContentResource object ready for use

Throws:

ResourceNotFoundException - if template not found from any available source.

ParseErrorException

Exception

getContent

ContentResource getContent(String name,
                           String encoding)
                           throws ResourceNotFoundException,
                                  ParseErrorException,
                                  Exception

Returns a static content resource from the resource manager.

Parameters:

name - Name of content resource to get

encoding - Character encoding to use

Returns:

parsed ContentResource object ready for use

Throws:

ResourceNotFoundException - if template not found from any available source.

ParseErrorException

Exception

getLoaderNameForResource

String getLoaderNameForResource(String resourceName)

Determines is a template exists, and returns name of the loader that provides it. This is a slightly less hokey way to support the Velocity.templateExists() utility method, which was broken when per-template encoding was introduced. We can revisit this.

Parameters:

resourceName - Name of template or content resource

Returns:

class name of loader than can provide it

getString

String getString(String key,
                 String defaultValue)

String property accessor method with default to hide the configuration implementation.

Parameters:

key - property key

defaultValue - default value to return if key not found in resource manager.

Returns:

value of key or default

getVelocimacro

Directive getVelocimacro(String vmName,
                         String templateName)

Returns the appropriate VelocimacroProxy object if strVMname is a valid current Velocimacro.

Parameters:

vmName - Name of velocimacro requested

templateName -

Returns:

VelocimacroProxy

addVelocimacro

boolean addVelocimacro(String name,
                       String macro,
                       String[] argArray,
                       String sourceTemplate,
                       int line,
                       int column)

Adds a new Velocimacro. Usually called by Macro only while parsing.

Parameters:

name - Name of velocimacro

macro - String form of macro body

argArray - Array of strings, containing the #macro() arguments. the 0th is the name.

line - the line, where the macro starts

column - the column, where the macro starts

Returns:

True if added, false if rejected for some reason (either parameters or permission settings)

isVelocimacro

boolean isVelocimacro(String vmName,
                      String templateName)

Checks to see if a VM exists

Parameters:

vmName - Name of velocimacro

templateName -

Returns:

True if VM by that name exists, false if not

dumpVMNamespace

boolean dumpVMNamespace(String namespace)

tells the vmFactory to dump the specified namespace. This is to support clearing the VM list when in inline-VM-local-scope mode

getString

String getString(String key)

String property accessor method to hide the configuration implementation

Parameters:

key - property key

Returns:

value of key or null

getInt

int getInt(String key)

Int property accessor method to hide the configuration implementation.

Parameters:

key - property key

Returns:

value

getInt

int getInt(String key,
           int defaultValue)

Int property accessor method to hide the configuration implementation.

Parameters:

key - property key

defaultValue - default value

Returns:

value

getBoolean

boolean getBoolean(String key,
                   boolean def)

Boolean property accessor method to hide the configuration implementation.

Parameters:

key - property key

def - default value if property not found

Returns:

value of key or default value

getConfiguration

org.apache.commons.collections.ExtendedProperties getConfiguration()

Return the velocity runtime configuration object.

Returns:

configuration object which houses the velocity runtime properties.

getApplicationAttribute

Object getApplicationAttribute(Object key)

Return the specified applcation attribute.

Parameters:

key - The name of the attribute to retrieve.

getUberspect

Uberspect getUberspect()

Returns the configured class introspection/reflection implemenation.

getIntrospector

Introspector getIntrospector()

Returns the configured method introspection/reflection implemenation.