blob: ed578ae3de6ee4bca2375afec07c566de2d948cd [file] [log] [blame]
<!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>ClasspathResourceLoader 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/ClasspathResourceLoader.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.io.InputStream;
<a name="23" href="#23">23</a>
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.commons.collections.ExtendedProperties;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang.StringUtils;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.ResourceNotFoundException;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.resource.Resource;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.ClassUtils;
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.ExceptionUtils;
<a name="30" href="#30">30</a>
<a name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * ClasspathResourceLoader is a simple loader that will load</em>
<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * templates from the classpath.</em>
<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * &lt;br&gt;</em>
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * &lt;br&gt;</em>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * Will load templates from from multiple instances of</em>
<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * and arbitrary combinations of :</em>
<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * &lt;ul&gt;</em>
<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * &lt;li&gt; jar files</em>
<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * &lt;li&gt; zip files</em>
<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * &lt;li&gt; template directories (any directory containing templates)</em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * &lt;/ul&gt;</em>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * This is a configuration-free loader, in that there are no</em>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * parameters to be specified in the configuration properties,</em>
<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * other than specifying this as the loader to use. For example</em>
<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * the following is all that the loader needs to be functional :</em>
<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * &lt;br&gt;</em>
<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * &lt;br&gt;</em>
<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * resource.loader = class</em>
<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * class.resource.loader.class =</em>
<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader</em>
<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * &lt;br&gt;</em>
<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * &lt;br&gt;</em>
<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * To use, put your template directories, jars</em>
<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * and zip files into the classpath or other mechanisms that make</em>
<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * resources accessable to the classloader.</em>
<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * &lt;br&gt;</em>
<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * &lt;br&gt;</em>
<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * This makes deployment trivial for web applications running in</em>
<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * any Servlet 2.2 compliant servlet runner, such as Tomcat 3.2</em>
<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * and others.</em>
<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * &lt;br&gt;</em>
<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * &lt;br&gt;</em>
<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * For a Servlet Spec v2.2 servlet runner,</em>
<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * just drop the jars of template files into the WEB-INF/lib</em>
<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * directory of your webapp, and you won't have to worry about setting</em>
<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * template paths or altering them with the root of the webapp</em>
<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * before initializing.</em>
<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * &lt;br&gt;</em>
<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * &lt;br&gt;</em>
<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * I have also tried it with a WAR deployment, and that seemed to</em>
<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * work just fine.</em>
<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> *</em>
<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="mailto:mailmur@yahoo.com" target="alexandria_uri">mailto:mailmur@yahoo.com</a>"&gt;Aki Nieminen&lt;/a&gt;</em>
<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="mailto:geirm@optonline.net" target="alexandria_uri">mailto:geirm@optonline.net</a>"&gt;Geir Magnusson Jr.&lt;/a&gt;</em>
<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * @version $Id: ClasspathResourceLoader.java 471259 2006-11-04 20:26:57Z henning $</em>
<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> */</em>
<a name="78" href="#78">78</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/velocity/runtime/resource/loader/ClasspathResourceLoader.html">ClasspathResourceLoader</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/velocity/runtime/resource/loader/ResourceLoader.html">ResourceLoader</a>
<a name="79" href="#79">79</a> {
<a name="80" href="#80">80</a>
<a name="81" href="#81">81</a> <em class="jxr_javadoccomment">/**</em>
<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * This is abstract in the base class, so we need it</em>
<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * @param configuration</em>
<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> */</em>
<a name="85" href="#85">85</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init( ExtendedProperties configuration)
<a name="86" href="#86">86</a> {
<a name="87" href="#87">87</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled())
<a name="88" href="#88">88</a> {
<a name="89" href="#89">89</a> log.trace(<span class="jxr_string">"ClasspathResourceLoader : initialization complete."</span>);
<a name="90" href="#90">90</a> }
<a name="91" href="#91">91</a> }
<a name="92" href="#92">92</a>
<a name="93" href="#93">93</a> <em class="jxr_javadoccomment">/**</em>
<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * Get an InputStream so that the Runtime can build a</em>
<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * template with it.</em>
<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> *</em>
<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * @param name name of template to get</em>
<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * @return InputStream containing the template</em>
<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * @throws ResourceNotFoundException if template not found</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * in classpath.</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> */</em>
<a name="102" href="#102">102</a> <strong class="jxr_keyword">public</strong> InputStream getResourceStream( String name )
<a name="103" href="#103">103</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../../../org/apache/velocity/exception/ResourceNotFoundException.html">ResourceNotFoundException</a>
<a name="104" href="#104">104</a> {
<a name="105" href="#105">105</a> InputStream result = <strong class="jxr_keyword">null</strong>;
<a name="106" href="#106">106</a>
<a name="107" href="#107">107</a> <strong class="jxr_keyword">if</strong> (StringUtils.isEmpty(name))
<a name="108" href="#108">108</a> {
<a name="109" href="#109">109</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="110" href="#110">110</a> }
<a name="111" href="#111">111</a>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">/**</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * look for resource in thread classloader first (e.g. WEB-INF\lib in</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * a servlet container) then fall back to the system classloader.</em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> */</em>
<a name="116" href="#116">116</a>
<a name="117" href="#117">117</a> <strong class="jxr_keyword">try</strong>
<a name="118" href="#118">118</a> {
<a name="119" href="#119">119</a> result = ClassUtils.getResourceAsStream( getClass(), name );
<a name="120" href="#120">120</a> }
<a name="121" href="#121">121</a> <strong class="jxr_keyword">catch</strong>( Exception fnfe )
<a name="122" href="#122">122</a> {
<a name="123" href="#123">123</a> <strong class="jxr_keyword">throw</strong> (ResourceNotFoundException) ExceptionUtils.createWithCause(ResourceNotFoundException.<strong class="jxr_keyword">class</strong>, <span class="jxr_string">"problem with template: "</span> + name, fnfe );
<a name="124" href="#124">124</a> }
<a name="125" href="#125">125</a>
<a name="126" href="#126">126</a> <strong class="jxr_keyword">if</strong> (result == <strong class="jxr_keyword">null</strong>)
<a name="127" href="#127">127</a> {
<a name="128" href="#128">128</a> String msg = <span class="jxr_string">"ClasspathResourceLoader Error: cannot find resource "</span> +
<a name="129" href="#129">129</a> name;
<a name="130" href="#130">130</a>
<a name="131" href="#131">131</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/velocity/exception/ResourceNotFoundException.html">ResourceNotFoundException</a>( msg );
<a name="132" href="#132">132</a> }
<a name="133" href="#133">133</a>
<a name="134" href="#134">134</a> <strong class="jxr_keyword">return</strong> result;
<a name="135" href="#135">135</a> }
<a name="136" href="#136">136</a>
<a name="137" href="#137">137</a> <em class="jxr_javadoccomment">/**</em>
<a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#isSourceModified(org.apache.velocity.runtime.resource.Resource)</em>
<a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> */</em>
<a name="140" href="#140">140</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isSourceModified(<a href="../../../../../../org/apache/velocity/runtime/resource/Resource.html">Resource</a> resource)
<a name="141" href="#141">141</a> {
<a name="142" href="#142">142</a> <strong class="jxr_keyword">return</strong> false;
<a name="143" href="#143">143</a> }
<a name="144" href="#144">144</a>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">/**</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#getLastModified(org.apache.velocity.runtime.resource.Resource)</em>
<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> */</em>
<a name="148" href="#148">148</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getLastModified(<a href="../../../../../../org/apache/velocity/runtime/resource/Resource.html">Resource</a> resource)
<a name="149" href="#149">149</a> {
<a name="150" href="#150">150</a> <strong class="jxr_keyword">return</strong> 0;
<a name="151" href="#151">151</a> }
<a name="152" href="#152">152</a> }
<a name="153" href="#153">153</a>
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>