| <!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>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 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.mgt; |
| <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.session.Session; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.PrincipalCollection; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.Subject; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.support.DefaultSubjectContext; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.support.DelegatingSubject; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.lang.reflect.Field; |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * Default {@code SubjectDAO} implementation that stores Subject state in the Subject's Session by default (but this</em> |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * can be disabled - see below). The Subject instance</em> |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * can be re-created at a later time by first acquiring the associated Session (typically from a</em> |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.session.mgt.SessionManager SessionManager}) via a session ID or session key and then</em> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * building a {@code Subject} instance from {@code Session} attributes.</em> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * <h2>Controlling how Sessions are used</h2></em> |
| <a class="jxr_linenumber" name="L38" href="#L38">38</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 class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * <em>per-Subject</em> basis as determined by the configured</em> |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * {@link #setSessionStorageEvaluator(SessionStorageEvaluator) sessionStorageEvaluator}.</em> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * The default {@code Evaluator} is a {@link DefaultSessionStorageEvaluator}, which supports enabling or disabling</em> |
| <a class="jxr_linenumber" name="L42" href="#L42">42</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 class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * used).</em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * <h3>Disabling Session Persistence Entirely</h3></em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * Because the default {@code SessionStorageEvaluator} instance is a {@link DefaultSessionStorageEvaluator}, you</em> |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * can disable Session usage for Subject state entirely by configuring that instance directly, e.g.:</em> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * ((DefaultSessionStorageEvaluator)sessionDAO.getSessionStorageEvaluator()).setSessionStorageEnabled(false);</em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * or, for example, in {@code shiro.ini}:</em> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * securityManager.subjectDAO.sessionStorageEvaluator.sessionStorageEnabled = false</em> |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * but <b>note:</b> ONLY do this your</em> |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * application is 100% stateless and you <em>DO NOT</em> need subjects to be remembered across remote</em> |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * invocations, or in a web environment across HTTP requests.</em> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * <h3>Supporting Both Stateful and Stateless Subject paradigms</h3></em> |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * Perhaps your application needs to support a hybrid approach of both stateful and stateless Subjects:</em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * <li>Stateful: Stateful subjects might represent web end-users that need their identity and authentication</em> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * state to be remembered from page to page.</li></em> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * <li>Stateless: Stateless subjects might represent API clients (e.g. REST clients) that authenticate on every</em> |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * request, and therefore don't need authentication state to be stored across requests in a session.</li></em> |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</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 class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * {@link SessionStorageEvaluator} interface and configure it via the</em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * {@link #setSessionStorageEvaluator(SessionStorageEvaluator)} method, or, with {@code shiro.ini}:</em> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * myEvaluator = com.my.CustomSessionStorageEvaluator</em> |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * securityManager.subjectDAO.sessionStorageEvaluator = $myEvaluator</em> |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * Unless overridden, the default evaluator is a {@link DefaultSessionStorageEvaluator}, which enables session usage for</em> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * Subject state by default.</em> |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * @see #isSessionStorageEnabled(org.apache.shiro.subject.Subject)</em> |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * @see SessionStorageEvaluator</em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * @see DefaultSessionStorageEvaluator</em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="DefaultSubjectDAO" href="../../../../org/apache/shiro/mgt/DefaultSubjectDAO.html#DefaultSubjectDAO">DefaultSubjectDAO</a> <strong class="jxr_keyword">implements</strong> <a name="SubjectDAO" href="../../../../org/apache/shiro/mgt/SubjectDAO.html#SubjectDAO">SubjectDAO</a> { |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> |
| <a class="jxr_linenumber" name="L83" href="#L83">83</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 class="jxr_linenumber" name="L84" href="#L84">84</a> |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L86" href="#L86">86</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 class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">private</strong> <a name="SessionStorageEvaluator" href="../../../../org/apache/shiro/mgt/SessionStorageEvaluator.html#SessionStorageEvaluator">SessionStorageEvaluator</a> sessionStorageEvaluator; |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">public</strong> <a name="DefaultSubjectDAO" href="../../../../org/apache/shiro/mgt/DefaultSubjectDAO.html#DefaultSubjectDAO">DefaultSubjectDAO</a>() { |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_comment">//default implementation allows enabling/disabling session usages at a global level for all subjects:</em> |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">this</strong>.sessionStorageEvaluator = <strong class="jxr_keyword">new</strong> <a name="DefaultSessionStorageEvaluator" href="../../../../org/apache/shiro/mgt/DefaultSessionStorageEvaluator.html#DefaultSessionStorageEvaluator">DefaultSessionStorageEvaluator</a>(); |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> } |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * Determines if the subject's session will be used to persist subject state or not. This implementation</em> |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * merely delegates to the internal {@link SessionStorageEvaluator} (a</em> |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * {@code DefaultSessionStorageEvaluator} by default).</em> |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L100" href="#L100">100</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 class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * state or not.</em> |
| <a class="jxr_linenumber" name="L102" href="#L102">102</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 class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * @see #setSessionStorageEvaluator(SessionStorageEvaluator)</em> |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * @see DefaultSessionStorageEvaluator</em> |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isSessionStorageEnabled(<a name="Subject" href="../../../../org/apache/shiro/subject/Subject.html#Subject">Subject</a> subject) { |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">return</strong> getSessionStorageEvaluator().isSessionStorageEnabled(subject); |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> } |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * Returns the {@code SessionStorageEvaluator} that will determine if a {@code Subject}'s state may be persisted in</em> |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * the Subject's session. The default instance is a {@link DefaultSessionStorageEvaluator}.</em> |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * @return the {@code SessionStorageEvaluator} that will determine if a {@code Subject}'s state may be persisted in</em> |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * the Subject's session.</em> |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * @see DefaultSessionStorageEvaluator</em> |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">public</strong> <a name="SessionStorageEvaluator" href="../../../../org/apache/shiro/mgt/SessionStorageEvaluator.html#SessionStorageEvaluator">SessionStorageEvaluator</a> getSessionStorageEvaluator() { |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">return</strong> sessionStorageEvaluator; |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> } |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * Sets the {@code SessionStorageEvaluator} that will determine if a {@code Subject}'s state may be persisted in</em> |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * the Subject's session. The default instance is a {@link DefaultSessionStorageEvaluator}.</em> |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @param sessionStorageEvaluator the {@code SessionStorageEvaluator} that will determine if a {@code Subject}'s</em> |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * state may be persisted in the Subject's session.</em> |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * @see DefaultSessionStorageEvaluator</em> |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSessionStorageEvaluator(<a name="SessionStorageEvaluator" href="../../../../org/apache/shiro/mgt/SessionStorageEvaluator.html#SessionStorageEvaluator">SessionStorageEvaluator</a> sessionStorageEvaluator) { |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">this</strong>.sessionStorageEvaluator = sessionStorageEvaluator; |
| <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> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L135" href="#L135">135</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 class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * if {@link #isSessionStorageEnabled(Subject) sessionStorageEnabled(subject)}. If session storage is not enabled</em> |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * for the specific {@code Subject}, this method does nothing.</em> |
| <a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * In either case, the argument {@code Subject} is returned directly (a new Subject instance is not created).</em> |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * @param subject the Subject instance for which its state will be created or updated.</em> |
| <a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * @return the same {@code Subject} passed in (a new Subject instance is not created).</em> |
| <a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">public</strong> <a name="Subject" href="../../../../org/apache/shiro/subject/Subject.html#Subject">Subject</a> save(<a name="Subject" href="../../../../org/apache/shiro/subject/Subject.html#Subject">Subject</a> subject) { |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">if</strong> (isSessionStorageEnabled(subject)) { |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> saveToSession(subject); |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L148" href="#L148">148</a> log.trace(<span class="jxr_string">"Session storage of subject state for Subject [{}] has been disabled: identity and "</span> + |
| <a class="jxr_linenumber" name="L149" href="#L149">149</a> <span class="jxr_string">"authentication state are expected to be initialized on every request or invocation."</span>, subject); |
| <a class="jxr_linenumber" name="L150" href="#L150">150</a> } |
| <a class="jxr_linenumber" name="L151" href="#L151">151</a> |
| <a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">return</strong> subject; |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> } |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * Saves the subject's state (it's principals and authentication state) to its</em> |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.subject.Subject#getSession() session}. The session can be retrieved at a later time</em> |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * (typically from a {@link org.apache.shiro.session.mgt.SessionManager SessionManager} to be used to recreate</em> |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * the {@code Subject} instance.</em> |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * @param subject the subject for which state will be persisted to its session.</em> |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> saveToSession(<a name="Subject" href="../../../../org/apache/shiro/subject/Subject.html#Subject">Subject</a> subject) { |
| <a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_comment">//performs merge logic, only updating the Subject's session if it does not match the current state:</em> |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> mergePrincipals(subject); |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> mergeAuthenticationState(subject); |
| <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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isEmpty(<a name="PrincipalCollection" href="../../../../org/apache/shiro/subject/PrincipalCollection.html#PrincipalCollection">PrincipalCollection</a> pc) { |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">return</strong> pc == <strong class="jxr_keyword">null</strong> || pc.isEmpty(); |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> } |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * Merges the Subject's current {@link org.apache.shiro.subject.Subject#getPrincipals()} with whatever may be in</em> |
| <a class="jxr_linenumber" name="L175" href="#L175">175</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 class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * state.</em> |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * @param subject the Subject for which principals will potentially be merged into the Subject's session.</em> |
| <a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> mergePrincipals(<a name="Subject" href="../../../../org/apache/shiro/subject/Subject.html#Subject">Subject</a> subject) { |
| <a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_comment">//merge PrincipalCollection state:</em> |
| <a class="jxr_linenumber" name="L182" href="#L182">182</a> |
| <a class="jxr_linenumber" name="L183" href="#L183">183</a> <a name="PrincipalCollection" href="../../../../org/apache/shiro/subject/PrincipalCollection.html#PrincipalCollection">PrincipalCollection</a> currentPrincipals = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_comment">//SHIRO-380: added if/else block - need to retain original (source) principals</em> |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_comment">//This technique (reflection) is only temporary - a proper long term solution needs to be found,</em> |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_comment">//but this technique allowed an immediate fix that is API point-version forwards and backwards compatible</em> |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_comment">//</em> |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_comment">//A more comprehensive review / cleaning of runAs should be performed for Shiro 1.3 / 2.0 +</em> |
| <a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">if</strong> (subject.isRunAs() && subject instanceof <a name="DelegatingSubject" href="../../../../org/apache/shiro/subject/support/DelegatingSubject.html#DelegatingSubject">DelegatingSubject</a>) { |
| <a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L192" href="#L192">192</a> Field field = DelegatingSubject.<strong class="jxr_keyword">class</strong>.getDeclaredField(<span class="jxr_string">"principals"</span>); |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> field.setAccessible(<strong class="jxr_keyword">true</strong>); |
| <a class="jxr_linenumber" name="L194" href="#L194">194</a> currentPrincipals = (<a name="PrincipalCollection" href="../../../../org/apache/shiro/subject/PrincipalCollection.html#PrincipalCollection">PrincipalCollection</a>)field.get(subject); |
| <a class="jxr_linenumber" name="L195" href="#L195">195</a> } <strong class="jxr_keyword">catch</strong> (Exception e) { |
| <a class="jxr_linenumber" name="L196" href="#L196">196</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 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> <strong class="jxr_keyword">if</strong> (currentPrincipals == <strong class="jxr_keyword">null</strong> || currentPrincipals.isEmpty()) { |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> currentPrincipals = subject.getPrincipals(); |
| <a class="jxr_linenumber" name="L201" href="#L201">201</a> } |
| <a class="jxr_linenumber" name="L202" href="#L202">202</a> |
| <a class="jxr_linenumber" name="L203" href="#L203">203</a> <a name="Session" href="../../../../org/apache/shiro/session/Session.html#Session">Session</a> session = subject.getSession(false); |
| <a class="jxr_linenumber" name="L204" href="#L204">204</a> |
| <a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">if</strong> (session == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">if</strong> (!isEmpty(currentPrincipals)) { |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> session = subject.getSession(); |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> session.setAttribute(DefaultSubjectContext.PRINCIPALS_SESSION_KEY, currentPrincipals); |
| <a class="jxr_linenumber" name="L209" href="#L209">209</a> } |
| <a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_comment">// otherwise no session and no principals - nothing to save</em> |
| <a class="jxr_linenumber" name="L211" href="#L211">211</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L212" href="#L212">212</a> <a name="PrincipalCollection" href="../../../../org/apache/shiro/subject/PrincipalCollection.html#PrincipalCollection">PrincipalCollection</a> existingPrincipals = |
| <a class="jxr_linenumber" name="L213" href="#L213">213</a> (<a name="PrincipalCollection" href="../../../../org/apache/shiro/subject/PrincipalCollection.html#PrincipalCollection">PrincipalCollection</a>) session.getAttribute(DefaultSubjectContext.PRINCIPALS_SESSION_KEY); |
| <a class="jxr_linenumber" name="L214" href="#L214">214</a> |
| <a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">if</strong> (isEmpty(currentPrincipals)) { |
| <a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">if</strong> (!isEmpty(existingPrincipals)) { |
| <a class="jxr_linenumber" name="L217" href="#L217">217</a> session.removeAttribute(DefaultSubjectContext.PRINCIPALS_SESSION_KEY); |
| <a class="jxr_linenumber" name="L218" href="#L218">218</a> } |
| <a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_comment">// otherwise both are null or empty - no need to update the session</em> |
| <a class="jxr_linenumber" name="L220" href="#L220">220</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">if</strong> (!currentPrincipals.equals(existingPrincipals)) { |
| <a class="jxr_linenumber" name="L222" href="#L222">222</a> session.setAttribute(DefaultSubjectContext.PRINCIPALS_SESSION_KEY, currentPrincipals); |
| <a class="jxr_linenumber" name="L223" href="#L223">223</a> } |
| <a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_comment">// otherwise they're the same - no need to update the session</em> |
| <a class="jxr_linenumber" name="L225" href="#L225">225</a> } |
| <a class="jxr_linenumber" name="L226" href="#L226">226</a> } |
| <a class="jxr_linenumber" name="L227" href="#L227">227</a> } |
| <a class="jxr_linenumber" name="L228" href="#L228">228</a> |
| <a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> * Merges the Subject's current authentication state with whatever may be in</em> |
| <a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> * any available session. Only updates the Subject's session if the session does not match the current</em> |
| <a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> * authentication state.</em> |
| <a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> * @param subject the Subject for which principals will potentially be merged into the Subject's session.</em> |
| <a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> mergeAuthenticationState(<a name="Subject" href="../../../../org/apache/shiro/subject/Subject.html#Subject">Subject</a> subject) { |
| <a class="jxr_linenumber" name="L237" href="#L237">237</a> |
| <a class="jxr_linenumber" name="L238" href="#L238">238</a> <a name="Session" href="../../../../org/apache/shiro/session/Session.html#Session">Session</a> session = subject.getSession(false); |
| <a class="jxr_linenumber" name="L239" href="#L239">239</a> |
| <a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">if</strong> (session == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">if</strong> (subject.isAuthenticated()) { |
| <a class="jxr_linenumber" name="L242" href="#L242">242</a> session = subject.getSession(); |
| <a class="jxr_linenumber" name="L243" href="#L243">243</a> session.setAttribute(DefaultSubjectContext.AUTHENTICATED_SESSION_KEY, Boolean.TRUE); |
| <a class="jxr_linenumber" name="L244" href="#L244">244</a> } |
| <a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_comment">//otherwise no session and not authenticated - nothing to save</em> |
| <a class="jxr_linenumber" name="L246" href="#L246">246</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L247" href="#L247">247</a> Boolean existingAuthc = (Boolean) session.getAttribute(DefaultSubjectContext.AUTHENTICATED_SESSION_KEY); |
| <a class="jxr_linenumber" name="L248" href="#L248">248</a> |
| <a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">if</strong> (subject.isAuthenticated()) { |
| <a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">if</strong> (existingAuthc == <strong class="jxr_keyword">null</strong> || !existingAuthc) { |
| <a class="jxr_linenumber" name="L251" href="#L251">251</a> session.setAttribute(DefaultSubjectContext.AUTHENTICATED_SESSION_KEY, Boolean.TRUE); |
| <a class="jxr_linenumber" name="L252" href="#L252">252</a> } |
| <a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_comment">//otherwise authc state matches - no need to update the session</em> |
| <a class="jxr_linenumber" name="L254" href="#L254">254</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">if</strong> (existingAuthc != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_comment">//existing doesn't match the current state - remove it:</em> |
| <a class="jxr_linenumber" name="L257" href="#L257">257</a> session.removeAttribute(DefaultSubjectContext.AUTHENTICATED_SESSION_KEY); |
| <a class="jxr_linenumber" name="L258" href="#L258">258</a> } |
| <a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_comment">//otherwise not in the session and not authenticated - no need to update the session</em> |
| <a class="jxr_linenumber" name="L260" href="#L260">260</a> } |
| <a class="jxr_linenumber" name="L261" href="#L261">261</a> } |
| <a class="jxr_linenumber" name="L262" href="#L262">262</a> } |
| <a class="jxr_linenumber" name="L263" href="#L263">263</a> |
| <a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> * Removes any existing subject state from the Subject's session (if the session exists). If the session</em> |
| <a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> * does not exist, this method does not do anything.</em> |
| <a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * @param subject the subject for which any existing subject state will be removed from its session.</em> |
| <a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L270" href="#L270">270</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> removeFromSession(<a name="Subject" href="../../../../org/apache/shiro/subject/Subject.html#Subject">Subject</a> subject) { |
| <a class="jxr_linenumber" name="L271" href="#L271">271</a> <a name="Session" href="../../../../org/apache/shiro/session/Session.html#Session">Session</a> session = subject.getSession(false); |
| <a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">if</strong> (session != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L273" href="#L273">273</a> session.removeAttribute(DefaultSubjectContext.AUTHENTICATED_SESSION_KEY); |
| <a class="jxr_linenumber" name="L274" href="#L274">274</a> session.removeAttribute(DefaultSubjectContext.PRINCIPALS_SESSION_KEY); |
| <a class="jxr_linenumber" name="L275" href="#L275">275</a> } |
| <a class="jxr_linenumber" name="L276" href="#L276">276</a> } |
| <a class="jxr_linenumber" name="L277" href="#L277">277</a> |
| <a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> * Removes any existing subject state from the subject's session (if the session exists).</em> |
| <a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_javadoccomment"> * @param subject the Subject instance for which any persistent state should be deleted.</em> |
| <a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> delete(<a name="Subject" href="../../../../org/apache/shiro/subject/Subject.html#Subject">Subject</a> subject) { |
| <a class="jxr_linenumber" name="L284" href="#L284">284</a> removeFromSession(subject); |
| <a class="jxr_linenumber" name="L285" href="#L285">285</a> } |
| <a class="jxr_linenumber" name="L286" href="#L286">286</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2004–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
