Modified: websites/production/turbine/content/fulcrum/fulcrum-parser/xref/org/apache/fulcrum/parser/DefaultCookieParser.html ============================================================================== --- websites/production/turbine/content/fulcrum/fulcrum-parser/xref/org/apache/fulcrum/parser/DefaultCookieParser.html (original) +++ websites/production/turbine/content/fulcrum/fulcrum-parser/xref/org/apache/fulcrum/parser/DefaultCookieParser.html Thu Oct 3 10:37:43 2013 @@ -1,173 +1,172 @@ <!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" /> +<meta http-equiv="content-type" content="text/html; charset=UTF-8" /> <title>DefaultCookieParser xref</title> <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> </head> <body> <div id="overview"><a href="../../../../../apidocs/org/apache/fulcrum/parser/DefaultCookieParser.html">View Javadoc</a></div><pre> -<a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.fulcrum.parser; -<a name="2" href="#2">2</a> -<a name="3" href="#3">3</a> -<a name="4" href="#4">4</a> <em class="jxr_comment">/*</em> -<a name="5" href="#5">5</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> -<a name="6" href="#6">6</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> -<a name="7" href="#7">7</a> <em class="jxr_comment"> * distributed with this work for additional information</em> -<a name="8" href="#8">8</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> -<a name="9" href="#9">9</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> -<a name="10" href="#10">10</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> -<a name="11" href="#11">11</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> -<a name="12" href="#12">12</a> <em class="jxr_comment"> *</em> -<a name="13" href="#13">13</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="14" href="#14">14</a> <em class="jxr_comment"> *</em> -<a name="15" href="#15">15</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> -<a name="16" href="#16">16</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> -<a name="17" href="#17">17</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> -<a name="18" href="#18">18</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> -<a name="19" href="#19">19</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> -<a name="20" href="#20">20</a> <em class="jxr_comment"> * under the License.</em> -<a name="21" href="#21">21</a> <em class="jxr_comment"> */</em> -<a name="22" href="#22">22</a> -<a name="23" href="#23">23</a> -<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.Cookie; -<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest; -<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse; -<a name="27" href="#27">27</a> -<a name="28" href="#28">28</a> <em class="jxr_javadoccomment">/**</em> -<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * CookieParser is used to get and set values of Cookies on the Client</em> -<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * Browser. You can use CookieParser to convert Cookie values to</em> -<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * various types or to set Bean values with setParameters(). See the</em> -<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * Servlet Spec for more information on Cookies.</em> -<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * <p></em> -<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * Use set() or unset() to Create or Destroy Cookies.</em> -<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * <p></em> -<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * NOTE: The name= portion of a name=value pair may be converted</em> -<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * to lowercase or uppercase when the object is initialized and when</em> -<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * new data is added. This behaviour is determined by the url.case.folding</em> -<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * property in TurbineResources.properties. Adding a name/value pair may</em> -<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * overwrite existing name=value pairs if the names match:</em> -<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> *</em> -<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * <pre></em> -<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * CookieParser cp = data.getCookies();</em> -<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * cp.add("ERROR",1);</em> -<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * cp.add("eRrOr",2);</em> -<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * int result = cp.getInt("ERROR");</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"> *</em> -<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * In the above example, result is 2.</em> -<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> *</em> -<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Ilkka Priha</a></em> -<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Leon Messerschmidt</a></em> -<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Thomas Vandahl</a></em> -<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @version $Id: DefaultCookieParser.java 812786 2009-09-09 07:01:49Z tv $</em> -<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em> -<a name="56" href="#56">56</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/fulcrum/parser/DefaultCookieParser.html">DefaultCookieParser</a> -<a name="57" href="#57">57</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/fulcrum/parser/BaseValueParser.html">BaseValueParser</a> -<a name="58" href="#58">58</a> implements <a href="../../../../org/apache/fulcrum/parser/CookieParser.html">CookieParser</a> -<a name="59" href="#59">59</a> -<a name="60" href="#60">60</a> { -<a name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em> -<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * The servlet request objects to parse.</em> -<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> */</em> -<a name="64" href="#64">64</a> <strong class="jxr_keyword">private</strong> HttpServletRequest request; -<a name="65" href="#65">65</a> <strong class="jxr_keyword">private</strong> HttpServletResponse response; -<a name="66" href="#66">66</a> -<a name="67" href="#67">67</a> <em class="jxr_javadoccomment">/**</em> -<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * Constructs a new CookieParser.</em> -<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> */</em> -<a name="70" href="#70">70</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/fulcrum/parser/DefaultCookieParser.html">DefaultCookieParser</a>() -<a name="71" href="#71">71</a> { -<a name="72" href="#72">72</a> <strong class="jxr_keyword">super</strong>(); -<a name="73" href="#73">73</a> } -<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"> * Disposes the parser.</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">void</strong> dispose() -<a name="79" href="#79">79</a> { -<a name="80" href="#80">80</a> <strong class="jxr_keyword">this</strong>.request = <strong class="jxr_keyword">null</strong>; -<a name="81" href="#81">81</a> <strong class="jxr_keyword">super</strong>.dispose(); -<a name="82" href="#82">82</a> } -<a name="83" href="#83">83</a> -<a name="84" href="#84">84</a> <em class="jxr_javadoccomment">/**</em> -<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * Gets the servlet request.</em> -<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> *</em> -<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * @return the servlet request object or null.</em> -<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> */</em> -<a name="89" href="#89">89</a> <strong class="jxr_keyword">public</strong> HttpServletRequest getRequest() -<a name="90" href="#90">90</a> { -<a name="91" href="#91">91</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.request; -<a name="92" href="#92">92</a> } -<a name="93" href="#93">93</a> -<a name="94" href="#94">94</a> <em class="jxr_javadoccomment">/**</em> -<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * Sets the servlet request and response to be parsed.</em> -<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * All previous cookies will be cleared.</em> -<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> *</em> -<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * @param request the servlet request object.</em> -<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * @param response the servlet response object</em> -<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> */</em> -<a name="101" href="#101">101</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setData (HttpServletRequest request, -<a name="102" href="#102">102</a> HttpServletResponse response) -<a name="103" href="#103">103</a> { -<a name="104" href="#104">104</a> clear(); -<a name="105" href="#105">105</a> -<a name="106" href="#106">106</a> String enc = request.getCharacterEncoding(); -<a name="107" href="#107">107</a> setCharacterEncoding(enc != <strong class="jxr_keyword">null</strong> ? enc : <span class="jxr_string">"US-ASCII"</span>); -<a name="108" href="#108">108</a> -<a name="109" href="#109">109</a> Cookie[] cookies = request.getCookies(); -<a name="110" href="#110">110</a> -<a name="111" href="#111">111</a> getLogger().debug (<span class="jxr_string">"Number of Cookies "</span>+cookies.length); -<a name="112" href="#112">112</a> -<a name="113" href="#113">113</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i=0; i<cookies.length; i++) -<a name="114" href="#114">114</a> { -<a name="115" href="#115">115</a> String name = convert (cookies[i].getName()); -<a name="116" href="#116">116</a> String value = cookies[i].getValue(); -<a name="117" href="#117">117</a> getLogger().debug (<span class="jxr_string">"Adding "</span>+name+<span class="jxr_string">"="</span>+value); -<a name="118" href="#118">118</a> add (name,value); -<a name="119" href="#119">119</a> } -<a name="120" href="#120">120</a> -<a name="121" href="#121">121</a> <strong class="jxr_keyword">this</strong>.request = request; -<a name="122" href="#122">122</a> <strong class="jxr_keyword">this</strong>.response = response; -<a name="123" href="#123">123</a> } -<a name="124" href="#124">124</a> -<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">/**</em> -<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * Set a cookie that will be stored on the client for</em> -<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * the duration of the session.</em> -<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> */</em> -<a name="129" href="#129">129</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> set (String name, String value) -<a name="130" href="#130">130</a> { -<a name="131" href="#131">131</a> set (name,value,AGE_SESSION); -<a name="132" href="#132">132</a> } -<a name="133" href="#133">133</a> -<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">/**</em> -<a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * Set a persisten cookie on the client that will expire</em> -<a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * after a maximum age (given in seconds).</em> -<a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> */</em> -<a name="138" href="#138">138</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> set (String name, String value, <strong class="jxr_keyword">int</strong> seconds_age) -<a name="139" href="#139">139</a> { -<a name="140" href="#140">140</a> <strong class="jxr_keyword">if</strong> (response == <strong class="jxr_keyword">null</strong>) -<a name="141" href="#141">141</a> { -<a name="142" href="#142">142</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"Servlet response not available"</span>); -<a name="143" href="#143">143</a> } -<a name="144" href="#144">144</a> -<a name="145" href="#145">145</a> Cookie cookie = <strong class="jxr_keyword">new</strong> Cookie (name,value); -<a name="146" href="#146">146</a> cookie.setMaxAge (seconds_age); -<a name="147" href="#147">147</a> cookie.setPath (request.getServletPath()); -<a name="148" href="#148">148</a> response.addCookie (cookie); -<a name="149" href="#149">149</a> } -<a name="150" href="#150">150</a> -<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">/**</em> -<a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * Remove a previously set cookie from the client machine.</em> -<a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> */</em> -<a name="154" href="#154">154</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> unset (String name) -<a name="155" href="#155">155</a> { -<a name="156" href="#156">156</a> set (name,<span class="jxr_string">" "</span>,AGE_DELETE); -<a name="157" href="#157">157</a> } -<a name="158" href="#158">158</a> -<a name="159" href="#159">159</a> } +<a class="jxr_linenumber" name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.fulcrum.parser; +<a class="jxr_linenumber" name="2" href="#2">2</a> +<a class="jxr_linenumber" name="3" href="#3">3</a> +<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> +<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> +<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * distributed with this work for additional information</em> +<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> +<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> +<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> +<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="13" href="#13">13</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 class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> +<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> +<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> +<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> +<a class="jxr_linenumber" name="19" href="#19">19</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> +<a class="jxr_linenumber" name="20" href="#20">20</a> <em class="jxr_comment"> * under the License.</em> +<a class="jxr_linenumber" name="21" href="#21">21</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="22" href="#22">22</a> +<a class="jxr_linenumber" name="23" href="#23">23</a> +<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.Cookie; +<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest; +<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse; +<a class="jxr_linenumber" name="27" href="#27">27</a> +<a class="jxr_linenumber" name="28" href="#28">28</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * CookieParser is used to get and set values of Cookies on the Client</em> +<a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * Browser. You can use CookieParser to convert Cookie values to</em> +<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * various types or to set Bean values with setParameters(). See the</em> +<a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * Servlet Spec for more information on Cookies.</em> +<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * Use set() or unset() to Create or Destroy Cookies.</em> +<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * NOTE: The name= portion of a name=value pair may be converted</em> +<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * to lowercase or uppercase when the object is initialized and when</em> +<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * new data is added. This behaviour is determined by the url.case.folding</em> +<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * property in TurbineResources.properties. Adding a name/value pair may</em> +<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * overwrite existing name=value pairs if the names match:</em> +<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * <pre></em> +<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * CookieParser cp = data.getCookies();</em> +<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * cp.add("ERROR",1);</em> +<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * cp.add("eRrOr",2);</em> +<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * int result = cp.getInt("ERROR");</em> +<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * </pre></em> +<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * In the above example, result is 2.</em> +<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Ilkka Priha</a></em> +<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Leon Messerschmidt</a></em> +<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Thomas Vandahl</a></em> +<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @version $Id: DefaultCookieParser.java 812786 2009-09-09 07:01:49Z tv $</em> +<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="56" href="#56">56</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/fulcrum/parser/DefaultCookieParser.html">DefaultCookieParser</a> +<a class="jxr_linenumber" name="57" href="#57">57</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/fulcrum/parser/BaseValueParser.html">BaseValueParser</a> +<a class="jxr_linenumber" name="58" href="#58">58</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../org/apache/fulcrum/parser/CookieParser.html">CookieParser</a> +<a class="jxr_linenumber" name="59" href="#59">59</a> +<a class="jxr_linenumber" name="60" href="#60">60</a> { +<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * The servlet request objects to parse.</em> +<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="64" href="#64">64</a> <strong class="jxr_keyword">private</strong> HttpServletRequest request; +<a class="jxr_linenumber" name="65" href="#65">65</a> <strong class="jxr_keyword">private</strong> HttpServletResponse response; +<a class="jxr_linenumber" name="66" href="#66">66</a> +<a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * Constructs a new CookieParser.</em> +<a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="70" href="#70">70</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/fulcrum/parser/DefaultCookieParser.html">DefaultCookieParser</a>() +<a class="jxr_linenumber" name="71" href="#71">71</a> { +<a class="jxr_linenumber" name="72" href="#72">72</a> <strong class="jxr_keyword">super</strong>(); +<a class="jxr_linenumber" name="73" href="#73">73</a> } +<a class="jxr_linenumber" name="74" href="#74">74</a> +<a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * Disposes the parser.</em> +<a class="jxr_linenumber" name="77" href="#77">77</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="78" href="#78">78</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> dispose() +<a class="jxr_linenumber" name="79" href="#79">79</a> { +<a class="jxr_linenumber" name="80" href="#80">80</a> <strong class="jxr_keyword">this</strong>.request = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="81" href="#81">81</a> <strong class="jxr_keyword">super</strong>.dispose(); +<a class="jxr_linenumber" name="82" href="#82">82</a> } +<a class="jxr_linenumber" name="83" href="#83">83</a> +<a class="jxr_linenumber" name="84" href="#84">84</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * Gets the servlet request.</em> +<a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * @return the servlet request object or null.</em> +<a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="89" href="#89">89</a> <strong class="jxr_keyword">public</strong> HttpServletRequest getRequest() +<a class="jxr_linenumber" name="90" href="#90">90</a> { +<a class="jxr_linenumber" name="91" href="#91">91</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.request; +<a class="jxr_linenumber" name="92" href="#92">92</a> } +<a class="jxr_linenumber" name="93" href="#93">93</a> +<a class="jxr_linenumber" name="94" href="#94">94</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * Sets the servlet request and response to be parsed.</em> +<a class="jxr_linenumber" name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * All previous cookies will be cleared.</em> +<a class="jxr_linenumber" name="97" href="#97">97</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * @param request the servlet request object.</em> +<a class="jxr_linenumber" name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * @param response the servlet response object</em> +<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="101" href="#101">101</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setData (HttpServletRequest request, +<a class="jxr_linenumber" name="102" href="#102">102</a> HttpServletResponse response) +<a class="jxr_linenumber" name="103" href="#103">103</a> { +<a class="jxr_linenumber" name="104" href="#104">104</a> clear(); +<a class="jxr_linenumber" name="105" href="#105">105</a> +<a class="jxr_linenumber" name="106" href="#106">106</a> String enc = request.getCharacterEncoding(); +<a class="jxr_linenumber" name="107" href="#107">107</a> setCharacterEncoding(enc != <strong class="jxr_keyword">null</strong> ? enc : <span class="jxr_string">"US-ASCII"</span>); +<a class="jxr_linenumber" name="108" href="#108">108</a> +<a class="jxr_linenumber" name="109" href="#109">109</a> Cookie[] cookies = request.getCookies(); +<a class="jxr_linenumber" name="110" href="#110">110</a> +<a class="jxr_linenumber" name="111" href="#111">111</a> getLogger().debug (<span class="jxr_string">"Number of Cookies "</span>+cookies.length); +<a class="jxr_linenumber" name="112" href="#112">112</a> +<a class="jxr_linenumber" name="113" href="#113">113</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i=0; i<cookies.length; i++) +<a class="jxr_linenumber" name="114" href="#114">114</a> { +<a class="jxr_linenumber" name="115" href="#115">115</a> String name = convert (cookies[i].getName()); +<a class="jxr_linenumber" name="116" href="#116">116</a> String value = cookies[i].getValue(); +<a class="jxr_linenumber" name="117" href="#117">117</a> getLogger().debug (<span class="jxr_string">"Adding "</span>+name+<span class="jxr_string">"="</span>+value); +<a class="jxr_linenumber" name="118" href="#118">118</a> add (name,value); +<a class="jxr_linenumber" name="119" href="#119">119</a> } +<a class="jxr_linenumber" name="120" href="#120">120</a> +<a class="jxr_linenumber" name="121" href="#121">121</a> <strong class="jxr_keyword">this</strong>.request = request; +<a class="jxr_linenumber" name="122" href="#122">122</a> <strong class="jxr_keyword">this</strong>.response = response; +<a class="jxr_linenumber" name="123" href="#123">123</a> } +<a class="jxr_linenumber" name="124" href="#124">124</a> +<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * Set a cookie that will be stored on the client for</em> +<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * the duration of the session.</em> +<a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="129" href="#129">129</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> set (String name, String value) +<a class="jxr_linenumber" name="130" href="#130">130</a> { +<a class="jxr_linenumber" name="131" href="#131">131</a> set (name,value,AGE_SESSION); +<a class="jxr_linenumber" name="132" href="#132">132</a> } +<a class="jxr_linenumber" name="133" href="#133">133</a> +<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * Set a persisten cookie on the client that will expire</em> +<a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * after a maximum age (given in seconds).</em> +<a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="138" href="#138">138</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> set (String name, String value, <strong class="jxr_keyword">int</strong> seconds_age) +<a class="jxr_linenumber" name="139" href="#139">139</a> { +<a class="jxr_linenumber" name="140" href="#140">140</a> <strong class="jxr_keyword">if</strong> (response == <strong class="jxr_keyword">null</strong>) +<a class="jxr_linenumber" name="141" href="#141">141</a> { +<a class="jxr_linenumber" name="142" href="#142">142</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"Servlet response not available"</span>); +<a class="jxr_linenumber" name="143" href="#143">143</a> } +<a class="jxr_linenumber" name="144" href="#144">144</a> +<a class="jxr_linenumber" name="145" href="#145">145</a> Cookie cookie = <strong class="jxr_keyword">new</strong> Cookie (name,value); +<a class="jxr_linenumber" name="146" href="#146">146</a> cookie.setMaxAge (seconds_age); +<a class="jxr_linenumber" name="147" href="#147">147</a> cookie.setPath (request.getServletPath()); +<a class="jxr_linenumber" name="148" href="#148">148</a> response.addCookie (cookie); +<a class="jxr_linenumber" name="149" href="#149">149</a> } +<a class="jxr_linenumber" name="150" href="#150">150</a> +<a class="jxr_linenumber" name="151" href="#151">151</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * Remove a previously set cookie from the client machine.</em> +<a class="jxr_linenumber" name="153" href="#153">153</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="154" href="#154">154</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> unset (String name) +<a class="jxr_linenumber" name="155" href="#155">155</a> { +<a class="jxr_linenumber" name="156" href="#156">156</a> set (name,<span class="jxr_string">" "</span>,AGE_DELETE); +<a class="jxr_linenumber" name="157" href="#157">157</a> } +<a class="jxr_linenumber" name="158" href="#158">158</a> +<a class="jxr_linenumber" name="159" href="#159">159</a> } </pre> <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/";>Maven</a></div></body> </html> -
