| <!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>EscapeReference xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../../apidocs/org/apache/velocity/app/event/implement/EscapeReference.html">View Javadoc</a></div><pre> |
| |
| <a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.velocity.app.event.implement; |
| <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> org.apache.oro.text.perl.MalformedPerl5PatternException; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.oro.text.perl.Perl5Util; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.app.event.ReferenceInsertionEventHandler; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.RuntimeServices; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.RuntimeServicesAware; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.StringUtils; |
| <a name="28" href="#28">28</a> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * Base class for escaping references. To use it, override the following methods:</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * <DL></em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * <DT><code>String escape(String text)</code></DT></em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * <DD>escape the provided text</DD></em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * <DT><code>String getMatchAttribute()</code></DT></em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * <DD>retrieve the configuration attribute used to match references (see below)</DD></em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * </DL></em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * <P>By default, all references are escaped. However, by setting the match attribute</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * in the configuration file to a regular expression, users can specify which references</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * to escape. For example the following configuration property tells the EscapeSqlReference</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * event handler to only escape references that start with "sql".</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * (e.g. <code>$sql</code>, <code>$sql.toString(),</code>, etc).</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * <PRE></em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * <CODE>eventhandler.escape.sql.match = /sql.*<!-- -->/</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * </CODE></em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * </PRE></em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * <!-- note: ignore empty HTML comment above - breaks up star slash avoiding javadoc end --></em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * Regular expressions should follow the "Perl5" format used by the ORO regular expression</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * library. More info is at</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://jakarta.apache.org/oro/api/org/apache/oro/text/perl/package-summary.html" target="alexandria_uri">http://jakarta.apache.org/oro/api/org/apache/oro/text/perl/package-summary.html</a>"><a href="http://jakarta.apache.org/oro/api/org/apache/oro/text/perl/package-summary.html" target="alexandria_uri">http://jakarta.apache.org/oro/api/org/apache/oro/text/perl/package-summary.html</a></a>.</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="54" href="#54">54</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="55" href="#55">55</a> <em class="jxr_javadoccomment"> * @version $Id: EscapeReference.java 470256 2006-11-02 07:20:36Z wglass $</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="57" href="#57">57</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/velocity/app/event/implement/EscapeReference.html">EscapeReference</a> implements ReferenceInsertionEventHandler,RuntimeServicesAware { |
| <a name="58" href="#58">58</a> |
| <a name="59" href="#59">59</a> |
| <a name="60" href="#60">60</a> <strong class="jxr_keyword">private</strong> Perl5Util perl = <strong class="jxr_keyword">new</strong> Perl5Util(); |
| <a name="61" href="#61">61</a> |
| <a name="62" href="#62">62</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/velocity/runtime/RuntimeServices.html">RuntimeServices</a> rs; |
| <a name="63" href="#63">63</a> |
| <a name="64" href="#64">64</a> <strong class="jxr_keyword">private</strong> String matchRegExp = <strong class="jxr_keyword">null</strong>; |
| <a name="65" href="#65">65</a> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * Escape the given text. Override this in a subclass to do the actual</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * escaping.</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * @param text the text to escape</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @return the escaped text</em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="73" href="#73">73</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> String escape(Object text); |
| <a name="74" href="#74">74</a> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * Specify the configuration attribute that specifies the</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * regular expression. Ideally should be in a form</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * <pre><code>eventhandler.escape.XYZ.match</code></pre></em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * <p>where <code>XYZ</code> is the type of escaping being done.</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * @return configuration attribute</em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="83" href="#83">83</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> String getMatchAttribute(); |
| <a name="84" href="#84">84</a> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * Escape the provided text if it matches the configured regular expression.</em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * </em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * @param reference</em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * @param value</em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * @return Escaped text.</em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="92" href="#92">92</a> <strong class="jxr_keyword">public</strong> Object referenceInsert(String reference, Object value) |
| <a name="93" href="#93">93</a> { |
| <a name="94" href="#94">94</a> <strong class="jxr_keyword">if</strong>(value == <strong class="jxr_keyword">null</strong>) |
| <a name="95" href="#95">95</a> { |
| <a name="96" href="#96">96</a> <strong class="jxr_keyword">return</strong> value; |
| <a name="97" href="#97">97</a> } |
| <a name="98" href="#98">98</a> |
| <a name="99" href="#99">99</a> <strong class="jxr_keyword">if</strong> (matchRegExp == <strong class="jxr_keyword">null</strong>) |
| <a name="100" href="#100">100</a> { |
| <a name="101" href="#101">101</a> <strong class="jxr_keyword">return</strong> escape(value); |
| <a name="102" href="#102">102</a> } |
| <a name="103" href="#103">103</a> |
| <a name="104" href="#104">104</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (perl.match(matchRegExp,reference)) |
| <a name="105" href="#105">105</a> { |
| <a name="106" href="#106">106</a> <strong class="jxr_keyword">return</strong> escape(value); |
| <a name="107" href="#107">107</a> } |
| <a name="108" href="#108">108</a> |
| <a name="109" href="#109">109</a> <strong class="jxr_keyword">else</strong> |
| <a name="110" href="#110">110</a> { |
| <a name="111" href="#111">111</a> <strong class="jxr_keyword">return</strong> value; |
| <a name="112" href="#112">112</a> } |
| <a name="113" href="#113">113</a> } |
| <a name="114" href="#114">114</a> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * Called automatically when event cartridge is initialized.</em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * </em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * @param rs instance of RuntimeServices</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="120" href="#120">120</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRuntimeServices(<a href="../../../../../../org/apache/velocity/runtime/RuntimeServices.html">RuntimeServices</a> rs) |
| <a name="121" href="#121">121</a> { |
| <a name="122" href="#122">122</a> <strong class="jxr_keyword">this</strong>.rs = rs; |
| <a name="123" href="#123">123</a> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * Get the regular expression pattern.</em> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="127" href="#127">127</a> matchRegExp = StringUtils.nullTrim(rs.getConfiguration().getString(getMatchAttribute())); |
| <a name="128" href="#128">128</a> <strong class="jxr_keyword">if</strong> ((matchRegExp != <strong class="jxr_keyword">null</strong>) && (matchRegExp.length() == 0)) |
| <a name="129" href="#129">129</a> { |
| <a name="130" href="#130">130</a> matchRegExp = <strong class="jxr_keyword">null</strong>; |
| <a name="131" href="#131">131</a> } |
| <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"> * Test the regular expression for a well formed pattern</em> |
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="136" href="#136">136</a> <strong class="jxr_keyword">if</strong> (matchRegExp != <strong class="jxr_keyword">null</strong>) |
| <a name="137" href="#137">137</a> { |
| <a name="138" href="#138">138</a> <strong class="jxr_keyword">try</strong> |
| <a name="139" href="#139">139</a> { |
| <a name="140" href="#140">140</a> perl.match(matchRegExp,<span class="jxr_string">""</span>); |
| <a name="141" href="#141">141</a> } |
| <a name="142" href="#142">142</a> <strong class="jxr_keyword">catch</strong> (MalformedPerl5PatternException E) |
| <a name="143" href="#143">143</a> { |
| <a name="144" href="#144">144</a> rs.getLog().error(<span class="jxr_string">"Invalid regular expression '"</span> + matchRegExp |
| <a name="145" href="#145">145</a> + <span class="jxr_string">"'. No escaping will be performed."</span>, E); |
| <a name="146" href="#146">146</a> matchRegExp = <strong class="jxr_keyword">null</strong>; |
| <a name="147" href="#147">147</a> } |
| <a name="148" href="#148">148</a> } |
| <a name="149" href="#149">149</a> |
| <a name="150" href="#150">150</a> } |
| <a name="151" href="#151">151</a> |
| <a name="152" href="#152">152</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * Retrieve a reference to RuntimeServices. Use this for checking additional</em> |
| <a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * configuration properties.</em> |
| <a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * </em> |
| <a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * @return The current runtime services object.</em> |
| <a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="158" href="#158">158</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/velocity/runtime/RuntimeServices.html">RuntimeServices</a> getRuntimeServices() |
| <a name="159" href="#159">159</a> { |
| <a name="160" href="#160">160</a> <strong class="jxr_keyword">return</strong> rs; |
| <a name="161" href="#161">161</a> } |
| <a name="162" href="#162">162</a> |
| <a name="163" href="#163">163</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
