This is the Runtime system for Velocity. It is the
single access point for all functionality in Velocity.
It adheres to the mediator pattern and is the only
structure that developers need to be familiar with
in order to get Velocity to perform.
The Runtime will also cooperate with external
systems like Turbine. Runtime properties can
set and then the Runtime is initialized.
Turbine for example knows where the templates
are to be loaded from, and where the velocity
log file should be placed.
So in the case of Velocity cooperating with Turbine
the code might look something like the following:
RuntimeSingleton.setProperty(RuntimeConstants.FILE_RESOURCE_LOADER_PATH, templatePath);
RuntimeSingleton.setProperty(RuntimeConstants.RUNTIME_LOG, pathToVelocityLog);
RuntimeSingleton.init();
-----------------------------------------------------------------------
N O T E S O N R U N T I M E I N I T I A L I Z A T I O N
-----------------------------------------------------------------------
RuntimeSingleton.init()
If Runtime.init() is called by itself the Runtime will
initialize with a set of default values.
-----------------------------------------------------------------------
RuntimeSingleton.init(String/Properties)
In this case the default velocity properties are layed down
first to provide a solid base, then any properties provided
in the given properties object will override the corresponding
default property.
-----------------------------------------------------------------------
addProperty
public static 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"]
addVelocimacro
public static boolean addVelocimacro(String name,
String macro,
argArray[] ,
String sourceTemplate)
Adds a new Velocimacro. Usually called by Macro only while parsing.
- boolean True if added, false if rejected for some
reason (either parameters or permission settings)
clearProperty
public static void clearProperty(String key)
Clear the values pertaining to a particular
property.
createNewParser
private static Parser createNewParser()
Returns a JavaCC generated Parser.
- Parser javacc generated parser
debug
public static void debug(Object message)
Log a debug message.
dumpVMNamespace
public static 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
error
public static void error(Object message)
Log an error message.
getApplicationAttribute
public static Object getApplicationAttribute(Object key)
getBoolean
public static boolean getBoolean(String key,
boolean def)
Boolean property accessor method to hide the configuration implementation.
- boolean value of key or default value
getConfiguration
public static ExtendedProperties getConfiguration()
Return the velocity runtime configuration object.
- ExtendedProperties configuration object which houses
the velocity runtime properties.
getContent
public static 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.
name
- Name of content resource to get
- parsed ContentResource object ready for use
getContent
public static ContentResource getContent(String name,
String encoding)
throws ResourceNotFoundException,
ParseErrorException,
Exception
Returns a static content resource from the
resource manager.
name
- Name of content resource to getencoding
- Character encoding to use
- parsed ContentResource object ready for use
getInt
public static int getInt(String key)
Int property accessor method to hide the configuration implementation.
getInt
public static int getInt(String key,
int defaultValue)
Int property accessor method to hide the configuration implementation.
getIntrospector
public static Introspector getIntrospector()
Return the Introspector for this RuntimeInstance
- Introspector object for this runtime instance
getLoaderNameForResource
public static 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.
resourceName
- Name of template or content resource
- class name of loader than can provide it
getProperty
public static 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.
getRuntimeInstance
public static RuntimeInstance getRuntimeInstance()
Use getRuntimeServices() instead.
getRuntimeServices
public static RuntimeServices getRuntimeServices()
- The RuntimeInstance used by this wrapper.
getString
public static String getString(String key)
String property accessor method to hide the configuration implementation
getString
public static String getString(String key,
String defaultValue)
String property accessor method with default to hide the
configuration implementation.
- String value of key or default
getTemplate
public static 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"
name
- The file name of the desired template.
getTemplate
public static Template getTemplate(String name,
String encoding)
throws ResourceNotFoundException,
ParseErrorException,
Exception
Returns a Template
from the resource manager
name
- The name of the desired template.encoding
- Character encoding of the template
getUberspect
public static Uberspect getUberspect()
getVelocimacro
public static Directive getVelocimacro(String vmName,
String templateName)
Returns the appropriate VelocimacroProxy object if strVMname
is a valid current Velocimacro.
info
public static void info(Object message)
Log an info message.
init
public static void init()
throws Exception
This is the primary initialization method in the Velocity
Runtime. The systems that are setup/initialized here are
as follows:
- Logging System
- ResourceManager
- Parser Pool
- Global Cache
- Static Content Include System
- Velocimacro System
init
public static void init(Properties p)
throws Exception
Initialize the Velocity Runtime with a Properties
object.
init
public static void init(String configurationFile)
throws Exception
Initialize the Velocity Runtime with the name of
ExtendedProperties object.
isVelocimacro
public static boolean isVelocimacro(String vmName,
String templateName)
Checks to see if a VM exists
- boolean True if VM by that name exists, false if not
parse
public static 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.
parse
public static SimpleNode parse(Reader reader,
String templateName,
boolean dumpNamespace)
throws ParseException
Parse the input and return the root of the AST node structure.
dumpNamespace
- flag to dump the Velocimacro namespace for this template
setConfiguration
public static void setConfiguration(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.
setProperty
public static void setProperty(String key,
Object value)
Allows an external system to set a property in
the Velocity Runtime.
warn
public static void warn(Object message)
Log a warning message.