| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> |
| <title>RuntimeInstance xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/velocity/runtime/RuntimeInstance.html">View Javadoc</a></div><pre> |
|
|
| <a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.velocity.runtime;
|
| <a name="2" href="#2">2</a>
|
| <a name="3" href="#3">3</a> <em class="jxr_comment">/*</em>
|
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
|
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
|
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
|
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
|
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
|
| <a name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
|
| <a name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
|
| <a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
|
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
|
| <a name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
|
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
|
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
|
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
|
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
|
| <a name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
|
| <a name="19" href="#19">19</a> <em class="jxr_comment"> * under the License. </em>
|
| <a name="20" href="#20">20</a> <em class="jxr_comment"> */</em>
|
| <a name="21" href="#21">21</a>
|
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.File;
|
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
|
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
|
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.io.Reader;
|
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.io.StringReader;
|
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.io.Writer;
|
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.Enumeration;
|
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.util.HashMap;
|
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.util.Hashtable;
|
| <a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> java.util.Map;
|
| <a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> java.util.Properties;
|
| <a name="33" href="#33">33</a>
|
| <a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.apache.commons.collections.ExtendedProperties;
|
| <a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang.text.StrBuilder;
|
| <a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.Template;
|
| <a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.app.event.EventCartridge;
|
| <a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.app.event.EventHandler;
|
| <a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.app.event.IncludeEventHandler;
|
| <a name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.app.event.InvalidReferenceEventHandler;
|
| <a name="41" href="#41">41</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.app.event.MethodExceptionEventHandler;
|
| <a name="42" href="#42">42</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.app.event.NullSetEventHandler;
|
| <a name="43" href="#43">43</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.app.event.ReferenceInsertionEventHandler;
|
| <a name="44" href="#44">44</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.context.Context;
|
| <a name="45" href="#45">45</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.context.InternalContextAdapterImpl;
|
| <a name="46" href="#46">46</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.MethodInvocationException;
|
| <a name="47" href="#47">47</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.ParseErrorException;
|
| <a name="48" href="#48">48</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.ResourceNotFoundException;
|
| <a name="49" href="#49">49</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.TemplateInitException;
|
| <a name="50" href="#50">50</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.VelocityException;
|
| <a name="51" href="#51">51</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.directive.Directive;
|
| <a name="52" href="#52">52</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.log.Log;
|
| <a name="53" href="#53">53</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.log.LogManager;
|
| <a name="54" href="#54">54</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.parser.ParseException;
|
| <a name="55" href="#55">55</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.parser.Parser;
|
| <a name="56" href="#56">56</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.parser.node.Node;
|
| <a name="57" href="#57">57</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.parser.node.SimpleNode;
|
| <a name="58" href="#58">58</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.resource.ContentResource;
|
| <a name="59" href="#59">59</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.resource.ResourceManager;
|
| <a name="60" href="#60">60</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.ClassUtils;
|
| <a name="61" href="#61">61</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.RuntimeServicesAware;
|
| <a name="62" href="#62">62</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.StringUtils;
|
| <a name="63" href="#63">63</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.introspection.Introspector;
|
| <a name="64" href="#64">64</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.introspection.Uberspect;
|
| <a name="65" href="#65">65</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.introspection.UberspectLoggable;
|
| <a name="66" href="#66">66</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.introspection.ChainableUberspector;
|
| <a name="67" href="#67">67</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.introspection.LinkingUberspector;
|
| <a name="68" href="#68">68</a>
|
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * This is the Runtime system for Velocity. It is the</em>
|
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * single access point for all functionality in Velocity.</em>
|
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * It adheres to the mediator pattern and is the only</em>
|
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * structure that developers need to be familiar with</em>
|
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * in order to get Velocity to perform.</em>
|
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * The Runtime will also cooperate with external</em>
|
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * systems like Turbine. Runtime properties can</em>
|
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * set and then the Runtime is initialized.</em>
|
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * Turbine, for example, knows where the templates</em>
|
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * are to be loaded from, and where the Velocity</em>
|
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * log file should be placed.</em>
|
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * So in the case of Velocity cooperating with Turbine</em>
|
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * the code might look something like the following:</em>
|
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * <blockquote><code><pre></em>
|
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * ri.setProperty(Runtime.FILE_RESOURCE_LOADER_PATH, templatePath);</em>
|
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * ri.setProperty(Runtime.RUNTIME_LOG, pathToVelocityLog);</em>
|
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * ri.init();</em>
|
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * </pre></code></blockquote></em>
|
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * <pre></em>
|
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * -----------------------------------------------------------------------</em>
|
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * 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</em>
|
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * -----------------------------------------------------------------------</em>
|
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * init()</em>
|
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * If init() is called by itself the RuntimeInstance will initialize</em>
|
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * with a set of default values.</em>
|
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * -----------------------------------------------------------------------</em>
|
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * init(String/Properties)</em>
|
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * In this case the default velocity properties are layed down</em>
|
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * first to provide a solid base, then any properties provided</em>
|
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * in the given properties object will override the corresponding</em>
|
| <a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * default property.</em>
|
| <a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * -----------------------------------------------------------------------</em>
|
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * </pre></em>
|
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:jvanzyl@apache.org" target="alexandria_uri">mailto:jvanzyl@apache.org</a>">Jason van Zyl</a></em>
|
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:jlb@houseofdistraction.com" target="alexandria_uri">mailto:jlb@houseofdistraction.com</a>">Jeff Bowden</a></em>
|
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:geirm@optonline.net" target="alexandria_uri">mailto:geirm@optonline.net</a>">Geir Magusson Jr.</a></em>
|
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * @version $Id: RuntimeInstance.java 703049 2008-10-09 03:18:58Z nbubna $</em>
|
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="116" href="#116">116</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html">RuntimeInstance</a> implements RuntimeConstants, <a href="../../../../org/apache/velocity/runtime/RuntimeServices.html">RuntimeServices</a>
|
| <a name="117" href="#117">117</a> {
|
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * VelocimacroFactory object to manage VMs</em>
|
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="121" href="#121">121</a> <strong class="jxr_keyword">private</strong> VelocimacroFactory vmFactory = <strong class="jxr_keyword">null</strong>;
|
| <a name="122" href="#122">122</a>
|
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * The Runtime logger. We start with an instance of</em>
|
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * a 'primordial logger', which just collects log messages</em>
|
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * then, when the log system is initialized, all the</em>
|
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * messages get dumpted out of the primordial one into the real one.</em>
|
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="129" href="#129">129</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/velocity/runtime/log/Log.html">Log</a> log = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/runtime/log/Log.html">Log</a>();
|
| <a name="130" href="#130">130</a>
|
| <a name="131" href="#131">131</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * The Runtime parser pool</em>
|
| <a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="134" href="#134">134</a> <strong class="jxr_keyword">private</strong> ParserPool parserPool;
|
| <a name="135" href="#135">135</a>
|
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * Indicate whether the Runtime is in the midst of initialization.</em>
|
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="139" href="#139">139</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> initializing = false;
|
| <a name="140" href="#140">140</a>
|
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * Indicate whether the Runtime has been fully initialized.</em>
|
| <a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="144" href="#144">144</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> initialized = false;
|
| <a name="145" href="#145">145</a>
|
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * These are the properties that are laid down over top</em>
|
| <a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * of the default properties when requested.</em>
|
| <a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="150" href="#150">150</a> <strong class="jxr_keyword">private</strong> ExtendedProperties overridingProperties = <strong class="jxr_keyword">null</strong>;
|
| <a name="151" href="#151">151</a>
|
| <a name="152" href="#152">152</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * This is a hashtable of initialized directives.</em>
|
| <a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * The directives that populate this hashtable are</em>
|
| <a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * taken from the RUNTIME_DEFAULT_DIRECTIVES</em>
|
| <a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * property file. This hashtable is passed</em>
|
| <a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * to each parser that is created.</em>
|
| <a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="159" href="#159">159</a> <strong class="jxr_keyword">private</strong> Hashtable runtimeDirectives;
|
| <a name="160" href="#160">160</a>
|
| <a name="161" href="#161">161</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * Object that houses the configuration options for</em>
|
| <a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * the velocity runtime. The ExtendedProperties object allows</em>
|
| <a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * the convenient retrieval of a subset of properties.</em>
|
| <a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * For example all the properties for a resource loader</em>
|
| <a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * can be retrieved from the main ExtendedProperties object</em>
|
| <a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * using something like the following:</em>
|
| <a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> * ExtendedProperties loaderConfiguration =</em>
|
| <a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * configuration.subset(loaderID);</em>
|
| <a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> * And a configuration is a lot more convenient to deal</em>
|
| <a name="173" href="#173">173</a> <em class="jxr_javadoccomment"> * with then conventional properties objects, or Maps.</em>
|
| <a name="174" href="#174">174</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="175" href="#175">175</a> <strong class="jxr_keyword">private</strong> ExtendedProperties configuration = <strong class="jxr_keyword">new</strong> ExtendedProperties();
|
| <a name="176" href="#176">176</a>
|
| <a name="177" href="#177">177</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/velocity/runtime/resource/ResourceManager.html">ResourceManager</a> resourceManager = <strong class="jxr_keyword">null</strong>;
|
| <a name="178" href="#178">178</a>
|
| <a name="179" href="#179">179</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> * This stores the engine-wide set of event handlers. Event handlers for</em>
|
| <a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> * each specific merge are stored in the context.</em>
|
| <a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="183" href="#183">183</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/velocity/app/event/EventCartridge.html">EventCartridge</a> eventCartridge = <strong class="jxr_keyword">null</strong>;
|
| <a name="184" href="#184">184</a>
|
| <a name="185" href="#185">185</a> <em class="jxr_comment">/*</em>
|
| <a name="186" href="#186">186</a> <em class="jxr_comment"> * Each runtime instance has it's own introspector</em>
|
| <a name="187" href="#187">187</a> <em class="jxr_comment"> * to ensure that each instance is completely separate.</em>
|
| <a name="188" href="#188">188</a> <em class="jxr_comment"> */</em>
|
| <a name="189" href="#189">189</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/velocity/util/introspection/Introspector.html">Introspector</a> introspector = <strong class="jxr_keyword">null</strong>;
|
| <a name="190" href="#190">190</a>
|
| <a name="191" href="#191">191</a>
|
| <a name="192" href="#192">192</a> <em class="jxr_comment">/*</em>
|
| <a name="193" href="#193">193</a> <em class="jxr_comment"> * Opaque reference to something specificed by the</em>
|
| <a name="194" href="#194">194</a> <em class="jxr_comment"> * application for use in application supplied/specified</em>
|
| <a name="195" href="#195">195</a> <em class="jxr_comment"> * pluggable components</em>
|
| <a name="196" href="#196">196</a> <em class="jxr_comment"> */</em>
|
| <a name="197" href="#197">197</a> <strong class="jxr_keyword">private</strong> Map applicationAttributes = <strong class="jxr_keyword">null</strong>;
|
| <a name="198" href="#198">198</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/velocity/util/introspection/Uberspect.html">Uberspect</a> uberSpect;
|
| <a name="199" href="#199">199</a> <strong class="jxr_keyword">private</strong> String encoding;
|
| <a name="200" href="#200">200</a>
|
| <a name="201" href="#201">201</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> * Creates a new RuntimeInstance object.</em>
|
| <a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="204" href="#204">204</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/runtime/RuntimeInstance.html">RuntimeInstance</a>()
|
| <a name="205" href="#205">205</a> {
|
| <a name="206" href="#206">206</a> <em class="jxr_comment">/*</em>
|
| <a name="207" href="#207">207</a> <em class="jxr_comment"> * create a VM factory, introspector, and application attributes</em>
|
| <a name="208" href="#208">208</a> <em class="jxr_comment"> */</em>
|
| <a name="209" href="#209">209</a> vmFactory = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/runtime/VelocimacroFactory.html">VelocimacroFactory</a>( <strong class="jxr_keyword">this</strong> );
|
| <a name="210" href="#210">210</a>
|
| <a name="211" href="#211">211</a> <em class="jxr_comment">/*</em>
|
| <a name="212" href="#212">212</a> <em class="jxr_comment"> * make a new introspector and initialize it</em>
|
| <a name="213" href="#213">213</a> <em class="jxr_comment"> */</em>
|
| <a name="214" href="#214">214</a> introspector = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/util/introspection/Introspector.html">Introspector</a>(getLog());
|
| <a name="215" href="#215">215</a>
|
| <a name="216" href="#216">216</a> <em class="jxr_comment">/*</em>
|
| <a name="217" href="#217">217</a> <em class="jxr_comment"> * and a store for the application attributes</em>
|
| <a name="218" href="#218">218</a> <em class="jxr_comment"> */</em>
|
| <a name="219" href="#219">219</a> applicationAttributes = <strong class="jxr_keyword">new</strong> HashMap();
|
| <a name="220" href="#220">220</a> }
|
| <a name="221" href="#221">221</a>
|
| <a name="222" href="#222">222</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="223" href="#223">223</a> <em class="jxr_javadoccomment"> * This is the primary initialization method in the Velocity</em>
|
| <a name="224" href="#224">224</a> <em class="jxr_javadoccomment"> * Runtime. The systems that are setup/initialized here are</em>
|
| <a name="225" href="#225">225</a> <em class="jxr_javadoccomment"> * as follows:</em>
|
| <a name="226" href="#226">226</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="227" href="#227">227</a> <em class="jxr_javadoccomment"> * <ul></em>
|
| <a name="228" href="#228">228</a> <em class="jxr_javadoccomment"> * <li>Logging System</li></em>
|
| <a name="229" href="#229">229</a> <em class="jxr_javadoccomment"> * <li>ResourceManager</li></em>
|
| <a name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * <li>EventHandler</li></em>
|
| <a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * <li>Parser Pool</li></em>
|
| <a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * <li>Global Cache</li></em>
|
| <a name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * <li>Static Content Include System</li></em>
|
| <a name="234" href="#234">234</a> <em class="jxr_javadoccomment"> * <li>Velocimacro System</li></em>
|
| <a name="235" href="#235">235</a> <em class="jxr_javadoccomment"> * </ul></em>
|
| <a name="236" href="#236">236</a> <em class="jxr_javadoccomment"> * @throws Exception When an error occured during initialization.</em>
|
| <a name="237" href="#237">237</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="238" href="#238">238</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> init()
|
| <a name="239" href="#239">239</a> <strong class="jxr_keyword">throws</strong> Exception
|
| <a name="240" href="#240">240</a> {
|
| <a name="241" href="#241">241</a> <strong class="jxr_keyword">if</strong> (!initialized && !initializing)
|
| <a name="242" href="#242">242</a> {
|
| <a name="243" href="#243">243</a> initializing = <strong class="jxr_keyword">true</strong>;
|
| <a name="244" href="#244">244</a>
|
| <a name="245" href="#245">245</a> log.trace(<span class="jxr_string">"*******************************************************************"</span>);
|
| <a name="246" href="#246">246</a> log.debug(<span class="jxr_string">"Starting Apache Velocity v@build.version@ (compiled: @build.time@)"</span>);
|
| <a name="247" href="#247">247</a> log.trace(<span class="jxr_string">"RuntimeInstance initializing."</span>);
|
| <a name="248" href="#248">248</a>
|
| <a name="249" href="#249">249</a> initializeProperties();
|
| <a name="250" href="#250">250</a> initializeLog();
|
| <a name="251" href="#251">251</a> initializeResourceManager();
|
| <a name="252" href="#252">252</a> initializeDirectives();
|
| <a name="253" href="#253">253</a> initializeEventHandlers();
|
| <a name="254" href="#254">254</a> initializeParserPool();
|
| <a name="255" href="#255">255</a>
|
| <a name="256" href="#256">256</a> initializeIntrospection();
|
| <a name="257" href="#257">257</a> <em class="jxr_comment">/*</em>
|
| <a name="258" href="#258">258</a> <em class="jxr_comment"> * initialize the VM Factory. It will use the properties</em>
|
| <a name="259" href="#259">259</a> <em class="jxr_comment"> * accessable from Runtime, so keep this here at the end.</em>
|
| <a name="260" href="#260">260</a> <em class="jxr_comment"> */</em>
|
| <a name="261" href="#261">261</a> vmFactory.initVelocimacro();
|
| <a name="262" href="#262">262</a>
|
| <a name="263" href="#263">263</a> log.trace(<span class="jxr_string">"RuntimeInstance successfully initialized."</span>);
|
| <a name="264" href="#264">264</a>
|
| <a name="265" href="#265">265</a> initialized = <strong class="jxr_keyword">true</strong>;
|
| <a name="266" href="#266">266</a> initializing = false;
|
| <a name="267" href="#267">267</a> }
|
| <a name="268" href="#268">268</a> }
|
| <a name="269" href="#269">269</a>
|
| <a name="270" href="#270">270</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="271" href="#271">271</a> <em class="jxr_javadoccomment"> * Returns true if the RuntimeInstance has been successfully initialized.</em>
|
| <a name="272" href="#272">272</a> <em class="jxr_javadoccomment"> * @return True if the RuntimeInstance has been successfully initialized.</em>
|
| <a name="273" href="#273">273</a> <em class="jxr_javadoccomment"> * @since 1.5</em>
|
| <a name="274" href="#274">274</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="275" href="#275">275</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isInitialized()
|
| <a name="276" href="#276">276</a> {
|
| <a name="277" href="#277">277</a> <strong class="jxr_keyword">return</strong> initialized;
|
| <a name="278" href="#278">278</a> }
|
| <a name="279" href="#279">279</a>
|
| <a name="280" href="#280">280</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="281" href="#281">281</a> <em class="jxr_javadoccomment"> * Init or die! (with some log help, of course)</em>
|
| <a name="282" href="#282">282</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="283" href="#283">283</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> requireInitialization()
|
| <a name="284" href="#284">284</a> {
|
| <a name="285" href="#285">285</a> <strong class="jxr_keyword">if</strong> (!initialized && !initializing)
|
| <a name="286" href="#286">286</a> {
|
| <a name="287" href="#287">287</a> log.debug(<span class="jxr_string">"Velocity was not initialized! Calling init()..."</span>);
|
| <a name="288" href="#288">288</a> <strong class="jxr_keyword">try</strong>
|
| <a name="289" href="#289">289</a> {
|
| <a name="290" href="#290">290</a> init();
|
| <a name="291" href="#291">291</a> }
|
| <a name="292" href="#292">292</a> <strong class="jxr_keyword">catch</strong> (Exception e)
|
| <a name="293" href="#293">293</a> {
|
| <a name="294" href="#294">294</a> getLog().error(<span class="jxr_string">"Could not auto-initialize Velocity"</span>, e);
|
| <a name="295" href="#295">295</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException(<span class="jxr_string">"Velocity could not be initialized!"</span>, e);
|
| <a name="296" href="#296">296</a> }
|
| <a name="297" href="#297">297</a> }
|
| <a name="298" href="#298">298</a> }
|
| <a name="299" href="#299">299</a>
|
| <a name="300" href="#300">300</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="301" href="#301">301</a> <em class="jxr_javadoccomment"> * Gets the classname for the Uberspect introspection package and</em>
|
| <a name="302" href="#302">302</a> <em class="jxr_javadoccomment"> * instantiates an instance.</em>
|
| <a name="303" href="#303">303</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="304" href="#304">304</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> initializeIntrospection()
|
| <a name="305" href="#305">305</a> <strong class="jxr_keyword">throws</strong> Exception
|
| <a name="306" href="#306">306</a> {
|
| <a name="307" href="#307">307</a> String[] uberspectors = configuration.getStringArray(RuntimeConstants.UBERSPECT_CLASSNAME);
|
| <a name="308" href="#308">308</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i=0; i <uberspectors.length;i++)
|
| <a name="309" href="#309">309</a> {
|
| <a name="310" href="#310">310</a> String rm = uberspectors[i];
|
| <a name="311" href="#311">311</a> Object o = <strong class="jxr_keyword">null</strong>;
|
| <a name="312" href="#312">312</a>
|
| <a name="313" href="#313">313</a> <strong class="jxr_keyword">try</strong>
|
| <a name="314" href="#314">314</a> {
|
| <a name="315" href="#315">315</a> o = ClassUtils.getNewInstance( rm );
|
| <a name="316" href="#316">316</a> }
|
| <a name="317" href="#317">317</a> <strong class="jxr_keyword">catch</strong> (ClassNotFoundException cnfe)
|
| <a name="318" href="#318">318</a> {
|
| <a name="319" href="#319">319</a> String err = <span class="jxr_string">"The specified class for Uberspect ("</span> + rm
|
| <a name="320" href="#320">320</a> + <span class="jxr_string">") does not exist or is not accessible to the current classloader."</span>;
|
| <a name="321" href="#321">321</a> log.error(err);
|
| <a name="322" href="#322">322</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Exception(err);
|
| <a name="323" href="#323">323</a> }
|
| <a name="324" href="#324">324</a>
|
| <a name="325" href="#325">325</a> <strong class="jxr_keyword">if</strong> (!(o instanceof Uberspect))
|
| <a name="326" href="#326">326</a> {
|
| <a name="327" href="#327">327</a> String err = <span class="jxr_string">"The specified class for Uberspect ("</span>
|
| <a name="328" href="#328">328</a> + rm + <span class="jxr_string">") does not implement "</span> + Uberspect.<strong class="jxr_keyword">class</strong>.getName()
|
| <a name="329" href="#329">329</a> + <span class="jxr_string">"; Velocity is not initialized correctly."</span>;
|
| <a name="330" href="#330">330</a>
|
| <a name="331" href="#331">331</a> log.error(err);
|
| <a name="332" href="#332">332</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Exception(err);
|
| <a name="333" href="#333">333</a> }
|
| <a name="334" href="#334">334</a>
|
| <a name="335" href="#335">335</a> <a href="../../../../org/apache/velocity/util/introspection/Uberspect.html">Uberspect</a> u = (Uberspect)o;
|
| <a name="336" href="#336">336</a>
|
| <a name="337" href="#337">337</a> <strong class="jxr_keyword">if</strong> (u instanceof UberspectLoggable)
|
| <a name="338" href="#338">338</a> {
|
| <a name="339" href="#339">339</a> ((<a href="../../../../org/apache/velocity/util/introspection/UberspectLoggable.html">UberspectLoggable</a>)u).setLog(getLog());
|
| <a name="340" href="#340">340</a> }
|
| <a name="341" href="#341">341</a>
|
| <a name="342" href="#342">342</a> <strong class="jxr_keyword">if</strong> (u instanceof RuntimeServicesAware)
|
| <a name="343" href="#343">343</a> {
|
| <a name="344" href="#344">344</a> ((<a href="../../../../org/apache/velocity/util/RuntimeServicesAware.html">RuntimeServicesAware</a>)u).setRuntimeServices(<strong class="jxr_keyword">this</strong>);
|
| <a name="345" href="#345">345</a> }
|
| <a name="346" href="#346">346</a>
|
| <a name="347" href="#347">347</a> <strong class="jxr_keyword">if</strong> (uberSpect == <strong class="jxr_keyword">null</strong>)
|
| <a name="348" href="#348">348</a> {
|
| <a name="349" href="#349">349</a> uberSpect = u;
|
| <a name="350" href="#350">350</a> }
|
| <a name="351" href="#351">351</a> <strong class="jxr_keyword">else</strong>
|
| <a name="352" href="#352">352</a> {
|
| <a name="353" href="#353">353</a> <strong class="jxr_keyword">if</strong> (u instanceof ChainableUberspector)
|
| <a name="354" href="#354">354</a> {
|
| <a name="355" href="#355">355</a> ((<a href="../../../../org/apache/velocity/util/introspection/ChainableUberspector.html">ChainableUberspector</a>)u).wrap(uberSpect);
|
| <a name="356" href="#356">356</a> uberSpect = u;
|
| <a name="357" href="#357">357</a> }
|
| <a name="358" href="#358">358</a> <strong class="jxr_keyword">else</strong>
|
| <a name="359" href="#359">359</a> {
|
| <a name="360" href="#360">360</a> uberSpect = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/util/introspection/LinkingUberspector.html">LinkingUberspector</a>(uberSpect,u);
|
| <a name="361" href="#361">361</a> }
|
| <a name="362" href="#362">362</a> }
|
| <a name="363" href="#363">363</a> }
|
| <a name="364" href="#364">364</a>
|
| <a name="365" href="#365">365</a> <strong class="jxr_keyword">if</strong>(uberSpect != <strong class="jxr_keyword">null</strong>)
|
| <a name="366" href="#366">366</a> {
|
| <a name="367" href="#367">367</a> uberSpect.init();
|
| <a name="368" href="#368">368</a> }
|
| <a name="369" href="#369">369</a> <strong class="jxr_keyword">else</strong>
|
| <a name="370" href="#370">370</a> {
|
| <a name="371" href="#371">371</a> <em class="jxr_comment">/*</em>
|
| <a name="372" href="#372">372</a> <em class="jxr_comment"> * someone screwed up. Lets not fool around...</em>
|
| <a name="373" href="#373">373</a> <em class="jxr_comment"> */</em>
|
| <a name="374" href="#374">374</a>
|
| <a name="375" href="#375">375</a> String err = <span class="jxr_string">"It appears that no class was specified as the"</span>
|
| <a name="376" href="#376">376</a> + <span class="jxr_string">" Uberspect. Please ensure that all configuration"</span>
|
| <a name="377" href="#377">377</a> + <span class="jxr_string">" information is correct."</span>;
|
| <a name="378" href="#378">378</a>
|
| <a name="379" href="#379">379</a> log.error(err);
|
| <a name="380" href="#380">380</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Exception(err);
|
| <a name="381" href="#381">381</a> }
|
| <a name="382" href="#382">382</a> }
|
| <a name="383" href="#383">383</a>
|
| <a name="384" href="#384">384</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="385" href="#385">385</a> <em class="jxr_javadoccomment"> * Initializes the Velocity Runtime with properties file.</em>
|
| <a name="386" href="#386">386</a> <em class="jxr_javadoccomment"> * The properties file may be in the file system proper,</em>
|
| <a name="387" href="#387">387</a> <em class="jxr_javadoccomment"> * or the properties file may be in the classpath.</em>
|
| <a name="388" href="#388">388</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="389" href="#389">389</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> setDefaultProperties()
|
| <a name="390" href="#390">390</a> {
|
| <a name="391" href="#391">391</a> InputStream inputStream = <strong class="jxr_keyword">null</strong>;
|
| <a name="392" href="#392">392</a> <strong class="jxr_keyword">try</strong>
|
| <a name="393" href="#393">393</a> {
|
| <a name="394" href="#394">394</a> inputStream = getClass()
|
| <a name="395" href="#395">395</a> .getResourceAsStream('/' + DEFAULT_RUNTIME_PROPERTIES);
|
| <a name="396" href="#396">396</a>
|
| <a name="397" href="#397">397</a> configuration.load( inputStream );
|
| <a name="398" href="#398">398</a>
|
| <a name="399" href="#399">399</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled())
|
| <a name="400" href="#400">400</a> {
|
| <a name="401" href="#401">401</a> log.debug(<span class="jxr_string">"Default Properties File: "</span> +
|
| <a name="402" href="#402">402</a> <strong class="jxr_keyword">new</strong> File(DEFAULT_RUNTIME_PROPERTIES).getPath());
|
| <a name="403" href="#403">403</a> }
|
| <a name="404" href="#404">404</a>
|
| <a name="405" href="#405">405</a>
|
| <a name="406" href="#406">406</a> }
|
| <a name="407" href="#407">407</a> <strong class="jxr_keyword">catch</strong> (IOException ioe)
|
| <a name="408" href="#408">408</a> {
|
| <a name="409" href="#409">409</a> String msg = <span class="jxr_string">"Cannot get Velocity Runtime default properties!"</span>;
|
| <a name="410" href="#410">410</a> log.error(msg, ioe);
|
| <a name="411" href="#411">411</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException(msg, ioe);
|
| <a name="412" href="#412">412</a> }
|
| <a name="413" href="#413">413</a> <strong class="jxr_keyword">finally</strong>
|
| <a name="414" href="#414">414</a> {
|
| <a name="415" href="#415">415</a> <strong class="jxr_keyword">try</strong>
|
| <a name="416" href="#416">416</a> {
|
| <a name="417" href="#417">417</a> <strong class="jxr_keyword">if</strong> (inputStream != <strong class="jxr_keyword">null</strong>)
|
| <a name="418" href="#418">418</a> {
|
| <a name="419" href="#419">419</a> inputStream.close();
|
| <a name="420" href="#420">420</a> }
|
| <a name="421" href="#421">421</a> }
|
| <a name="422" href="#422">422</a> <strong class="jxr_keyword">catch</strong> (IOException ioe)
|
| <a name="423" href="#423">423</a> {
|
| <a name="424" href="#424">424</a> String msg = <span class="jxr_string">"Cannot close Velocity Runtime default properties!"</span>;
|
| <a name="425" href="#425">425</a> log.error(msg, ioe);
|
| <a name="426" href="#426">426</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException(msg, ioe);
|
| <a name="427" href="#427">427</a> }
|
| <a name="428" href="#428">428</a> }
|
| <a name="429" href="#429">429</a> }
|
| <a name="430" href="#430">430</a>
|
| <a name="431" href="#431">431</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="432" href="#432">432</a> <em class="jxr_javadoccomment"> * Allows an external system to set a property in</em>
|
| <a name="433" href="#433">433</a> <em class="jxr_javadoccomment"> * the Velocity Runtime.</em>
|
| <a name="434" href="#434">434</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="435" href="#435">435</a> <em class="jxr_javadoccomment"> * @param key property key</em>
|
| <a name="436" href="#436">436</a> <em class="jxr_javadoccomment"> * @param value property value</em>
|
| <a name="437" href="#437">437</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="438" href="#438">438</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setProperty(String key, Object value)
|
| <a name="439" href="#439">439</a> {
|
| <a name="440" href="#440">440</a> <strong class="jxr_keyword">if</strong> (overridingProperties == <strong class="jxr_keyword">null</strong>)
|
| <a name="441" href="#441">441</a> {
|
| <a name="442" href="#442">442</a> overridingProperties = <strong class="jxr_keyword">new</strong> ExtendedProperties();
|
| <a name="443" href="#443">443</a> }
|
| <a name="444" href="#444">444</a>
|
| <a name="445" href="#445">445</a> overridingProperties.setProperty(key, value);
|
| <a name="446" href="#446">446</a> }
|
| <a name="447" href="#447">447</a>
|
| <a name="448" href="#448">448</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="449" href="#449">449</a> <em class="jxr_javadoccomment"> * Allow an external system to set an ExtendedProperties</em>
|
| <a name="450" href="#450">450</a> <em class="jxr_javadoccomment"> * object to use. This is useful where the external</em>
|
| <a name="451" href="#451">451</a> <em class="jxr_javadoccomment"> * system also uses the ExtendedProperties class and</em>
|
| <a name="452" href="#452">452</a> <em class="jxr_javadoccomment"> * the velocity configuration is a subset of</em>
|
| <a name="453" href="#453">453</a> <em class="jxr_javadoccomment"> * parent application's configuration. This is</em>
|
| <a name="454" href="#454">454</a> <em class="jxr_javadoccomment"> * the case with Turbine.</em>
|
| <a name="455" href="#455">455</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="456" href="#456">456</a> <em class="jxr_javadoccomment"> * @param configuration</em>
|
| <a name="457" href="#457">457</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="458" href="#458">458</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setConfiguration( ExtendedProperties configuration)
|
| <a name="459" href="#459">459</a> {
|
| <a name="460" href="#460">460</a> <strong class="jxr_keyword">if</strong> (overridingProperties == <strong class="jxr_keyword">null</strong>)
|
| <a name="461" href="#461">461</a> {
|
| <a name="462" href="#462">462</a> overridingProperties = configuration;
|
| <a name="463" href="#463">463</a> }
|
| <a name="464" href="#464">464</a> <strong class="jxr_keyword">else</strong>
|
| <a name="465" href="#465">465</a> {
|
| <a name="466" href="#466">466</a> <em class="jxr_comment">// Avoid possible ConcurrentModificationException</em>
|
| <a name="467" href="#467">467</a> <strong class="jxr_keyword">if</strong> (overridingProperties != configuration)
|
| <a name="468" href="#468">468</a> {
|
| <a name="469" href="#469">469</a> overridingProperties.combine(configuration);
|
| <a name="470" href="#470">470</a> }
|
| <a name="471" href="#471">471</a> }
|
| <a name="472" href="#472">472</a> }
|
| <a name="473" href="#473">473</a>
|
| <a name="474" href="#474">474</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="475" href="#475">475</a> <em class="jxr_javadoccomment"> * Add a property to the configuration. If it already</em>
|
| <a name="476" href="#476">476</a> <em class="jxr_javadoccomment"> * exists then the value stated here will be added</em>
|
| <a name="477" href="#477">477</a> <em class="jxr_javadoccomment"> * to the configuration entry. For example, if</em>
|
| <a name="478" href="#478">478</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="479" href="#479">479</a> <em class="jxr_javadoccomment"> * resource.loader = file</em>
|
| <a name="480" href="#480">480</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="481" href="#481">481</a> <em class="jxr_javadoccomment"> * is already present in the configuration and you</em>
|
| <a name="482" href="#482">482</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="483" href="#483">483</a> <em class="jxr_javadoccomment"> * addProperty("resource.loader", "classpath")</em>
|
| <a name="484" href="#484">484</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="485" href="#485">485</a> <em class="jxr_javadoccomment"> * Then you will end up with a Vector like the</em>
|
| <a name="486" href="#486">486</a> <em class="jxr_javadoccomment"> * following:</em>
|
| <a name="487" href="#487">487</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="488" href="#488">488</a> <em class="jxr_javadoccomment"> * ["file", "classpath"]</em>
|
| <a name="489" href="#489">489</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="490" href="#490">490</a> <em class="jxr_javadoccomment"> * @param key</em>
|
| <a name="491" href="#491">491</a> <em class="jxr_javadoccomment"> * @param value</em>
|
| <a name="492" href="#492">492</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="493" href="#493">493</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addProperty(String key, Object value)
|
| <a name="494" href="#494">494</a> {
|
| <a name="495" href="#495">495</a> <strong class="jxr_keyword">if</strong> (overridingProperties == <strong class="jxr_keyword">null</strong>)
|
| <a name="496" href="#496">496</a> {
|
| <a name="497" href="#497">497</a> overridingProperties = <strong class="jxr_keyword">new</strong> ExtendedProperties();
|
| <a name="498" href="#498">498</a> }
|
| <a name="499" href="#499">499</a>
|
| <a name="500" href="#500">500</a> overridingProperties.addProperty(key, value);
|
| <a name="501" href="#501">501</a> }
|
| <a name="502" href="#502">502</a>
|
| <a name="503" href="#503">503</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="504" href="#504">504</a> <em class="jxr_javadoccomment"> * Clear the values pertaining to a particular</em>
|
| <a name="505" href="#505">505</a> <em class="jxr_javadoccomment"> * property.</em>
|
| <a name="506" href="#506">506</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="507" href="#507">507</a> <em class="jxr_javadoccomment"> * @param key of property to clear</em>
|
| <a name="508" href="#508">508</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="509" href="#509">509</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> clearProperty(String key)
|
| <a name="510" href="#510">510</a> {
|
| <a name="511" href="#511">511</a> <strong class="jxr_keyword">if</strong> (overridingProperties != <strong class="jxr_keyword">null</strong>)
|
| <a name="512" href="#512">512</a> {
|
| <a name="513" href="#513">513</a> overridingProperties.clearProperty(key);
|
| <a name="514" href="#514">514</a> }
|
| <a name="515" href="#515">515</a> }
|
| <a name="516" href="#516">516</a>
|
| <a name="517" href="#517">517</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="518" href="#518">518</a> <em class="jxr_javadoccomment"> * Allows an external caller to get a property. The calling</em>
|
| <a name="519" href="#519">519</a> <em class="jxr_javadoccomment"> * routine is required to know the type, as this routine</em>
|
| <a name="520" href="#520">520</a> <em class="jxr_javadoccomment"> * will return an Object, as that is what properties can be.</em>
|
| <a name="521" href="#521">521</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="522" href="#522">522</a> <em class="jxr_javadoccomment"> * @param key property to return</em>
|
| <a name="523" href="#523">523</a> <em class="jxr_javadoccomment"> * @return Value of the property or null if it does not exist.</em>
|
| <a name="524" href="#524">524</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="525" href="#525">525</a> <strong class="jxr_keyword">public</strong> Object getProperty(String key)
|
| <a name="526" href="#526">526</a> {
|
| <a name="527" href="#527">527</a> Object o = <strong class="jxr_keyword">null</strong>;
|
| <a name="528" href="#528">528</a>
|
| <a name="529" href="#529">529</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="530" href="#530">530</a> <em class="jxr_javadoccomment"> * Before initialization, check the user-entered properties first.</em>
|
| <a name="531" href="#531">531</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="532" href="#532">532</a> <strong class="jxr_keyword">if</strong> (!initialized && !initializing && overridingProperties != <strong class="jxr_keyword">null</strong>)
|
| <a name="533" href="#533">533</a> {
|
| <a name="534" href="#534">534</a> o = overridingProperties.get(key);
|
| <a name="535" href="#535">535</a> }
|
| <a name="536" href="#536">536</a>
|
| <a name="537" href="#537">537</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="538" href="#538">538</a> <em class="jxr_javadoccomment"> * After initialization, configuration will hold all properties.</em>
|
| <a name="539" href="#539">539</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="540" href="#540">540</a> <strong class="jxr_keyword">if</strong> (o == <strong class="jxr_keyword">null</strong>)
|
| <a name="541" href="#541">541</a> {
|
| <a name="542" href="#542">542</a> o = configuration.getProperty(key);
|
| <a name="543" href="#543">543</a> }
|
| <a name="544" href="#544">544</a> <strong class="jxr_keyword">if</strong> (o instanceof String)
|
| <a name="545" href="#545">545</a> {
|
| <a name="546" href="#546">546</a> <strong class="jxr_keyword">return</strong> StringUtils.nullTrim((String) o);
|
| <a name="547" href="#547">547</a> }
|
| <a name="548" href="#548">548</a> <strong class="jxr_keyword">else</strong>
|
| <a name="549" href="#549">549</a> {
|
| <a name="550" href="#550">550</a> <strong class="jxr_keyword">return</strong> o;
|
| <a name="551" href="#551">551</a> }
|
| <a name="552" href="#552">552</a> }
|
| <a name="553" href="#553">553</a>
|
| <a name="554" href="#554">554</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="555" href="#555">555</a> <em class="jxr_javadoccomment"> * Initialize Velocity properties, if the default</em>
|
| <a name="556" href="#556">556</a> <em class="jxr_javadoccomment"> * properties have not been laid down first then</em>
|
| <a name="557" href="#557">557</a> <em class="jxr_javadoccomment"> * do so. Then proceed to process any overriding</em>
|
| <a name="558" href="#558">558</a> <em class="jxr_javadoccomment"> * properties. Laying down the default properties</em>
|
| <a name="559" href="#559">559</a> <em class="jxr_javadoccomment"> * gives a much greater chance of having a</em>
|
| <a name="560" href="#560">560</a> <em class="jxr_javadoccomment"> * working system.</em>
|
| <a name="561" href="#561">561</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="562" href="#562">562</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> initializeProperties()
|
| <a name="563" href="#563">563</a> {
|
| <a name="564" href="#564">564</a> <em class="jxr_comment">/*</em>
|
| <a name="565" href="#565">565</a> <em class="jxr_comment"> * Always lay down the default properties first as</em>
|
| <a name="566" href="#566">566</a> <em class="jxr_comment"> * to provide a solid base.</em>
|
| <a name="567" href="#567">567</a> <em class="jxr_comment"> */</em>
|
| <a name="568" href="#568">568</a> <strong class="jxr_keyword">if</strong> (configuration.isInitialized() == false)
|
| <a name="569" href="#569">569</a> {
|
| <a name="570" href="#570">570</a> setDefaultProperties();
|
| <a name="571" href="#571">571</a> }
|
| <a name="572" href="#572">572</a>
|
| <a name="573" href="#573">573</a> <strong class="jxr_keyword">if</strong>( overridingProperties != <strong class="jxr_keyword">null</strong>)
|
| <a name="574" href="#574">574</a> {
|
| <a name="575" href="#575">575</a> configuration.combine(overridingProperties);
|
| <a name="576" href="#576">576</a> }
|
| <a name="577" href="#577">577</a> }
|
| <a name="578" href="#578">578</a>
|
| <a name="579" href="#579">579</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="580" href="#580">580</a> <em class="jxr_javadoccomment"> * Initialize the Velocity Runtime with a Properties</em>
|
| <a name="581" href="#581">581</a> <em class="jxr_javadoccomment"> * object.</em>
|
| <a name="582" href="#582">582</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="583" href="#583">583</a> <em class="jxr_javadoccomment"> * @param p</em>
|
| <a name="584" href="#584">584</a> <em class="jxr_javadoccomment"> * @throws Exception When an error occurs during initialization.</em>
|
| <a name="585" href="#585">585</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="586" href="#586">586</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init(Properties p) <strong class="jxr_keyword">throws</strong> Exception
|
| <a name="587" href="#587">587</a> {
|
| <a name="588" href="#588">588</a> setProperties(ExtendedProperties.convertProperties(p));
|
| <a name="589" href="#589">589</a> init();
|
| <a name="590" href="#590">590</a> }
|
| <a name="591" href="#591">591</a>
|
| <a name="592" href="#592">592</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> setProperties(ExtendedProperties p)
|
| <a name="593" href="#593">593</a> {
|
| <a name="594" href="#594">594</a> <strong class="jxr_keyword">if</strong> (overridingProperties == <strong class="jxr_keyword">null</strong>)
|
| <a name="595" href="#595">595</a> {
|
| <a name="596" href="#596">596</a> overridingProperties = p;
|
| <a name="597" href="#597">597</a> }
|
| <a name="598" href="#598">598</a> <strong class="jxr_keyword">else</strong>
|
| <a name="599" href="#599">599</a> {
|
| <a name="600" href="#600">600</a> overridingProperties.combine(p);
|
| <a name="601" href="#601">601</a> }
|
| <a name="602" href="#602">602</a> }
|
| <a name="603" href="#603">603</a>
|
| <a name="604" href="#604">604</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="605" href="#605">605</a> <em class="jxr_javadoccomment"> * Initialize the Velocity Runtime with the name of</em>
|
| <a name="606" href="#606">606</a> <em class="jxr_javadoccomment"> * ExtendedProperties object.</em>
|
| <a name="607" href="#607">607</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="608" href="#608">608</a> <em class="jxr_javadoccomment"> * @param configurationFile</em>
|
| <a name="609" href="#609">609</a> <em class="jxr_javadoccomment"> * @throws Exception When an error occurs during initialization.</em>
|
| <a name="610" href="#610">610</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="611" href="#611">611</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init(String configurationFile)
|
| <a name="612" href="#612">612</a> <strong class="jxr_keyword">throws</strong> Exception
|
| <a name="613" href="#613">613</a> {
|
| <a name="614" href="#614">614</a> setProperties(<strong class="jxr_keyword">new</strong> ExtendedProperties(configurationFile));
|
| <a name="615" href="#615">615</a> init();
|
| <a name="616" href="#616">616</a> }
|
| <a name="617" href="#617">617</a>
|
| <a name="618" href="#618">618</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> initializeResourceManager()
|
| <a name="619" href="#619">619</a> <strong class="jxr_keyword">throws</strong> Exception
|
| <a name="620" href="#620">620</a> {
|
| <a name="621" href="#621">621</a> <em class="jxr_comment">/*</em>
|
| <a name="622" href="#622">622</a> <em class="jxr_comment"> * Which resource manager?</em>
|
| <a name="623" href="#623">623</a> <em class="jxr_comment"> */</em>
|
| <a name="624" href="#624">624</a>
|
| <a name="625" href="#625">625</a> String rm = getString(RuntimeConstants.RESOURCE_MANAGER_CLASS);
|
| <a name="626" href="#626">626</a>
|
| <a name="627" href="#627">627</a> <strong class="jxr_keyword">if</strong> (rm != <strong class="jxr_keyword">null</strong> && rm.length() > 0)
|
| <a name="628" href="#628">628</a> {
|
| <a name="629" href="#629">629</a> <em class="jxr_comment">/*</em>
|
| <a name="630" href="#630">630</a> <em class="jxr_comment"> * if something was specified, then make one.</em>
|
| <a name="631" href="#631">631</a> <em class="jxr_comment"> * if that isn't a ResourceManager, consider</em>
|
| <a name="632" href="#632">632</a> <em class="jxr_comment"> * this a huge error and throw</em>
|
| <a name="633" href="#633">633</a> <em class="jxr_comment"> */</em>
|
| <a name="634" href="#634">634</a>
|
| <a name="635" href="#635">635</a> Object o = <strong class="jxr_keyword">null</strong>;
|
| <a name="636" href="#636">636</a>
|
| <a name="637" href="#637">637</a> <strong class="jxr_keyword">try</strong>
|
| <a name="638" href="#638">638</a> {
|
| <a name="639" href="#639">639</a> o = ClassUtils.getNewInstance( rm );
|
| <a name="640" href="#640">640</a> }
|
| <a name="641" href="#641">641</a> <strong class="jxr_keyword">catch</strong> (ClassNotFoundException cnfe )
|
| <a name="642" href="#642">642</a> {
|
| <a name="643" href="#643">643</a> String err = <span class="jxr_string">"The specified class for ResourceManager ("</span> + rm
|
| <a name="644" href="#644">644</a> + <span class="jxr_string">") does not exist or is not accessible to the current classloader."</span>;
|
| <a name="645" href="#645">645</a> log.error(err);
|
| <a name="646" href="#646">646</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Exception(err);
|
| <a name="647" href="#647">647</a> }
|
| <a name="648" href="#648">648</a>
|
| <a name="649" href="#649">649</a> <strong class="jxr_keyword">if</strong> (!(o instanceof ResourceManager))
|
| <a name="650" href="#650">650</a> {
|
| <a name="651" href="#651">651</a> String err = <span class="jxr_string">"The specified class for ResourceManager ("</span> + rm
|
| <a name="652" href="#652">652</a> + <span class="jxr_string">") does not implement "</span> + ResourceManager.<strong class="jxr_keyword">class</strong>.getName()
|
| <a name="653" href="#653">653</a> + <span class="jxr_string">"; Velocity is not initialized correctly."</span>;
|
| <a name="654" href="#654">654</a>
|
| <a name="655" href="#655">655</a> log.error(err);
|
| <a name="656" href="#656">656</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Exception(err);
|
| <a name="657" href="#657">657</a> }
|
| <a name="658" href="#658">658</a>
|
| <a name="659" href="#659">659</a> resourceManager = (ResourceManager) o;
|
| <a name="660" href="#660">660</a>
|
| <a name="661" href="#661">661</a> resourceManager.initialize(<strong class="jxr_keyword">this</strong>);
|
| <a name="662" href="#662">662</a> }
|
| <a name="663" href="#663">663</a> <strong class="jxr_keyword">else</strong>
|
| <a name="664" href="#664">664</a> {
|
| <a name="665" href="#665">665</a> <em class="jxr_comment">/*</em>
|
| <a name="666" href="#666">666</a> <em class="jxr_comment"> * someone screwed up. Lets not fool around...</em>
|
| <a name="667" href="#667">667</a> <em class="jxr_comment"> */</em>
|
| <a name="668" href="#668">668</a>
|
| <a name="669" href="#669">669</a> String err = <span class="jxr_string">"It appears that no class was specified as the"</span>
|
| <a name="670" href="#670">670</a> + <span class="jxr_string">" ResourceManager. Please ensure that all configuration"</span>
|
| <a name="671" href="#671">671</a> + <span class="jxr_string">" information is correct."</span>;
|
| <a name="672" href="#672">672</a>
|
| <a name="673" href="#673">673</a> log.error(err);
|
| <a name="674" href="#674">674</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Exception( err );
|
| <a name="675" href="#675">675</a> }
|
| <a name="676" href="#676">676</a> }
|
| <a name="677" href="#677">677</a>
|
| <a name="678" href="#678">678</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> initializeEventHandlers()
|
| <a name="679" href="#679">679</a> <strong class="jxr_keyword">throws</strong> Exception
|
| <a name="680" href="#680">680</a> {
|
| <a name="681" href="#681">681</a>
|
| <a name="682" href="#682">682</a> eventCartridge = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/app/event/EventCartridge.html">EventCartridge</a>();
|
| <a name="683" href="#683">683</a>
|
| <a name="684" href="#684">684</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="685" href="#685">685</a> <em class="jxr_javadoccomment"> * For each type of event handler, get the class name, instantiate it, and store it.</em>
|
| <a name="686" href="#686">686</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="687" href="#687">687</a>
|
| <a name="688" href="#688">688</a> String[] referenceinsertion = configuration.getStringArray(RuntimeConstants.EVENTHANDLER_REFERENCEINSERTION);
|
| <a name="689" href="#689">689</a> <strong class="jxr_keyword">if</strong> ( referenceinsertion != <strong class="jxr_keyword">null</strong> )
|
| <a name="690" href="#690">690</a> {
|
| <a name="691" href="#691">691</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> i=0; i < referenceinsertion.length; i++ )
|
| <a name="692" href="#692">692</a> {
|
| <a name="693" href="#693">693</a> <a href="../../../../org/apache/velocity/app/event/EventHandler.html">EventHandler</a> ev = initializeSpecificEventHandler(referenceinsertion[i],RuntimeConstants.EVENTHANDLER_REFERENCEINSERTION,ReferenceInsertionEventHandler.<strong class="jxr_keyword">class</strong>);
|
| <a name="694" href="#694">694</a> <strong class="jxr_keyword">if</strong> (ev != <strong class="jxr_keyword">null</strong>)
|
| <a name="695" href="#695">695</a> eventCartridge.addReferenceInsertionEventHandler((ReferenceInsertionEventHandler) ev);
|
| <a name="696" href="#696">696</a> }
|
| <a name="697" href="#697">697</a> }
|
| <a name="698" href="#698">698</a>
|
| <a name="699" href="#699">699</a> String[] nullset = configuration.getStringArray(RuntimeConstants.EVENTHANDLER_NULLSET);
|
| <a name="700" href="#700">700</a> <strong class="jxr_keyword">if</strong> ( nullset != <strong class="jxr_keyword">null</strong> )
|
| <a name="701" href="#701">701</a> {
|
| <a name="702" href="#702">702</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> i=0; i < nullset.length; i++ )
|
| <a name="703" href="#703">703</a> {
|
| <a name="704" href="#704">704</a> <a href="../../../../org/apache/velocity/app/event/EventHandler.html">EventHandler</a> ev = initializeSpecificEventHandler(nullset[i],RuntimeConstants.EVENTHANDLER_NULLSET,NullSetEventHandler.<strong class="jxr_keyword">class</strong>);
|
| <a name="705" href="#705">705</a> <strong class="jxr_keyword">if</strong> (ev != <strong class="jxr_keyword">null</strong>)
|
| <a name="706" href="#706">706</a> eventCartridge.addNullSetEventHandler((NullSetEventHandler) ev);
|
| <a name="707" href="#707">707</a> }
|
| <a name="708" href="#708">708</a> }
|
| <a name="709" href="#709">709</a>
|
| <a name="710" href="#710">710</a> String[] methodexception = configuration.getStringArray(RuntimeConstants.EVENTHANDLER_METHODEXCEPTION);
|
| <a name="711" href="#711">711</a> <strong class="jxr_keyword">if</strong> ( methodexception != <strong class="jxr_keyword">null</strong> )
|
| <a name="712" href="#712">712</a> {
|
| <a name="713" href="#713">713</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> i=0; i < methodexception.length; i++ )
|
| <a name="714" href="#714">714</a> {
|
| <a name="715" href="#715">715</a> <a href="../../../../org/apache/velocity/app/event/EventHandler.html">EventHandler</a> ev = initializeSpecificEventHandler(methodexception[i],RuntimeConstants.EVENTHANDLER_METHODEXCEPTION,MethodExceptionEventHandler.<strong class="jxr_keyword">class</strong>);
|
| <a name="716" href="#716">716</a> <strong class="jxr_keyword">if</strong> (ev != <strong class="jxr_keyword">null</strong>)
|
| <a name="717" href="#717">717</a> eventCartridge.addMethodExceptionHandler((MethodExceptionEventHandler) ev);
|
| <a name="718" href="#718">718</a> }
|
| <a name="719" href="#719">719</a> }
|
| <a name="720" href="#720">720</a>
|
| <a name="721" href="#721">721</a> String[] includeHandler = configuration.getStringArray(RuntimeConstants.EVENTHANDLER_INCLUDE);
|
| <a name="722" href="#722">722</a> <strong class="jxr_keyword">if</strong> ( includeHandler != <strong class="jxr_keyword">null</strong> )
|
| <a name="723" href="#723">723</a> {
|
| <a name="724" href="#724">724</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> i=0; i < includeHandler.length; i++ )
|
| <a name="725" href="#725">725</a> {
|
| <a name="726" href="#726">726</a> <a href="../../../../org/apache/velocity/app/event/EventHandler.html">EventHandler</a> ev = initializeSpecificEventHandler(includeHandler[i],RuntimeConstants.EVENTHANDLER_INCLUDE,IncludeEventHandler.<strong class="jxr_keyword">class</strong>);
|
| <a name="727" href="#727">727</a> <strong class="jxr_keyword">if</strong> (ev != <strong class="jxr_keyword">null</strong>)
|
| <a name="728" href="#728">728</a> eventCartridge.addIncludeEventHandler((IncludeEventHandler) ev);
|
| <a name="729" href="#729">729</a> }
|
| <a name="730" href="#730">730</a> }
|
| <a name="731" href="#731">731</a>
|
| <a name="732" href="#732">732</a> String[] invalidReferenceSet = configuration.getStringArray(RuntimeConstants.EVENTHANDLER_INVALIDREFERENCES);
|
| <a name="733" href="#733">733</a> <strong class="jxr_keyword">if</strong> ( invalidReferenceSet != <strong class="jxr_keyword">null</strong> )
|
| <a name="734" href="#734">734</a> {
|
| <a name="735" href="#735">735</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> i=0; i < invalidReferenceSet.length; i++ )
|
| <a name="736" href="#736">736</a> {
|
| <a name="737" href="#737">737</a> <a href="../../../../org/apache/velocity/app/event/EventHandler.html">EventHandler</a> ev = initializeSpecificEventHandler(invalidReferenceSet[i],RuntimeConstants.EVENTHANDLER_INVALIDREFERENCES,InvalidReferenceEventHandler.<strong class="jxr_keyword">class</strong>);
|
| <a name="738" href="#738">738</a> <strong class="jxr_keyword">if</strong> (ev != <strong class="jxr_keyword">null</strong>)
|
| <a name="739" href="#739">739</a> {
|
| <a name="740" href="#740">740</a> eventCartridge.addInvalidReferenceEventHandler((InvalidReferenceEventHandler) ev);
|
| <a name="741" href="#741">741</a> }
|
| <a name="742" href="#742">742</a> }
|
| <a name="743" href="#743">743</a> }
|
| <a name="744" href="#744">744</a>
|
| <a name="745" href="#745">745</a>
|
| <a name="746" href="#746">746</a> }
|
| <a name="747" href="#747">747</a>
|
| <a name="748" href="#748">748</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/velocity/app/event/EventHandler.html">EventHandler</a> initializeSpecificEventHandler(String classname, String paramName, Class EventHandlerInterface)
|
| <a name="749" href="#749">749</a> <strong class="jxr_keyword">throws</strong> Exception
|
| <a name="750" href="#750">750</a> {
|
| <a name="751" href="#751">751</a> <strong class="jxr_keyword">if</strong> ( classname != <strong class="jxr_keyword">null</strong> && classname.length() > 0)
|
| <a name="752" href="#752">752</a> {
|
| <a name="753" href="#753">753</a> Object o = <strong class="jxr_keyword">null</strong>;
|
| <a name="754" href="#754">754</a> <strong class="jxr_keyword">try</strong> {
|
| <a name="755" href="#755">755</a> o = ClassUtils.getNewInstance(classname);
|
| <a name="756" href="#756">756</a> }
|
| <a name="757" href="#757">757</a> <strong class="jxr_keyword">catch</strong> (ClassNotFoundException cnfe )
|
| <a name="758" href="#758">758</a> {
|
| <a name="759" href="#759">759</a> String err = <span class="jxr_string">"The specified class for "</span>
|
| <a name="760" href="#760">760</a> + paramName + <span class="jxr_string">" ("</span> + classname
|
| <a name="761" href="#761">761</a> + <span class="jxr_string">") does not exist or is not accessible to the current classloader."</span>;
|
| <a name="762" href="#762">762</a> log.error(err);
|
| <a name="763" href="#763">763</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Exception(err);
|
| <a name="764" href="#764">764</a> }
|
| <a name="765" href="#765">765</a>
|
| <a name="766" href="#766">766</a> <strong class="jxr_keyword">if</strong> (!EventHandlerInterface.isAssignableFrom(EventHandlerInterface))
|
| <a name="767" href="#767">767</a> {
|
| <a name="768" href="#768">768</a> String err = <span class="jxr_string">"The specified class for "</span> + paramName + <span class="jxr_string">" ("</span>
|
| <a name="769" href="#769">769</a> + classname + <span class="jxr_string">") does not implement "</span>
|
| <a name="770" href="#770">770</a> + EventHandlerInterface.getName()
|
| <a name="771" href="#771">771</a> + <span class="jxr_string">"; Velocity is not initialized correctly."</span>;
|
| <a name="772" href="#772">772</a>
|
| <a name="773" href="#773">773</a> log.error(err);
|
| <a name="774" href="#774">774</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Exception(err);
|
| <a name="775" href="#775">775</a> }
|
| <a name="776" href="#776">776</a>
|
| <a name="777" href="#777">777</a> <a href="../../../../org/apache/velocity/app/event/EventHandler.html">EventHandler</a> ev = (EventHandler) o;
|
| <a name="778" href="#778">778</a> <strong class="jxr_keyword">if</strong> ( ev instanceof RuntimeServicesAware )
|
| <a name="779" href="#779">779</a> ((<a href="../../../../org/apache/velocity/util/RuntimeServicesAware.html">RuntimeServicesAware</a>) ev).setRuntimeServices(<strong class="jxr_keyword">this</strong>);
|
| <a name="780" href="#780">780</a> <strong class="jxr_keyword">return</strong> ev;
|
| <a name="781" href="#781">781</a>
|
| <a name="782" href="#782">782</a> } <strong class="jxr_keyword">else</strong>
|
| <a name="783" href="#783">783</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
|
| <a name="784" href="#784">784</a> }
|
| <a name="785" href="#785">785</a>
|
| <a name="786" href="#786">786</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="787" href="#787">787</a> <em class="jxr_javadoccomment"> * Initialize the Velocity logging system.</em>
|
| <a name="788" href="#788">788</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="789" href="#789">789</a> <em class="jxr_javadoccomment"> * @throws Exception</em>
|
| <a name="790" href="#790">790</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="791" href="#791">791</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> initializeLog() <strong class="jxr_keyword">throws</strong> Exception
|
| <a name="792" href="#792">792</a> {
|
| <a name="793" href="#793">793</a> <em class="jxr_comment">// since the Log we started with was just placeholding,</em>
|
| <a name="794" href="#794">794</a> <em class="jxr_comment">// let's update it with the real LogChute settings.</em>
|
| <a name="795" href="#795">795</a> LogManager.updateLog(<strong class="jxr_keyword">this</strong>.log, <strong class="jxr_keyword">this</strong>);
|
| <a name="796" href="#796">796</a> }
|
| <a name="797" href="#797">797</a>
|
| <a name="798" href="#798">798</a>
|
| <a name="799" href="#799">799</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="800" href="#800">800</a> <em class="jxr_javadoccomment"> * This methods initializes all the directives</em>
|
| <a name="801" href="#801">801</a> <em class="jxr_javadoccomment"> * that are used by the Velocity Runtime. The</em>
|
| <a name="802" href="#802">802</a> <em class="jxr_javadoccomment"> * directives to be initialized are listed in</em>
|
| <a name="803" href="#803">803</a> <em class="jxr_javadoccomment"> * the RUNTIME_DEFAULT_DIRECTIVES properties</em>
|
| <a name="804" href="#804">804</a> <em class="jxr_javadoccomment"> * file.</em>
|
| <a name="805" href="#805">805</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="806" href="#806">806</a> <em class="jxr_javadoccomment"> * @throws Exception</em>
|
| <a name="807" href="#807">807</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="808" href="#808">808</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> initializeDirectives()
|
| <a name="809" href="#809">809</a> <strong class="jxr_keyword">throws</strong> Exception
|
| <a name="810" href="#810">810</a> {
|
| <a name="811" href="#811">811</a> <em class="jxr_comment">/*</em>
|
| <a name="812" href="#812">812</a> <em class="jxr_comment"> * Initialize the runtime directive table.</em>
|
| <a name="813" href="#813">813</a> <em class="jxr_comment"> * This will be used for creating parsers.</em>
|
| <a name="814" href="#814">814</a> <em class="jxr_comment"> */</em>
|
| <a name="815" href="#815">815</a> runtimeDirectives = <strong class="jxr_keyword">new</strong> Hashtable();
|
| <a name="816" href="#816">816</a>
|
| <a name="817" href="#817">817</a> Properties directiveProperties = <strong class="jxr_keyword">new</strong> Properties();
|
| <a name="818" href="#818">818</a>
|
| <a name="819" href="#819">819</a> <em class="jxr_comment">/*</em>
|
| <a name="820" href="#820">820</a> <em class="jxr_comment"> * Grab the properties file with the list of directives</em>
|
| <a name="821" href="#821">821</a> <em class="jxr_comment"> * that we should initialize.</em>
|
| <a name="822" href="#822">822</a> <em class="jxr_comment"> */</em>
|
| <a name="823" href="#823">823</a>
|
| <a name="824" href="#824">824</a> InputStream inputStream = <strong class="jxr_keyword">null</strong>;
|
| <a name="825" href="#825">825</a>
|
| <a name="826" href="#826">826</a> <strong class="jxr_keyword">try</strong>
|
| <a name="827" href="#827">827</a> {
|
| <a name="828" href="#828">828</a> inputStream = getClass().getResourceAsStream('/' + DEFAULT_RUNTIME_DIRECTIVES);
|
| <a name="829" href="#829">829</a>
|
| <a name="830" href="#830">830</a> <strong class="jxr_keyword">if</strong> (inputStream == <strong class="jxr_keyword">null</strong>)
|
| <a name="831" href="#831">831</a> {
|
| <a name="832" href="#832">832</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Exception(<span class="jxr_string">"Error loading directive.properties! "</span> +
|
| <a name="833" href="#833">833</a> <span class="jxr_string">"Something is very wrong if these properties "</span> +
|
| <a name="834" href="#834">834</a> <span class="jxr_string">"aren't being located. Either your Velocity "</span> +
|
| <a name="835" href="#835">835</a> <span class="jxr_string">"distribution is incomplete or your Velocity "</span> +
|
| <a name="836" href="#836">836</a> <span class="jxr_string">"jar file is corrupted!"</span>);
|
| <a name="837" href="#837">837</a> }
|
| <a name="838" href="#838">838</a>
|
| <a name="839" href="#839">839</a> directiveProperties.load(inputStream);
|
| <a name="840" href="#840">840</a>
|
| <a name="841" href="#841">841</a> }
|
| <a name="842" href="#842">842</a> <strong class="jxr_keyword">catch</strong> (IOException ioe)
|
| <a name="843" href="#843">843</a> {
|
| <a name="844" href="#844">844</a> String msg = <span class="jxr_string">"Error while loading directive properties!"</span>;
|
| <a name="845" href="#845">845</a> log.error(msg, ioe);
|
| <a name="846" href="#846">846</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException(msg, ioe);
|
| <a name="847" href="#847">847</a> }
|
| <a name="848" href="#848">848</a> <strong class="jxr_keyword">finally</strong>
|
| <a name="849" href="#849">849</a> {
|
| <a name="850" href="#850">850</a> <strong class="jxr_keyword">try</strong>
|
| <a name="851" href="#851">851</a> {
|
| <a name="852" href="#852">852</a> <strong class="jxr_keyword">if</strong> (inputStream != <strong class="jxr_keyword">null</strong>)
|
| <a name="853" href="#853">853</a> {
|
| <a name="854" href="#854">854</a> inputStream.close();
|
| <a name="855" href="#855">855</a> }
|
| <a name="856" href="#856">856</a> }
|
| <a name="857" href="#857">857</a> <strong class="jxr_keyword">catch</strong> (IOException ioe)
|
| <a name="858" href="#858">858</a> {
|
| <a name="859" href="#859">859</a> String msg = <span class="jxr_string">"Cannot close directive properties!"</span>;
|
| <a name="860" href="#860">860</a> log.error(msg, ioe);
|
| <a name="861" href="#861">861</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException(msg, ioe);
|
| <a name="862" href="#862">862</a> }
|
| <a name="863" href="#863">863</a> }
|
| <a name="864" href="#864">864</a>
|
| <a name="865" href="#865">865</a>
|
| <a name="866" href="#866">866</a> <em class="jxr_comment">/*</em>
|
| <a name="867" href="#867">867</a> <em class="jxr_comment"> * Grab all the values of the properties. These</em>
|
| <a name="868" href="#868">868</a> <em class="jxr_comment"> * are all class names for example:</em>
|
| <a name="869" href="#869">869</a> <em class="jxr_comment"> *</em>
|
| <a name="870" href="#870">870</a> <em class="jxr_comment"> * org.apache.velocity.runtime.directive.Foreach</em>
|
| <a name="871" href="#871">871</a> <em class="jxr_comment"> */</em>
|
| <a name="872" href="#872">872</a> Enumeration directiveClasses = directiveProperties.elements();
|
| <a name="873" href="#873">873</a>
|
| <a name="874" href="#874">874</a> <strong class="jxr_keyword">while</strong> (directiveClasses.hasMoreElements())
|
| <a name="875" href="#875">875</a> {
|
| <a name="876" href="#876">876</a> String directiveClass = (String) directiveClasses.nextElement();
|
| <a name="877" href="#877">877</a> loadDirective(directiveClass);
|
| <a name="878" href="#878">878</a> log.debug(<span class="jxr_string">"Loaded System Directive: "</span> + directiveClass);
|
| <a name="879" href="#879">879</a> }
|
| <a name="880" href="#880">880</a>
|
| <a name="881" href="#881">881</a> <em class="jxr_comment">/*</em>
|
| <a name="882" href="#882">882</a> <em class="jxr_comment"> * now the user's directives</em>
|
| <a name="883" href="#883">883</a> <em class="jxr_comment"> */</em>
|
| <a name="884" href="#884">884</a>
|
| <a name="885" href="#885">885</a> String[] userdirective = configuration.getStringArray(<span class="jxr_string">"userdirective"</span>);
|
| <a name="886" href="#886">886</a>
|
| <a name="887" href="#887">887</a> <strong class="jxr_keyword">for</strong>( <strong class="jxr_keyword">int</strong> i = 0; i < userdirective.length; i++)
|
| <a name="888" href="#888">888</a> {
|
| <a name="889" href="#889">889</a> loadDirective(userdirective[i]);
|
| <a name="890" href="#890">890</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled())
|
| <a name="891" href="#891">891</a> {
|
| <a name="892" href="#892">892</a> log.debug(<span class="jxr_string">"Loaded User Directive: "</span> + userdirective[i]);
|
| <a name="893" href="#893">893</a> }
|
| <a name="894" href="#894">894</a> }
|
| <a name="895" href="#895">895</a>
|
| <a name="896" href="#896">896</a> }
|
| <a name="897" href="#897">897</a>
|
| <a name="898" href="#898">898</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="899" href="#899">899</a> <em class="jxr_javadoccomment"> * Programatically add a directive.</em>
|
| <a name="900" href="#900">900</a> <em class="jxr_javadoccomment"> * @param directive</em>
|
| <a name="901" href="#901">901</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="902" href="#902">902</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addDirective(<a href="../../../../org/apache/velocity/runtime/directive/Directive.html">Directive</a> directive)
|
| <a name="903" href="#903">903</a> {
|
| <a name="904" href="#904">904</a> runtimeDirectives.put(directive.getName(), directive);
|
| <a name="905" href="#905">905</a> }
|
| <a name="906" href="#906">906</a>
|
| <a name="907" href="#907">907</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="908" href="#908">908</a> <em class="jxr_javadoccomment"> * Retrieve a previously instantiated directive.</em>
|
| <a name="909" href="#909">909</a> <em class="jxr_javadoccomment"> * @param name name of the directive</em>
|
| <a name="910" href="#910">910</a> <em class="jxr_javadoccomment"> * @return the {@link Directive} for that name</em>
|
| <a name="911" href="#911">911</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="912" href="#912">912</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/runtime/directive/Directive.html">Directive</a> getDirective(String name)
|
| <a name="913" href="#913">913</a> {
|
| <a name="914" href="#914">914</a> <strong class="jxr_keyword">return</strong> (Directive) runtimeDirectives.get(name);
|
| <a name="915" href="#915">915</a> }
|
| <a name="916" href="#916">916</a>
|
| <a name="917" href="#917">917</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="918" href="#918">918</a> <em class="jxr_javadoccomment"> * Remove a directive.</em>
|
| <a name="919" href="#919">919</a> <em class="jxr_javadoccomment"> * @param name name of the directive.</em>
|
| <a name="920" href="#920">920</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="921" href="#921">921</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> removeDirective(String name)
|
| <a name="922" href="#922">922</a> {
|
| <a name="923" href="#923">923</a> runtimeDirectives.remove(name);
|
| <a name="924" href="#924">924</a> }
|
| <a name="925" href="#925">925</a>
|
| <a name="926" href="#926">926</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="927" href="#927">927</a> <em class="jxr_javadoccomment"> * instantiates and loads the directive with some basic checks</em>
|
| <a name="928" href="#928">928</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="929" href="#929">929</a> <em class="jxr_javadoccomment"> * @param directiveClass classname of directive to load</em>
|
| <a name="930" href="#930">930</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="931" href="#931">931</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> loadDirective(String directiveClass)
|
| <a name="932" href="#932">932</a> {
|
| <a name="933" href="#933">933</a> <strong class="jxr_keyword">try</strong>
|
| <a name="934" href="#934">934</a> {
|
| <a name="935" href="#935">935</a> Object o = ClassUtils.getNewInstance( directiveClass );
|
| <a name="936" href="#936">936</a>
|
| <a name="937" href="#937">937</a> <strong class="jxr_keyword">if</strong> (o instanceof Directive)
|
| <a name="938" href="#938">938</a> {
|
| <a name="939" href="#939">939</a> <a href="../../../../org/apache/velocity/runtime/directive/Directive.html">Directive</a> directive = (Directive) o;
|
| <a name="940" href="#940">940</a> addDirective(directive);
|
| <a name="941" href="#941">941</a> }
|
| <a name="942" href="#942">942</a> <strong class="jxr_keyword">else</strong>
|
| <a name="943" href="#943">943</a> {
|
| <a name="944" href="#944">944</a> String msg = directiveClass + <span class="jxr_string">" does not implement "</span>
|
| <a name="945" href="#945">945</a> + Directive.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">"; it cannot be loaded."</span>;
|
| <a name="946" href="#946">946</a> log.error(msg);
|
| <a name="947" href="#947">947</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/exception/VelocityException.html">VelocityException</a>(msg);
|
| <a name="948" href="#948">948</a> }
|
| <a name="949" href="#949">949</a> }
|
| <a name="950" href="#950">950</a> <em class="jxr_comment">// The ugly threesome: ClassNotFoundException,</em>
|
| <a name="951" href="#951">951</a> <em class="jxr_comment">// IllegalAccessException, InstantiationException.</em>
|
| <a name="952" href="#952">952</a> <em class="jxr_comment">// Ignore Findbugs complaint for now.</em>
|
| <a name="953" href="#953">953</a> <strong class="jxr_keyword">catch</strong> (Exception e)
|
| <a name="954" href="#954">954</a> {
|
| <a name="955" href="#955">955</a> String msg = <span class="jxr_string">"Failed to load Directive: "</span> + directiveClass;
|
| <a name="956" href="#956">956</a> log.error(msg, e);
|
| <a name="957" href="#957">957</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/exception/VelocityException.html">VelocityException</a>(msg, e);
|
| <a name="958" href="#958">958</a> }
|
| <a name="959" href="#959">959</a> }
|
| <a name="960" href="#960">960</a>
|
| <a name="961" href="#961">961</a>
|
| <a name="962" href="#962">962</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="963" href="#963">963</a> <em class="jxr_javadoccomment"> * Initializes the Velocity parser pool.</em>
|
| <a name="964" href="#964">964</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="965" href="#965">965</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> initializeParserPool() <strong class="jxr_keyword">throws</strong> Exception
|
| <a name="966" href="#966">966</a> {
|
| <a name="967" href="#967">967</a> <em class="jxr_comment">/*</em>
|
| <a name="968" href="#968">968</a> <em class="jxr_comment"> * Which parser pool?</em>
|
| <a name="969" href="#969">969</a> <em class="jxr_comment"> */</em>
|
| <a name="970" href="#970">970</a> String pp = getString(RuntimeConstants.PARSER_POOL_CLASS);
|
| <a name="971" href="#971">971</a>
|
| <a name="972" href="#972">972</a> <strong class="jxr_keyword">if</strong> (pp != <strong class="jxr_keyword">null</strong> && pp.length() > 0)
|
| <a name="973" href="#973">973</a> {
|
| <a name="974" href="#974">974</a> <em class="jxr_comment">/*</em>
|
| <a name="975" href="#975">975</a> <em class="jxr_comment"> * if something was specified, then make one.</em>
|
| <a name="976" href="#976">976</a> <em class="jxr_comment"> * if that isn't a ParserPool, consider</em>
|
| <a name="977" href="#977">977</a> <em class="jxr_comment"> * this a huge error and throw</em>
|
| <a name="978" href="#978">978</a> <em class="jxr_comment"> */</em>
|
| <a name="979" href="#979">979</a>
|
| <a name="980" href="#980">980</a> Object o = <strong class="jxr_keyword">null</strong>;
|
| <a name="981" href="#981">981</a>
|
| <a name="982" href="#982">982</a> <strong class="jxr_keyword">try</strong>
|
| <a name="983" href="#983">983</a> {
|
| <a name="984" href="#984">984</a> o = ClassUtils.getNewInstance( pp );
|
| <a name="985" href="#985">985</a> }
|
| <a name="986" href="#986">986</a> <strong class="jxr_keyword">catch</strong> (ClassNotFoundException cnfe )
|
| <a name="987" href="#987">987</a> {
|
| <a name="988" href="#988">988</a> String err = <span class="jxr_string">"The specified class for ParserPool ("</span>
|
| <a name="989" href="#989">989</a> + pp
|
| <a name="990" href="#990">990</a> + <span class="jxr_string">") does not exist (or is not accessible to the current classloader."</span>;
|
| <a name="991" href="#991">991</a> log.error(err);
|
| <a name="992" href="#992">992</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Exception(err);
|
| <a name="993" href="#993">993</a> }
|
| <a name="994" href="#994">994</a>
|
| <a name="995" href="#995">995</a> <strong class="jxr_keyword">if</strong> (!(o instanceof ParserPool))
|
| <a name="996" href="#996">996</a> {
|
| <a name="997" href="#997">997</a> String err = <span class="jxr_string">"The specified class for ParserPool ("</span>
|
| <a name="998" href="#998">998</a> + pp + <span class="jxr_string">") does not implement "</span> + ParserPool.<strong class="jxr_keyword">class</strong>
|
| <a name="999" href="#999">999</a> + <span class="jxr_string">" Velocity not initialized correctly."</span>;
|
| <a name="1000" href="#1000">1000</a>
|
| <a name="1001" href="#1001">1001</a> log.error(err);
|
| <a name="1002" href="#1002">1002</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Exception(err);
|
| <a name="1003" href="#1003">1003</a> }
|
| <a name="1004" href="#1004">1004</a>
|
| <a name="1005" href="#1005">1005</a> parserPool = (ParserPool) o;
|
| <a name="1006" href="#1006">1006</a>
|
| <a name="1007" href="#1007">1007</a> parserPool.initialize(<strong class="jxr_keyword">this</strong>);
|
| <a name="1008" href="#1008">1008</a> }
|
| <a name="1009" href="#1009">1009</a> <strong class="jxr_keyword">else</strong>
|
| <a name="1010" href="#1010">1010</a> {
|
| <a name="1011" href="#1011">1011</a> <em class="jxr_comment">/*</em>
|
| <a name="1012" href="#1012">1012</a> <em class="jxr_comment"> * someone screwed up. Lets not fool around...</em>
|
| <a name="1013" href="#1013">1013</a> <em class="jxr_comment"> */</em>
|
| <a name="1014" href="#1014">1014</a>
|
| <a name="1015" href="#1015">1015</a> String err = <span class="jxr_string">"It appears that no class was specified as the"</span>
|
| <a name="1016" href="#1016">1016</a> + <span class="jxr_string">" ParserPool. Please ensure that all configuration"</span>
|
| <a name="1017" href="#1017">1017</a> + <span class="jxr_string">" information is correct."</span>;
|
| <a name="1018" href="#1018">1018</a>
|
| <a name="1019" href="#1019">1019</a> log.error(err);
|
| <a name="1020" href="#1020">1020</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Exception( err );
|
| <a name="1021" href="#1021">1021</a> }
|
| <a name="1022" href="#1022">1022</a>
|
| <a name="1023" href="#1023">1023</a> }
|
| <a name="1024" href="#1024">1024</a>
|
| <a name="1025" href="#1025">1025</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1026" href="#1026">1026</a> <em class="jxr_javadoccomment"> * Returns a JavaCC generated Parser.</em>
|
| <a name="1027" href="#1027">1027</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1028" href="#1028">1028</a> <em class="jxr_javadoccomment"> * @return Parser javacc generated parser</em>
|
| <a name="1029" href="#1029">1029</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1030" href="#1030">1030</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/runtime/parser/Parser.html">Parser</a> createNewParser()
|
| <a name="1031" href="#1031">1031</a> {
|
| <a name="1032" href="#1032">1032</a> requireInitialization();
|
| <a name="1033" href="#1033">1033</a>
|
| <a name="1034" href="#1034">1034</a> <a href="../../../../org/apache/velocity/runtime/parser/Parser.html">Parser</a> parser = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/runtime/parser/Parser.html">Parser</a>(<strong class="jxr_keyword">this</strong>);
|
| <a name="1035" href="#1035">1035</a> parser.setDirectives(runtimeDirectives);
|
| <a name="1036" href="#1036">1036</a> <strong class="jxr_keyword">return</strong> parser;
|
| <a name="1037" href="#1037">1037</a> }
|
| <a name="1038" href="#1038">1038</a>
|
| <a name="1039" href="#1039">1039</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1040" href="#1040">1040</a> <em class="jxr_javadoccomment"> * Parse the input and return the root of</em>
|
| <a name="1041" href="#1041">1041</a> <em class="jxr_javadoccomment"> * AST node structure.</em>
|
| <a name="1042" href="#1042">1042</a> <em class="jxr_javadoccomment"> * <br><br></em>
|
| <a name="1043" href="#1043">1043</a> <em class="jxr_javadoccomment"> * In the event that it runs out of parsers in the</em>
|
| <a name="1044" href="#1044">1044</a> <em class="jxr_javadoccomment"> * pool, it will create and let them be GC'd</em>
|
| <a name="1045" href="#1045">1045</a> <em class="jxr_javadoccomment"> * dynamically, logging that it has to do that. This</em>
|
| <a name="1046" href="#1046">1046</a> <em class="jxr_javadoccomment"> * is considered an exceptional condition. It is</em>
|
| <a name="1047" href="#1047">1047</a> <em class="jxr_javadoccomment"> * expected that the user will set the</em>
|
| <a name="1048" href="#1048">1048</a> <em class="jxr_javadoccomment"> * PARSER_POOL_SIZE property appropriately for their</em>
|
| <a name="1049" href="#1049">1049</a> <em class="jxr_javadoccomment"> * application. We will revisit this.</em>
|
| <a name="1050" href="#1050">1050</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1051" href="#1051">1051</a> <em class="jxr_javadoccomment"> * @param string String to be parsed</em>
|
| <a name="1052" href="#1052">1052</a> <em class="jxr_javadoccomment"> * @param templateName name of the template being parsed</em>
|
| <a name="1053" href="#1053">1053</a> <em class="jxr_javadoccomment"> * @return A root node representing the template as an AST tree.</em>
|
| <a name="1054" href="#1054">1054</a> <em class="jxr_javadoccomment"> * @throws ParseException When the string could not be parsed as a template.</em>
|
| <a name="1055" href="#1055">1055</a> <em class="jxr_javadoccomment"> * @since 1.6</em>
|
| <a name="1056" href="#1056">1056</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1057" href="#1057">1057</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/runtime/parser/node/SimpleNode.html">SimpleNode</a> parse(String string, String templateName)
|
| <a name="1058" href="#1058">1058</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../org/apache/velocity/runtime/parser/ParseException.html">ParseException</a>
|
| <a name="1059" href="#1059">1059</a> {
|
| <a name="1060" href="#1060">1060</a> <strong class="jxr_keyword">return</strong> parse(<strong class="jxr_keyword">new</strong> StringReader(string), templateName);
|
| <a name="1061" href="#1061">1061</a> }
|
| <a name="1062" href="#1062">1062</a>
|
| <a name="1063" href="#1063">1063</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1064" href="#1064">1064</a> <em class="jxr_javadoccomment"> * Parse the input and return the root of</em>
|
| <a name="1065" href="#1065">1065</a> <em class="jxr_javadoccomment"> * AST node structure.</em>
|
| <a name="1066" href="#1066">1066</a> <em class="jxr_javadoccomment"> * <br><br></em>
|
| <a name="1067" href="#1067">1067</a> <em class="jxr_javadoccomment"> * In the event that it runs out of parsers in the</em>
|
| <a name="1068" href="#1068">1068</a> <em class="jxr_javadoccomment"> * pool, it will create and let them be GC'd</em>
|
| <a name="1069" href="#1069">1069</a> <em class="jxr_javadoccomment"> * dynamically, logging that it has to do that. This</em>
|
| <a name="1070" href="#1070">1070</a> <em class="jxr_javadoccomment"> * is considered an exceptional condition. It is</em>
|
| <a name="1071" href="#1071">1071</a> <em class="jxr_javadoccomment"> * expected that the user will set the</em>
|
| <a name="1072" href="#1072">1072</a> <em class="jxr_javadoccomment"> * PARSER_POOL_SIZE property appropriately for their</em>
|
| <a name="1073" href="#1073">1073</a> <em class="jxr_javadoccomment"> * application. We will revisit this.</em>
|
| <a name="1074" href="#1074">1074</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1075" href="#1075">1075</a> <em class="jxr_javadoccomment"> * @param reader Reader retrieved by a resource loader</em>
|
| <a name="1076" href="#1076">1076</a> <em class="jxr_javadoccomment"> * @param templateName name of the template being parsed</em>
|
| <a name="1077" href="#1077">1077</a> <em class="jxr_javadoccomment"> * @return A root node representing the template as an AST tree.</em>
|
| <a name="1078" href="#1078">1078</a> <em class="jxr_javadoccomment"> * @throws ParseException When the template could not be parsed.</em>
|
| <a name="1079" href="#1079">1079</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1080" href="#1080">1080</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/runtime/parser/node/SimpleNode.html">SimpleNode</a> parse(Reader reader, String templateName)
|
| <a name="1081" href="#1081">1081</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../org/apache/velocity/runtime/parser/ParseException.html">ParseException</a>
|
| <a name="1082" href="#1082">1082</a> {
|
| <a name="1083" href="#1083">1083</a> <em class="jxr_comment">/*</em>
|
| <a name="1084" href="#1084">1084</a> <em class="jxr_comment"> * do it and dump the VM namespace for this template</em>
|
| <a name="1085" href="#1085">1085</a> <em class="jxr_comment"> */</em>
|
| <a name="1086" href="#1086">1086</a> <strong class="jxr_keyword">return</strong> parse(reader, templateName, <strong class="jxr_keyword">true</strong>);
|
| <a name="1087" href="#1087">1087</a> }
|
| <a name="1088" href="#1088">1088</a>
|
| <a name="1089" href="#1089">1089</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1090" href="#1090">1090</a> <em class="jxr_javadoccomment"> * Parse the input and return the root of the AST node structure.</em>
|
| <a name="1091" href="#1091">1091</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1092" href="#1092">1092</a> <em class="jxr_javadoccomment"> * @param reader Reader retrieved by a resource loader</em>
|
| <a name="1093" href="#1093">1093</a> <em class="jxr_javadoccomment"> * @param templateName name of the template being parsed</em>
|
| <a name="1094" href="#1094">1094</a> <em class="jxr_javadoccomment"> * @param dumpNamespace flag to dump the Velocimacro namespace for this template</em>
|
| <a name="1095" href="#1095">1095</a> <em class="jxr_javadoccomment"> * @return A root node representing the template as an AST tree.</em>
|
| <a name="1096" href="#1096">1096</a> <em class="jxr_javadoccomment"> * @throws ParseException When the template could not be parsed.</em>
|
| <a name="1097" href="#1097">1097</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1098" href="#1098">1098</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/runtime/parser/node/SimpleNode.html">SimpleNode</a> parse(Reader reader, String templateName, <strong class="jxr_keyword">boolean</strong> dumpNamespace)
|
| <a name="1099" href="#1099">1099</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../org/apache/velocity/runtime/parser/ParseException.html">ParseException</a>
|
| <a name="1100" href="#1100">1100</a> {
|
| <a name="1101" href="#1101">1101</a> requireInitialization();
|
| <a name="1102" href="#1102">1102</a>
|
| <a name="1103" href="#1103">1103</a> <a href="../../../../org/apache/velocity/runtime/parser/Parser.html">Parser</a> parser = (Parser) parserPool.get();
|
| <a name="1104" href="#1104">1104</a> <strong class="jxr_keyword">boolean</strong> keepParser = <strong class="jxr_keyword">true</strong>;
|
| <a name="1105" href="#1105">1105</a> <strong class="jxr_keyword">if</strong> (parser == <strong class="jxr_keyword">null</strong>)
|
| <a name="1106" href="#1106">1106</a> {
|
| <a name="1107" href="#1107">1107</a> <em class="jxr_comment">/*</em>
|
| <a name="1108" href="#1108">1108</a> <em class="jxr_comment"> * if we couldn't get a parser from the pool make one and log it.</em>
|
| <a name="1109" href="#1109">1109</a> <em class="jxr_comment"> */</em>
|
| <a name="1110" href="#1110">1110</a> <strong class="jxr_keyword">if</strong> (log.isInfoEnabled())
|
| <a name="1111" href="#1111">1111</a> {
|
| <a name="1112" href="#1112">1112</a> log.info(<span class="jxr_string">"Runtime : ran out of parsers. Creating a new one. "</span>
|
| <a name="1113" href="#1113">1113</a> + <span class="jxr_string">" Please increment the parser.pool.size property."</span>
|
| <a name="1114" href="#1114">1114</a> + <span class="jxr_string">" The current value is too small."</span>);
|
| <a name="1115" href="#1115">1115</a> }
|
| <a name="1116" href="#1116">1116</a> parser = createNewParser();
|
| <a name="1117" href="#1117">1117</a> keepParser = false;
|
| <a name="1118" href="#1118">1118</a> }
|
| <a name="1119" href="#1119">1119</a>
|
| <a name="1120" href="#1120">1120</a> <strong class="jxr_keyword">try</strong>
|
| <a name="1121" href="#1121">1121</a> {
|
| <a name="1122" href="#1122">1122</a> <em class="jxr_comment">/*</em>
|
| <a name="1123" href="#1123">1123</a> <em class="jxr_comment"> * dump namespace if we are told to. Generally, you want to</em>
|
| <a name="1124" href="#1124">1124</a> <em class="jxr_comment"> * do this - you don't in special circumstances, such as</em>
|
| <a name="1125" href="#1125">1125</a> <em class="jxr_comment"> * when a VM is getting init()-ed & parsed</em>
|
| <a name="1126" href="#1126">1126</a> <em class="jxr_comment"> */</em>
|
| <a name="1127" href="#1127">1127</a> <strong class="jxr_keyword">if</strong> (dumpNamespace)
|
| <a name="1128" href="#1128">1128</a> {
|
| <a name="1129" href="#1129">1129</a> dumpVMNamespace(templateName);
|
| <a name="1130" href="#1130">1130</a> }
|
| <a name="1131" href="#1131">1131</a> <strong class="jxr_keyword">return</strong> parser.parse(reader, templateName);
|
| <a name="1132" href="#1132">1132</a> }
|
| <a name="1133" href="#1133">1133</a> <strong class="jxr_keyword">finally</strong>
|
| <a name="1134" href="#1134">1134</a> {
|
| <a name="1135" href="#1135">1135</a> <strong class="jxr_keyword">if</strong> (keepParser)
|
| <a name="1136" href="#1136">1136</a> {
|
| <a name="1137" href="#1137">1137</a> parserPool.put(parser);
|
| <a name="1138" href="#1138">1138</a> }
|
| <a name="1139" href="#1139">1139</a>
|
| <a name="1140" href="#1140">1140</a> }
|
| <a name="1141" href="#1141">1141</a> }
|
| <a name="1142" href="#1142">1142</a>
|
| <a name="1143" href="#1143">1143</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1144" href="#1144">1144</a> <em class="jxr_javadoccomment"> * Renders the input string using the context into the output writer.</em>
|
| <a name="1145" href="#1145">1145</a> <em class="jxr_javadoccomment"> * To be used when a template is dynamically constructed, or want to use</em>
|
| <a name="1146" href="#1146">1146</a> <em class="jxr_javadoccomment"> * Velocity as a token replacer.</em>
|
| <a name="1147" href="#1147">1147</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1148" href="#1148">1148</a> <em class="jxr_javadoccomment"> * @param context context to use in rendering input string</em>
|
| <a name="1149" href="#1149">1149</a> <em class="jxr_javadoccomment"> * @param out Writer in which to render the output</em>
|
| <a name="1150" href="#1150">1150</a> <em class="jxr_javadoccomment"> * @param logTag string to be used as the template name for log</em>
|
| <a name="1151" href="#1151">1151</a> <em class="jxr_javadoccomment"> * messages in case of error</em>
|
| <a name="1152" href="#1152">1152</a> <em class="jxr_javadoccomment"> * @param instring input string containing the VTL to be rendered</em>
|
| <a name="1153" href="#1153">1153</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1154" href="#1154">1154</a> <em class="jxr_javadoccomment"> * @return true if successful, false otherwise. If false, see</em>
|
| <a name="1155" href="#1155">1155</a> <em class="jxr_javadoccomment"> * Velocity runtime log</em>
|
| <a name="1156" href="#1156">1156</a> <em class="jxr_javadoccomment"> * @throws ParseErrorException The template could not be parsed.</em>
|
| <a name="1157" href="#1157">1157</a> <em class="jxr_javadoccomment"> * @throws MethodInvocationException A method on a context object could not be invoked.</em>
|
| <a name="1158" href="#1158">1158</a> <em class="jxr_javadoccomment"> * @throws ResourceNotFoundException A referenced resource could not be loaded.</em>
|
| <a name="1159" href="#1159">1159</a> <em class="jxr_javadoccomment"> * @throws IOException While rendering to the writer, an I/O problem occured.</em>
|
| <a name="1160" href="#1160">1160</a> <em class="jxr_javadoccomment"> * @since Velocity 1.6</em>
|
| <a name="1161" href="#1161">1161</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1162" href="#1162">1162</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> evaluate(<a href="../../../../org/apache/velocity/context/Context.html">Context</a> context, Writer out,
|
| <a name="1163" href="#1163">1163</a> String logTag, String instring) <strong class="jxr_keyword">throws</strong> IOException
|
| <a name="1164" href="#1164">1164</a> {
|
| <a name="1165" href="#1165">1165</a> <strong class="jxr_keyword">return</strong> evaluate(context, out, logTag, <strong class="jxr_keyword">new</strong> StringReader(instring));
|
| <a name="1166" href="#1166">1166</a> }
|
| <a name="1167" href="#1167">1167</a>
|
| <a name="1168" href="#1168">1168</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1169" href="#1169">1169</a> <em class="jxr_javadoccomment"> * Renders the input reader using the context into the output writer.</em>
|
| <a name="1170" href="#1170">1170</a> <em class="jxr_javadoccomment"> * To be used when a template is dynamically constructed, or want to</em>
|
| <a name="1171" href="#1171">1171</a> <em class="jxr_javadoccomment"> * use Velocity as a token replacer.</em>
|
| <a name="1172" href="#1172">1172</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1173" href="#1173">1173</a> <em class="jxr_javadoccomment"> * @param context context to use in rendering input string</em>
|
| <a name="1174" href="#1174">1174</a> <em class="jxr_javadoccomment"> * @param writer Writer in which to render the output</em>
|
| <a name="1175" href="#1175">1175</a> <em class="jxr_javadoccomment"> * @param logTag string to be used as the template name for log messages</em>
|
| <a name="1176" href="#1176">1176</a> <em class="jxr_javadoccomment"> * in case of error</em>
|
| <a name="1177" href="#1177">1177</a> <em class="jxr_javadoccomment"> * @param reader Reader containing the VTL to be rendered</em>
|
| <a name="1178" href="#1178">1178</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1179" href="#1179">1179</a> <em class="jxr_javadoccomment"> * @return true if successful, false otherwise. If false, see</em>
|
| <a name="1180" href="#1180">1180</a> <em class="jxr_javadoccomment"> * Velocity runtime log</em>
|
| <a name="1181" href="#1181">1181</a> <em class="jxr_javadoccomment"> * @throws ParseErrorException The template could not be parsed.</em>
|
| <a name="1182" href="#1182">1182</a> <em class="jxr_javadoccomment"> * @throws MethodInvocationException A method on a context object could not be invoked.</em>
|
| <a name="1183" href="#1183">1183</a> <em class="jxr_javadoccomment"> * @throws ResourceNotFoundException A referenced resource could not be loaded.</em>
|
| <a name="1184" href="#1184">1184</a> <em class="jxr_javadoccomment"> * @throws IOException While reading from the reader or rendering to the writer,</em>
|
| <a name="1185" href="#1185">1185</a> <em class="jxr_javadoccomment"> * an I/O problem occured.</em>
|
| <a name="1186" href="#1186">1186</a> <em class="jxr_javadoccomment"> * @since Velocity 1.6</em>
|
| <a name="1187" href="#1187">1187</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1188" href="#1188">1188</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> evaluate(<a href="../../../../org/apache/velocity/context/Context.html">Context</a> context, Writer writer,
|
| <a name="1189" href="#1189">1189</a> String logTag, Reader reader) <strong class="jxr_keyword">throws</strong> IOException
|
| <a name="1190" href="#1190">1190</a> {
|
| <a name="1191" href="#1191">1191</a> <strong class="jxr_keyword">if</strong> (logTag == <strong class="jxr_keyword">null</strong>)
|
| <a name="1192" href="#1192">1192</a> {
|
| <a name="1193" href="#1193">1193</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"logTag (i.e. template name) cannot be null, you must provide an identifier for the content being evaluated"</span>);
|
| <a name="1194" href="#1194">1194</a> }
|
| <a name="1195" href="#1195">1195</a>
|
| <a name="1196" href="#1196">1196</a> <a href="../../../../org/apache/velocity/runtime/parser/node/SimpleNode.html">SimpleNode</a> nodeTree = <strong class="jxr_keyword">null</strong>;
|
| <a name="1197" href="#1197">1197</a> <strong class="jxr_keyword">try</strong>
|
| <a name="1198" href="#1198">1198</a> {
|
| <a name="1199" href="#1199">1199</a> nodeTree = parse(reader, logTag);
|
| <a name="1200" href="#1200">1200</a> }
|
| <a name="1201" href="#1201">1201</a> <strong class="jxr_keyword">catch</strong> (ParseException pex)
|
| <a name="1202" href="#1202">1202</a> {
|
| <a name="1203" href="#1203">1203</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/exception/ParseErrorException.html">ParseErrorException</a>(pex);
|
| <a name="1204" href="#1204">1204</a> }
|
| <a name="1205" href="#1205">1205</a> <strong class="jxr_keyword">catch</strong> (TemplateInitException pex)
|
| <a name="1206" href="#1206">1206</a> {
|
| <a name="1207" href="#1207">1207</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/exception/ParseErrorException.html">ParseErrorException</a>(pex);
|
| <a name="1208" href="#1208">1208</a> }
|
| <a name="1209" href="#1209">1209</a>
|
| <a name="1210" href="#1210">1210</a> <strong class="jxr_keyword">if</strong> (nodeTree == <strong class="jxr_keyword">null</strong>)
|
| <a name="1211" href="#1211">1211</a> {
|
| <a name="1212" href="#1212">1212</a> <strong class="jxr_keyword">return</strong> false;
|
| <a name="1213" href="#1213">1213</a> }
|
| <a name="1214" href="#1214">1214</a> <strong class="jxr_keyword">else</strong>
|
| <a name="1215" href="#1215">1215</a> {
|
| <a name="1216" href="#1216">1216</a> <strong class="jxr_keyword">return</strong> render(context, writer, logTag, nodeTree);
|
| <a name="1217" href="#1217">1217</a> }
|
| <a name="1218" href="#1218">1218</a> }
|
| <a name="1219" href="#1219">1219</a>
|
| <a name="1220" href="#1220">1220</a>
|
| <a name="1221" href="#1221">1221</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1222" href="#1222">1222</a> <em class="jxr_javadoccomment"> * Initializes and renders the AST {@link SimpleNode} using the context</em>
|
| <a name="1223" href="#1223">1223</a> <em class="jxr_javadoccomment"> * into the output writer.</em>
|
| <a name="1224" href="#1224">1224</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1225" href="#1225">1225</a> <em class="jxr_javadoccomment"> * @param context context to use in rendering input string</em>
|
| <a name="1226" href="#1226">1226</a> <em class="jxr_javadoccomment"> * @param writer Writer in which to render the output</em>
|
| <a name="1227" href="#1227">1227</a> <em class="jxr_javadoccomment"> * @param logTag string to be used as the template name for log messages</em>
|
| <a name="1228" href="#1228">1228</a> <em class="jxr_javadoccomment"> * in case of error</em>
|
| <a name="1229" href="#1229">1229</a> <em class="jxr_javadoccomment"> * @param nodeTree SimpleNode which is the root of the AST to be rendered</em>
|
| <a name="1230" href="#1230">1230</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1231" href="#1231">1231</a> <em class="jxr_javadoccomment"> * @return true if successful, false otherwise. If false, see</em>
|
| <a name="1232" href="#1232">1232</a> <em class="jxr_javadoccomment"> * Velocity runtime log for errors</em>
|
| <a name="1233" href="#1233">1233</a> <em class="jxr_javadoccomment"> * @throws ParseErrorException The template could not be parsed.</em>
|
| <a name="1234" href="#1234">1234</a> <em class="jxr_javadoccomment"> * @throws MethodInvocationException A method on a context object could not be invoked.</em>
|
| <a name="1235" href="#1235">1235</a> <em class="jxr_javadoccomment"> * @throws ResourceNotFoundException A referenced resource could not be loaded.</em>
|
| <a name="1236" href="#1236">1236</a> <em class="jxr_javadoccomment"> * @throws IOException While rendering to the writer, an I/O problem occured.</em>
|
| <a name="1237" href="#1237">1237</a> <em class="jxr_javadoccomment"> * @since Velocity 1.6</em>
|
| <a name="1238" href="#1238">1238</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1239" href="#1239">1239</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> render(<a href="../../../../org/apache/velocity/context/Context.html">Context</a> context, Writer writer,
|
| <a name="1240" href="#1240">1240</a> String logTag, <a href="../../../../org/apache/velocity/runtime/parser/node/SimpleNode.html">SimpleNode</a> nodeTree) <strong class="jxr_keyword">throws</strong> IOException
|
| <a name="1241" href="#1241">1241</a> {
|
| <a name="1242" href="#1242">1242</a> <em class="jxr_comment">/*</em>
|
| <a name="1243" href="#1243">1243</a> <em class="jxr_comment"> * we want to init then render</em>
|
| <a name="1244" href="#1244">1244</a> <em class="jxr_comment"> */</em>
|
| <a name="1245" href="#1245">1245</a> <a href="../../../../org/apache/velocity/context/InternalContextAdapterImpl.html">InternalContextAdapterImpl</a> ica =
|
| <a name="1246" href="#1246">1246</a> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/context/InternalContextAdapterImpl.html">InternalContextAdapterImpl</a>(context);
|
| <a name="1247" href="#1247">1247</a>
|
| <a name="1248" href="#1248">1248</a> ica.pushCurrentTemplateName(logTag);
|
| <a name="1249" href="#1249">1249</a>
|
| <a name="1250" href="#1250">1250</a> <strong class="jxr_keyword">try</strong>
|
| <a name="1251" href="#1251">1251</a> {
|
| <a name="1252" href="#1252">1252</a> <strong class="jxr_keyword">try</strong>
|
| <a name="1253" href="#1253">1253</a> {
|
| <a name="1254" href="#1254">1254</a> nodeTree.init(ica, <strong class="jxr_keyword">this</strong>);
|
| <a name="1255" href="#1255">1255</a> }
|
| <a name="1256" href="#1256">1256</a> <strong class="jxr_keyword">catch</strong> (TemplateInitException pex)
|
| <a name="1257" href="#1257">1257</a> {
|
| <a name="1258" href="#1258">1258</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/exception/ParseErrorException.html">ParseErrorException</a>(pex);
|
| <a name="1259" href="#1259">1259</a> }
|
| <a name="1260" href="#1260">1260</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1261" href="#1261">1261</a> <em class="jxr_javadoccomment"> * pass through application level runtime exceptions</em>
|
| <a name="1262" href="#1262">1262</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1263" href="#1263">1263</a> <strong class="jxr_keyword">catch</strong>(RuntimeException e)
|
| <a name="1264" href="#1264">1264</a> {
|
| <a name="1265" href="#1265">1265</a> <strong class="jxr_keyword">throw</strong> e;
|
| <a name="1266" href="#1266">1266</a> }
|
| <a name="1267" href="#1267">1267</a> <strong class="jxr_keyword">catch</strong>(Exception e)
|
| <a name="1268" href="#1268">1268</a> {
|
| <a name="1269" href="#1269">1269</a> String msg = <span class="jxr_string">"RuntimeInstance.render(): init exception for tag = "</span>+logTag;
|
| <a name="1270" href="#1270">1270</a> getLog().error(msg, e);
|
| <a name="1271" href="#1271">1271</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/exception/VelocityException.html">VelocityException</a>(msg, e);
|
| <a name="1272" href="#1272">1272</a> }
|
| <a name="1273" href="#1273">1273</a>
|
| <a name="1274" href="#1274">1274</a> <em class="jxr_comment">/*</em>
|
| <a name="1275" href="#1275">1275</a> <em class="jxr_comment"> * now render, and let any exceptions fly</em>
|
| <a name="1276" href="#1276">1276</a> <em class="jxr_comment"> */</em>
|
| <a name="1277" href="#1277">1277</a> nodeTree.render(ica, writer);
|
| <a name="1278" href="#1278">1278</a> }
|
| <a name="1279" href="#1279">1279</a> <strong class="jxr_keyword">finally</strong>
|
| <a name="1280" href="#1280">1280</a> {
|
| <a name="1281" href="#1281">1281</a> ica.popCurrentTemplateName();
|
| <a name="1282" href="#1282">1282</a> }
|
| <a name="1283" href="#1283">1283</a>
|
| <a name="1284" href="#1284">1284</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
|
| <a name="1285" href="#1285">1285</a> }
|
| <a name="1286" href="#1286">1286</a>
|
| <a name="1287" href="#1287">1287</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1288" href="#1288">1288</a> <em class="jxr_javadoccomment"> * Invokes a currently registered Velocimacro with the params provided</em>
|
| <a name="1289" href="#1289">1289</a> <em class="jxr_javadoccomment"> * and places the rendered stream into the writer.</em>
|
| <a name="1290" href="#1290">1290</a> <em class="jxr_javadoccomment"> * <br></em>
|
| <a name="1291" href="#1291">1291</a> <em class="jxr_javadoccomment"> * Note : currently only accepts args to the VM if they are in the context.</em>
|
| <a name="1292" href="#1292">1292</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1293" href="#1293">1293</a> <em class="jxr_javadoccomment"> * @param vmName name of Velocimacro to call</em>
|
| <a name="1294" href="#1294">1294</a> <em class="jxr_javadoccomment"> * @param logTag string to be used for template name in case of error. if null,</em>
|
| <a name="1295" href="#1295">1295</a> <em class="jxr_javadoccomment"> * the vmName will be used</em>
|
| <a name="1296" href="#1296">1296</a> <em class="jxr_javadoccomment"> * @param params keys for args used to invoke Velocimacro, in java format</em>
|
| <a name="1297" href="#1297">1297</a> <em class="jxr_javadoccomment"> * rather than VTL (eg "foo" or "bar" rather than "$foo" or "$bar")</em>
|
| <a name="1298" href="#1298">1298</a> <em class="jxr_javadoccomment"> * @param context Context object containing data/objects used for rendering.</em>
|
| <a name="1299" href="#1299">1299</a> <em class="jxr_javadoccomment"> * @param writer Writer for output stream</em>
|
| <a name="1300" href="#1300">1300</a> <em class="jxr_javadoccomment"> * @return true if Velocimacro exists and successfully invoked, false otherwise.</em>
|
| <a name="1301" href="#1301">1301</a> <em class="jxr_javadoccomment"> * @throws IOException While rendering to the writer, an I/O problem occured.</em>
|
| <a name="1302" href="#1302">1302</a> <em class="jxr_javadoccomment"> * @since 1.6</em>
|
| <a name="1303" href="#1303">1303</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1304" href="#1304">1304</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> invokeVelocimacro(<strong class="jxr_keyword">final</strong> String vmName, String logTag,
|
| <a name="1305" href="#1305">1305</a> String[] params, <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/velocity/context/Context.html">Context</a> context,
|
| <a name="1306" href="#1306">1306</a> <strong class="jxr_keyword">final</strong> Writer writer)
|
| <a name="1307" href="#1307">1307</a> <strong class="jxr_keyword">throws</strong> IOException
|
| <a name="1308" href="#1308">1308</a> {
|
| <a name="1309" href="#1309">1309</a> <em class="jxr_comment">/*<em class="jxr_comment"> check necessary parameters */</em></em>
|
| <a name="1310" href="#1310">1310</a> <strong class="jxr_keyword">if</strong> (vmName == <strong class="jxr_keyword">null</strong> || context == <strong class="jxr_keyword">null</strong> || writer == <strong class="jxr_keyword">null</strong>)
|
| <a name="1311" href="#1311">1311</a> {
|
| <a name="1312" href="#1312">1312</a> String msg = <span class="jxr_string">"RuntimeInstance.invokeVelocimacro() : invalid call : vmName, context, and writer must not be null"</span>;
|
| <a name="1313" href="#1313">1313</a> getLog().error(msg);
|
| <a name="1314" href="#1314">1314</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(msg);
|
| <a name="1315" href="#1315">1315</a> }
|
| <a name="1316" href="#1316">1316</a>
|
| <a name="1317" href="#1317">1317</a> <em class="jxr_comment">/*<em class="jxr_comment"> handle easily corrected parameters */</em></em>
|
| <a name="1318" href="#1318">1318</a> <strong class="jxr_keyword">if</strong> (logTag == <strong class="jxr_keyword">null</strong>)
|
| <a name="1319" href="#1319">1319</a> {
|
| <a name="1320" href="#1320">1320</a> logTag = vmName;
|
| <a name="1321" href="#1321">1321</a> }
|
| <a name="1322" href="#1322">1322</a> <strong class="jxr_keyword">if</strong> (params == <strong class="jxr_keyword">null</strong>)
|
| <a name="1323" href="#1323">1323</a> {
|
| <a name="1324" href="#1324">1324</a> params = <strong class="jxr_keyword">new</strong> String[0];
|
| <a name="1325" href="#1325">1325</a> }
|
| <a name="1326" href="#1326">1326</a>
|
| <a name="1327" href="#1327">1327</a> <em class="jxr_comment">/*<em class="jxr_comment"> does the VM exist? */</em></em>
|
| <a name="1328" href="#1328">1328</a> <strong class="jxr_keyword">if</strong> (!isVelocimacro(vmName, logTag))
|
| <a name="1329" href="#1329">1329</a> {
|
| <a name="1330" href="#1330">1330</a> String msg = <span class="jxr_string">"RuntimeInstance.invokeVelocimacro() : VM '"</span> + vmName
|
| <a name="1331" href="#1331">1331</a> + <span class="jxr_string">"' is not registered."</span>;
|
| <a name="1332" href="#1332">1332</a> getLog().error(msg);
|
| <a name="1333" href="#1333">1333</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/exception/VelocityException.html">VelocityException</a>(msg);
|
| <a name="1334" href="#1334">1334</a> }
|
| <a name="1335" href="#1335">1335</a>
|
| <a name="1336" href="#1336">1336</a> <em class="jxr_comment">/*<em class="jxr_comment"> now just create the VM call, and use evaluate */</em></em>
|
| <a name="1337" href="#1337">1337</a> StrBuilder template = <strong class="jxr_keyword">new</strong> StrBuilder(<span class="jxr_string">"#"</span>);
|
| <a name="1338" href="#1338">1338</a> template.append(vmName);
|
| <a name="1339" href="#1339">1339</a> template.append(<span class="jxr_string">"("</span>);
|
| <a name="1340" href="#1340">1340</a> <strong class="jxr_keyword">for</strong>( <strong class="jxr_keyword">int</strong> i = 0; i < params.length; i++)
|
| <a name="1341" href="#1341">1341</a> {
|
| <a name="1342" href="#1342">1342</a> template.append(<span class="jxr_string">" $"</span>);
|
| <a name="1343" href="#1343">1343</a> template.append(params[i]);
|
| <a name="1344" href="#1344">1344</a> }
|
| <a name="1345" href="#1345">1345</a> template.append(<span class="jxr_string">" )"</span>);
|
| <a name="1346" href="#1346">1346</a>
|
| <a name="1347" href="#1347">1347</a> <strong class="jxr_keyword">return</strong> evaluate(context, writer, logTag, template.toString());
|
| <a name="1348" href="#1348">1348</a> }
|
| <a name="1349" href="#1349">1349</a>
|
| <a name="1350" href="#1350">1350</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1351" href="#1351">1351</a> <em class="jxr_javadoccomment"> * Retrieves and caches the configured default encoding</em>
|
| <a name="1352" href="#1352">1352</a> <em class="jxr_javadoccomment"> * for better performance. (VELOCITY-606)</em>
|
| <a name="1353" href="#1353">1353</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1354" href="#1354">1354</a> <strong class="jxr_keyword">private</strong> String getDefaultEncoding()
|
| <a name="1355" href="#1355">1355</a> {
|
| <a name="1356" href="#1356">1356</a> <strong class="jxr_keyword">if</strong> (encoding == <strong class="jxr_keyword">null</strong>)
|
| <a name="1357" href="#1357">1357</a> {
|
| <a name="1358" href="#1358">1358</a> encoding = getString(INPUT_ENCODING, ENCODING_DEFAULT);
|
| <a name="1359" href="#1359">1359</a> }
|
| <a name="1360" href="#1360">1360</a> <strong class="jxr_keyword">return</strong> encoding;
|
| <a name="1361" href="#1361">1361</a> }
|
| <a name="1362" href="#1362">1362</a>
|
| <a name="1363" href="#1363">1363</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1364" href="#1364">1364</a> <em class="jxr_javadoccomment"> * Returns a <code>Template</code> from the resource manager.</em>
|
| <a name="1365" href="#1365">1365</a> <em class="jxr_javadoccomment"> * This method assumes that the character encoding of the</em>
|
| <a name="1366" href="#1366">1366</a> <em class="jxr_javadoccomment"> * template is set by the <code>input.encoding</code></em>
|
| <a name="1367" href="#1367">1367</a> <em class="jxr_javadoccomment"> * property. The default is "ISO-8859-1"</em>
|
| <a name="1368" href="#1368">1368</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1369" href="#1369">1369</a> <em class="jxr_javadoccomment"> * @param name The file name of the desired template.</em>
|
| <a name="1370" href="#1370">1370</a> <em class="jxr_javadoccomment"> * @return The template.</em>
|
| <a name="1371" href="#1371">1371</a> <em class="jxr_javadoccomment"> * @throws ResourceNotFoundException if template not found</em>
|
| <a name="1372" href="#1372">1372</a> <em class="jxr_javadoccomment"> * from any available source.</em>
|
| <a name="1373" href="#1373">1373</a> <em class="jxr_javadoccomment"> * @throws ParseErrorException if template cannot be parsed due</em>
|
| <a name="1374" href="#1374">1374</a> <em class="jxr_javadoccomment"> * to syntax (or other) error.</em>
|
| <a name="1375" href="#1375">1375</a> <em class="jxr_javadoccomment"> * @throws Exception if an error occurs in template initialization</em>
|
| <a name="1376" href="#1376">1376</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1377" href="#1377">1377</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/Template.html">Template</a> getTemplate(String name)
|
| <a name="1378" href="#1378">1378</a> <strong class="jxr_keyword">throws</strong> ResourceNotFoundException, ParseErrorException, Exception
|
| <a name="1379" href="#1379">1379</a> {
|
| <a name="1380" href="#1380">1380</a> <strong class="jxr_keyword">return</strong> getTemplate(name, getDefaultEncoding());
|
| <a name="1381" href="#1381">1381</a> }
|
| <a name="1382" href="#1382">1382</a>
|
| <a name="1383" href="#1383">1383</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1384" href="#1384">1384</a> <em class="jxr_javadoccomment"> * Returns a <code>Template</code> from the resource manager</em>
|
| <a name="1385" href="#1385">1385</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1386" href="#1386">1386</a> <em class="jxr_javadoccomment"> * @param name The name of the desired template.</em>
|
| <a name="1387" href="#1387">1387</a> <em class="jxr_javadoccomment"> * @param encoding Character encoding of the template</em>
|
| <a name="1388" href="#1388">1388</a> <em class="jxr_javadoccomment"> * @return The template.</em>
|
| <a name="1389" href="#1389">1389</a> <em class="jxr_javadoccomment"> * @throws ResourceNotFoundException if template not found</em>
|
| <a name="1390" href="#1390">1390</a> <em class="jxr_javadoccomment"> * from any available source.</em>
|
| <a name="1391" href="#1391">1391</a> <em class="jxr_javadoccomment"> * @throws ParseErrorException if template cannot be parsed due</em>
|
| <a name="1392" href="#1392">1392</a> <em class="jxr_javadoccomment"> * to syntax (or other) error.</em>
|
| <a name="1393" href="#1393">1393</a> <em class="jxr_javadoccomment"> * @throws Exception if an error occurs in template initialization</em>
|
| <a name="1394" href="#1394">1394</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1395" href="#1395">1395</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/Template.html">Template</a> getTemplate(String name, String encoding)
|
| <a name="1396" href="#1396">1396</a> <strong class="jxr_keyword">throws</strong> ResourceNotFoundException, ParseErrorException, Exception
|
| <a name="1397" href="#1397">1397</a> {
|
| <a name="1398" href="#1398">1398</a> requireInitialization();
|
| <a name="1399" href="#1399">1399</a>
|
| <a name="1400" href="#1400">1400</a> <strong class="jxr_keyword">return</strong> (Template)
|
| <a name="1401" href="#1401">1401</a> resourceManager.getResource(name,
|
| <a name="1402" href="#1402">1402</a> ResourceManager.RESOURCE_TEMPLATE, encoding);
|
| <a name="1403" href="#1403">1403</a> }
|
| <a name="1404" href="#1404">1404</a>
|
| <a name="1405" href="#1405">1405</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1406" href="#1406">1406</a> <em class="jxr_javadoccomment"> * Returns a static content resource from the</em>
|
| <a name="1407" href="#1407">1407</a> <em class="jxr_javadoccomment"> * resource manager. Uses the current value</em>
|
| <a name="1408" href="#1408">1408</a> <em class="jxr_javadoccomment"> * if INPUT_ENCODING as the character encoding.</em>
|
| <a name="1409" href="#1409">1409</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1410" href="#1410">1410</a> <em class="jxr_javadoccomment"> * @param name Name of content resource to get</em>
|
| <a name="1411" href="#1411">1411</a> <em class="jxr_javadoccomment"> * @return parsed ContentResource object ready for use</em>
|
| <a name="1412" href="#1412">1412</a> <em class="jxr_javadoccomment"> * @throws ResourceNotFoundException if template not found</em>
|
| <a name="1413" href="#1413">1413</a> <em class="jxr_javadoccomment"> * from any available source.</em>
|
| <a name="1414" href="#1414">1414</a> <em class="jxr_javadoccomment"> * @throws ParseErrorException When the template could not be parsed.</em>
|
| <a name="1415" href="#1415">1415</a> <em class="jxr_javadoccomment"> * @throws Exception Any other error.</em>
|
| <a name="1416" href="#1416">1416</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1417" href="#1417">1417</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/runtime/resource/ContentResource.html">ContentResource</a> getContent(String name)
|
| <a name="1418" href="#1418">1418</a> <strong class="jxr_keyword">throws</strong> ResourceNotFoundException, ParseErrorException, Exception
|
| <a name="1419" href="#1419">1419</a> {
|
| <a name="1420" href="#1420">1420</a> <em class="jxr_comment">/*</em>
|
| <a name="1421" href="#1421">1421</a> <em class="jxr_comment"> * the encoding is irrelvant as we don't do any converstion</em>
|
| <a name="1422" href="#1422">1422</a> <em class="jxr_comment"> * the bytestream should be dumped to the output stream</em>
|
| <a name="1423" href="#1423">1423</a> <em class="jxr_comment"> */</em>
|
| <a name="1424" href="#1424">1424</a>
|
| <a name="1425" href="#1425">1425</a> <strong class="jxr_keyword">return</strong> getContent(name, getDefaultEncoding());
|
| <a name="1426" href="#1426">1426</a> }
|
| <a name="1427" href="#1427">1427</a>
|
| <a name="1428" href="#1428">1428</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1429" href="#1429">1429</a> <em class="jxr_javadoccomment"> * Returns a static content resource from the</em>
|
| <a name="1430" href="#1430">1430</a> <em class="jxr_javadoccomment"> * resource manager.</em>
|
| <a name="1431" href="#1431">1431</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1432" href="#1432">1432</a> <em class="jxr_javadoccomment"> * @param name Name of content resource to get</em>
|
| <a name="1433" href="#1433">1433</a> <em class="jxr_javadoccomment"> * @param encoding Character encoding to use</em>
|
| <a name="1434" href="#1434">1434</a> <em class="jxr_javadoccomment"> * @return parsed ContentResource object ready for use</em>
|
| <a name="1435" href="#1435">1435</a> <em class="jxr_javadoccomment"> * @throws ResourceNotFoundException if template not found</em>
|
| <a name="1436" href="#1436">1436</a> <em class="jxr_javadoccomment"> * from any available source.</em>
|
| <a name="1437" href="#1437">1437</a> <em class="jxr_javadoccomment"> * @throws ParseErrorException When the template could not be parsed.</em>
|
| <a name="1438" href="#1438">1438</a> <em class="jxr_javadoccomment"> * @throws Exception Any other error.</em>
|
| <a name="1439" href="#1439">1439</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1440" href="#1440">1440</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/runtime/resource/ContentResource.html">ContentResource</a> getContent(String name, String encoding)
|
| <a name="1441" href="#1441">1441</a> <strong class="jxr_keyword">throws</strong> ResourceNotFoundException, ParseErrorException, Exception
|
| <a name="1442" href="#1442">1442</a> {
|
| <a name="1443" href="#1443">1443</a> requireInitialization();
|
| <a name="1444" href="#1444">1444</a>
|
| <a name="1445" href="#1445">1445</a> <strong class="jxr_keyword">return</strong> (ContentResource)
|
| <a name="1446" href="#1446">1446</a> resourceManager.getResource(name,
|
| <a name="1447" href="#1447">1447</a> ResourceManager.RESOURCE_CONTENT, encoding);
|
| <a name="1448" href="#1448">1448</a> }
|
| <a name="1449" href="#1449">1449</a>
|
| <a name="1450" href="#1450">1450</a>
|
| <a name="1451" href="#1451">1451</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1452" href="#1452">1452</a> <em class="jxr_javadoccomment"> * Determines if a template exists and returns name of the loader that</em>
|
| <a name="1453" href="#1453">1453</a> <em class="jxr_javadoccomment"> * provides it. This is a slightly less hokey way to support</em>
|
| <a name="1454" href="#1454">1454</a> <em class="jxr_javadoccomment"> * the Velocity.resourceExists() utility method, which was broken</em>
|
| <a name="1455" href="#1455">1455</a> <em class="jxr_javadoccomment"> * when per-template encoding was introduced. We can revisit this.</em>
|
| <a name="1456" href="#1456">1456</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1457" href="#1457">1457</a> <em class="jxr_javadoccomment"> * @param resourceName Name of template or content resource</em>
|
| <a name="1458" href="#1458">1458</a> <em class="jxr_javadoccomment"> * @return class name of loader than can provide it</em>
|
| <a name="1459" href="#1459">1459</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1460" href="#1460">1460</a> <strong class="jxr_keyword">public</strong> String getLoaderNameForResource(String resourceName)
|
| <a name="1461" href="#1461">1461</a> {
|
| <a name="1462" href="#1462">1462</a> requireInitialization();
|
| <a name="1463" href="#1463">1463</a>
|
| <a name="1464" href="#1464">1464</a> <strong class="jxr_keyword">return</strong> resourceManager.getLoaderNameForResource(resourceName);
|
| <a name="1465" href="#1465">1465</a> }
|
| <a name="1466" href="#1466">1466</a>
|
| <a name="1467" href="#1467">1467</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1468" href="#1468">1468</a> <em class="jxr_javadoccomment"> * Returns a convenient Log instance that wraps the current LogChute.</em>
|
| <a name="1469" href="#1469">1469</a> <em class="jxr_javadoccomment"> * Use this to log error messages. It has the usual methods.</em>
|
| <a name="1470" href="#1470">1470</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1471" href="#1471">1471</a> <em class="jxr_javadoccomment"> * @return A convenience Log instance that wraps the current LogChute.</em>
|
| <a name="1472" href="#1472">1472</a> <em class="jxr_javadoccomment"> * @since 1.5</em>
|
| <a name="1473" href="#1473">1473</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1474" href="#1474">1474</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/runtime/log/Log.html">Log</a> getLog()
|
| <a name="1475" href="#1475">1475</a> {
|
| <a name="1476" href="#1476">1476</a> <strong class="jxr_keyword">return</strong> log;
|
| <a name="1477" href="#1477">1477</a> }
|
| <a name="1478" href="#1478">1478</a>
|
| <a name="1479" href="#1479">1479</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1480" href="#1480">1480</a> <em class="jxr_javadoccomment"> * @deprecated Use getLog() and call warn() on it.</em>
|
| <a name="1481" href="#1481">1481</a> <em class="jxr_javadoccomment"> * @see Log#warn(Object)</em>
|
| <a name="1482" href="#1482">1482</a> <em class="jxr_javadoccomment"> * @param message The message to log.</em>
|
| <a name="1483" href="#1483">1483</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1484" href="#1484">1484</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> warn(Object message)
|
| <a name="1485" href="#1485">1485</a> {
|
| <a name="1486" href="#1486">1486</a> getLog().warn(message);
|
| <a name="1487" href="#1487">1487</a> }
|
| <a name="1488" href="#1488">1488</a>
|
| <a name="1489" href="#1489">1489</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1490" href="#1490">1490</a> <em class="jxr_javadoccomment"> * @deprecated Use getLog() and call info() on it.</em>
|
| <a name="1491" href="#1491">1491</a> <em class="jxr_javadoccomment"> * @see Log#info(Object)</em>
|
| <a name="1492" href="#1492">1492</a> <em class="jxr_javadoccomment"> * @param message The message to log.</em>
|
| <a name="1493" href="#1493">1493</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1494" href="#1494">1494</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> info(Object message)
|
| <a name="1495" href="#1495">1495</a> {
|
| <a name="1496" href="#1496">1496</a> getLog().info(message);
|
| <a name="1497" href="#1497">1497</a> }
|
| <a name="1498" href="#1498">1498</a>
|
| <a name="1499" href="#1499">1499</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1500" href="#1500">1500</a> <em class="jxr_javadoccomment"> * @deprecated Use getLog() and call error() on it.</em>
|
| <a name="1501" href="#1501">1501</a> <em class="jxr_javadoccomment"> * @see Log#error(Object)</em>
|
| <a name="1502" href="#1502">1502</a> <em class="jxr_javadoccomment"> * @param message The message to log.</em>
|
| <a name="1503" href="#1503">1503</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1504" href="#1504">1504</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> error(Object message)
|
| <a name="1505" href="#1505">1505</a> {
|
| <a name="1506" href="#1506">1506</a> getLog().error(message);
|
| <a name="1507" href="#1507">1507</a> }
|
| <a name="1508" href="#1508">1508</a>
|
| <a name="1509" href="#1509">1509</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1510" href="#1510">1510</a> <em class="jxr_javadoccomment"> * @deprecated Use getLog() and call debug() on it.</em>
|
| <a name="1511" href="#1511">1511</a> <em class="jxr_javadoccomment"> * @see Log#debug(Object)</em>
|
| <a name="1512" href="#1512">1512</a> <em class="jxr_javadoccomment"> * @param message The message to log.</em>
|
| <a name="1513" href="#1513">1513</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1514" href="#1514">1514</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> debug(Object message)
|
| <a name="1515" href="#1515">1515</a> {
|
| <a name="1516" href="#1516">1516</a> getLog().debug(message);
|
| <a name="1517" href="#1517">1517</a> }
|
| <a name="1518" href="#1518">1518</a>
|
| <a name="1519" href="#1519">1519</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1520" href="#1520">1520</a> <em class="jxr_javadoccomment"> * String property accessor method with default to hide the</em>
|
| <a name="1521" href="#1521">1521</a> <em class="jxr_javadoccomment"> * configuration implementation.</em>
|
| <a name="1522" href="#1522">1522</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1523" href="#1523">1523</a> <em class="jxr_javadoccomment"> * @param key property key</em>
|
| <a name="1524" href="#1524">1524</a> <em class="jxr_javadoccomment"> * @param defaultValue default value to return if key not</em>
|
| <a name="1525" href="#1525">1525</a> <em class="jxr_javadoccomment"> * found in resource manager.</em>
|
| <a name="1526" href="#1526">1526</a> <em class="jxr_javadoccomment"> * @return value of key or default</em>
|
| <a name="1527" href="#1527">1527</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1528" href="#1528">1528</a> <strong class="jxr_keyword">public</strong> String getString( String key, String defaultValue)
|
| <a name="1529" href="#1529">1529</a> {
|
| <a name="1530" href="#1530">1530</a> <strong class="jxr_keyword">return</strong> configuration.getString(key, defaultValue);
|
| <a name="1531" href="#1531">1531</a> }
|
| <a name="1532" href="#1532">1532</a>
|
| <a name="1533" href="#1533">1533</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1534" href="#1534">1534</a> <em class="jxr_javadoccomment"> * Returns the appropriate VelocimacroProxy object if vmName</em>
|
| <a name="1535" href="#1535">1535</a> <em class="jxr_javadoccomment"> * is a valid current Velocimacro.</em>
|
| <a name="1536" href="#1536">1536</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1537" href="#1537">1537</a> <em class="jxr_javadoccomment"> * @param vmName Name of velocimacro requested</em>
|
| <a name="1538" href="#1538">1538</a> <em class="jxr_javadoccomment"> * @param templateName Name of the template that contains the velocimacro.</em>
|
| <a name="1539" href="#1539">1539</a> <em class="jxr_javadoccomment"> * @return The requested VelocimacroProxy.</em>
|
| <a name="1540" href="#1540">1540</a> <em class="jxr_javadoccomment"> * @since 1.6</em>
|
| <a name="1541" href="#1541">1541</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1542" href="#1542">1542</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/runtime/directive/Directive.html">Directive</a> getVelocimacro(String vmName, String templateName)
|
| <a name="1543" href="#1543">1543</a> {
|
| <a name="1544" href="#1544">1544</a> <strong class="jxr_keyword">return</strong> vmFactory.getVelocimacro( vmName, templateName );
|
| <a name="1545" href="#1545">1545</a> }
|
| <a name="1546" href="#1546">1546</a>
|
| <a name="1547" href="#1547">1547</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1548" href="#1548">1548</a> <em class="jxr_javadoccomment"> * Returns the appropriate VelocimacroProxy object if vmName</em>
|
| <a name="1549" href="#1549">1549</a> <em class="jxr_javadoccomment"> * is a valid current Velocimacro.</em>
|
| <a name="1550" href="#1550">1550</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1551" href="#1551">1551</a> <em class="jxr_javadoccomment"> * @param vmName Name of velocimacro requested</em>
|
| <a name="1552" href="#1552">1552</a> <em class="jxr_javadoccomment"> * @param templateName Name of the namespace.</em>
|
| <a name="1553" href="#1553">1553</a> <em class="jxr_javadoccomment"> * @param renderingTemplate Name of the template we are currently rendering. This</em>
|
| <a name="1554" href="#1554">1554</a> <em class="jxr_javadoccomment"> * information is needed when VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL setting is true</em>
|
| <a name="1555" href="#1555">1555</a> <em class="jxr_javadoccomment"> * and template contains a macro with the same name as the global macro library.</em>
|
| <a name="1556" href="#1556">1556</a> <em class="jxr_javadoccomment"> * </em>
|
| <a name="1557" href="#1557">1557</a> <em class="jxr_javadoccomment"> * @since Velocity 1.6</em>
|
| <a name="1558" href="#1558">1558</a> <em class="jxr_javadoccomment"> * </em>
|
| <a name="1559" href="#1559">1559</a> <em class="jxr_javadoccomment"> * @return VelocimacroProxy</em>
|
| <a name="1560" href="#1560">1560</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1561" href="#1561">1561</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/runtime/directive/Directive.html">Directive</a> getVelocimacro(String vmName, String templateName, String renderingTemplate)
|
| <a name="1562" href="#1562">1562</a> {
|
| <a name="1563" href="#1563">1563</a> <strong class="jxr_keyword">return</strong> vmFactory.getVelocimacro( vmName, templateName, renderingTemplate );
|
| <a name="1564" href="#1564">1564</a> }
|
| <a name="1565" href="#1565">1565</a>
|
| <a name="1566" href="#1566">1566</a>
|
| <a name="1567" href="#1567">1567</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1568" href="#1568">1568</a> <em class="jxr_javadoccomment"> * Adds a new Velocimacro. Usually called by Macro only while parsing.</em>
|
| <a name="1569" href="#1569">1569</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1570" href="#1570">1570</a> <em class="jxr_javadoccomment"> * @param name Name of velocimacro</em>
|
| <a name="1571" href="#1571">1571</a> <em class="jxr_javadoccomment"> * @param macro String form of macro body</em>
|
| <a name="1572" href="#1572">1572</a> <em class="jxr_javadoccomment"> * @param argArray Array of strings, containing the</em>
|
| <a name="1573" href="#1573">1573</a> <em class="jxr_javadoccomment"> * #macro() arguments. the 0th is the name.</em>
|
| <a name="1574" href="#1574">1574</a> <em class="jxr_javadoccomment"> * @param sourceTemplate Name of the template that contains the velocimacro.</em>
|
| <a name="1575" href="#1575">1575</a> <em class="jxr_javadoccomment"> * </em>
|
| <a name="1576" href="#1576">1576</a> <em class="jxr_javadoccomment"> * @deprecated Use addVelocimacro(String, Node, String[], String) instead</em>
|
| <a name="1577" href="#1577">1577</a> <em class="jxr_javadoccomment"> * </em>
|
| <a name="1578" href="#1578">1578</a> <em class="jxr_javadoccomment"> * @return True if added, false if rejected for some</em>
|
| <a name="1579" href="#1579">1579</a> <em class="jxr_javadoccomment"> * reason (either parameters or permission settings)</em>
|
| <a name="1580" href="#1580">1580</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1581" href="#1581">1581</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> addVelocimacro( String name,
|
| <a name="1582" href="#1582">1582</a> String macro,
|
| <a name="1583" href="#1583">1583</a> String argArray[],
|
| <a name="1584" href="#1584">1584</a> String sourceTemplate )
|
| <a name="1585" href="#1585">1585</a> {
|
| <a name="1586" href="#1586">1586</a> <strong class="jxr_keyword">return</strong> vmFactory.addVelocimacro(name, macro, argArray, sourceTemplate);
|
| <a name="1587" href="#1587">1587</a> }
|
| <a name="1588" href="#1588">1588</a>
|
| <a name="1589" href="#1589">1589</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1590" href="#1590">1590</a> <em class="jxr_javadoccomment"> * Adds a new Velocimacro. Usually called by Macro only while parsing.</em>
|
| <a name="1591" href="#1591">1591</a> <em class="jxr_javadoccomment"> * </em>
|
| <a name="1592" href="#1592">1592</a> <em class="jxr_javadoccomment"> * Called by org.apache.velocity.runtime.directive.processAndRegister</em>
|
| <a name="1593" href="#1593">1593</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1594" href="#1594">1594</a> <em class="jxr_javadoccomment"> * @param name Name of velocimacro</em>
|
| <a name="1595" href="#1595">1595</a> <em class="jxr_javadoccomment"> * @param macro root AST node of the parsed macro</em>
|
| <a name="1596" href="#1596">1596</a> <em class="jxr_javadoccomment"> * @param argArray Array of strings, containing the</em>
|
| <a name="1597" href="#1597">1597</a> <em class="jxr_javadoccomment"> * #macro() arguments. the 0th is the name.</em>
|
| <a name="1598" href="#1598">1598</a> <em class="jxr_javadoccomment"> * @param sourceTemplate</em>
|
| <a name="1599" href="#1599">1599</a> <em class="jxr_javadoccomment"> * </em>
|
| <a name="1600" href="#1600">1600</a> <em class="jxr_javadoccomment"> * @since Velocity 1.6</em>
|
| <a name="1601" href="#1601">1601</a> <em class="jxr_javadoccomment"> * </em>
|
| <a name="1602" href="#1602">1602</a> <em class="jxr_javadoccomment"> * @return boolean True if added, false if rejected for some</em>
|
| <a name="1603" href="#1603">1603</a> <em class="jxr_javadoccomment"> * reason (either parameters or permission settings)</em>
|
| <a name="1604" href="#1604">1604</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1605" href="#1605">1605</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> addVelocimacro( String name,
|
| <a name="1606" href="#1606">1606</a> <a href="../../../../org/apache/velocity/runtime/parser/node/Node.html">Node</a> macro,
|
| <a name="1607" href="#1607">1607</a> String argArray[],
|
| <a name="1608" href="#1608">1608</a> String sourceTemplate )
|
| <a name="1609" href="#1609">1609</a> {
|
| <a name="1610" href="#1610">1610</a> <strong class="jxr_keyword">return</strong> vmFactory.addVelocimacro(name, macro, argArray, sourceTemplate);
|
| <a name="1611" href="#1611">1611</a> }
|
| <a name="1612" href="#1612">1612</a>
|
| <a name="1613" href="#1613">1613</a>
|
| <a name="1614" href="#1614">1614</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1615" href="#1615">1615</a> <em class="jxr_javadoccomment"> * Checks to see if a VM exists</em>
|
| <a name="1616" href="#1616">1616</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1617" href="#1617">1617</a> <em class="jxr_javadoccomment"> * @param vmName Name of the Velocimacro.</em>
|
| <a name="1618" href="#1618">1618</a> <em class="jxr_javadoccomment"> * @param templateName Template on which to look for the Macro.</em>
|
| <a name="1619" href="#1619">1619</a> <em class="jxr_javadoccomment"> * @return True if VM by that name exists, false if not</em>
|
| <a name="1620" href="#1620">1620</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1621" href="#1621">1621</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isVelocimacro( String vmName, String templateName )
|
| <a name="1622" href="#1622">1622</a> {
|
| <a name="1623" href="#1623">1623</a> <strong class="jxr_keyword">return</strong> vmFactory.isVelocimacro(vmName, templateName);
|
| <a name="1624" href="#1624">1624</a> }
|
| <a name="1625" href="#1625">1625</a>
|
| <a name="1626" href="#1626">1626</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1627" href="#1627">1627</a> <em class="jxr_javadoccomment"> * tells the vmFactory to dump the specified namespace. This is to support</em>
|
| <a name="1628" href="#1628">1628</a> <em class="jxr_javadoccomment"> * clearing the VM list when in inline-VM-local-scope mode</em>
|
| <a name="1629" href="#1629">1629</a> <em class="jxr_javadoccomment"> * @param namespace Namespace to dump.</em>
|
| <a name="1630" href="#1630">1630</a> <em class="jxr_javadoccomment"> * @return True if namespace was dumped successfully.</em>
|
| <a name="1631" href="#1631">1631</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1632" href="#1632">1632</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> dumpVMNamespace(String namespace)
|
| <a name="1633" href="#1633">1633</a> {
|
| <a name="1634" href="#1634">1634</a> <strong class="jxr_keyword">return</strong> vmFactory.dumpVMNamespace( namespace );
|
| <a name="1635" href="#1635">1635</a> }
|
| <a name="1636" href="#1636">1636</a>
|
| <a name="1637" href="#1637">1637</a> <em class="jxr_comment">/*<em class="jxr_comment"> --------------------------------------------------------------------</em></em>
|
| <a name="1638" href="#1638">1638</a> <em class="jxr_comment"> * R U N T I M E A C C E S S O R M E T H O D S</em>
|
| <a name="1639" href="#1639">1639</a> <em class="jxr_comment"> * --------------------------------------------------------------------</em>
|
| <a name="1640" href="#1640">1640</a> <em class="jxr_comment"> * These are the getXXX() methods that are a simple wrapper</em>
|
| <a name="1641" href="#1641">1641</a> <em class="jxr_comment"> * around the configuration object. This is an attempt</em>
|
| <a name="1642" href="#1642">1642</a> <em class="jxr_comment"> * to make a the Velocity Runtime the single access point</em>
|
| <a name="1643" href="#1643">1643</a> <em class="jxr_comment"> * for all things Velocity, and allow the Runtime to</em>
|
| <a name="1644" href="#1644">1644</a> <em class="jxr_comment"> * adhere as closely as possible the the Mediator pattern</em>
|
| <a name="1645" href="#1645">1645</a> <em class="jxr_comment"> * which is the ultimate goal.</em>
|
| <a name="1646" href="#1646">1646</a> <em class="jxr_comment"> * --------------------------------------------------------------------</em>
|
| <a name="1647" href="#1647">1647</a> <em class="jxr_comment"> */</em>
|
| <a name="1648" href="#1648">1648</a>
|
| <a name="1649" href="#1649">1649</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1650" href="#1650">1650</a> <em class="jxr_javadoccomment"> * String property accessor method to hide the configuration implementation</em>
|
| <a name="1651" href="#1651">1651</a> <em class="jxr_javadoccomment"> * @param key property key</em>
|
| <a name="1652" href="#1652">1652</a> <em class="jxr_javadoccomment"> * @return value of key or null</em>
|
| <a name="1653" href="#1653">1653</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1654" href="#1654">1654</a> <strong class="jxr_keyword">public</strong> String getString(String key)
|
| <a name="1655" href="#1655">1655</a> {
|
| <a name="1656" href="#1656">1656</a> <strong class="jxr_keyword">return</strong> StringUtils.nullTrim(configuration.getString(key));
|
| <a name="1657" href="#1657">1657</a> }
|
| <a name="1658" href="#1658">1658</a>
|
| <a name="1659" href="#1659">1659</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1660" href="#1660">1660</a> <em class="jxr_javadoccomment"> * Int property accessor method to hide the configuration implementation.</em>
|
| <a name="1661" href="#1661">1661</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1662" href="#1662">1662</a> <em class="jxr_javadoccomment"> * @param key Property key</em>
|
| <a name="1663" href="#1663">1663</a> <em class="jxr_javadoccomment"> * @return value</em>
|
| <a name="1664" href="#1664">1664</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1665" href="#1665">1665</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getInt(String key)
|
| <a name="1666" href="#1666">1666</a> {
|
| <a name="1667" href="#1667">1667</a> <strong class="jxr_keyword">return</strong> configuration.getInt(key);
|
| <a name="1668" href="#1668">1668</a> }
|
| <a name="1669" href="#1669">1669</a>
|
| <a name="1670" href="#1670">1670</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1671" href="#1671">1671</a> <em class="jxr_javadoccomment"> * Int property accessor method to hide the configuration implementation.</em>
|
| <a name="1672" href="#1672">1672</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1673" href="#1673">1673</a> <em class="jxr_javadoccomment"> * @param key property key</em>
|
| <a name="1674" href="#1674">1674</a> <em class="jxr_javadoccomment"> * @param defaultValue The default value.</em>
|
| <a name="1675" href="#1675">1675</a> <em class="jxr_javadoccomment"> * @return value</em>
|
| <a name="1676" href="#1676">1676</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1677" href="#1677">1677</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getInt(String key, <strong class="jxr_keyword">int</strong> defaultValue)
|
| <a name="1678" href="#1678">1678</a> {
|
| <a name="1679" href="#1679">1679</a> <strong class="jxr_keyword">return</strong> configuration.getInt(key, defaultValue);
|
| <a name="1680" href="#1680">1680</a> }
|
| <a name="1681" href="#1681">1681</a>
|
| <a name="1682" href="#1682">1682</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1683" href="#1683">1683</a> <em class="jxr_javadoccomment"> * Boolean property accessor method to hide the configuration implementation.</em>
|
| <a name="1684" href="#1684">1684</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1685" href="#1685">1685</a> <em class="jxr_javadoccomment"> * @param key property key</em>
|
| <a name="1686" href="#1686">1686</a> <em class="jxr_javadoccomment"> * @param def The default value if property not found.</em>
|
| <a name="1687" href="#1687">1687</a> <em class="jxr_javadoccomment"> * @return value of key or default value</em>
|
| <a name="1688" href="#1688">1688</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1689" href="#1689">1689</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> getBoolean(String key, <strong class="jxr_keyword">boolean</strong> def)
|
| <a name="1690" href="#1690">1690</a> {
|
| <a name="1691" href="#1691">1691</a> <strong class="jxr_keyword">return</strong> configuration.getBoolean(key, def);
|
| <a name="1692" href="#1692">1692</a> }
|
| <a name="1693" href="#1693">1693</a>
|
| <a name="1694" href="#1694">1694</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1695" href="#1695">1695</a> <em class="jxr_javadoccomment"> * Return the velocity runtime configuration object.</em>
|
| <a name="1696" href="#1696">1696</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1697" href="#1697">1697</a> <em class="jxr_javadoccomment"> * @return Configuration object which houses the Velocity runtime</em>
|
| <a name="1698" href="#1698">1698</a> <em class="jxr_javadoccomment"> * properties.</em>
|
| <a name="1699" href="#1699">1699</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1700" href="#1700">1700</a> <strong class="jxr_keyword">public</strong> ExtendedProperties getConfiguration()
|
| <a name="1701" href="#1701">1701</a> {
|
| <a name="1702" href="#1702">1702</a> <strong class="jxr_keyword">return</strong> configuration;
|
| <a name="1703" href="#1703">1703</a> }
|
| <a name="1704" href="#1704">1704</a>
|
| <a name="1705" href="#1705">1705</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1706" href="#1706">1706</a> <em class="jxr_javadoccomment"> * Return the Introspector for this instance</em>
|
| <a name="1707" href="#1707">1707</a> <em class="jxr_javadoccomment"> * @return The Introspector for this instance</em>
|
| <a name="1708" href="#1708">1708</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1709" href="#1709">1709</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/util/introspection/Introspector.html">Introspector</a> getIntrospector()
|
| <a name="1710" href="#1710">1710</a> {
|
| <a name="1711" href="#1711">1711</a> <strong class="jxr_keyword">return</strong> introspector;
|
| <a name="1712" href="#1712">1712</a> }
|
| <a name="1713" href="#1713">1713</a>
|
| <a name="1714" href="#1714">1714</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1715" href="#1715">1715</a> <em class="jxr_javadoccomment"> * Returns the event handlers for the application.</em>
|
| <a name="1716" href="#1716">1716</a> <em class="jxr_javadoccomment"> * @return The event handlers for the application.</em>
|
| <a name="1717" href="#1717">1717</a> <em class="jxr_javadoccomment"> * @since 1.5</em>
|
| <a name="1718" href="#1718">1718</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1719" href="#1719">1719</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/app/event/EventCartridge.html">EventCartridge</a> getApplicationEventCartridge()
|
| <a name="1720" href="#1720">1720</a> {
|
| <a name="1721" href="#1721">1721</a> <strong class="jxr_keyword">return</strong> eventCartridge;
|
| <a name="1722" href="#1722">1722</a> }
|
| <a name="1723" href="#1723">1723</a>
|
| <a name="1724" href="#1724">1724</a>
|
| <a name="1725" href="#1725">1725</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1726" href="#1726">1726</a> <em class="jxr_javadoccomment"> * Gets the application attribute for the given key</em>
|
| <a name="1727" href="#1727">1727</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1728" href="#1728">1728</a> <em class="jxr_javadoccomment"> * @param key</em>
|
| <a name="1729" href="#1729">1729</a> <em class="jxr_javadoccomment"> * @return The application attribute for the given key.</em>
|
| <a name="1730" href="#1730">1730</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1731" href="#1731">1731</a> <strong class="jxr_keyword">public</strong> Object getApplicationAttribute(Object key)
|
| <a name="1732" href="#1732">1732</a> {
|
| <a name="1733" href="#1733">1733</a> <strong class="jxr_keyword">return</strong> applicationAttributes.get(key);
|
| <a name="1734" href="#1734">1734</a> }
|
| <a name="1735" href="#1735">1735</a>
|
| <a name="1736" href="#1736">1736</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1737" href="#1737">1737</a> <em class="jxr_javadoccomment"> * Sets the application attribute for the given key</em>
|
| <a name="1738" href="#1738">1738</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1739" href="#1739">1739</a> <em class="jxr_javadoccomment"> * @param key</em>
|
| <a name="1740" href="#1740">1740</a> <em class="jxr_javadoccomment"> * @param o The new application attribute.</em>
|
| <a name="1741" href="#1741">1741</a> <em class="jxr_javadoccomment"> * @return The old value of this attribute or null if it hasn't been set before.</em>
|
| <a name="1742" href="#1742">1742</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1743" href="#1743">1743</a> <strong class="jxr_keyword">public</strong> Object setApplicationAttribute(Object key, Object o)
|
| <a name="1744" href="#1744">1744</a> {
|
| <a name="1745" href="#1745">1745</a> <strong class="jxr_keyword">return</strong> applicationAttributes.put(key, o);
|
| <a name="1746" href="#1746">1746</a> }
|
| <a name="1747" href="#1747">1747</a>
|
| <a name="1748" href="#1748">1748</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="1749" href="#1749">1749</a> <em class="jxr_javadoccomment"> * Returns the Uberspect object for this Instance.</em>
|
| <a name="1750" href="#1750">1750</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="1751" href="#1751">1751</a> <em class="jxr_javadoccomment"> * @return The Uberspect object for this Instance.</em>
|
| <a name="1752" href="#1752">1752</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="1753" href="#1753">1753</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/util/introspection/Uberspect.html">Uberspect</a> getUberspect()
|
| <a name="1754" href="#1754">1754</a> {
|
| <a name="1755" href="#1755">1755</a> <strong class="jxr_keyword">return</strong> uberSpect;
|
| <a name="1756" href="#1756">1756</a> }
|
| <a name="1757" href="#1757">1757</a>
|
| <a name="1758" href="#1758">1758</a> }
|
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
|
|
