| <!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>SimpleCookie xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/web/servlet/SimpleCookie.html">View Javadoc</a></div><pre> |
| |
| <a name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> |
| <a name="10" href="#10">10</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="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> */</em> |
| <a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.web.servlet; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a name="24" href="#24">24</a> |
| <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> <strong class="jxr_keyword">import</strong> java.text.DateFormat; |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.text.SimpleDateFormat; |
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.util.Calendar; |
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.util.Date; |
| <a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> java.util.Locale; |
| <a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> java.util.TimeZone; |
| <a name="33" href="#33">33</a> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * Default {@link Cookie Cookie} implementation. 'HttpOnly' is supported out of the box, even on</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * Servlet {@code 2.4} and {@code 2.5} container implementations, using raw header writing logic and not</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * {@link javax.servlet.http.Cookie javax.servlet.http.Cookie} objects (which only has 'HttpOnly' support in Servlet</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * {@code 2.6} specifications and above).</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="42" href="#42">42</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/web/servlet/SimpleCookie.html">SimpleCookie</a> implements <a href="../../../../../org/apache/shiro/web/servlet/Cookie.html">Cookie</a> { |
| <a name="43" href="#43">43</a> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * {@code -1}, indicating the cookie should expire when the browser closes.</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="47" href="#47">47</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_MAX_AGE = -1; |
| <a name="48" href="#48">48</a> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * {@code -1} indicating that no version property should be set on the cookie.</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="52" href="#52">52</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_VERSION = -1; |
| <a name="53" href="#53">53</a> |
| <a name="54" href="#54">54</a> <em class="jxr_comment">//These constants are protected on purpose so that the test case can use them</em> |
| <a name="55" href="#55">55</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String NAME_VALUE_DELIMITER = <span class="jxr_string">"="</span>; |
| <a name="56" href="#56">56</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ATTRIBUTE_DELIMITER = <span class="jxr_string">"; "</span>; |
| <a name="57" href="#57">57</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> DAY_MILLIS = 86400000; <em class="jxr_comment">//1 day = 86,400,000 milliseconds</em> |
| <a name="58" href="#58">58</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String GMT_TIME_ZONE_ID = <span class="jxr_string">"GMT"</span>; |
| <a name="59" href="#59">59</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String COOKIE_DATE_FORMAT_STRING = <span class="jxr_string">"EEE, dd-MMM-yyyy HH:mm:ss z"</span>; |
| <a name="60" href="#60">60</a> |
| <a name="61" href="#61">61</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String COOKIE_HEADER_NAME = <span class="jxr_string">"Set-Cookie"</span>; |
| <a name="62" href="#62">62</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PATH_ATTRIBUTE_NAME = <span class="jxr_string">"Path"</span>; |
| <a name="63" href="#63">63</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String EXPIRES_ATTRIBUTE_NAME = <span class="jxr_string">"Expires"</span>; |
| <a name="64" href="#64">64</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String MAXAGE_ATTRIBUTE_NAME = <span class="jxr_string">"Max-Age"</span>; |
| <a name="65" href="#65">65</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DOMAIN_ATTRIBUTE_NAME = <span class="jxr_string">"Domain"</span>; |
| <a name="66" href="#66">66</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String VERSION_ATTRIBUTE_NAME = <span class="jxr_string">"Version"</span>; |
| <a name="67" href="#67">67</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String COMMENT_ATTRIBUTE_NAME = <span class="jxr_string">"Comment"</span>; |
| <a name="68" href="#68">68</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SECURE_ATTRIBUTE_NAME = <span class="jxr_string">"Secure"</span>; |
| <a name="69" href="#69">69</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String HTTP_ONLY_ATTRIBUTE_NAME = <span class="jxr_string">"HttpOnly"</span>; |
| <a name="70" href="#70">70</a> |
| <a name="71" href="#71">71</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">transient</strong> Logger log = LoggerFactory.getLogger(SimpleCookie.<strong class="jxr_keyword">class</strong>); |
| <a name="72" href="#72">72</a> |
| <a name="73" href="#73">73</a> <strong class="jxr_keyword">private</strong> String name; |
| <a name="74" href="#74">74</a> <strong class="jxr_keyword">private</strong> String value; |
| <a name="75" href="#75">75</a> <strong class="jxr_keyword">private</strong> String comment; |
| <a name="76" href="#76">76</a> <strong class="jxr_keyword">private</strong> String domain; |
| <a name="77" href="#77">77</a> <strong class="jxr_keyword">private</strong> String path; |
| <a name="78" href="#78">78</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> maxAge; |
| <a name="79" href="#79">79</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> version; |
| <a name="80" href="#80">80</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> secure; |
| <a name="81" href="#81">81</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> httpOnly; |
| <a name="82" href="#82">82</a> |
| <a name="83" href="#83">83</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/web/servlet/SimpleCookie.html">SimpleCookie</a>() { |
| <a name="84" href="#84">84</a> <strong class="jxr_keyword">this</strong>.maxAge = DEFAULT_MAX_AGE; |
| <a name="85" href="#85">85</a> <strong class="jxr_keyword">this</strong>.version = DEFAULT_VERSION; |
| <a name="86" href="#86">86</a> <strong class="jxr_keyword">this</strong>.httpOnly = <strong class="jxr_keyword">true</strong>; <em class="jxr_comment">//most of the cookies ever used by Shiro should be as secure as possible.</em> |
| <a name="87" href="#87">87</a> } |
| <a name="88" href="#88">88</a> |
| <a name="89" href="#89">89</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/web/servlet/SimpleCookie.html">SimpleCookie</a>(String name) { |
| <a name="90" href="#90">90</a> <strong class="jxr_keyword">this</strong>(); |
| <a name="91" href="#91">91</a> <strong class="jxr_keyword">this</strong>.name = name; |
| <a name="92" href="#92">92</a> } |
| <a name="93" href="#93">93</a> |
| <a name="94" href="#94">94</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/web/servlet/SimpleCookie.html">SimpleCookie</a>(<a href="../../../../../org/apache/shiro/web/servlet/Cookie.html">Cookie</a> cookie) { |
| <a name="95" href="#95">95</a> <strong class="jxr_keyword">this</strong>.name = cookie.getName(); |
| <a name="96" href="#96">96</a> <strong class="jxr_keyword">this</strong>.value = cookie.getValue(); |
| <a name="97" href="#97">97</a> <strong class="jxr_keyword">this</strong>.comment = cookie.getComment(); |
| <a name="98" href="#98">98</a> <strong class="jxr_keyword">this</strong>.domain = cookie.getDomain(); |
| <a name="99" href="#99">99</a> <strong class="jxr_keyword">this</strong>.path = cookie.getPath(); |
| <a name="100" href="#100">100</a> <strong class="jxr_keyword">this</strong>.maxAge = Math.max(DEFAULT_MAX_AGE, cookie.getMaxAge()); |
| <a name="101" href="#101">101</a> <strong class="jxr_keyword">this</strong>.version = Math.max(DEFAULT_VERSION, cookie.getVersion()); |
| <a name="102" href="#102">102</a> <strong class="jxr_keyword">this</strong>.secure = cookie.isSecure(); |
| <a name="103" href="#103">103</a> <strong class="jxr_keyword">this</strong>.httpOnly = cookie.isHttpOnly(); |
| <a name="104" href="#104">104</a> } |
| <a name="105" href="#105">105</a> |
| <a name="106" href="#106">106</a> <strong class="jxr_keyword">public</strong> String getName() { |
| <a name="107" href="#107">107</a> <strong class="jxr_keyword">return</strong> name; |
| <a name="108" href="#108">108</a> } |
| <a name="109" href="#109">109</a> |
| <a name="110" href="#110">110</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setName(String name) { |
| <a name="111" href="#111">111</a> <strong class="jxr_keyword">if</strong> (!StringUtils.hasText(name)) { |
| <a name="112" href="#112">112</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Name cannot be null/empty."</span>); |
| <a name="113" href="#113">113</a> } |
| <a name="114" href="#114">114</a> <strong class="jxr_keyword">this</strong>.name = name; |
| <a name="115" href="#115">115</a> } |
| <a name="116" href="#116">116</a> |
| <a name="117" href="#117">117</a> <strong class="jxr_keyword">public</strong> String getValue() { |
| <a name="118" href="#118">118</a> <strong class="jxr_keyword">return</strong> 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">public</strong> <strong class="jxr_keyword">void</strong> setValue(String value) { |
| <a name="122" href="#122">122</a> <strong class="jxr_keyword">this</strong>.value = value; |
| <a name="123" href="#123">123</a> } |
| <a name="124" href="#124">124</a> |
| <a name="125" href="#125">125</a> <strong class="jxr_keyword">public</strong> String getComment() { |
| <a name="126" href="#126">126</a> <strong class="jxr_keyword">return</strong> comment; |
| <a name="127" href="#127">127</a> } |
| <a name="128" href="#128">128</a> |
| <a name="129" href="#129">129</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setComment(String comment) { |
| <a name="130" href="#130">130</a> <strong class="jxr_keyword">this</strong>.comment = comment; |
| <a name="131" href="#131">131</a> } |
| <a name="132" href="#132">132</a> |
| <a name="133" href="#133">133</a> <strong class="jxr_keyword">public</strong> String getDomain() { |
| <a name="134" href="#134">134</a> <strong class="jxr_keyword">return</strong> domain; |
| <a name="135" href="#135">135</a> } |
| <a name="136" href="#136">136</a> |
| <a name="137" href="#137">137</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setDomain(String domain) { |
| <a name="138" href="#138">138</a> <strong class="jxr_keyword">this</strong>.domain = domain; |
| <a name="139" href="#139">139</a> } |
| <a name="140" href="#140">140</a> |
| <a name="141" href="#141">141</a> <strong class="jxr_keyword">public</strong> String getPath() { |
| <a name="142" href="#142">142</a> <strong class="jxr_keyword">return</strong> path; |
| <a name="143" href="#143">143</a> } |
| <a name="144" href="#144">144</a> |
| <a name="145" href="#145">145</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPath(String path) { |
| <a name="146" href="#146">146</a> <strong class="jxr_keyword">this</strong>.path = path; |
| <a name="147" href="#147">147</a> } |
| <a name="148" href="#148">148</a> |
| <a name="149" href="#149">149</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getMaxAge() { |
| <a name="150" href="#150">150</a> <strong class="jxr_keyword">return</strong> maxAge; |
| <a name="151" href="#151">151</a> } |
| <a name="152" href="#152">152</a> |
| <a name="153" href="#153">153</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setMaxAge(<strong class="jxr_keyword">int</strong> maxAge) { |
| <a name="154" href="#154">154</a> <strong class="jxr_keyword">this</strong>.maxAge = Math.max(DEFAULT_MAX_AGE, maxAge); |
| <a name="155" href="#155">155</a> } |
| <a name="156" href="#156">156</a> |
| <a name="157" href="#157">157</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getVersion() { |
| <a name="158" href="#158">158</a> <strong class="jxr_keyword">return</strong> version; |
| <a name="159" href="#159">159</a> } |
| <a name="160" href="#160">160</a> |
| <a name="161" href="#161">161</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setVersion(<strong class="jxr_keyword">int</strong> version) { |
| <a name="162" href="#162">162</a> <strong class="jxr_keyword">this</strong>.version = Math.max(DEFAULT_VERSION, version); |
| <a name="163" href="#163">163</a> } |
| <a name="164" href="#164">164</a> |
| <a name="165" href="#165">165</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isSecure() { |
| <a name="166" href="#166">166</a> <strong class="jxr_keyword">return</strong> secure; |
| <a name="167" href="#167">167</a> } |
| <a name="168" href="#168">168</a> |
| <a name="169" href="#169">169</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSecure(<strong class="jxr_keyword">boolean</strong> secure) { |
| <a name="170" href="#170">170</a> <strong class="jxr_keyword">this</strong>.secure = secure; |
| <a name="171" href="#171">171</a> } |
| <a name="172" href="#172">172</a> |
| <a name="173" href="#173">173</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isHttpOnly() { |
| <a name="174" href="#174">174</a> <strong class="jxr_keyword">return</strong> httpOnly; |
| <a name="175" href="#175">175</a> } |
| <a name="176" href="#176">176</a> |
| <a name="177" href="#177">177</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setHttpOnly(<strong class="jxr_keyword">boolean</strong> httpOnly) { |
| <a name="178" href="#178">178</a> <strong class="jxr_keyword">this</strong>.httpOnly = httpOnly; |
| <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"> * Returns the Cookie's calculated path setting. If the {@link javax.servlet.http.Cookie#getPath() path} is {@code null}, then the</em> |
| <a name="183" href="#183">183</a> <em class="jxr_javadoccomment"> * {@code request}'s {@link javax.servlet.http.HttpServletRequest#getContextPath() context path}</em> |
| <a name="184" href="#184">184</a> <em class="jxr_javadoccomment"> * will be returned. If getContextPath() is the empty string or null then the ROOT_PATH constant is returned.</em> |
| <a name="185" href="#185">185</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * @param request the incoming HttpServletRequest</em> |
| <a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * @return the path to be used as the path when the cookie is created or removed</em> |
| <a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="189" href="#189">189</a> <strong class="jxr_keyword">private</strong> String calculatePath(HttpServletRequest request) { |
| <a name="190" href="#190">190</a> String path = StringUtils.clean(getPath()); |
| <a name="191" href="#191">191</a> <strong class="jxr_keyword">if</strong> (!StringUtils.hasText(path)) { |
| <a name="192" href="#192">192</a> path = StringUtils.clean(request.getContextPath()); |
| <a name="193" href="#193">193</a> } |
| <a name="194" href="#194">194</a> |
| <a name="195" href="#195">195</a> <em class="jxr_comment">//fix for http://issues.apache.org/jira/browse/SHIRO-9:</em> |
| <a name="196" href="#196">196</a> <strong class="jxr_keyword">if</strong> (path == <strong class="jxr_keyword">null</strong>) { |
| <a name="197" href="#197">197</a> path = ROOT_PATH; |
| <a name="198" href="#198">198</a> } |
| <a name="199" href="#199">199</a> log.trace(<span class="jxr_string">"calculated path: {}"</span>, path); |
| <a name="200" href="#200">200</a> <strong class="jxr_keyword">return</strong> path; |
| <a name="201" href="#201">201</a> } |
| <a name="202" href="#202">202</a> |
| <a name="203" href="#203">203</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> saveTo(HttpServletRequest request, HttpServletResponse response) { |
| <a name="204" href="#204">204</a> |
| <a name="205" href="#205">205</a> String name = getName(); |
| <a name="206" href="#206">206</a> String value = getValue(); |
| <a name="207" href="#207">207</a> String comment = getComment(); |
| <a name="208" href="#208">208</a> String domain = getDomain(); |
| <a name="209" href="#209">209</a> String path = calculatePath(request); |
| <a name="210" href="#210">210</a> <strong class="jxr_keyword">int</strong> maxAge = getMaxAge(); |
| <a name="211" href="#211">211</a> <strong class="jxr_keyword">int</strong> version = getVersion(); |
| <a name="212" href="#212">212</a> <strong class="jxr_keyword">boolean</strong> secure = isSecure(); |
| <a name="213" href="#213">213</a> <strong class="jxr_keyword">boolean</strong> httpOnly = isHttpOnly(); |
| <a name="214" href="#214">214</a> |
| <a name="215" href="#215">215</a> addCookieHeader(response, name, value, comment, domain, path, maxAge, version, secure, httpOnly); |
| <a name="216" href="#216">216</a> } |
| <a name="217" href="#217">217</a> |
| <a name="218" href="#218">218</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> addCookieHeader(HttpServletResponse response, String name, String value, String comment, |
| <a name="219" href="#219">219</a> String domain, String path, <strong class="jxr_keyword">int</strong> maxAge, <strong class="jxr_keyword">int</strong> version, |
| <a name="220" href="#220">220</a> <strong class="jxr_keyword">boolean</strong> secure, <strong class="jxr_keyword">boolean</strong> httpOnly) { |
| <a name="221" href="#221">221</a> |
| <a name="222" href="#222">222</a> String headerValue = buildHeaderValue(name, value, comment, domain, path, maxAge, version, secure, httpOnly); |
| <a name="223" href="#223">223</a> response.addHeader(COOKIE_HEADER_NAME, headerValue); |
| <a name="224" href="#224">224</a> |
| <a name="225" href="#225">225</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) { |
| <a name="226" href="#226">226</a> log.debug(<span class="jxr_string">"Added HttpServletResponse Cookie [{}]"</span>, headerValue); |
| <a name="227" href="#227">227</a> } |
| <a name="228" href="#228">228</a> } |
| <a name="229" href="#229">229</a> |
| <a name="230" href="#230">230</a> <em class="jxr_comment">/*</em> |
| <a name="231" href="#231">231</a> <em class="jxr_comment"> * This implementation followed the grammar defined here for convenience:</em> |
| <a name="232" href="#232">232</a> <em class="jxr_comment"> * <a href="<a href="http://github.com/abarth/http-state/blob/master/notes/2009-11-07-Yui-Naruse.txt" target="alexandria_uri">http://github.com/abarth/http-state/blob/master/notes/2009-11-07-Yui-Naruse.txt</a>">Cookie grammar</a>.</em> |
| <a name="233" href="#233">233</a> <em class="jxr_comment"> *</em> |
| <a name="234" href="#234">234</a> <em class="jxr_comment"> * @return the 'Set-Cookie' header value for this cookie instance.</em> |
| <a name="235" href="#235">235</a> <em class="jxr_comment"> */</em> |
| <a name="236" href="#236">236</a> |
| <a name="237" href="#237">237</a> <strong class="jxr_keyword">protected</strong> String buildHeaderValue(String name, String value, String comment, |
| <a name="238" href="#238">238</a> String domain, String path, <strong class="jxr_keyword">int</strong> maxAge, <strong class="jxr_keyword">int</strong> version, |
| <a name="239" href="#239">239</a> <strong class="jxr_keyword">boolean</strong> secure, <strong class="jxr_keyword">boolean</strong> httpOnly) { |
| <a name="240" href="#240">240</a> |
| <a name="241" href="#241">241</a> <strong class="jxr_keyword">if</strong> (!StringUtils.hasText(name)) { |
| <a name="242" href="#242">242</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"Cookie name cannot be null/empty."</span>); |
| <a name="243" href="#243">243</a> } |
| <a name="244" href="#244">244</a> |
| <a name="245" href="#245">245</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder(name).append(NAME_VALUE_DELIMITER); |
| <a name="246" href="#246">246</a> |
| <a name="247" href="#247">247</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(value)) { |
| <a name="248" href="#248">248</a> sb.append(value); |
| <a name="249" href="#249">249</a> } |
| <a name="250" href="#250">250</a> |
| <a name="251" href="#251">251</a> appendComment(sb, comment); |
| <a name="252" href="#252">252</a> appendDomain(sb, domain); |
| <a name="253" href="#253">253</a> appendPath(sb, path); |
| <a name="254" href="#254">254</a> appendExpires(sb, maxAge); |
| <a name="255" href="#255">255</a> appendVersion(sb, version); |
| <a name="256" href="#256">256</a> appendSecure(sb, secure); |
| <a name="257" href="#257">257</a> appendHttpOnly(sb, httpOnly); |
| <a name="258" href="#258">258</a> |
| <a name="259" href="#259">259</a> <strong class="jxr_keyword">return</strong> sb.toString(); |
| <a name="260" href="#260">260</a> |
| <a name="261" href="#261">261</a> } |
| <a name="262" href="#262">262</a> |
| <a name="263" href="#263">263</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> appendComment(StringBuilder sb, String comment) { |
| <a name="264" href="#264">264</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(comment)) { |
| <a name="265" href="#265">265</a> sb.append(ATTRIBUTE_DELIMITER); |
| <a name="266" href="#266">266</a> sb.append(COMMENT_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(comment); |
| <a name="267" href="#267">267</a> } |
| <a name="268" href="#268">268</a> } |
| <a name="269" href="#269">269</a> |
| <a name="270" href="#270">270</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> appendDomain(StringBuilder sb, String domain) { |
| <a name="271" href="#271">271</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(domain)) { |
| <a name="272" href="#272">272</a> sb.append(ATTRIBUTE_DELIMITER); |
| <a name="273" href="#273">273</a> sb.append(DOMAIN_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(domain); |
| <a name="274" href="#274">274</a> } |
| <a name="275" href="#275">275</a> } |
| <a name="276" href="#276">276</a> |
| <a name="277" href="#277">277</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> appendPath(StringBuilder sb, String path) { |
| <a name="278" href="#278">278</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(path)) { |
| <a name="279" href="#279">279</a> sb.append(ATTRIBUTE_DELIMITER); |
| <a name="280" href="#280">280</a> sb.append(PATH_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(path); |
| <a name="281" href="#281">281</a> } |
| <a name="282" href="#282">282</a> } |
| <a name="283" href="#283">283</a> |
| <a name="284" href="#284">284</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> appendExpires(StringBuilder sb, <strong class="jxr_keyword">int</strong> maxAge) { |
| <a name="285" href="#285">285</a> <em class="jxr_comment">// if maxAge is negative, cookie should should expire when browser closes</em> |
| <a name="286" href="#286">286</a> <em class="jxr_comment">// Don't write the maxAge cookie value if it's negative - at least on Firefox it'll cause the </em> |
| <a name="287" href="#287">287</a> <em class="jxr_comment">// cookie to be deleted immediately</em> |
| <a name="288" href="#288">288</a> <em class="jxr_comment">// Write the expires header used by older browsers, but may be unnecessary</em> |
| <a name="289" href="#289">289</a> <em class="jxr_comment">// and it is not by the spec, see http://www.faqs.org/rfcs/rfc2965.html</em> |
| <a name="290" href="#290">290</a> <em class="jxr_comment">// TODO consider completely removing the following </em> |
| <a name="291" href="#291">291</a> <strong class="jxr_keyword">if</strong> (maxAge >= 0) { |
| <a name="292" href="#292">292</a> sb.append(ATTRIBUTE_DELIMITER); |
| <a name="293" href="#293">293</a> sb.append(MAXAGE_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(maxAge); |
| <a name="294" href="#294">294</a> sb.append(ATTRIBUTE_DELIMITER); |
| <a name="295" href="#295">295</a> Date expires; |
| <a name="296" href="#296">296</a> <strong class="jxr_keyword">if</strong> (maxAge == 0) { |
| <a name="297" href="#297">297</a> <em class="jxr_comment">//delete the cookie by specifying a time in the past (1 day ago):</em> |
| <a name="298" href="#298">298</a> expires = <strong class="jxr_keyword">new</strong> Date(System.currentTimeMillis() - DAY_MILLIS); |
| <a name="299" href="#299">299</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="300" href="#300">300</a> <em class="jxr_comment">//Value is in seconds. So take 'now' and add that many seconds, and that's our expiration date:</em> |
| <a name="301" href="#301">301</a> Calendar cal = Calendar.getInstance(); |
| <a name="302" href="#302">302</a> cal.add(Calendar.SECOND, maxAge); |
| <a name="303" href="#303">303</a> expires = cal.getTime(); |
| <a name="304" href="#304">304</a> } |
| <a name="305" href="#305">305</a> String formatted = toCookieDate(expires); |
| <a name="306" href="#306">306</a> sb.append(EXPIRES_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(formatted); |
| <a name="307" href="#307">307</a> } |
| <a name="308" href="#308">308</a> } |
| <a name="309" href="#309">309</a> |
| <a name="310" href="#310">310</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> appendVersion(StringBuilder sb, <strong class="jxr_keyword">int</strong> version) { |
| <a name="311" href="#311">311</a> <strong class="jxr_keyword">if</strong> (version > DEFAULT_VERSION) { |
| <a name="312" href="#312">312</a> sb.append(ATTRIBUTE_DELIMITER); |
| <a name="313" href="#313">313</a> sb.append(VERSION_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(version); |
| <a name="314" href="#314">314</a> } |
| <a name="315" href="#315">315</a> } |
| <a name="316" href="#316">316</a> |
| <a name="317" href="#317">317</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> appendSecure(StringBuilder sb, <strong class="jxr_keyword">boolean</strong> secure) { |
| <a name="318" href="#318">318</a> <strong class="jxr_keyword">if</strong> (secure) { |
| <a name="319" href="#319">319</a> sb.append(ATTRIBUTE_DELIMITER); |
| <a name="320" href="#320">320</a> sb.append(SECURE_ATTRIBUTE_NAME); <em class="jxr_comment">//No value for this attribute</em> |
| <a name="321" href="#321">321</a> } |
| <a name="322" href="#322">322</a> } |
| <a name="323" href="#323">323</a> |
| <a name="324" href="#324">324</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> appendHttpOnly(StringBuilder sb, <strong class="jxr_keyword">boolean</strong> httpOnly) { |
| <a name="325" href="#325">325</a> <strong class="jxr_keyword">if</strong> (httpOnly) { |
| <a name="326" href="#326">326</a> sb.append(ATTRIBUTE_DELIMITER); |
| <a name="327" href="#327">327</a> sb.append(HTTP_ONLY_ATTRIBUTE_NAME); <em class="jxr_comment">//No value for this attribute</em> |
| <a name="328" href="#328">328</a> } |
| <a name="329" href="#329">329</a> } |
| <a name="330" href="#330">330</a> |
| <a name="331" href="#331">331</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="332" href="#332">332</a> <em class="jxr_javadoccomment"> * Formats a date into a cookie date compatible string (Netscape's specification).</em> |
| <a name="333" href="#333">333</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="334" href="#334">334</a> <em class="jxr_javadoccomment"> * @param date the date to format</em> |
| <a name="335" href="#335">335</a> <em class="jxr_javadoccomment"> * @return an HTTP 1.0/1.1 Cookie compatible date string (GMT-based).</em> |
| <a name="336" href="#336">336</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="337" href="#337">337</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String toCookieDate(Date date) { |
| <a name="338" href="#338">338</a> TimeZone tz = TimeZone.getTimeZone(GMT_TIME_ZONE_ID); |
| <a name="339" href="#339">339</a> DateFormat fmt = <strong class="jxr_keyword">new</strong> SimpleDateFormat(COOKIE_DATE_FORMAT_STRING, Locale.US); |
| <a name="340" href="#340">340</a> fmt.setTimeZone(tz); |
| <a name="341" href="#341">341</a> <strong class="jxr_keyword">return</strong> fmt.format(date); |
| <a name="342" href="#342">342</a> } |
| <a name="343" href="#343">343</a> |
| <a name="344" href="#344">344</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> removeFrom(HttpServletRequest request, HttpServletResponse response) { |
| <a name="345" href="#345">345</a> String name = getName(); |
| <a name="346" href="#346">346</a> String value = DELETED_COOKIE_VALUE; |
| <a name="347" href="#347">347</a> String comment = <strong class="jxr_keyword">null</strong>; <em class="jxr_comment">//don't need to add extra size to the response - comments are irrelevant for deletions</em> |
| <a name="348" href="#348">348</a> String domain = getDomain(); |
| <a name="349" href="#349">349</a> String path = calculatePath(request); |
| <a name="350" href="#350">350</a> <strong class="jxr_keyword">int</strong> maxAge = 0; <em class="jxr_comment">//always zero for deletion</em> |
| <a name="351" href="#351">351</a> <strong class="jxr_keyword">int</strong> version = getVersion(); |
| <a name="352" href="#352">352</a> <strong class="jxr_keyword">boolean</strong> secure = isSecure(); |
| <a name="353" href="#353">353</a> <strong class="jxr_keyword">boolean</strong> httpOnly = false; <em class="jxr_comment">//no need to add the extra text, plus the value 'deleteMe' is not sensitive at all</em> |
| <a name="354" href="#354">354</a> |
| <a name="355" href="#355">355</a> addCookieHeader(response, name, value, comment, domain, path, maxAge, version, secure, httpOnly); |
| <a name="356" href="#356">356</a> |
| <a name="357" href="#357">357</a> log.trace(<span class="jxr_string">"Removed '{}' cookie by setting maxAge=0"</span>, name); |
| <a name="358" href="#358">358</a> } |
| <a name="359" href="#359">359</a> |
| <a name="360" href="#360">360</a> <strong class="jxr_keyword">public</strong> String readValue(HttpServletRequest request, HttpServletResponse ignored) { |
| <a name="361" href="#361">361</a> String name = getName(); |
| <a name="362" href="#362">362</a> String value = <strong class="jxr_keyword">null</strong>; |
| <a name="363" href="#363">363</a> javax.servlet.http.Cookie cookie = getCookie(request, name); |
| <a name="364" href="#364">364</a> <strong class="jxr_keyword">if</strong> (cookie != <strong class="jxr_keyword">null</strong>) { |
| <a name="365" href="#365">365</a> value = cookie.getValue(); |
| <a name="366" href="#366">366</a> log.debug(<span class="jxr_string">"Found '{}' cookie value [{}]"</span>, name, value); |
| <a name="367" href="#367">367</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="368" href="#368">368</a> log.trace(<span class="jxr_string">"No '{}' cookie value"</span>, name); |
| <a name="369" href="#369">369</a> } |
| <a name="370" href="#370">370</a> |
| <a name="371" href="#371">371</a> <strong class="jxr_keyword">return</strong> value; |
| <a name="372" href="#372">372</a> } |
| <a name="373" href="#373">373</a> |
| <a name="374" href="#374">374</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="375" href="#375">375</a> <em class="jxr_javadoccomment"> * Returns the cookie with the given name from the request or {@code null} if no cookie</em> |
| <a name="376" href="#376">376</a> <em class="jxr_javadoccomment"> * with that name could be found.</em> |
| <a name="377" href="#377">377</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="378" href="#378">378</a> <em class="jxr_javadoccomment"> * @param request the current executing http request.</em> |
| <a name="379" href="#379">379</a> <em class="jxr_javadoccomment"> * @param cookieName the name of the cookie to find and return.</em> |
| <a name="380" href="#380">380</a> <em class="jxr_javadoccomment"> * @return the cookie with the given name from the request or {@code null} if no cookie</em> |
| <a name="381" href="#381">381</a> <em class="jxr_javadoccomment"> * with that name could be found.</em> |
| <a name="382" href="#382">382</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="383" href="#383">383</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> javax.servlet.http.Cookie getCookie(HttpServletRequest request, String cookieName) { |
| <a name="384" href="#384">384</a> javax.servlet.http.Cookie cookies[] = request.getCookies(); |
| <a name="385" href="#385">385</a> <strong class="jxr_keyword">if</strong> (cookies != <strong class="jxr_keyword">null</strong>) { |
| <a name="386" href="#386">386</a> <strong class="jxr_keyword">for</strong> (javax.servlet.http.Cookie cookie : cookies) { |
| <a name="387" href="#387">387</a> <strong class="jxr_keyword">if</strong> (cookie.getName().equals(cookieName)) { |
| <a name="388" href="#388">388</a> <strong class="jxr_keyword">return</strong> cookie; |
| <a name="389" href="#389">389</a> } |
| <a name="390" href="#390">390</a> } |
| <a name="391" href="#391">391</a> } |
| <a name="392" href="#392">392</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a name="393" href="#393">393</a> } |
| <a name="394" href="#394">394</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
| |
