| <!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>StringResourceLoader xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../../apidocs/org/apache/velocity/runtime/resource/loader/StringResourceLoader.html">View Javadoc</a></div><pre> |
|
|
| <a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.velocity.runtime.resource.loader;
|
| <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.util.Collections;
|
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.HashMap;
|
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.Map;
|
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.io.ByteArrayInputStream;
|
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
|
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException;
|
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.commons.collections.ExtendedProperties;
|
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang.StringUtils;
|
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.ResourceNotFoundException;
|
| <a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.VelocityException;
|
| <a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.resource.Resource;
|
| <a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.resource.util.StringResource;
|
| <a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.resource.util.StringResourceRepository;
|
| <a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.resource.util.StringResourceRepositoryImpl;
|
| <a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.ClassUtils;
|
| <a name="37" href="#37">37</a>
|
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * Resource loader that works with Strings. Users should manually add</em>
|
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * resources to the repository that is used by the resource loader instance.</em>
|
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * Below is an example configuration for this loader.</em>
|
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * Note that 'repository.class' is not necessary;</em>
|
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * if not provided, the factory will fall back on using </em>
|
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * {@link StringResourceRepositoryImpl} as the default.</em>
|
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * <pre></em>
|
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * resource.loader = string</em>
|
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * string.resource.loader.description = Velocity StringResource loader</em>
|
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * string.resource.loader.class = org.apache.velocity.runtime.resource.loader.StringResourceLoader</em>
|
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * string.resource.loader.repository.class = org.apache.velocity.runtime.resource.loader.StringResourceRepositoryImpl</em>
|
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * </pre></em>
|
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * Resources can be added to the repository like this:</em>
|
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * <pre><code></em>
|
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * StringResourceRepository repo = StringResourceLoader.getRepository();</em>
|
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * String myTemplateName = "/some/imaginary/path/hello.vm";</em>
|
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * String myTemplate = "Hi, ${username}... this is some template!";</em>
|
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * repo.putStringResource(myTemplateName, myTemplate);</em>
|
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * </code></pre></em>
|
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * After this, the templates can be retrieved as usual.</em>
|
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * <br></em>
|
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * <p>If there will be multiple StringResourceLoaders used in an application,</em>
|
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * you should consider specifying a 'string.resource.loader.repository.name = foo'</em>
|
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * property in order to keep you string resources in a non-default repository.</em>
|
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * This can help to avoid conflicts between different frameworks or components</em>
|
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * that are using StringResourceLoader.</em>
|
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * You can then retrieve your named repository like this:</em>
|
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * <pre><code></em>
|
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * StringResourceRepository repo = StringResourceLoader.getRepository("foo");</em>
|
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * </code></pre></em>
|
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * and add string resources to the repo just as in the previous example.</em>
|
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * </p></em>
|
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * <p>If you have concerns about memory leaks or for whatever reason do not wish</em>
|
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * to have your string repository stored statically as a class member, then you</em>
|
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * should set 'string.resource.loader.repository.static = false' in your properties.</em>
|
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * This will tell the resource loader that the string repository should be stored</em>
|
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * in the Velocity application attributes. To retrieve the repository, do:</em>
|
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * <pre><code></em>
|
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * StringResourceRepository repo = velocityEngine.getApplicationAttribute("foo");</em>
|
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * </code></pre></em>
|
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * If you did not specify a name for the repository, then it will be stored under the</em>
|
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * class name of the repository implementation class (for which the default is </em>
|
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * 'org.apache.velocity.runtime.resource.util.StringResourceRepositoryImpl'). </em>
|
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * Incidentally, this is also true for the default statically stored repository.</em>
|
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * </p></em>
|
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * <p>Whether your repository is stored statically or in Velocity's application</em>
|
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * attributes, you can also manually create and set it prior to Velocity</em>
|
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * initialization. For a static repository, you can do something like this:</em>
|
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * <pre><code></em>
|
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * StringResourceRepository repo = new MyStringResourceRepository();</em>
|
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * repo.magicallyAddSomeStringResources();</em>
|
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * StringResourceLoader.setRepository("foo", repo);</em>
|
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * </code></pre></em>
|
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * Or for a non-static repository:</em>
|
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * <pre><code></em>
|
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * StringResourceRepository repo = new MyStringResourceRepository();</em>
|
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * repo.magicallyAddSomeStringResources();</em>
|
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * velocityEngine.setApplicationAttribute("foo", repo);</em>
|
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * </code></pre></em>
|
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * Then, assuming the 'string.resource.loader.repository.name' property is</em>
|
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * set to 'some.name', the StringResourceLoader will use that already created</em>
|
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * repository, rather than creating a new one.</em>
|
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * </p></em>
|
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:eelco.hillenius@openedge.nl" target="alexandria_uri">mailto:eelco.hillenius@openedge.nl</a>">Eelco Hillenius</a></em>
|
| <a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:henning@apache.org" target="alexandria_uri">mailto:henning@apache.org</a>">Henning P. Schmiedehausen</a></em>
|
| <a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * @author Nathan Bubna</em>
|
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * @version $Id: StringResourceLoader.java 687518 2008-08-21 00:18:03Z nbubna $</em>
|
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * @since 1.5</em>
|
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="112" href="#112">112</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/velocity/runtime/resource/loader/StringResourceLoader.html">StringResourceLoader</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/velocity/runtime/resource/loader/ResourceLoader.html">ResourceLoader</a>
|
| <a name="113" href="#113">113</a> {
|
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * Key to determine whether the repository should be set as the static one or not.</em>
|
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * @since 1.6</em>
|
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="118" href="#118">118</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String REPOSITORY_STATIC = <span class="jxr_string">"repository.static"</span>;
|
| <a name="119" href="#119">119</a>
|
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * By default, repositories are stored statically (shared across the VM).</em>
|
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * @since 1.6</em>
|
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="124" href="#124">124</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> REPOSITORY_STATIC_DEFAULT = <strong class="jxr_keyword">true</strong>;
|
| <a name="125" href="#125">125</a>
|
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Key to look up the repository implementation class. */</em>
|
| <a name="127" href="#127">127</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String REPOSITORY_CLASS = <span class="jxr_string">"repository.class"</span>;
|
| <a name="128" href="#128">128</a>
|
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The default implementation class. */</em>
|
| <a name="130" href="#130">130</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String REPOSITORY_CLASS_DEFAULT =
|
| <a name="131" href="#131">131</a> StringResourceRepositoryImpl.<strong class="jxr_keyword">class</strong>.getName();
|
| <a name="132" href="#132">132</a>
|
| <a name="133" href="#133">133</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * Key to look up the name for the repository to be used.</em>
|
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * @since 1.6</em>
|
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="137" href="#137">137</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String REPOSITORY_NAME = <span class="jxr_string">"repository.name"</span>;
|
| <a name="138" href="#138">138</a>
|
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The default name for string resource repositories</em>
|
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * ('org.apache.velocity.runtime.resource.util.StringResourceRepository').</em>
|
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> * @since 1.6</em>
|
| <a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="143" href="#143">143</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String REPOSITORY_NAME_DEFAULT =
|
| <a name="144" href="#144">144</a> StringResourceRepository.<strong class="jxr_keyword">class</strong>.getName();
|
| <a name="145" href="#145">145</a>
|
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Key to look up the repository char encoding. */</em>
|
| <a name="147" href="#147">147</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String REPOSITORY_ENCODING = <span class="jxr_string">"repository.encoding"</span>;
|
| <a name="148" href="#148">148</a>
|
| <a name="149" href="#149">149</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The default repository encoding. */</em>
|
| <a name="150" href="#150">150</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String REPOSITORY_ENCODING_DEFAULT = <span class="jxr_string">"UTF-8"</span>;
|
| <a name="151" href="#151">151</a>
|
| <a name="152" href="#152">152</a>
|
| <a name="153" href="#153">153</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Map STATIC_REPOSITORIES =
|
| <a name="154" href="#154">154</a> Collections.synchronizedMap(<strong class="jxr_keyword">new</strong> HashMap());
|
| <a name="155" href="#155">155</a>
|
| <a name="156" href="#156">156</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * Returns a reference to the default static repository.</em>
|
| <a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="159" href="#159">159</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/velocity/runtime/resource/util/StringResourceRepository.html">StringResourceRepository</a> getRepository()
|
| <a name="160" href="#160">160</a> {
|
| <a name="161" href="#161">161</a> <strong class="jxr_keyword">return</strong> getRepository(REPOSITORY_NAME_DEFAULT);
|
| <a name="162" href="#162">162</a> }
|
| <a name="163" href="#163">163</a>
|
| <a name="164" href="#164">164</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * Returns a reference to the repository stored statically under the</em>
|
| <a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * specified name.</em>
|
| <a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * @since 1.6</em>
|
| <a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="169" href="#169">169</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/velocity/runtime/resource/util/StringResourceRepository.html">StringResourceRepository</a> getRepository(String name)
|
| <a name="170" href="#170">170</a> {
|
| <a name="171" href="#171">171</a> <strong class="jxr_keyword">return</strong> (StringResourceRepository)STATIC_REPOSITORIES.get(name);
|
| <a name="172" href="#172">172</a> }
|
| <a name="173" href="#173">173</a>
|
| <a name="174" href="#174">174</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * Sets the specified {@link StringResourceRepository} in static storage</em>
|
| <a name="176" href="#176">176</a> <em class="jxr_javadoccomment"> * under the specified name.</em>
|
| <a name="177" href="#177">177</a> <em class="jxr_javadoccomment"> * @since 1.6</em>
|
| <a name="178" href="#178">178</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="179" href="#179">179</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> setRepository(String name, <a href="../../../../../../org/apache/velocity/runtime/resource/util/StringResourceRepository.html">StringResourceRepository</a> repo)
|
| <a name="180" href="#180">180</a> {
|
| <a name="181" href="#181">181</a> STATIC_REPOSITORIES.put(name, repo);
|
| <a name="182" href="#182">182</a> }
|
| <a name="183" href="#183">183</a>
|
| <a name="184" href="#184">184</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="185" href="#185">185</a> <em class="jxr_javadoccomment"> * Removes the {@link StringResourceRepository} stored under the specified</em>
|
| <a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * name.</em>
|
| <a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * @since 1.6</em>
|
| <a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="189" href="#189">189</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/velocity/runtime/resource/util/StringResourceRepository.html">StringResourceRepository</a> removeRepository(String name)
|
| <a name="190" href="#190">190</a> {
|
| <a name="191" href="#191">191</a> <strong class="jxr_keyword">return</strong> (StringResourceRepository)STATIC_REPOSITORIES.remove(name);
|
| <a name="192" href="#192">192</a> }
|
| <a name="193" href="#193">193</a>
|
| <a name="194" href="#194">194</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="195" href="#195">195</a> <em class="jxr_javadoccomment"> * Removes all statically stored {@link StringResourceRepository}s.</em>
|
| <a name="196" href="#196">196</a> <em class="jxr_javadoccomment"> * @since 1.6</em>
|
| <a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="198" href="#198">198</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> clearRepositories()
|
| <a name="199" href="#199">199</a> {
|
| <a name="200" href="#200">200</a> STATIC_REPOSITORIES.clear();
|
| <a name="201" href="#201">201</a> }
|
| <a name="202" href="#202">202</a>
|
| <a name="203" href="#203">203</a>
|
| <a name="204" href="#204">204</a> <em class="jxr_comment">// the repository used internally by this resource loader</em>
|
| <a name="205" href="#205">205</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/velocity/runtime/resource/util/StringResourceRepository.html">StringResourceRepository</a> repository;
|
| <a name="206" href="#206">206</a>
|
| <a name="207" href="#207">207</a>
|
| <a name="208" href="#208">208</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="209" href="#209">209</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#init(org.apache.commons.collections.ExtendedProperties)</em>
|
| <a name="210" href="#210">210</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="211" href="#211">211</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init(<strong class="jxr_keyword">final</strong> ExtendedProperties configuration)
|
| <a name="212" href="#212">212</a> {
|
| <a name="213" href="#213">213</a> log.trace(<span class="jxr_string">"StringResourceLoader : initialization starting."</span>);
|
| <a name="214" href="#214">214</a>
|
| <a name="215" href="#215">215</a> <em class="jxr_comment">// get the repository configuration info</em>
|
| <a name="216" href="#216">216</a> String repoClass = configuration.getString(REPOSITORY_CLASS, REPOSITORY_CLASS_DEFAULT);
|
| <a name="217" href="#217">217</a> String repoName = configuration.getString(REPOSITORY_NAME, REPOSITORY_NAME_DEFAULT);
|
| <a name="218" href="#218">218</a> <strong class="jxr_keyword">boolean</strong> isStatic = configuration.getBoolean(REPOSITORY_STATIC, REPOSITORY_STATIC_DEFAULT);
|
| <a name="219" href="#219">219</a> String encoding = configuration.getString(REPOSITORY_ENCODING);
|
| <a name="220" href="#220">220</a>
|
| <a name="221" href="#221">221</a> <em class="jxr_comment">// look for an existing repository of that name and isStatic setting</em>
|
| <a name="222" href="#222">222</a> <strong class="jxr_keyword">if</strong> (isStatic)
|
| <a name="223" href="#223">223</a> {
|
| <a name="224" href="#224">224</a> <strong class="jxr_keyword">this</strong>.repository = getRepository(repoName);
|
| <a name="225" href="#225">225</a> <strong class="jxr_keyword">if</strong> (repository != <strong class="jxr_keyword">null</strong> && log.isDebugEnabled())
|
| <a name="226" href="#226">226</a> {
|
| <a name="227" href="#227">227</a> log.debug(<span class="jxr_string">"Loaded repository '"</span>+repoName+<span class="jxr_string">"' from static repo store"</span>);
|
| <a name="228" href="#228">228</a> }
|
| <a name="229" href="#229">229</a> }
|
| <a name="230" href="#230">230</a> <strong class="jxr_keyword">else</strong>
|
| <a name="231" href="#231">231</a> {
|
| <a name="232" href="#232">232</a> <strong class="jxr_keyword">this</strong>.repository = (StringResourceRepository)rsvc.getApplicationAttribute(repoName);
|
| <a name="233" href="#233">233</a> <strong class="jxr_keyword">if</strong> (repository != <strong class="jxr_keyword">null</strong> && log.isDebugEnabled())
|
| <a name="234" href="#234">234</a> {
|
| <a name="235" href="#235">235</a> log.debug(<span class="jxr_string">"Loaded repository '"</span>+repoName+<span class="jxr_string">"' from application attributes"</span>);
|
| <a name="236" href="#236">236</a> }
|
| <a name="237" href="#237">237</a> }
|
| <a name="238" href="#238">238</a>
|
| <a name="239" href="#239">239</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.repository == <strong class="jxr_keyword">null</strong>)
|
| <a name="240" href="#240">240</a> {
|
| <a name="241" href="#241">241</a> <em class="jxr_comment">// since there's no repository under the repo name, create a new one</em>
|
| <a name="242" href="#242">242</a> <strong class="jxr_keyword">this</strong>.repository = createRepository(repoClass, encoding);
|
| <a name="243" href="#243">243</a>
|
| <a name="244" href="#244">244</a> <em class="jxr_comment">// and store it according to the isStatic setting</em>
|
| <a name="245" href="#245">245</a> <strong class="jxr_keyword">if</strong> (isStatic)
|
| <a name="246" href="#246">246</a> {
|
| <a name="247" href="#247">247</a> setRepository(repoName, <strong class="jxr_keyword">this</strong>.repository);
|
| <a name="248" href="#248">248</a> }
|
| <a name="249" href="#249">249</a> <strong class="jxr_keyword">else</strong>
|
| <a name="250" href="#250">250</a> {
|
| <a name="251" href="#251">251</a> rsvc.setApplicationAttribute(repoName, <strong class="jxr_keyword">this</strong>.repository);
|
| <a name="252" href="#252">252</a> }
|
| <a name="253" href="#253">253</a> }
|
| <a name="254" href="#254">254</a> <strong class="jxr_keyword">else</strong>
|
| <a name="255" href="#255">255</a> {
|
| <a name="256" href="#256">256</a> <em class="jxr_comment">// ok, we already have a repo</em>
|
| <a name="257" href="#257">257</a> <em class="jxr_comment">// warn them if they are trying to change the class of the repository</em>
|
| <a name="258" href="#258">258</a> <strong class="jxr_keyword">if</strong> (!<strong class="jxr_keyword">this</strong>.repository.getClass().getName().equals(repoClass))
|
| <a name="259" href="#259">259</a> {
|
| <a name="260" href="#260">260</a> log.debug(<span class="jxr_string">"Cannot change class of string repository '"</span>+repoName+
|
| <a name="261" href="#261">261</a> <span class="jxr_string">"' from "</span>+<strong class="jxr_keyword">this</strong>.repository.getClass().getName()+<span class="jxr_string">" to "</span>+repoClass+
|
| <a name="262" href="#262">262</a> <span class="jxr_string">". The change will be ignored."</span>);
|
| <a name="263" href="#263">263</a> }
|
| <a name="264" href="#264">264</a>
|
| <a name="265" href="#265">265</a> <em class="jxr_comment">// allow them to change the default encoding of the repo</em>
|
| <a name="266" href="#266">266</a> <strong class="jxr_keyword">if</strong> (encoding != <strong class="jxr_keyword">null</strong> &&
|
| <a name="267" href="#267">267</a> !<strong class="jxr_keyword">this</strong>.repository.getEncoding().equals(encoding))
|
| <a name="268" href="#268">268</a> {
|
| <a name="269" href="#269">269</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled())
|
| <a name="270" href="#270">270</a> {
|
| <a name="271" href="#271">271</a> log.debug(<span class="jxr_string">"Changing the default encoding of string repository '"</span>+repoName+
|
| <a name="272" href="#272">272</a> <span class="jxr_string">"' from "</span>+<strong class="jxr_keyword">this</strong>.repository.getEncoding()+<span class="jxr_string">" to "</span>+encoding);
|
| <a name="273" href="#273">273</a> }
|
| <a name="274" href="#274">274</a> <strong class="jxr_keyword">this</strong>.repository.setEncoding(encoding);
|
| <a name="275" href="#275">275</a> }
|
| <a name="276" href="#276">276</a> }
|
| <a name="277" href="#277">277</a>
|
| <a name="278" href="#278">278</a> log.trace(<span class="jxr_string">"StringResourceLoader : initialization complete."</span>);
|
| <a name="279" href="#279">279</a> }
|
| <a name="280" href="#280">280</a>
|
| <a name="281" href="#281">281</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="282" href="#282">282</a> <em class="jxr_javadoccomment"> * @since 1.6</em>
|
| <a name="283" href="#283">283</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="284" href="#284">284</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/velocity/runtime/resource/util/StringResourceRepository.html">StringResourceRepository</a> createRepository(<strong class="jxr_keyword">final</strong> String className,
|
| <a name="285" href="#285">285</a> <strong class="jxr_keyword">final</strong> String encoding)
|
| <a name="286" href="#286">286</a> {
|
| <a name="287" href="#287">287</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled())
|
| <a name="288" href="#288">288</a> {
|
| <a name="289" href="#289">289</a> log.debug(<span class="jxr_string">"Creating string repository using class "</span>+className+<span class="jxr_string">"..."</span>);
|
| <a name="290" href="#290">290</a> }
|
| <a name="291" href="#291">291</a>
|
| <a name="292" href="#292">292</a> <a href="../../../../../../org/apache/velocity/runtime/resource/util/StringResourceRepository.html">StringResourceRepository</a> repo;
|
| <a name="293" href="#293">293</a> <strong class="jxr_keyword">try</strong>
|
| <a name="294" href="#294">294</a> {
|
| <a name="295" href="#295">295</a> repo = (StringResourceRepository) ClassUtils.getNewInstance(className);
|
| <a name="296" href="#296">296</a> }
|
| <a name="297" href="#297">297</a> <strong class="jxr_keyword">catch</strong> (ClassNotFoundException cnfe)
|
| <a name="298" href="#298">298</a> {
|
| <a name="299" href="#299">299</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/velocity/exception/VelocityException.html">VelocityException</a>(<span class="jxr_string">"Could not find '"</span> + className + <span class="jxr_string">"'"</span>, cnfe);
|
| <a name="300" href="#300">300</a> }
|
| <a name="301" href="#301">301</a> <strong class="jxr_keyword">catch</strong> (IllegalAccessException iae)
|
| <a name="302" href="#302">302</a> {
|
| <a name="303" href="#303">303</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/velocity/exception/VelocityException.html">VelocityException</a>(<span class="jxr_string">"Could not access '"</span> + className + <span class="jxr_string">"'"</span>, iae);
|
| <a name="304" href="#304">304</a> }
|
| <a name="305" href="#305">305</a> <strong class="jxr_keyword">catch</strong> (InstantiationException ie)
|
| <a name="306" href="#306">306</a> {
|
| <a name="307" href="#307">307</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/velocity/exception/VelocityException.html">VelocityException</a>(<span class="jxr_string">"Could not instantiate '"</span> + className + <span class="jxr_string">"'"</span>, ie);
|
| <a name="308" href="#308">308</a> }
|
| <a name="309" href="#309">309</a>
|
| <a name="310" href="#310">310</a> <strong class="jxr_keyword">if</strong> (encoding != <strong class="jxr_keyword">null</strong>)
|
| <a name="311" href="#311">311</a> {
|
| <a name="312" href="#312">312</a> repo.setEncoding(encoding);
|
| <a name="313" href="#313">313</a> }
|
| <a name="314" href="#314">314</a> <strong class="jxr_keyword">else</strong>
|
| <a name="315" href="#315">315</a> {
|
| <a name="316" href="#316">316</a> repo.setEncoding(REPOSITORY_ENCODING_DEFAULT);
|
| <a name="317" href="#317">317</a> }
|
| <a name="318" href="#318">318</a>
|
| <a name="319" href="#319">319</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled())
|
| <a name="320" href="#320">320</a> {
|
| <a name="321" href="#321">321</a> log.debug(<span class="jxr_string">"Default repository encoding is "</span> + repo.getEncoding());
|
| <a name="322" href="#322">322</a> }
|
| <a name="323" href="#323">323</a> <strong class="jxr_keyword">return</strong> repo;
|
| <a name="324" href="#324">324</a> }
|
| <a name="325" href="#325">325</a>
|
| <a name="326" href="#326">326</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="327" href="#327">327</a> <em class="jxr_javadoccomment"> * Overrides superclass for better performance.</em>
|
| <a name="328" href="#328">328</a> <em class="jxr_javadoccomment"> * @since 1.6</em>
|
| <a name="329" href="#329">329</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="330" href="#330">330</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> resourceExists(<strong class="jxr_keyword">final</strong> String name)
|
| <a name="331" href="#331">331</a> {
|
| <a name="332" href="#332">332</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong>)
|
| <a name="333" href="#333">333</a> {
|
| <a name="334" href="#334">334</a> <strong class="jxr_keyword">return</strong> false;
|
| <a name="335" href="#335">335</a> }
|
| <a name="336" href="#336">336</a> <strong class="jxr_keyword">return</strong> (<strong class="jxr_keyword">this</strong>.repository.getStringResource(name) != <strong class="jxr_keyword">null</strong>);
|
| <a name="337" href="#337">337</a> }
|
| <a name="338" href="#338">338</a>
|
| <a name="339" href="#339">339</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="340" href="#340">340</a> <em class="jxr_javadoccomment"> * Get an InputStream so that the Runtime can build a</em>
|
| <a name="341" href="#341">341</a> <em class="jxr_javadoccomment"> * template with it.</em>
|
| <a name="342" href="#342">342</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="343" href="#343">343</a> <em class="jxr_javadoccomment"> * @param name name of template to get.</em>
|
| <a name="344" href="#344">344</a> <em class="jxr_javadoccomment"> * @return InputStream containing the template.</em>
|
| <a name="345" href="#345">345</a> <em class="jxr_javadoccomment"> * @throws ResourceNotFoundException Ff template not found</em>
|
| <a name="346" href="#346">346</a> <em class="jxr_javadoccomment"> * in the RepositoryFactory.</em>
|
| <a name="347" href="#347">347</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="348" href="#348">348</a> <strong class="jxr_keyword">public</strong> InputStream getResourceStream(<strong class="jxr_keyword">final</strong> String name)
|
| <a name="349" href="#349">349</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../../../org/apache/velocity/exception/ResourceNotFoundException.html">ResourceNotFoundException</a>
|
| <a name="350" href="#350">350</a> {
|
| <a name="351" href="#351">351</a> <strong class="jxr_keyword">if</strong> (StringUtils.isEmpty(name))
|
| <a name="352" href="#352">352</a> {
|
| <a name="353" href="#353">353</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/velocity/exception/ResourceNotFoundException.html">ResourceNotFoundException</a>(<span class="jxr_string">"No template name provided"</span>);
|
| <a name="354" href="#354">354</a> }
|
| <a name="355" href="#355">355</a>
|
| <a name="356" href="#356">356</a> <a href="../../../../../../org/apache/velocity/runtime/resource/util/StringResource.html">StringResource</a> resource = <strong class="jxr_keyword">this</strong>.repository.getStringResource(name);
|
| <a name="357" href="#357">357</a>
|
| <a name="358" href="#358">358</a> <strong class="jxr_keyword">if</strong>(resource == <strong class="jxr_keyword">null</strong>)
|
| <a name="359" href="#359">359</a> {
|
| <a name="360" href="#360">360</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/velocity/exception/ResourceNotFoundException.html">ResourceNotFoundException</a>(<span class="jxr_string">"Could not locate resource '"</span> + name + <span class="jxr_string">"'"</span>);
|
| <a name="361" href="#361">361</a> }
|
| <a name="362" href="#362">362</a>
|
| <a name="363" href="#363">363</a> byte [] byteArray = <strong class="jxr_keyword">null</strong>;
|
| <a name="364" href="#364">364</a>
|
| <a name="365" href="#365">365</a> <strong class="jxr_keyword">try</strong>
|
| <a name="366" href="#366">366</a> {
|
| <a name="367" href="#367">367</a> byteArray = resource.getBody().getBytes(resource.getEncoding());
|
| <a name="368" href="#368">368</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> ByteArrayInputStream(byteArray);
|
| <a name="369" href="#369">369</a> }
|
| <a name="370" href="#370">370</a> <strong class="jxr_keyword">catch</strong>(UnsupportedEncodingException ue)
|
| <a name="371" href="#371">371</a> {
|
| <a name="372" href="#372">372</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/velocity/exception/VelocityException.html">VelocityException</a>(<span class="jxr_string">"Could not convert String using encoding "</span> + resource.getEncoding(), ue);
|
| <a name="373" href="#373">373</a> }
|
| <a name="374" href="#374">374</a> }
|
| <a name="375" href="#375">375</a>
|
| <a name="376" href="#376">376</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="377" href="#377">377</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#isSourceModified(org.apache.velocity.runtime.resource.Resource)</em>
|
| <a name="378" href="#378">378</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="379" href="#379">379</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isSourceModified(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/velocity/runtime/resource/Resource.html">Resource</a> resource)
|
| <a name="380" href="#380">380</a> {
|
| <a name="381" href="#381">381</a> <a href="../../../../../../org/apache/velocity/runtime/resource/util/StringResource.html">StringResource</a> original = <strong class="jxr_keyword">null</strong>;
|
| <a name="382" href="#382">382</a> <strong class="jxr_keyword">boolean</strong> result = <strong class="jxr_keyword">true</strong>;
|
| <a name="383" href="#383">383</a>
|
| <a name="384" href="#384">384</a> original = <strong class="jxr_keyword">this</strong>.repository.getStringResource(resource.getName());
|
| <a name="385" href="#385">385</a>
|
| <a name="386" href="#386">386</a> <strong class="jxr_keyword">if</strong> (original != <strong class="jxr_keyword">null</strong>)
|
| <a name="387" href="#387">387</a> {
|
| <a name="388" href="#388">388</a> result = original.getLastModified() != resource.getLastModified();
|
| <a name="389" href="#389">389</a> }
|
| <a name="390" href="#390">390</a>
|
| <a name="391" href="#391">391</a> <strong class="jxr_keyword">return</strong> result;
|
| <a name="392" href="#392">392</a> }
|
| <a name="393" href="#393">393</a>
|
| <a name="394" href="#394">394</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="395" href="#395">395</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#getLastModified(org.apache.velocity.runtime.resource.Resource)</em>
|
| <a name="396" href="#396">396</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="397" href="#397">397</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getLastModified(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/velocity/runtime/resource/Resource.html">Resource</a> resource)
|
| <a name="398" href="#398">398</a> {
|
| <a name="399" href="#399">399</a> <a href="../../../../../../org/apache/velocity/runtime/resource/util/StringResource.html">StringResource</a> original = <strong class="jxr_keyword">null</strong>;
|
| <a name="400" href="#400">400</a>
|
| <a name="401" href="#401">401</a> original = <strong class="jxr_keyword">this</strong>.repository.getStringResource(resource.getName());
|
| <a name="402" href="#402">402</a>
|
| <a name="403" href="#403">403</a> <strong class="jxr_keyword">return</strong> (original != <strong class="jxr_keyword">null</strong>)
|
| <a name="404" href="#404">404</a> ? original.getLastModified()
|
| <a name="405" href="#405">405</a> : 0;
|
| <a name="406" href="#406">406</a> }
|
| <a name="407" href="#407">407</a>
|
| <a name="408" href="#408">408</a> }
|
| <a name="409" href="#409">409</a>
|
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
|
|
