| <!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>DefaultWebSessionStorageEvaluator xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/web/mgt/DefaultWebSessionStorageEvaluator.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.mgt; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.mgt.DefaultSessionStorageEvaluator; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.mgt.NativeSessionManager; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.mgt.SessionManager; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.Subject; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.subject.WebSubject; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.util.WebUtils; |
| <a name="27" href="#27">27</a> |
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * A web-specific {@code SessionStorageEvaluator} that performs the same logic as the parent class</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * {@link DefaultSessionStorageEvaluator} but additionally checks for a request-specific flag that may enable or</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * disable session access.</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * This implementation usually works in conjunction with the</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.web.filter.session.NoSessionCreationFilter}: If the {@code NoSessionCreationFilter}</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * is configured in a filter chain, that filter will set a specific</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * {@code ServletRequest} {@link javax.servlet.ServletRequest#setAttribute attribute} indicating that session creation</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * should be disabled.</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * This {@code DefaultWebSessionStorageEvaluator} will then inspect this attribute, and if it has been set, will return</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * {@code false} from {@link #isSessionStorageEnabled(org.apache.shiro.subject.Subject)} method, thereby preventing</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * Shiro from creating a session for the purpose of storing subject state.</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * If the request attribute has</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * not been set (i.e. the {@code NoSessionCreationFilter} is not configured or has been disabled), this class does</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * nothing and delegates to the parent class for existing behavior.</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="49" href="#49">49</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/web/mgt/DefaultWebSessionStorageEvaluator.html">DefaultWebSessionStorageEvaluator</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/mgt/DefaultSessionStorageEvaluator.html">DefaultSessionStorageEvaluator</a> { |
| <a name="50" href="#50">50</a> |
| <a name="51" href="#51">51</a> <em class="jxr_comment">//since 1.2.1</em> |
| <a name="52" href="#52">52</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/shiro/session/mgt/SessionManager.html">SessionManager</a> sessionManager; |
| <a name="53" href="#53">53</a> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * Sets the session manager to use when checking to see if session storage is possible.</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * @param sessionManager the session manager instance for checking.</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * @since 1.2.1</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="59" href="#59">59</a> <em class="jxr_comment">//package protected on purpose to maintain point-version compatibility: (1.2.3 -> 1.2.1 should work always).</em> |
| <a name="60" href="#60">60</a> <strong class="jxr_keyword">void</strong> setSessionManager(<a href="../../../../../org/apache/shiro/session/mgt/SessionManager.html">SessionManager</a> sessionManager) { |
| <a name="61" href="#61">61</a> <strong class="jxr_keyword">this</strong>.sessionManager = sessionManager; |
| <a name="62" href="#62">62</a> } |
| <a name="63" href="#63">63</a> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * Returns {@code true} if session storage is generally available (as determined by the super class's global</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * configuration property {@link #isSessionStorageEnabled()} and no request-specific override has turned off</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * session storage, {@code false} otherwise.</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * This means session storage is disabled if the {@link #isSessionStorageEnabled()} property is {@code false} or if</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * a request attribute is discovered that turns off session storage for the current request.</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @param subject the {@code Subject} for which session state persistence may be enabled</em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @return {@code true} if session storage is generally available (as determined by the super class's global</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * configuration property {@link #isSessionStorageEnabled()} and no request-specific override has turned off</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * session storage, {@code false} otherwise.</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="77" href="#77">77</a> @SuppressWarnings({<span class="jxr_string">"SimplifiableIfStatement"</span>}) |
| <a name="78" href="#78">78</a> @Override |
| <a name="79" href="#79">79</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isSessionStorageEnabled(<a href="../../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) { |
| <a name="80" href="#80">80</a> <strong class="jxr_keyword">if</strong> (subject.getSession(false) != <strong class="jxr_keyword">null</strong>) { |
| <a name="81" href="#81">81</a> <em class="jxr_comment">//use what already exists</em> |
| <a name="82" href="#82">82</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a name="83" href="#83">83</a> } |
| <a name="84" href="#84">84</a> |
| <a name="85" href="#85">85</a> <strong class="jxr_keyword">if</strong> (!isSessionStorageEnabled()) { |
| <a name="86" href="#86">86</a> <em class="jxr_comment">//honor global setting:</em> |
| <a name="87" href="#87">87</a> <strong class="jxr_keyword">return</strong> false; |
| <a name="88" href="#88">88</a> } |
| <a name="89" href="#89">89</a> |
| <a name="90" href="#90">90</a> <em class="jxr_comment">//SHIRO-350: non-web subject instances can't be saved to web-only session managers:</em> |
| <a name="91" href="#91">91</a> <em class="jxr_comment">//since 1.2.1:</em> |
| <a name="92" href="#92">92</a> <strong class="jxr_keyword">if</strong> (!(subject instanceof WebSubject) && (<strong class="jxr_keyword">this</strong>.sessionManager != <strong class="jxr_keyword">null</strong> && !(<strong class="jxr_keyword">this</strong>.sessionManager instanceof NativeSessionManager))) { |
| <a name="93" href="#93">93</a> <strong class="jxr_keyword">return</strong> false; |
| <a name="94" href="#94">94</a> } |
| <a name="95" href="#95">95</a> |
| <a name="96" href="#96">96</a> <strong class="jxr_keyword">return</strong> WebUtils._isSessionCreationEnabled(subject); |
| <a name="97" href="#97">97</a> } |
| <a name="98" href="#98">98</a> |
| <a name="99" href="#99">99</a> |
| <a name="100" href="#100">100</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
| |
