| <!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>DataSourceResourceLoader 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/DataSourceResourceLoader.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.BufferedInputStream; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.InputStream; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.sql.Connection; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.sql.PreparedStatement; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.sql.ResultSet; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.sql.SQLException; |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.sql.Timestamp; |
| <a name="29" href="#29">29</a> |
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> javax.naming.InitialContext; |
| <a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> javax.naming.NamingException; |
| <a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> javax.sql.DataSource; |
| <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.velocity.exception.ResourceNotFoundException; |
| <a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.resource.Resource; |
| <a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.ExceptionUtils; |
| <a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.StringUtils; |
| <a name="39" href="#39">39</a> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * <P>This is a simple template file loader that loads templates</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * from a DataSource instead of plain files.</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * <P>It can be configured with a datasource name, a table name,</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * id column (name), content column (the template body) and a</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * datetime column (for last modification info).</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * <br></em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * <br></em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * Example configuration snippet for velocity.properties:</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * <br></em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * <br></em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * resource.loader = file, ds <br></em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * <br></em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * ds.resource.loader.public.name = DataSource <br></em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * ds.resource.loader.description = Velocity DataSource Resource Loader <br></em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * ds.resource.loader.class = org.apache.velocity.runtime.resource.loader.DataSourceResourceLoader <br></em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * ds.resource.loader.resource.datasource = java:comp/env/jdbc/Velocity <br></em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * ds.resource.loader.resource.table = tb_velocity_template <br></em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * ds.resource.loader.resource.keycolumn = id_template <br></em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * ds.resource.loader.resource.templatecolumn = template_definition <br></em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * ds.resource.loader.resource.timestampcolumn = template_timestamp <br></em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * ds.resource.loader.cache = false <br></em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * ds.resource.loader.modificationCheckInterval = 60 <br></em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * <br></em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * <P>Optionally, the developer can instantiate the DataSourceResourceLoader and set the DataSource via code in</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * a manner similar to the following:</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * <BR></em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * <BR></em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * DataSourceResourceLoader ds = new DataSourceResourceLoader();<BR></em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * ds.setDataSource(DATASOURCE);<BR></em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * Velocity.setProperty("ds.resource.loader.instance",ds);<BR></em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * <P> The property <code>ds.resource.loader.class</code> should be left out, otherwise all the other</em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * properties in velocity.properties would remain the same.</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * <BR></em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * <BR></em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * Example WEB-INF/web.xml: <br></em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * <br></em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * <resource-ref> <br></em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * <description>Velocity template DataSource</description> <br></em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * <res-ref-name>jdbc/Velocity</res-ref-name> <br></em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * <res-type>javax.sql.DataSource</res-type> <br></em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * <res-auth>Container</res-auth> <br></em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * </resource-ref> <br></em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * <br></em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * <br></em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * and Tomcat 4 server.xml file: <br></em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * [...] <br></em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * <Context path="/exampleVelocity" docBase="exampleVelocity" debug="0"> <br></em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * [...] <br></em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * <ResourceParams name="jdbc/Velocity"> <br></em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * <parameter> <br></em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * <name>driverClassName</name> <br></em> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * <value>org.hsql.jdbcDriver</value> <br></em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * </parameter> <br></em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * <parameter> <br></em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * <name>driverName</name> <br></em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * <value>jdbc:HypersonicSQL:database</value> <br></em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * </parameter> <br></em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * <parameter> <br></em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * <name>user</name> <br></em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * <value>database_username</value> <br></em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * </parameter> <br></em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * <parameter> <br></em> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * <name>password</name> <br></em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * <value>database_password</value> <br></em> |
| <a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * </parameter> <br></em> |
| <a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * </ResourceParams> <br></em> |
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * [...] <br></em> |
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * </Context> <br></em> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * [...] <br></em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * <br></em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * Example sql script:<br></em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * CREATE TABLE tb_velocity_template ( <br></em> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * id_template varchar (40) NOT NULL , <br></em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * template_definition text (16) NOT NULL , <br></em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * template_timestamp datetime NOT NULL <br></em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * ) <br></em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:wglass@forio.com" target="alexandria_uri">mailto:wglass@forio.com</a>">Will Glass-Husain</a></em> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:matt@raibledesigns.com" target="alexandria_uri">mailto:matt@raibledesigns.com</a>">Matt Raible</a></em> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:david.kinnvall@alertir.com" target="alexandria_uri">mailto:david.kinnvall@alertir.com</a>">David Kinnvall</a></em> |
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:paulo.gaspar@krankikom.de" target="alexandria_uri">mailto:paulo.gaspar@krankikom.de</a>">Paulo Gaspar</a></em> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:lachiewicz@plusnet.pl" target="alexandria_uri">mailto:lachiewicz@plusnet.pl</a>">Sylwester Lachiewicz</a></em> |
| <a name="125" href="#125">125</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="126" href="#126">126</a> <em class="jxr_javadoccomment"> * @version $Id: DataSourceResourceLoader.java 471259 2006-11-04 20:26:57Z henning $</em> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="128" href="#128">128</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/velocity/runtime/resource/loader/DataSourceResourceLoader.html">DataSourceResourceLoader</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/velocity/runtime/resource/loader/ResourceLoader.html">ResourceLoader</a> |
| <a name="129" href="#129">129</a> { |
| <a name="130" href="#130">130</a> <strong class="jxr_keyword">private</strong> String dataSourceName; |
| <a name="131" href="#131">131</a> <strong class="jxr_keyword">private</strong> String tableName; |
| <a name="132" href="#132">132</a> <strong class="jxr_keyword">private</strong> String keyColumn; |
| <a name="133" href="#133">133</a> <strong class="jxr_keyword">private</strong> String templateColumn; |
| <a name="134" href="#134">134</a> <strong class="jxr_keyword">private</strong> String timestampColumn; |
| <a name="135" href="#135">135</a> <strong class="jxr_keyword">private</strong> InitialContext ctx; |
| <a name="136" href="#136">136</a> <strong class="jxr_keyword">private</strong> DataSource dataSource; |
| <a name="137" href="#137">137</a> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#init(org.apache.commons.collections.ExtendedProperties)</em> |
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="141" href="#141">141</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init(ExtendedProperties configuration) |
| <a name="142" href="#142">142</a> { |
| <a name="143" href="#143">143</a> dataSourceName = StringUtils.nullTrim(configuration.getString(<span class="jxr_string">"resource.datasource"</span>)); |
| <a name="144" href="#144">144</a> tableName = StringUtils.nullTrim(configuration.getString(<span class="jxr_string">"resource.table"</span>)); |
| <a name="145" href="#145">145</a> keyColumn = StringUtils.nullTrim(configuration.getString(<span class="jxr_string">"resource.keycolumn"</span>)); |
| <a name="146" href="#146">146</a> templateColumn = StringUtils.nullTrim(configuration.getString(<span class="jxr_string">"resource.templatecolumn"</span>)); |
| <a name="147" href="#147">147</a> timestampColumn = StringUtils.nullTrim(configuration.getString(<span class="jxr_string">"resource.timestampcolumn"</span>)); |
| <a name="148" href="#148">148</a> |
| <a name="149" href="#149">149</a> <strong class="jxr_keyword">if</strong> (dataSource != <strong class="jxr_keyword">null</strong>) |
| <a name="150" href="#150">150</a> { |
| <a name="151" href="#151">151</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) |
| <a name="152" href="#152">152</a> { |
| <a name="153" href="#153">153</a> log.debug(<span class="jxr_string">"DataSourceResourceLoader: using dataSource instance with table \""</span> |
| <a name="154" href="#154">154</a> + tableName + <span class="jxr_string">"\""</span>); |
| <a name="155" href="#155">155</a> log.debug(<span class="jxr_string">"DataSourceResourceLoader: using columns \""</span> |
| <a name="156" href="#156">156</a> + keyColumn + <span class="jxr_string">"\", \""</span> + templateColumn + <span class="jxr_string">"\" and \""</span> |
| <a name="157" href="#157">157</a> + timestampColumn + <span class="jxr_string">"\""</span>); |
| <a name="158" href="#158">158</a> } |
| <a name="159" href="#159">159</a> |
| <a name="160" href="#160">160</a> log.trace(<span class="jxr_string">"DataSourceResourceLoader initialized."</span>); |
| <a name="161" href="#161">161</a> } |
| <a name="162" href="#162">162</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (dataSourceName != <strong class="jxr_keyword">null</strong>) |
| <a name="163" href="#163">163</a> { |
| <a name="164" href="#164">164</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) |
| <a name="165" href="#165">165</a> { |
| <a name="166" href="#166">166</a> log.debug(<span class="jxr_string">"DataSourceResourceLoader: using \""</span> + dataSourceName |
| <a name="167" href="#167">167</a> + <span class="jxr_string">"\" datasource with table \""</span> + tableName + <span class="jxr_string">"\""</span>); |
| <a name="168" href="#168">168</a> log.debug(<span class="jxr_string">"DataSourceResourceLoader: using columns \""</span> |
| <a name="169" href="#169">169</a> + keyColumn + <span class="jxr_string">"\", \""</span> + templateColumn + <span class="jxr_string">"\" and \""</span> |
| <a name="170" href="#170">170</a> + timestampColumn + <span class="jxr_string">"\""</span>); |
| <a name="171" href="#171">171</a> } |
| <a name="172" href="#172">172</a> |
| <a name="173" href="#173">173</a> log.trace(<span class="jxr_string">"DataSourceResourceLoader initialized."</span>); |
| <a name="174" href="#174">174</a> } |
| <a name="175" href="#175">175</a> <strong class="jxr_keyword">else</strong> |
| <a name="176" href="#176">176</a> { |
| <a name="177" href="#177">177</a> log.warn(<span class="jxr_string">"DataSourceResourceLoader not properly initialized. No DataSource was identified."</span>); |
| <a name="178" href="#178">178</a> } |
| <a name="179" href="#179">179</a> } |
| <a name="180" href="#180">180</a> |
| <a name="181" href="#181">181</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * Set the DataSource used by this resource loader. Call this as an alternative to</em> |
| <a name="183" href="#183">183</a> <em class="jxr_javadoccomment"> * specifying the data source name via properties.</em> |
| <a name="184" href="#184">184</a> <em class="jxr_javadoccomment"> * @param dataSource The data source for this ResourceLoader.</em> |
| <a name="185" href="#185">185</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="186" href="#186">186</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setDataSource(<strong class="jxr_keyword">final</strong> DataSource dataSource) |
| <a name="187" href="#187">187</a> { |
| <a name="188" href="#188">188</a> <strong class="jxr_keyword">this</strong>.dataSource = dataSource; |
| <a name="189" href="#189">189</a> } |
| <a name="190" href="#190">190</a> |
| <a name="191" href="#191">191</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="192" href="#192">192</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#isSourceModified(org.apache.velocity.runtime.resource.Resource)</em> |
| <a name="193" href="#193">193</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="194" href="#194">194</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="195" href="#195">195</a> { |
| <a name="196" href="#196">196</a> <strong class="jxr_keyword">return</strong> (resource.getLastModified() != |
| <a name="197" href="#197">197</a> readLastModified(resource, <span class="jxr_string">"checking timestamp"</span>)); |
| <a name="198" href="#198">198</a> } |
| <a name="199" href="#199">199</a> |
| <a name="200" href="#200">200</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#getLastModified(org.apache.velocity.runtime.resource.Resource)</em> |
| <a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="203" href="#203">203</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="204" href="#204">204</a> { |
| <a name="205" href="#205">205</a> <strong class="jxr_keyword">return</strong> readLastModified(resource, <span class="jxr_string">"getting timestamp"</span>); |
| <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"> * Get an InputStream so that the Runtime can build a</em> |
| <a name="210" href="#210">210</a> <em class="jxr_javadoccomment"> * template with it.</em> |
| <a name="211" href="#211">211</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="212" href="#212">212</a> <em class="jxr_javadoccomment"> * @param name name of template</em> |
| <a name="213" href="#213">213</a> <em class="jxr_javadoccomment"> * @return InputStream containing template</em> |
| <a name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * @throws ResourceNotFoundException</em> |
| <a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="216" href="#216">216</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> InputStream getResourceStream(<strong class="jxr_keyword">final</strong> String name) |
| <a name="217" href="#217">217</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../../../org/apache/velocity/exception/ResourceNotFoundException.html">ResourceNotFoundException</a> |
| <a name="218" href="#218">218</a> { |
| <a name="219" href="#219">219</a> <strong class="jxr_keyword">if</strong> (org.apache.commons.lang.StringUtils.isEmpty(name)) |
| <a name="220" href="#220">220</a> { |
| <a name="221" href="#221">221</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">"DataSourceResourceLoader: "</span> |
| <a name="222" href="#222">222</a> + <span class="jxr_string">"Template name was empty or null"</span>); |
| <a name="223" href="#223">223</a> } |
| <a name="224" href="#224">224</a> |
| <a name="225" href="#225">225</a> Connection conn = <strong class="jxr_keyword">null</strong>; |
| <a name="226" href="#226">226</a> ResultSet rs = <strong class="jxr_keyword">null</strong>; |
| <a name="227" href="#227">227</a> <strong class="jxr_keyword">try</strong> |
| <a name="228" href="#228">228</a> { |
| <a name="229" href="#229">229</a> conn = openDbConnection(); |
| <a name="230" href="#230">230</a> rs = readData(conn, templateColumn, name); |
| <a name="231" href="#231">231</a> |
| <a name="232" href="#232">232</a> <strong class="jxr_keyword">if</strong> (rs.next()) |
| <a name="233" href="#233">233</a> { |
| <a name="234" href="#234">234</a> InputStream ascStream = rs.getAsciiStream(templateColumn); |
| <a name="235" href="#235">235</a> <strong class="jxr_keyword">if</strong> (ascStream == <strong class="jxr_keyword">null</strong>) |
| <a name="236" href="#236">236</a> { |
| <a name="237" href="#237">237</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ResourceNotFoundException(<span class="jxr_string">"DataSourceResourceLoader: "</span> |
| <a name="238" href="#238">238</a> + <span class="jxr_string">"template column for '"</span> + name + <span class="jxr_string">"' is null"</span>); |
| <a name="239" href="#239">239</a> } |
| <a name="240" href="#240">240</a> |
| <a name="241" href="#241">241</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> BufferedInputStream(ascStream); |
| <a name="242" href="#242">242</a> } |
| <a name="243" href="#243">243</a> <strong class="jxr_keyword">else</strong> |
| <a name="244" href="#244">244</a> { |
| <a name="245" href="#245">245</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ResourceNotFoundException(<span class="jxr_string">"DataSourceResourceLoader: "</span> |
| <a name="246" href="#246">246</a> + <span class="jxr_string">"could not find resource '"</span> + name + <span class="jxr_string">"'"</span>); |
| <a name="247" href="#247">247</a> |
| <a name="248" href="#248">248</a> } |
| <a name="249" href="#249">249</a> } |
| <a name="250" href="#250">250</a> <strong class="jxr_keyword">catch</strong>(SQLException sqle) |
| <a name="251" href="#251">251</a> { |
| <a name="252" href="#252">252</a> String msg = <span class="jxr_string">"DataSourceResourceLoader: database problem while getting resource '"</span> |
| <a name="253" href="#253">253</a> + name + <span class="jxr_string">"': "</span>; |
| <a name="254" href="#254">254</a> |
| <a name="255" href="#255">255</a> log.error(msg, sqle); |
| <a name="256" href="#256">256</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="257" href="#257">257</a> } |
| <a name="258" href="#258">258</a> <strong class="jxr_keyword">catch</strong>(NamingException ne) |
| <a name="259" href="#259">259</a> { |
| <a name="260" href="#260">260</a> String msg = <span class="jxr_string">"DataSourceResourceLoader: database problem while getting resource '"</span> |
| <a name="261" href="#261">261</a> + name + <span class="jxr_string">"': "</span>; |
| <a name="262" href="#262">262</a> |
| <a name="263" href="#263">263</a> log.error(msg, ne); |
| <a name="264" href="#264">264</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="265" href="#265">265</a> } |
| <a name="266" href="#266">266</a> <strong class="jxr_keyword">finally</strong> |
| <a name="267" href="#267">267</a> { |
| <a name="268" href="#268">268</a> closeResultSet(rs); |
| <a name="269" href="#269">269</a> closeDbConnection(conn); |
| <a name="270" href="#270">270</a> } |
| <a name="271" href="#271">271</a> } |
| <a name="272" href="#272">272</a> |
| <a name="273" href="#273">273</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="274" href="#274">274</a> <em class="jxr_javadoccomment"> * Fetches the last modification time of the resource</em> |
| <a name="275" href="#275">275</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="276" href="#276">276</a> <em class="jxr_javadoccomment"> * @param resource Resource object we are finding timestamp of</em> |
| <a name="277" href="#277">277</a> <em class="jxr_javadoccomment"> * @param operation string for logging, indicating caller's intention</em> |
| <a name="278" href="#278">278</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="279" href="#279">279</a> <em class="jxr_javadoccomment"> * @return timestamp as long</em> |
| <a name="280" href="#280">280</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="281" href="#281">281</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">long</strong> readLastModified(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/velocity/runtime/resource/Resource.html">Resource</a> resource, <strong class="jxr_keyword">final</strong> String operation) |
| <a name="282" href="#282">282</a> { |
| <a name="283" href="#283">283</a> <strong class="jxr_keyword">long</strong> timeStamp = 0; |
| <a name="284" href="#284">284</a> |
| <a name="285" href="#285">285</a> <em class="jxr_comment">/*</em> |
| <a name="286" href="#286">286</a> <em class="jxr_comment"> * get the template name from the resource</em> |
| <a name="287" href="#287">287</a> <em class="jxr_comment"> */</em> |
| <a name="288" href="#288">288</a> String name = resource.getName(); |
| <a name="289" href="#289">289</a> |
| <a name="290" href="#290">290</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong> || name.length() == 0) |
| <a name="291" href="#291">291</a> { |
| <a name="292" href="#292">292</a> log.error(<span class="jxr_string">"DataSourceResourceLoader: "</span> |
| <a name="293" href="#293">293</a> + <span class="jxr_string">"Template name was empty or null"</span>); |
| <a name="294" href="#294">294</a> } |
| <a name="295" href="#295">295</a> <strong class="jxr_keyword">else</strong> |
| <a name="296" href="#296">296</a> { |
| <a name="297" href="#297">297</a> Connection conn = <strong class="jxr_keyword">null</strong>; |
| <a name="298" href="#298">298</a> ResultSet rs = <strong class="jxr_keyword">null</strong>; |
| <a name="299" href="#299">299</a> |
| <a name="300" href="#300">300</a> <strong class="jxr_keyword">try</strong> |
| <a name="301" href="#301">301</a> { |
| <a name="302" href="#302">302</a> conn = openDbConnection(); |
| <a name="303" href="#303">303</a> rs = readData(conn, timestampColumn, name); |
| <a name="304" href="#304">304</a> |
| <a name="305" href="#305">305</a> <strong class="jxr_keyword">if</strong> (rs.next()) |
| <a name="306" href="#306">306</a> { |
| <a name="307" href="#307">307</a> Timestamp ts = rs.getTimestamp(timestampColumn); |
| <a name="308" href="#308">308</a> timeStamp = ts != <strong class="jxr_keyword">null</strong> ? ts.getTime() : 0; |
| <a name="309" href="#309">309</a> } |
| <a name="310" href="#310">310</a> <strong class="jxr_keyword">else</strong> |
| <a name="311" href="#311">311</a> { |
| <a name="312" href="#312">312</a> log.error(<span class="jxr_string">"DataSourceResourceLoader: could not find resource "</span> |
| <a name="313" href="#313">313</a> + name + <span class="jxr_string">" while "</span> + operation); |
| <a name="314" href="#314">314</a> } |
| <a name="315" href="#315">315</a> } |
| <a name="316" href="#316">316</a> <strong class="jxr_keyword">catch</strong>(SQLException sqle) |
| <a name="317" href="#317">317</a> { |
| <a name="318" href="#318">318</a> String msg = <span class="jxr_string">"DataSourceResourceLoader: database problem while "</span> + operation + <span class="jxr_string">" of '"</span> |
| <a name="319" href="#319">319</a> + name + <span class="jxr_string">"': "</span>; |
| <a name="320" href="#320">320</a> |
| <a name="321" href="#321">321</a> log.error(msg, sqle); |
| <a name="322" href="#322">322</a> <strong class="jxr_keyword">throw</strong> ExceptionUtils.createRuntimeException(msg, sqle); |
| <a name="323" href="#323">323</a> } |
| <a name="324" href="#324">324</a> <strong class="jxr_keyword">catch</strong>(NamingException ne) |
| <a name="325" href="#325">325</a> { |
| <a name="326" href="#326">326</a> String msg = <span class="jxr_string">"DataSourceResourceLoader: database problem while "</span> + operation + <span class="jxr_string">" of '"</span> |
| <a name="327" href="#327">327</a> + name + <span class="jxr_string">"': "</span>; |
| <a name="328" href="#328">328</a> |
| <a name="329" href="#329">329</a> log.error(msg, ne); |
| <a name="330" href="#330">330</a> <strong class="jxr_keyword">throw</strong> ExceptionUtils.createRuntimeException(msg, ne); |
| <a name="331" href="#331">331</a> } |
| <a name="332" href="#332">332</a> <strong class="jxr_keyword">finally</strong> |
| <a name="333" href="#333">333</a> { |
| <a name="334" href="#334">334</a> closeResultSet(rs); |
| <a name="335" href="#335">335</a> closeDbConnection(conn); |
| <a name="336" href="#336">336</a> } |
| <a name="337" href="#337">337</a> } |
| <a name="338" href="#338">338</a> <strong class="jxr_keyword">return</strong> timeStamp; |
| <a name="339" href="#339">339</a> } |
| <a name="340" href="#340">340</a> |
| <a name="341" href="#341">341</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="342" href="#342">342</a> <em class="jxr_javadoccomment"> * Gets connection to the datasource specified through the configuration</em> |
| <a name="343" href="#343">343</a> <em class="jxr_javadoccomment"> * parameters.</em> |
| <a name="344" href="#344">344</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="345" href="#345">345</a> <em class="jxr_javadoccomment"> * @return connection</em> |
| <a name="346" href="#346">346</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="347" href="#347">347</a> <strong class="jxr_keyword">private</strong> Connection openDbConnection() |
| <a name="348" href="#348">348</a> <strong class="jxr_keyword">throws</strong> NamingException, SQLException |
| <a name="349" href="#349">349</a> { |
| <a name="350" href="#350">350</a> <strong class="jxr_keyword">if</strong> (dataSource != <strong class="jxr_keyword">null</strong>) |
| <a name="351" href="#351">351</a> { |
| <a name="352" href="#352">352</a> <strong class="jxr_keyword">return</strong> dataSource.getConnection(); |
| <a name="353" href="#353">353</a> } |
| <a name="354" href="#354">354</a> |
| <a name="355" href="#355">355</a> <strong class="jxr_keyword">if</strong> (ctx == <strong class="jxr_keyword">null</strong>) |
| <a name="356" href="#356">356</a> { |
| <a name="357" href="#357">357</a> ctx = <strong class="jxr_keyword">new</strong> InitialContext(); |
| <a name="358" href="#358">358</a> } |
| <a name="359" href="#359">359</a> |
| <a name="360" href="#360">360</a> dataSource = (DataSource) ctx.lookup(dataSourceName); |
| <a name="361" href="#361">361</a> |
| <a name="362" href="#362">362</a> <strong class="jxr_keyword">return</strong> dataSource.getConnection(); |
| <a name="363" href="#363">363</a> } |
| <a name="364" href="#364">364</a> |
| <a name="365" href="#365">365</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="366" href="#366">366</a> <em class="jxr_javadoccomment"> * Closes connection to the datasource</em> |
| <a name="367" href="#367">367</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="368" href="#368">368</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> closeDbConnection(<strong class="jxr_keyword">final</strong> Connection conn) |
| <a name="369" href="#369">369</a> { |
| <a name="370" href="#370">370</a> <strong class="jxr_keyword">if</strong> (conn != <strong class="jxr_keyword">null</strong>) |
| <a name="371" href="#371">371</a> { |
| <a name="372" href="#372">372</a> <strong class="jxr_keyword">try</strong> |
| <a name="373" href="#373">373</a> { |
| <a name="374" href="#374">374</a> conn.close(); |
| <a name="375" href="#375">375</a> } |
| <a name="376" href="#376">376</a> <strong class="jxr_keyword">catch</strong> (RuntimeException re) |
| <a name="377" href="#377">377</a> { |
| <a name="378" href="#378">378</a> <strong class="jxr_keyword">throw</strong> re; |
| <a name="379" href="#379">379</a> } |
| <a name="380" href="#380">380</a> <strong class="jxr_keyword">catch</strong> (Exception e) |
| <a name="381" href="#381">381</a> { |
| <a name="382" href="#382">382</a> log.warn(<span class="jxr_string">"DataSourceResourceLoader: problem when closing connection"</span>, e); |
| <a name="383" href="#383">383</a> } |
| <a name="384" href="#384">384</a> } |
| <a name="385" href="#385">385</a> } |
| <a name="386" href="#386">386</a> |
| <a name="387" href="#387">387</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="388" href="#388">388</a> <em class="jxr_javadoccomment"> * Closes the result set.</em> |
| <a name="389" href="#389">389</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="390" href="#390">390</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> closeResultSet(<strong class="jxr_keyword">final</strong> ResultSet rs) |
| <a name="391" href="#391">391</a> { |
| <a name="392" href="#392">392</a> <strong class="jxr_keyword">if</strong> (rs != <strong class="jxr_keyword">null</strong>) |
| <a name="393" href="#393">393</a> { |
| <a name="394" href="#394">394</a> <strong class="jxr_keyword">try</strong> |
| <a name="395" href="#395">395</a> { |
| <a name="396" href="#396">396</a> rs.close(); |
| <a name="397" href="#397">397</a> } |
| <a name="398" href="#398">398</a> <strong class="jxr_keyword">catch</strong> (RuntimeException re) |
| <a name="399" href="#399">399</a> { |
| <a name="400" href="#400">400</a> <strong class="jxr_keyword">throw</strong> re; |
| <a name="401" href="#401">401</a> } |
| <a name="402" href="#402">402</a> <strong class="jxr_keyword">catch</strong> (Exception e) |
| <a name="403" href="#403">403</a> { |
| <a name="404" href="#404">404</a> log.warn(<span class="jxr_string">"DataSourceResourceLoader: problem when closing result set: "</span>, e); |
| <a name="405" href="#405">405</a> } |
| <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> <em class="jxr_javadoccomment">/**</em> |
| <a name="410" href="#410">410</a> <em class="jxr_javadoccomment"> * Reads the data from the datasource. It simply does the following query :</em> |
| <a name="411" href="#411">411</a> <em class="jxr_javadoccomment"> * <br></em> |
| <a name="412" href="#412">412</a> <em class="jxr_javadoccomment"> * SELECT <i>columnNames</i> FROM <i>tableName</i> WHERE <i>keyColumn</i></em> |
| <a name="413" href="#413">413</a> <em class="jxr_javadoccomment"> * = '<i>templateName</i>'</em> |
| <a name="414" href="#414">414</a> <em class="jxr_javadoccomment"> * <br></em> |
| <a name="415" href="#415">415</a> <em class="jxr_javadoccomment"> * where <i>keyColumn</i> is a class member set in init()</em> |
| <a name="416" href="#416">416</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="417" href="#417">417</a> <em class="jxr_javadoccomment"> * @param conn connection to datasource</em> |
| <a name="418" href="#418">418</a> <em class="jxr_javadoccomment"> * @param columnNames columns to fetch from datasource</em> |
| <a name="419" href="#419">419</a> <em class="jxr_javadoccomment"> * @param templateName name of template to fetch</em> |
| <a name="420" href="#420">420</a> <em class="jxr_javadoccomment"> * @return result set from query</em> |
| <a name="421" href="#421">421</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="422" href="#422">422</a> <strong class="jxr_keyword">private</strong> ResultSet readData(<strong class="jxr_keyword">final</strong> Connection conn, <strong class="jxr_keyword">final</strong> String columnNames, <strong class="jxr_keyword">final</strong> String templateName) |
| <a name="423" href="#423">423</a> <strong class="jxr_keyword">throws</strong> SQLException |
| <a name="424" href="#424">424</a> { |
| <a name="425" href="#425">425</a> PreparedStatement ps = conn.prepareStatement(<span class="jxr_string">"SELECT "</span> + columnNames + <span class="jxr_string">" FROM "</span>+ tableName + <span class="jxr_string">" WHERE "</span> + keyColumn + <span class="jxr_string">" = ?"</span>); |
| <a name="426" href="#426">426</a> ps.setString(1, templateName); |
| <a name="427" href="#427">427</a> <strong class="jxr_keyword">return</strong> ps.executeQuery(); |
| <a name="428" href="#428">428</a> } |
| <a name="429" href="#429">429</a> } |
| <a name="430" href="#430">430</a> |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
