| <!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>DefaultSubjectDAO xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/shiro/mgt/DefaultSubjectDAO.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.mgt; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.Session; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.PrincipalCollection; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.Subject; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.support.DefaultSubjectContext; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.support.DelegatingSubject; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.CollectionUtils; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a name="29" href="#29">29</a> |
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.lang.reflect.Field; |
| <a name="31" href="#31">31</a> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * Default {@code SubjectDAO} implementation that stores Subject state in the Subject's Session by default (but this</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * can be disabled - see below). The Subject instance</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * can be re-created at a later time by first acquiring the associated Session (typically from a</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.session.mgt.SessionManager SessionManager}) via a session ID or session key and then</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * building a {@code Subject} instance from {@code Session} attributes.</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * <h2>Controlling how Sessions are used</h2></em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * Whether or not a {@code Subject}'s {@code Session} is used or not to persist its own state is controlled on a</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * <em>per-Subject</em> basis as determined by the configured</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * {@link #setSessionStorageEvaluator(SessionStorageEvaluator) sessionStorageEvaluator}.</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * The default {@code Evaluator} is a {@link DefaultSessionStorageEvaluator}, which supports enabling or disabling</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * session usage for Subject persistence at a global level for all subjects (and defaults to allowing sessions to be</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * used).</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * <h3>Disabling Session Persistence Entirely</h3></em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Because the default {@code SessionStorageEvaluator} instance is a {@link DefaultSessionStorageEvaluator}, you</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * can disable Session usage for Subject state entirely by configuring that instance directly, e.g.:</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * ((DefaultSessionStorageEvaluator)sessionDAO.getSessionStorageEvaluator()).setSessionStorageEnabled(false);</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * or, for example, in {@code shiro.ini}:</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * securityManager.subjectDAO.sessionStorageEvaluator.sessionStorageEnabled = false</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * but <b>note:</b> ONLY do this your</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * application is 100% stateless and you <em>DO NOT</em> need subjects to be remembered across remote</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * invocations, or in a web environment across HTTP requests.</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * <h3>Supporting Both Stateful and Stateless Subject paradigms</h3></em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * Perhaps your application needs to support a hybrid approach of both stateful and stateless Subjects:</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * <li>Stateful: Stateful subjects might represent web end-users that need their identity and authentication</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * state to be remembered from page to page.</li></em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * <li>Stateless: Stateless subjects might represent API clients (e.g. REST clients) that authenticate on every</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * request, and therefore don't need authentication state to be stored across requests in a session.</li></em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * To support the hybrid <em>per-Subject</em> approach, you will need to create your own implementation of the</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * {@link SessionStorageEvaluator} interface and configure it via the</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * {@link #setSessionStorageEvaluator(SessionStorageEvaluator)} method, or, with {@code shiro.ini}:</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * myEvaluator = com.my.CustomSessionStorageEvaluator</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * securityManager.subjectDAO.sessionStorageEvaluator = $myEvaluator</em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * Unless overridden, the default evaluator is a {@link DefaultSessionStorageEvaluator}, which enables session usage for</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * Subject state by default.</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * @see #isSessionStorageEnabled(org.apache.shiro.subject.Subject)</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * @see SessionStorageEvaluator</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * @see DefaultSessionStorageEvaluator</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="82" href="#82">82</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/shiro/mgt/DefaultSubjectDAO.html">DefaultSubjectDAO</a> implements <a href="../../../../org/apache/shiro/mgt/SubjectDAO.html">SubjectDAO</a> { |
| <a name="83" href="#83">83</a> |
| <a name="84" href="#84">84</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(DefaultSubjectDAO.<strong class="jxr_keyword">class</strong>); |
| <a name="85" href="#85">85</a> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * Evaluator that determines if a Subject's session may be used to store the Subject's own state.</em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="89" href="#89">89</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/shiro/mgt/SessionStorageEvaluator.html">SessionStorageEvaluator</a> sessionStorageEvaluator; |
| <a name="90" href="#90">90</a> |
| <a name="91" href="#91">91</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/mgt/DefaultSubjectDAO.html">DefaultSubjectDAO</a>() { |
| <a name="92" href="#92">92</a> <em class="jxr_comment">//default implementation allows enabling/disabling session usages at a global level for all subjects:</em> |
| <a name="93" href="#93">93</a> <strong class="jxr_keyword">this</strong>.sessionStorageEvaluator = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/mgt/DefaultSessionStorageEvaluator.html">DefaultSessionStorageEvaluator</a>(); |
| <a name="94" href="#94">94</a> } |
| <a name="95" href="#95">95</a> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * Determines if the subject's session will be used to persist subject state or not. This implementation</em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * merely delegates to the internal {@link SessionStorageEvaluator} (a</em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * {@code DefaultSessionStorageEvaluator} by default).</em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * @param subject the subject to inspect to determine if the subject's session will be used to persist subject</em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * state or not.</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * @return {@code true} if the subject's session will be used to persist subject state, {@code false} otherwise.</em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * @see #setSessionStorageEvaluator(SessionStorageEvaluator)</em> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * @see DefaultSessionStorageEvaluator</em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="107" href="#107">107</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isSessionStorageEnabled(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) { |
| <a name="108" href="#108">108</a> <strong class="jxr_keyword">return</strong> getSessionStorageEvaluator().isSessionStorageEnabled(subject); |
| <a name="109" href="#109">109</a> } |
| <a name="110" href="#110">110</a> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * Returns the {@code SessionStorageEvaluator} that will determine if a {@code Subject}'s state may be persisted in</em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * the Subject's session. The default instance is a {@link DefaultSessionStorageEvaluator}.</em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * @return the {@code SessionStorageEvaluator} that will determine if a {@code Subject}'s state may be persisted in</em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * the Subject's session.</em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * @see DefaultSessionStorageEvaluator</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="119" href="#119">119</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/mgt/SessionStorageEvaluator.html">SessionStorageEvaluator</a> getSessionStorageEvaluator() { |
| <a name="120" href="#120">120</a> <strong class="jxr_keyword">return</strong> sessionStorageEvaluator; |
| <a name="121" href="#121">121</a> } |
| <a name="122" href="#122">122</a> |
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * Sets the {@code SessionStorageEvaluator} that will determine if a {@code Subject}'s state may be persisted in</em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * the Subject's session. The default instance is a {@link DefaultSessionStorageEvaluator}.</em> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * @param sessionStorageEvaluator the {@code SessionStorageEvaluator} that will determine if a {@code Subject}'s</em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * state may be persisted in the Subject's session.</em> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * @see DefaultSessionStorageEvaluator</em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="131" href="#131">131</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSessionStorageEvaluator(<a href="../../../../org/apache/shiro/mgt/SessionStorageEvaluator.html">SessionStorageEvaluator</a> sessionStorageEvaluator) { |
| <a name="132" href="#132">132</a> <strong class="jxr_keyword">this</strong>.sessionStorageEvaluator = sessionStorageEvaluator; |
| <a name="133" href="#133">133</a> } |
| <a name="134" href="#134">134</a> |
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * Saves the subject's state to the subject's {@link org.apache.shiro.subject.Subject#getSession() session} only</em> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * if {@link #isSessionStorageEnabled(Subject) sessionStorageEnabled(subject)}. If session storage is not enabled</em> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * for the specific {@code Subject}, this method does nothing.</em> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * In either case, the argument {@code Subject} is returned directly (a new Subject instance is not created).</em> |
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * @param subject the Subject instance for which its state will be created or updated.</em> |
| <a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * @return the same {@code Subject} passed in (a new Subject instance is not created).</em> |
| <a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="145" href="#145">145</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> save(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) { |
| <a name="146" href="#146">146</a> <strong class="jxr_keyword">if</strong> (isSessionStorageEnabled(subject)) { |
| <a name="147" href="#147">147</a> saveToSession(subject); |
| <a name="148" href="#148">148</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="149" href="#149">149</a> log.trace(<span class="jxr_string">"Session storage of subject state for Subject [{}] has been disabled: identity and "</span> + |
| <a name="150" href="#150">150</a> <span class="jxr_string">"authentication state are expected to be initialized on every request or invocation."</span>, subject); |
| <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">return</strong> subject; |
| <a name="154" href="#154">154</a> } |
| <a name="155" href="#155">155</a> |
| <a name="156" href="#156">156</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * Saves the subject's state (it's principals and authentication state) to its</em> |
| <a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.subject.Subject#getSession() session}. The session can be retrieved at a later time</em> |
| <a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * (typically from a {@link org.apache.shiro.session.mgt.SessionManager SessionManager} to be used to recreate</em> |
| <a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * the {@code Subject} instance.</em> |
| <a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * @param subject the subject for which state will be persisted to its session.</em> |
| <a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="164" href="#164">164</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> saveToSession(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) { |
| <a name="165" href="#165">165</a> <em class="jxr_comment">//performs merge logic, only updating the Subject's session if it does not match the current state:</em> |
| <a name="166" href="#166">166</a> mergePrincipals(subject); |
| <a name="167" href="#167">167</a> mergeAuthenticationState(subject); |
| <a name="168" href="#168">168</a> } |
| <a name="169" href="#169">169</a> |
| <a name="170" href="#170">170</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * Merges the Subject's current {@link org.apache.shiro.subject.Subject#getPrincipals()} with whatever may be in</em> |
| <a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> * any available session. Only updates the Subject's session if the session does not match the current principals</em> |
| <a name="173" href="#173">173</a> <em class="jxr_javadoccomment"> * state.</em> |
| <a name="174" href="#174">174</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * @param subject the Subject for which principals will potentially be merged into the Subject's session.</em> |
| <a name="176" href="#176">176</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="177" href="#177">177</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> mergePrincipals(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) { |
| <a name="178" href="#178">178</a> <em class="jxr_comment">//merge PrincipalCollection state:</em> |
| <a name="179" href="#179">179</a> |
| <a name="180" href="#180">180</a> <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> currentPrincipals = <strong class="jxr_keyword">null</strong>; |
| <a name="181" href="#181">181</a> |
| <a name="182" href="#182">182</a> <em class="jxr_comment">//SHIRO-380: added if/else block - need to retain original (source) principals</em> |
| <a name="183" href="#183">183</a> <em class="jxr_comment">//This technique (reflection) is only temporary - a proper long term solution needs to be found,</em> |
| <a name="184" href="#184">184</a> <em class="jxr_comment">//but this technique allowed an immediate fix that is API point-version forwards and backwards compatible</em> |
| <a name="185" href="#185">185</a> <em class="jxr_comment">//</em> |
| <a name="186" href="#186">186</a> <em class="jxr_comment">//A more comprehensive review / cleaning of runAs should be performed for Shiro 1.3 / 2.0 +</em> |
| <a name="187" href="#187">187</a> <strong class="jxr_keyword">if</strong> (subject.isRunAs() && subject instanceof DelegatingSubject) { |
| <a name="188" href="#188">188</a> <strong class="jxr_keyword">try</strong> { |
| <a name="189" href="#189">189</a> Field field = DelegatingSubject.<strong class="jxr_keyword">class</strong>.getDeclaredField(<span class="jxr_string">"principals"</span>); |
| <a name="190" href="#190">190</a> field.setAccessible(<strong class="jxr_keyword">true</strong>); |
| <a name="191" href="#191">191</a> currentPrincipals = (PrincipalCollection)field.get(subject); |
| <a name="192" href="#192">192</a> } <strong class="jxr_keyword">catch</strong> (Exception e) { |
| <a name="193" href="#193">193</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"Unable to access DelegatingSubject principals property."</span>, e); |
| <a name="194" href="#194">194</a> } |
| <a name="195" href="#195">195</a> } |
| <a name="196" href="#196">196</a> <strong class="jxr_keyword">if</strong> (currentPrincipals == <strong class="jxr_keyword">null</strong> || currentPrincipals.isEmpty()) { |
| <a name="197" href="#197">197</a> currentPrincipals = subject.getPrincipals(); |
| <a name="198" href="#198">198</a> } |
| <a name="199" href="#199">199</a> |
| <a name="200" href="#200">200</a> <a href="../../../../org/apache/shiro/session/Session.html">Session</a> session = subject.getSession(false); |
| <a name="201" href="#201">201</a> |
| <a name="202" href="#202">202</a> <strong class="jxr_keyword">if</strong> (session == <strong class="jxr_keyword">null</strong>) { |
| <a name="203" href="#203">203</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(currentPrincipals)) { |
| <a name="204" href="#204">204</a> session = subject.getSession(); |
| <a name="205" href="#205">205</a> session.setAttribute(DefaultSubjectContext.PRINCIPALS_SESSION_KEY, currentPrincipals); |
| <a name="206" href="#206">206</a> } |
| <a name="207" href="#207">207</a> <em class="jxr_comment">//otherwise no session and no principals - nothing to save</em> |
| <a name="208" href="#208">208</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="209" href="#209">209</a> <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> existingPrincipals = |
| <a name="210" href="#210">210</a> (<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a>) session.getAttribute(DefaultSubjectContext.PRINCIPALS_SESSION_KEY); |
| <a name="211" href="#211">211</a> |
| <a name="212" href="#212">212</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(currentPrincipals)) { |
| <a name="213" href="#213">213</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(existingPrincipals)) { |
| <a name="214" href="#214">214</a> session.removeAttribute(DefaultSubjectContext.PRINCIPALS_SESSION_KEY); |
| <a name="215" href="#215">215</a> } |
| <a name="216" href="#216">216</a> <em class="jxr_comment">//otherwise both are null or empty - no need to update the session</em> |
| <a name="217" href="#217">217</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="218" href="#218">218</a> <strong class="jxr_keyword">if</strong> (!currentPrincipals.equals(existingPrincipals)) { |
| <a name="219" href="#219">219</a> session.setAttribute(DefaultSubjectContext.PRINCIPALS_SESSION_KEY, currentPrincipals); |
| <a name="220" href="#220">220</a> } |
| <a name="221" href="#221">221</a> <em class="jxr_comment">//otherwise they're the same - no need to update the session</em> |
| <a name="222" href="#222">222</a> } |
| <a name="223" href="#223">223</a> } |
| <a name="224" href="#224">224</a> } |
| <a name="225" href="#225">225</a> |
| <a name="226" href="#226">226</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="227" href="#227">227</a> <em class="jxr_javadoccomment"> * Merges the Subject's current authentication state with whatever may be in</em> |
| <a name="228" href="#228">228</a> <em class="jxr_javadoccomment"> * any available session. Only updates the Subject's session if the session does not match the current</em> |
| <a name="229" href="#229">229</a> <em class="jxr_javadoccomment"> * authentication state.</em> |
| <a name="230" href="#230">230</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * @param subject the Subject for which principals will potentially be merged into the Subject's session.</em> |
| <a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="233" href="#233">233</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> mergeAuthenticationState(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) { |
| <a name="234" href="#234">234</a> |
| <a name="235" href="#235">235</a> <a href="../../../../org/apache/shiro/session/Session.html">Session</a> session = subject.getSession(false); |
| <a name="236" href="#236">236</a> |
| <a name="237" href="#237">237</a> <strong class="jxr_keyword">if</strong> (session == <strong class="jxr_keyword">null</strong>) { |
| <a name="238" href="#238">238</a> <strong class="jxr_keyword">if</strong> (subject.isAuthenticated()) { |
| <a name="239" href="#239">239</a> session = subject.getSession(); |
| <a name="240" href="#240">240</a> session.setAttribute(DefaultSubjectContext.AUTHENTICATED_SESSION_KEY, Boolean.TRUE); |
| <a name="241" href="#241">241</a> } |
| <a name="242" href="#242">242</a> <em class="jxr_comment">//otherwise no session and not authenticated - nothing to save</em> |
| <a name="243" href="#243">243</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="244" href="#244">244</a> Boolean existingAuthc = (Boolean) session.getAttribute(DefaultSubjectContext.AUTHENTICATED_SESSION_KEY); |
| <a name="245" href="#245">245</a> |
| <a name="246" href="#246">246</a> <strong class="jxr_keyword">if</strong> (subject.isAuthenticated()) { |
| <a name="247" href="#247">247</a> <strong class="jxr_keyword">if</strong> (existingAuthc == <strong class="jxr_keyword">null</strong> || !existingAuthc) { |
| <a name="248" href="#248">248</a> session.setAttribute(DefaultSubjectContext.AUTHENTICATED_SESSION_KEY, Boolean.TRUE); |
| <a name="249" href="#249">249</a> } |
| <a name="250" href="#250">250</a> <em class="jxr_comment">//otherwise authc state matches - no need to update the session</em> |
| <a name="251" href="#251">251</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="252" href="#252">252</a> <strong class="jxr_keyword">if</strong> (existingAuthc != <strong class="jxr_keyword">null</strong>) { |
| <a name="253" href="#253">253</a> <em class="jxr_comment">//existing doesn't match the current state - remove it:</em> |
| <a name="254" href="#254">254</a> session.removeAttribute(DefaultSubjectContext.AUTHENTICATED_SESSION_KEY); |
| <a name="255" href="#255">255</a> } |
| <a name="256" href="#256">256</a> <em class="jxr_comment">//otherwise not in the session and not authenticated - no need to update the session</em> |
| <a name="257" href="#257">257</a> } |
| <a name="258" href="#258">258</a> } |
| <a name="259" href="#259">259</a> } |
| <a name="260" href="#260">260</a> |
| <a name="261" href="#261">261</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="262" href="#262">262</a> <em class="jxr_javadoccomment"> * Removes any existing subject state from the Subject's session (if the session exists). If the session</em> |
| <a name="263" href="#263">263</a> <em class="jxr_javadoccomment"> * does not exist, this method does not do anything.</em> |
| <a name="264" href="#264">264</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="265" href="#265">265</a> <em class="jxr_javadoccomment"> * @param subject the subject for which any existing subject state will be removed from its session.</em> |
| <a name="266" href="#266">266</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="267" href="#267">267</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> removeFromSession(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) { |
| <a name="268" href="#268">268</a> <a href="../../../../org/apache/shiro/session/Session.html">Session</a> session = subject.getSession(false); |
| <a name="269" href="#269">269</a> <strong class="jxr_keyword">if</strong> (session != <strong class="jxr_keyword">null</strong>) { |
| <a name="270" href="#270">270</a> session.removeAttribute(DefaultSubjectContext.AUTHENTICATED_SESSION_KEY); |
| <a name="271" href="#271">271</a> session.removeAttribute(DefaultSubjectContext.PRINCIPALS_SESSION_KEY); |
| <a name="272" href="#272">272</a> } |
| <a name="273" href="#273">273</a> } |
| <a name="274" href="#274">274</a> |
| <a name="275" href="#275">275</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="276" href="#276">276</a> <em class="jxr_javadoccomment"> * Removes any existing subject state from the subject's session (if the session exists).</em> |
| <a name="277" href="#277">277</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="278" href="#278">278</a> <em class="jxr_javadoccomment"> * @param subject the Subject instance for which any persistent state should be deleted.</em> |
| <a name="279" href="#279">279</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="280" href="#280">280</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> delete(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) { |
| <a name="281" href="#281">281</a> removeFromSession(subject); |
| <a name="282" href="#282">282</a> } |
| <a name="283" href="#283">283</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
