Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.7.0 / xref / org / apache / shiro / web / servlet / SimpleCookie.html
blob: f3bade78b6b31fe84f746475cce4258f4960d3b7 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<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 class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L10" href="#L10">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 class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.web.servlet;
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.owasp.encoder.Encode;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="L25" href="#L25">25</a>
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.text.DateFormat;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.text.SimpleDateFormat;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.util.Calendar;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.util.Date;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> java.util.TimeZone;
<a class="jxr_linenumber" name="L34" href="#L34">34</a>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * Default {@link Cookie Cookie} implementation. 'HttpOnly' is supported out of the box, even on</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * Servlet {@code 2.4} and {@code 2.5} container implementations, using raw header writing logic and not</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * {@link javax.servlet.http.Cookie javax.servlet.http.Cookie} objects (which only has 'HttpOnly' support in Servlet</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * {@code 2.6} specifications and above).</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="SimpleCookie" href="../../../../../org/apache/shiro/web/servlet/SimpleCookie.html#SimpleCookie">SimpleCookie</a> <strong class="jxr_keyword">implements</strong> <a name="Cookie" href="../../../../../org/apache/shiro/web/servlet/Cookie.html#Cookie">Cookie</a> {
<a class="jxr_linenumber" name="L44" href="#L44">44</a>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * {@code -1}, indicating the cookie should expire when the browser closes.</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</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 class="jxr_linenumber" name="L49" href="#L49">49</a>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * {@code -1} indicating that no version property should be set on the cookie.</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</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 class="jxr_linenumber" name="L54" href="#L54">54</a>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_comment">//These constants are protected on purpose so that the test case can use them</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</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 class="jxr_linenumber" name="L57" href="#L57">57</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 class="jxr_linenumber" name="L58" href="#L58">58</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 class="jxr_linenumber" name="L59" href="#L59">59</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 class="jxr_linenumber" name="L60" href="#L60">60</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 class="jxr_linenumber" name="L61" href="#L61">61</a>
<a class="jxr_linenumber" name="L62" href="#L62">62</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 class="jxr_linenumber" name="L63" href="#L63">63</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 class="jxr_linenumber" name="L64" href="#L64">64</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 class="jxr_linenumber" name="L65" href="#L65">65</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 class="jxr_linenumber" name="L66" href="#L66">66</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 class="jxr_linenumber" name="L67" href="#L67">67</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 class="jxr_linenumber" name="L68" href="#L68">68</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 class="jxr_linenumber" name="L69" href="#L69">69</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 class="jxr_linenumber" name="L70" href="#L70">70</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 class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SAME_SITE_ATTRIBUTE_NAME = <span class="jxr_string">"SameSite"</span>;
<a class="jxr_linenumber" name="L72" href="#L72">72</a>
<a class="jxr_linenumber" name="L73" href="#L73">73</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 class="jxr_linenumber" name="L74" href="#L74">74</a>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">private</strong> String name;
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">private</strong> String value;
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">private</strong> String comment;
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">private</strong> String domain;
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">private</strong> String path;
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> maxAge;
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> version;
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> secure;
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> httpOnly;
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">private</strong> SameSiteOptions sameSite;
<a class="jxr_linenumber" name="L85" href="#L85">85</a>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">public</strong> <a name="SimpleCookie" href="../../../../../org/apache/shiro/web/servlet/SimpleCookie.html#SimpleCookie">SimpleCookie</a>() {
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">this</strong>.maxAge = DEFAULT_MAX_AGE;
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">this</strong>.version = DEFAULT_VERSION;
<a class="jxr_linenumber" name="L89" href="#L89">89</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 class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">this</strong>.sameSite = SameSiteOptions.LAX;
<a class="jxr_linenumber" name="L91" href="#L91">91</a> }
<a class="jxr_linenumber" name="L92" href="#L92">92</a>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">public</strong> <a name="SimpleCookie" href="../../../../../org/apache/shiro/web/servlet/SimpleCookie.html#SimpleCookie">SimpleCookie</a>(String name) {
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">this</strong>();
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">this</strong>.name = name;
<a class="jxr_linenumber" name="L96" href="#L96">96</a> }
<a class="jxr_linenumber" name="L97" href="#L97">97</a>
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">public</strong> <a name="SimpleCookie" href="../../../../../org/apache/shiro/web/servlet/SimpleCookie.html#SimpleCookie">SimpleCookie</a>(<a name="Cookie" href="../../../../../org/apache/shiro/web/servlet/Cookie.html#Cookie">Cookie</a> cookie) {
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">this</strong>.name = cookie.getName();
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">this</strong>.value = cookie.getValue();
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">this</strong>.comment = cookie.getComment();
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">this</strong>.domain = cookie.getDomain();
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">this</strong>.path = cookie.getPath();
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">this</strong>.maxAge = Math.max(DEFAULT_MAX_AGE, cookie.getMaxAge());
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">this</strong>.version = Math.max(DEFAULT_VERSION, cookie.getVersion());
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">this</strong>.secure = cookie.isSecure();
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">this</strong>.httpOnly = cookie.isHttpOnly();
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">this</strong>.sameSite = cookie.getSameSite();
<a class="jxr_linenumber" name="L109" href="#L109">109</a> }
<a class="jxr_linenumber" name="L110" href="#L110">110</a>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> @Override
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">public</strong> String getName() {
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">return</strong> name;
<a class="jxr_linenumber" name="L114" href="#L114">114</a> }
<a class="jxr_linenumber" name="L115" href="#L115">115</a>
<a class="jxr_linenumber" name="L116" href="#L116">116</a> @Override
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setName(String name) {
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">if</strong> (!StringUtils.hasText(name)) {
<a class="jxr_linenumber" name="L119" href="#L119">119</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 class="jxr_linenumber" name="L120" href="#L120">120</a> }
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">this</strong>.name = name;
<a class="jxr_linenumber" name="L122" href="#L122">122</a> }
<a class="jxr_linenumber" name="L123" href="#L123">123</a>
<a class="jxr_linenumber" name="L124" href="#L124">124</a> @Override
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">public</strong> String getValue() {
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">return</strong> value;
<a class="jxr_linenumber" name="L127" href="#L127">127</a> }
<a class="jxr_linenumber" name="L128" href="#L128">128</a>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> @Override
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setValue(String value) {
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">this</strong>.value = value;
<a class="jxr_linenumber" name="L132" href="#L132">132</a> }
<a class="jxr_linenumber" name="L133" href="#L133">133</a>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> @Override
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">public</strong> String getComment() {
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">return</strong> comment;
<a class="jxr_linenumber" name="L137" href="#L137">137</a> }
<a class="jxr_linenumber" name="L138" href="#L138">138</a>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> @Override
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setComment(String comment) {
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">this</strong>.comment = comment;
<a class="jxr_linenumber" name="L142" href="#L142">142</a> }
<a class="jxr_linenumber" name="L143" href="#L143">143</a>
<a class="jxr_linenumber" name="L144" href="#L144">144</a> @Override
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">public</strong> String getDomain() {
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">return</strong> domain;
<a class="jxr_linenumber" name="L147" href="#L147">147</a> }
<a class="jxr_linenumber" name="L148" href="#L148">148</a>
<a class="jxr_linenumber" name="L149" href="#L149">149</a> @Override
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setDomain(String domain) {
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">this</strong>.domain = domain;
<a class="jxr_linenumber" name="L152" href="#L152">152</a> }
<a class="jxr_linenumber" name="L153" href="#L153">153</a>
<a class="jxr_linenumber" name="L154" href="#L154">154</a> @Override
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">public</strong> String getPath() {
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">return</strong> path;
<a class="jxr_linenumber" name="L157" href="#L157">157</a> }
<a class="jxr_linenumber" name="L158" href="#L158">158</a>
<a class="jxr_linenumber" name="L159" href="#L159">159</a> @Override
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPath(String path) {
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">this</strong>.path = path;
<a class="jxr_linenumber" name="L162" href="#L162">162</a> }
<a class="jxr_linenumber" name="L163" href="#L163">163</a>
<a class="jxr_linenumber" name="L164" href="#L164">164</a> @Override
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getMaxAge() {
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">return</strong> maxAge;
<a class="jxr_linenumber" name="L167" href="#L167">167</a> }
<a class="jxr_linenumber" name="L168" href="#L168">168</a>
<a class="jxr_linenumber" name="L169" href="#L169">169</a> @Override
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setMaxAge(<strong class="jxr_keyword">int</strong> maxAge) {
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">this</strong>.maxAge = Math.max(DEFAULT_MAX_AGE, maxAge);
<a class="jxr_linenumber" name="L172" href="#L172">172</a> }
<a class="jxr_linenumber" name="L173" href="#L173">173</a>
<a class="jxr_linenumber" name="L174" href="#L174">174</a> @Override
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getVersion() {
<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">return</strong> version;
<a class="jxr_linenumber" name="L177" href="#L177">177</a> }
<a class="jxr_linenumber" name="L178" href="#L178">178</a>
<a class="jxr_linenumber" name="L179" href="#L179">179</a> @Override
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setVersion(<strong class="jxr_keyword">int</strong> version) {
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">this</strong>.version = Math.max(DEFAULT_VERSION, version);
<a class="jxr_linenumber" name="L182" href="#L182">182</a> }
<a class="jxr_linenumber" name="L183" href="#L183">183</a>
<a class="jxr_linenumber" name="L184" href="#L184">184</a> @Override
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isSecure() {
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">return</strong> secure;
<a class="jxr_linenumber" name="L187" href="#L187">187</a> }
<a class="jxr_linenumber" name="L188" href="#L188">188</a>
<a class="jxr_linenumber" name="L189" href="#L189">189</a> @Override
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSecure(<strong class="jxr_keyword">boolean</strong> secure) {
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">this</strong>.secure = secure;
<a class="jxr_linenumber" name="L192" href="#L192">192</a> }
<a class="jxr_linenumber" name="L193" href="#L193">193</a>
<a class="jxr_linenumber" name="L194" href="#L194">194</a> @Override
<a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isHttpOnly() {
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">return</strong> httpOnly;
<a class="jxr_linenumber" name="L197" href="#L197">197</a> }
<a class="jxr_linenumber" name="L198" href="#L198">198</a>
<a class="jxr_linenumber" name="L199" href="#L199">199</a> @Override
<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setHttpOnly(<strong class="jxr_keyword">boolean</strong> httpOnly) {
<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">this</strong>.httpOnly = httpOnly;
<a class="jxr_linenumber" name="L202" href="#L202">202</a> }
<a class="jxr_linenumber" name="L203" href="#L203">203</a>
<a class="jxr_linenumber" name="L204" href="#L204">204</a> @Override
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">public</strong> SameSiteOptions getSameSite() {
<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">return</strong> sameSite;
<a class="jxr_linenumber" name="L207" href="#L207">207</a> }
<a class="jxr_linenumber" name="L208" href="#L208">208</a>
<a class="jxr_linenumber" name="L209" href="#L209">209</a> @Override
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSameSite(SameSiteOptions sameSite) {
<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">this</strong>.sameSite = sameSite;
<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.sameSite == SameSiteOptions.NONE) {
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_comment">// do not allow invalid cookies. Only secure cookies are allowed if SameSite is set to NONE.</em>
<a class="jxr_linenumber" name="L214" href="#L214">214</a> setSecure(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="L215" href="#L215">215</a> }
<a class="jxr_linenumber" name="L216" href="#L216">216</a> }
<a class="jxr_linenumber" name="L217" href="#L217">217</a>
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L219" href="#L219">219</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 class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * {@code request}'s {@link javax.servlet.http.HttpServletRequest#getContextPath() context path}</em>
<a class="jxr_linenumber" name="L221" href="#L221">221</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 class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> * @param request the incoming HttpServletRequest</em>
<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> * @return the path to be used as the path when the cookie is created or removed</em>
<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong class="jxr_keyword">private</strong> String calculatePath(HttpServletRequest request) {
<a class="jxr_linenumber" name="L227" href="#L227">227</a> String path = StringUtils.clean(getPath());
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">if</strong> (!StringUtils.hasText(path)) {
<a class="jxr_linenumber" name="L229" href="#L229">229</a> path = StringUtils.clean(request.getContextPath());
<a class="jxr_linenumber" name="L230" href="#L230">230</a> }
<a class="jxr_linenumber" name="L231" href="#L231">231</a>
<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_comment">//fix for http://issues.apache.org/jira/browse/SHIRO-9:</em>
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">if</strong> (path == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L234" href="#L234">234</a> path = ROOT_PATH;
<a class="jxr_linenumber" name="L235" href="#L235">235</a> }
<a class="jxr_linenumber" name="L236" href="#L236">236</a> log.trace(<span class="jxr_string">"calculated path: {}"</span>, path);
<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">return</strong> path;
<a class="jxr_linenumber" name="L238" href="#L238">238</a> }
<a class="jxr_linenumber" name="L239" href="#L239">239</a>
<a class="jxr_linenumber" name="L240" href="#L240">240</a> @Override
<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> saveTo(HttpServletRequest request, HttpServletResponse response) {
<a class="jxr_linenumber" name="L242" href="#L242">242</a>
<a class="jxr_linenumber" name="L243" href="#L243">243</a> String name = getName();
<a class="jxr_linenumber" name="L244" href="#L244">244</a> String value = getValue();
<a class="jxr_linenumber" name="L245" href="#L245">245</a> String comment = getComment();
<a class="jxr_linenumber" name="L246" href="#L246">246</a> String domain = getDomain();
<a class="jxr_linenumber" name="L247" href="#L247">247</a> String path = calculatePath(request);
<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong class="jxr_keyword">int</strong> maxAge = getMaxAge();
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">int</strong> version = getVersion();
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">boolean</strong> secure = isSecure();
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">boolean</strong> httpOnly = isHttpOnly();
<a class="jxr_linenumber" name="L252" href="#L252">252</a> SameSiteOptions sameSite = getSameSite();
<a class="jxr_linenumber" name="L253" href="#L253">253</a>
<a class="jxr_linenumber" name="L254" href="#L254">254</a> addCookieHeader(response, name, value, comment, domain, path, maxAge, version, secure, httpOnly, sameSite);
<a class="jxr_linenumber" name="L255" href="#L255">255</a> }
<a class="jxr_linenumber" name="L256" href="#L256">256</a>
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> addCookieHeader(HttpServletResponse response, String name, String value, String comment,
<a class="jxr_linenumber" name="L258" href="#L258">258</a> String domain, String path, <strong class="jxr_keyword">int</strong> maxAge, <strong class="jxr_keyword">int</strong> version,
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <strong class="jxr_keyword">boolean</strong> secure, <strong class="jxr_keyword">boolean</strong> httpOnly, SameSiteOptions sameSite) {
<a class="jxr_linenumber" name="L260" href="#L260">260</a>
<a class="jxr_linenumber" name="L261" href="#L261">261</a> String headerValue = buildHeaderValue(name, value, comment, domain, path, maxAge, version, secure, httpOnly, sameSite);
<a class="jxr_linenumber" name="L262" href="#L262">262</a> response.addHeader(COOKIE_HEADER_NAME, headerValue);
<a class="jxr_linenumber" name="L263" href="#L263">263</a>
<a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a class="jxr_linenumber" name="L265" href="#L265">265</a> log.debug(<span class="jxr_string">"Added HttpServletResponse Cookie [{}]"</span>, headerValue);
<a class="jxr_linenumber" name="L266" href="#L266">266</a> }
<a class="jxr_linenumber" name="L267" href="#L267">267</a> }
<a class="jxr_linenumber" name="L268" href="#L268">268</a>
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_comment"> * This implementation followed the grammar defined here for convenience:</em>
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_comment"> * &lt;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>"&gt;Cookie grammar&lt;/a&gt;.</em>
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_comment"> * @return the 'Set-Cookie' header value for this cookie instance.</em>
<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L275" href="#L275">275</a>
<a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong class="jxr_keyword">protected</strong> String buildHeaderValue(String name, String value, String comment,
<a class="jxr_linenumber" name="L277" href="#L277">277</a> String domain, String path, <strong class="jxr_keyword">int</strong> maxAge, <strong class="jxr_keyword">int</strong> version,
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">boolean</strong> secure, <strong class="jxr_keyword">boolean</strong> httpOnly) {
<a class="jxr_linenumber" name="L279" href="#L279">279</a>
<a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">return</strong> buildHeaderValue(name, value, comment, domain, path, maxAge, version, secure, httpOnly, getSameSite());
<a class="jxr_linenumber" name="L281" href="#L281">281</a> }
<a class="jxr_linenumber" name="L282" href="#L282">282</a>
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">protected</strong> String buildHeaderValue(String name, String value, String comment,
<a class="jxr_linenumber" name="L284" href="#L284">284</a> String domain, String path, <strong class="jxr_keyword">int</strong> maxAge, <strong class="jxr_keyword">int</strong> version,
<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">boolean</strong> secure, <strong class="jxr_keyword">boolean</strong> httpOnly, SameSiteOptions sameSite) {
<a class="jxr_linenumber" name="L286" href="#L286">286</a>
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <strong class="jxr_keyword">if</strong> (!StringUtils.hasText(name)) {
<a class="jxr_linenumber" name="L288" href="#L288">288</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 class="jxr_linenumber" name="L289" href="#L289">289</a> }
<a class="jxr_linenumber" name="L290" href="#L290">290</a>
<a class="jxr_linenumber" name="L291" href="#L291">291</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder(name).append(NAME_VALUE_DELIMITER);
<a class="jxr_linenumber" name="L292" href="#L292">292</a>
<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(value)) {
<a class="jxr_linenumber" name="L294" href="#L294">294</a> sb.append(value);
<a class="jxr_linenumber" name="L295" href="#L295">295</a> }
<a class="jxr_linenumber" name="L296" href="#L296">296</a>
<a class="jxr_linenumber" name="L297" href="#L297">297</a> appendComment(sb, comment);
<a class="jxr_linenumber" name="L298" href="#L298">298</a> appendDomain(sb, domain);
<a class="jxr_linenumber" name="L299" href="#L299">299</a> appendPath(sb, path);
<a class="jxr_linenumber" name="L300" href="#L300">300</a> appendExpires(sb, maxAge);
<a class="jxr_linenumber" name="L301" href="#L301">301</a> appendVersion(sb, version);
<a class="jxr_linenumber" name="L302" href="#L302">302</a> appendSecure(sb, secure);
<a class="jxr_linenumber" name="L303" href="#L303">303</a> appendHttpOnly(sb, httpOnly);
<a class="jxr_linenumber" name="L304" href="#L304">304</a> appendSameSite(sb, sameSite);
<a class="jxr_linenumber" name="L305" href="#L305">305</a>
<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong class="jxr_keyword">return</strong> sb.toString();
<a class="jxr_linenumber" name="L307" href="#L307">307</a>
<a class="jxr_linenumber" name="L308" href="#L308">308</a> }
<a class="jxr_linenumber" name="L309" href="#L309">309</a>
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> appendComment(StringBuilder sb, String comment) {
<a class="jxr_linenumber" name="L311" href="#L311">311</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(comment)) {
<a class="jxr_linenumber" name="L312" href="#L312">312</a> sb.append(ATTRIBUTE_DELIMITER);
<a class="jxr_linenumber" name="L313" href="#L313">313</a> sb.append(COMMENT_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(comment);
<a class="jxr_linenumber" name="L314" href="#L314">314</a> }
<a class="jxr_linenumber" name="L315" href="#L315">315</a> }
<a class="jxr_linenumber" name="L316" href="#L316">316</a>
<a class="jxr_linenumber" name="L317" href="#L317">317</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> appendDomain(StringBuilder sb, String domain) {
<a class="jxr_linenumber" name="L318" href="#L318">318</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(domain)) {
<a class="jxr_linenumber" name="L319" href="#L319">319</a> sb.append(ATTRIBUTE_DELIMITER);
<a class="jxr_linenumber" name="L320" href="#L320">320</a> sb.append(DOMAIN_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(domain);
<a class="jxr_linenumber" name="L321" href="#L321">321</a> }
<a class="jxr_linenumber" name="L322" href="#L322">322</a> }
<a class="jxr_linenumber" name="L323" href="#L323">323</a>
<a class="jxr_linenumber" name="L324" href="#L324">324</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> appendPath(StringBuilder sb, String path) {
<a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(path)) {
<a class="jxr_linenumber" name="L326" href="#L326">326</a> sb.append(ATTRIBUTE_DELIMITER);
<a class="jxr_linenumber" name="L327" href="#L327">327</a> sb.append(PATH_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(path);
<a class="jxr_linenumber" name="L328" href="#L328">328</a> }
<a class="jxr_linenumber" name="L329" href="#L329">329</a> }
<a class="jxr_linenumber" name="L330" href="#L330">330</a>
<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> appendExpires(StringBuilder sb, <strong class="jxr_keyword">int</strong> maxAge) {
<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_comment">// if maxAge is negative, cookie should should expire when browser closes</em>
<a class="jxr_linenumber" name="L333" href="#L333">333</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 class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_comment">// cookie to be deleted immediately</em>
<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_comment">// Write the expires header used by older browsers, but may be unnecessary</em>
<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_comment">// and it is not by the spec, see http://www.faqs.org/rfcs/rfc2965.html</em>
<a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_comment">// TODO consider completely removing the following </em>
<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong class="jxr_keyword">if</strong> (maxAge &gt;= 0) {
<a class="jxr_linenumber" name="L339" href="#L339">339</a> sb.append(ATTRIBUTE_DELIMITER);
<a class="jxr_linenumber" name="L340" href="#L340">340</a> sb.append(MAXAGE_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(maxAge);
<a class="jxr_linenumber" name="L341" href="#L341">341</a> sb.append(ATTRIBUTE_DELIMITER);
<a class="jxr_linenumber" name="L342" href="#L342">342</a> Date expires;
<a class="jxr_linenumber" name="L343" href="#L343">343</a> <strong class="jxr_keyword">if</strong> (maxAge == 0) {
<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_comment">//delete the cookie by specifying a time in the past (1 day ago):</em>
<a class="jxr_linenumber" name="L345" href="#L345">345</a> expires = <strong class="jxr_keyword">new</strong> Date(System.currentTimeMillis() - DAY_MILLIS);
<a class="jxr_linenumber" name="L346" href="#L346">346</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L347" href="#L347">347</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 class="jxr_linenumber" name="L348" href="#L348">348</a> Calendar cal = Calendar.getInstance();
<a class="jxr_linenumber" name="L349" href="#L349">349</a> cal.add(Calendar.SECOND, maxAge);
<a class="jxr_linenumber" name="L350" href="#L350">350</a> expires = cal.getTime();
<a class="jxr_linenumber" name="L351" href="#L351">351</a> }
<a class="jxr_linenumber" name="L352" href="#L352">352</a> String formatted = toCookieDate(expires);
<a class="jxr_linenumber" name="L353" href="#L353">353</a> sb.append(EXPIRES_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(formatted);
<a class="jxr_linenumber" name="L354" href="#L354">354</a> }
<a class="jxr_linenumber" name="L355" href="#L355">355</a> }
<a class="jxr_linenumber" name="L356" href="#L356">356</a>
<a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> appendVersion(StringBuilder sb, <strong class="jxr_keyword">int</strong> version) {
<a class="jxr_linenumber" name="L358" href="#L358">358</a> <strong class="jxr_keyword">if</strong> (version &gt; DEFAULT_VERSION) {
<a class="jxr_linenumber" name="L359" href="#L359">359</a> sb.append(ATTRIBUTE_DELIMITER);
<a class="jxr_linenumber" name="L360" href="#L360">360</a> sb.append(VERSION_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(version);
<a class="jxr_linenumber" name="L361" href="#L361">361</a> }
<a class="jxr_linenumber" name="L362" href="#L362">362</a> }
<a class="jxr_linenumber" name="L363" href="#L363">363</a>
<a class="jxr_linenumber" name="L364" href="#L364">364</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> appendSecure(StringBuilder sb, <strong class="jxr_keyword">boolean</strong> secure) {
<a class="jxr_linenumber" name="L365" href="#L365">365</a> <strong class="jxr_keyword">if</strong> (secure) {
<a class="jxr_linenumber" name="L366" href="#L366">366</a> sb.append(ATTRIBUTE_DELIMITER);
<a class="jxr_linenumber" name="L367" href="#L367">367</a> sb.append(SECURE_ATTRIBUTE_NAME); <em class="jxr_comment">//No value for this attribute</em>
<a class="jxr_linenumber" name="L368" href="#L368">368</a> }
<a class="jxr_linenumber" name="L369" href="#L369">369</a> }
<a class="jxr_linenumber" name="L370" href="#L370">370</a>
<a class="jxr_linenumber" name="L371" href="#L371">371</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> appendHttpOnly(StringBuilder sb, <strong class="jxr_keyword">boolean</strong> httpOnly) {
<a class="jxr_linenumber" name="L372" href="#L372">372</a> <strong class="jxr_keyword">if</strong> (httpOnly) {
<a class="jxr_linenumber" name="L373" href="#L373">373</a> sb.append(ATTRIBUTE_DELIMITER);
<a class="jxr_linenumber" name="L374" href="#L374">374</a> sb.append(HTTP_ONLY_ATTRIBUTE_NAME); <em class="jxr_comment">//No value for this attribute</em>
<a class="jxr_linenumber" name="L375" href="#L375">375</a> }
<a class="jxr_linenumber" name="L376" href="#L376">376</a> }
<a class="jxr_linenumber" name="L377" href="#L377">377</a>
<a class="jxr_linenumber" name="L378" href="#L378">378</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> appendSameSite(StringBuilder sb, SameSiteOptions sameSite) {
<a class="jxr_linenumber" name="L379" href="#L379">379</a> <strong class="jxr_keyword">if</strong> (sameSite != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L380" href="#L380">380</a> sb.append(ATTRIBUTE_DELIMITER);
<a class="jxr_linenumber" name="L381" href="#L381">381</a> sb.append(SAME_SITE_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(sameSite.toString().toLowerCase(Locale.ENGLISH));
<a class="jxr_linenumber" name="L382" href="#L382">382</a> }
<a class="jxr_linenumber" name="L383" href="#L383">383</a> }
<a class="jxr_linenumber" name="L384" href="#L384">384</a>
<a class="jxr_linenumber" name="L385" href="#L385">385</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_javadoccomment"> * Check whether the given {@code cookiePath} matches the {@code requestPath}</em>
<a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_javadoccomment"> * @param cookiePath</em>
<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment"> * @param requestPath</em>
<a class="jxr_linenumber" name="L390" href="#L390">390</a> <em class="jxr_javadoccomment"> * @return</em>
<a class="jxr_linenumber" name="L391" href="#L391">391</a> <em class="jxr_javadoccomment"> * @see &lt;a href="<a href="https://tools.ietf.org/html/rfc6265" target="alexandria_uri">https://tools.ietf.org/html/rfc6265</a>#section-5.1.4"&gt;RFC 6265, Section 5.1.4 "Paths and Path-Match"&lt;/a&gt;</em>
<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> pathMatches(String cookiePath, String requestPath) {
<a class="jxr_linenumber" name="L394" href="#L394">394</a> <strong class="jxr_keyword">if</strong> (!requestPath.startsWith(cookiePath)) {
<a class="jxr_linenumber" name="L395" href="#L395">395</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L396" href="#L396">396</a> }
<a class="jxr_linenumber" name="L397" href="#L397">397</a>
<a class="jxr_linenumber" name="L398" href="#L398">398</a> <strong class="jxr_keyword">return</strong> requestPath.length() == cookiePath.length()
<a class="jxr_linenumber" name="L399" href="#L399">399</a> || cookiePath.charAt(cookiePath.length() - 1) == '/'
<a class="jxr_linenumber" name="L400" href="#L400">400</a> || requestPath.charAt(cookiePath.length()) == '/';
<a class="jxr_linenumber" name="L401" href="#L401">401</a> }
<a class="jxr_linenumber" name="L402" href="#L402">402</a>
<a class="jxr_linenumber" name="L403" href="#L403">403</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L404" href="#L404">404</a> <em class="jxr_javadoccomment"> * Formats a date into a cookie date compatible string (Netscape's specification).</em>
<a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L406" href="#L406">406</a> <em class="jxr_javadoccomment"> * @param date the date to format</em>
<a class="jxr_linenumber" name="L407" href="#L407">407</a> <em class="jxr_javadoccomment"> * @return an HTTP 1.0/1.1 Cookie compatible date string (GMT-based).</em>
<a class="jxr_linenumber" name="L408" href="#L408">408</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L409" href="#L409">409</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String toCookieDate(Date date) {
<a class="jxr_linenumber" name="L410" href="#L410">410</a> TimeZone tz = TimeZone.getTimeZone(GMT_TIME_ZONE_ID);
<a class="jxr_linenumber" name="L411" href="#L411">411</a> DateFormat fmt = <strong class="jxr_keyword">new</strong> SimpleDateFormat(COOKIE_DATE_FORMAT_STRING, Locale.US);
<a class="jxr_linenumber" name="L412" href="#L412">412</a> fmt.setTimeZone(tz);
<a class="jxr_linenumber" name="L413" href="#L413">413</a> <strong class="jxr_keyword">return</strong> fmt.format(date);
<a class="jxr_linenumber" name="L414" href="#L414">414</a> }
<a class="jxr_linenumber" name="L415" href="#L415">415</a>
<a class="jxr_linenumber" name="L416" href="#L416">416</a> @Override
<a class="jxr_linenumber" name="L417" href="#L417">417</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> removeFrom(HttpServletRequest request, HttpServletResponse response) {
<a class="jxr_linenumber" name="L418" href="#L418">418</a> String name = getName();
<a class="jxr_linenumber" name="L419" href="#L419">419</a> String value = DELETED_COOKIE_VALUE;
<a class="jxr_linenumber" name="L420" href="#L420">420</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 class="jxr_linenumber" name="L421" href="#L421">421</a> String domain = getDomain();
<a class="jxr_linenumber" name="L422" href="#L422">422</a> String path = calculatePath(request);
<a class="jxr_linenumber" name="L423" href="#L423">423</a> <strong class="jxr_keyword">int</strong> maxAge = 0; <em class="jxr_comment">//always zero for deletion</em>
<a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong class="jxr_keyword">int</strong> version = getVersion();
<a class="jxr_linenumber" name="L425" href="#L425">425</a> <strong class="jxr_keyword">boolean</strong> secure = isSecure();
<a class="jxr_linenumber" name="L426" href="#L426">426</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 class="jxr_linenumber" name="L427" href="#L427">427</a> SameSiteOptions sameSite = getSameSite();
<a class="jxr_linenumber" name="L428" href="#L428">428</a>
<a class="jxr_linenumber" name="L429" href="#L429">429</a> addCookieHeader(response, name, value, comment, domain, path, maxAge, version, secure, httpOnly, sameSite);
<a class="jxr_linenumber" name="L430" href="#L430">430</a>
<a class="jxr_linenumber" name="L431" href="#L431">431</a> log.trace(<span class="jxr_string">"Removed '{}' cookie by setting maxAge=0"</span>, name);
<a class="jxr_linenumber" name="L432" href="#L432">432</a> }
<a class="jxr_linenumber" name="L433" href="#L433">433</a>
<a class="jxr_linenumber" name="L434" href="#L434">434</a> @Override
<a class="jxr_linenumber" name="L435" href="#L435">435</a> <strong class="jxr_keyword">public</strong> String readValue(HttpServletRequest request, HttpServletResponse ignored) {
<a class="jxr_linenumber" name="L436" href="#L436">436</a> String name = getName();
<a class="jxr_linenumber" name="L437" href="#L437">437</a> String value = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L438" href="#L438">438</a> javax.servlet.http.Cookie cookie = getCookie(request, name);
<a class="jxr_linenumber" name="L439" href="#L439">439</a> <strong class="jxr_keyword">if</strong> (cookie != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L440" href="#L440">440</a> <em class="jxr_comment">// Validate that the cookie is used at the correct place.</em>
<a class="jxr_linenumber" name="L441" href="#L441">441</a> String path = StringUtils.clean(getPath());
<a class="jxr_linenumber" name="L442" href="#L442">442</a> <strong class="jxr_keyword">if</strong> (path != <strong class="jxr_keyword">null</strong> &amp;&amp; !pathMatches(path, request.getRequestURI())) {
<a class="jxr_linenumber" name="L443" href="#L443">443</a> log.warn(<span class="jxr_string">"Found '{}' cookie at path '{}', but should be only used for '{}'"</span>,
<a class="jxr_linenumber" name="L444" href="#L444">444</a> <strong class="jxr_keyword">new</strong> Object[] { name, Encode.forHtml(request.getRequestURI()), path});
<a class="jxr_linenumber" name="L445" href="#L445">445</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L446" href="#L446">446</a> value = cookie.getValue();
<a class="jxr_linenumber" name="L447" href="#L447">447</a> log.debug(<span class="jxr_string">"Found '{}' cookie value [{}]"</span>, name, Encode.forHtml(value));
<a class="jxr_linenumber" name="L448" href="#L448">448</a> }
<a class="jxr_linenumber" name="L449" href="#L449">449</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L450" href="#L450">450</a> log.trace(<span class="jxr_string">"No '{}' cookie value"</span>, name);
<a class="jxr_linenumber" name="L451" href="#L451">451</a> }
<a class="jxr_linenumber" name="L452" href="#L452">452</a>
<a class="jxr_linenumber" name="L453" href="#L453">453</a> <strong class="jxr_keyword">return</strong> value;
<a class="jxr_linenumber" name="L454" href="#L454">454</a> }
<a class="jxr_linenumber" name="L455" href="#L455">455</a>
<a class="jxr_linenumber" name="L456" href="#L456">456</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L457" href="#L457">457</a> <em class="jxr_javadoccomment"> * Returns the cookie with the given name from the request or {@code null} if no cookie</em>
<a class="jxr_linenumber" name="L458" href="#L458">458</a> <em class="jxr_javadoccomment"> * with that name could be found.</em>
<a class="jxr_linenumber" name="L459" href="#L459">459</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L460" href="#L460">460</a> <em class="jxr_javadoccomment"> * @param request the current executing http request.</em>
<a class="jxr_linenumber" name="L461" href="#L461">461</a> <em class="jxr_javadoccomment"> * @param cookieName the name of the cookie to find and return.</em>
<a class="jxr_linenumber" name="L462" href="#L462">462</a> <em class="jxr_javadoccomment"> * @return the cookie with the given name from the request or {@code null} if no cookie</em>
<a class="jxr_linenumber" name="L463" href="#L463">463</a> <em class="jxr_javadoccomment"> * with that name could be found.</em>
<a class="jxr_linenumber" name="L464" href="#L464">464</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L465" href="#L465">465</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> javax.servlet.http.Cookie getCookie(HttpServletRequest request, String cookieName) {
<a class="jxr_linenumber" name="L466" href="#L466">466</a> javax.servlet.http.Cookie cookies[] = request.getCookies();
<a class="jxr_linenumber" name="L467" href="#L467">467</a> <strong class="jxr_keyword">if</strong> (cookies != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L468" href="#L468">468</a> <strong class="jxr_keyword">for</strong> (javax.servlet.http.Cookie cookie : cookies) {
<a class="jxr_linenumber" name="L469" href="#L469">469</a> <strong class="jxr_keyword">if</strong> (cookie.getName().equals(cookieName)) {
<a class="jxr_linenumber" name="L470" href="#L470">470</a> <strong class="jxr_keyword">return</strong> cookie;
<a class="jxr_linenumber" name="L471" href="#L471">471</a> }
<a class="jxr_linenumber" name="L472" href="#L472">472</a> }
<a class="jxr_linenumber" name="L473" href="#L473">473</a> }
<a class="jxr_linenumber" name="L474" href="#L474">474</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L475" href="#L475">475</a> }
<a class="jxr_linenumber" name="L476" href="#L476">476</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>