blob: fa96c20710a5f673aee861582d10c960c9d0ce62 [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=ISO-8859-1" />
<title>DefaultSecurityManager xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/shiro/mgt/DefaultSecurityManager.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.authc.*;
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authz.Authorizer;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.realm.Realm;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.InvalidSessionException;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.Session;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.mgt.DefaultSessionContext;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.mgt.DefaultSessionKey;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.mgt.SessionContext;
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.mgt.SessionKey;
<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.PrincipalCollection;
<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.Subject;
<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.SubjectContext;
<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.support.DefaultSubjectContext;
<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.CollectionUtils;
<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a name="37" href="#37">37</a>
<a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> java.io.Serializable;
<a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> java.util.Collection;
<a name="40" href="#40">40</a>
<a name="41" href="#41">41</a> <em class="jxr_javadoccomment">/**</em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * The Shiro framework's default concrete implementation of the {@link SecurityManager} interface,</em>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * based around a collection of {@link org.apache.shiro.realm.Realm}s. This implementation delegates its</em>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * authentication, authorization, and session operations to wrapped {@link Authenticator}, {@link Authorizer}, and</em>
<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.session.mgt.SessionManager SessionManager} instances respectively via superclass</em>
<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * implementation.</em>
<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * To greatly reduce and simplify configuration, this implementation (and its superclasses) will</em>
<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * create suitable defaults for all of its required dependencies, &lt;em&gt;except&lt;/em&gt; the required one or more</em>
<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * {@link Realm Realm}s. Because {@code Realm} implementations usually interact with an application's data model,</em>
<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * they are almost always application specific; you will want to specify at least one custom</em>
<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * {@code Realm} implementation that 'knows' about your application's data/security model</em>
<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * (via {@link #setRealm} or one of the overloaded constructors). All other attributes in this class hierarchy</em>
<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * will have suitable defaults for most enterprise applications.</em>
<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * &lt;b&gt;RememberMe notice&lt;/b&gt;: This class supports the ability to configure a</em>
<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * {@link #setRememberMeManager RememberMeManager}</em>
<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * for {@code RememberMe} identity services for login/logout, BUT, a default instance &lt;em&gt;will not&lt;/em&gt; be created</em>
<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * for this attribute at startup.</em>
<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * Because RememberMe services are inherently client tier-specific and</em>
<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * therefore aplication-dependent, if you want {@code RememberMe} services enabled, you will have to specify an</em>
<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * instance yourself via the {@link #setRememberMeManager(RememberMeManager) setRememberMeManager}</em>
<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * mutator. However if you're reading this JavaDoc with the</em>
<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * expectation of operating in a Web environment, take a look at the</em>
<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * {@code org.apache.shiro.web.DefaultWebSecurityManager} implementation, which</em>
<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * &lt;em&gt;does&lt;/em&gt; support {@code RememberMe} services by default at startup.</em>
<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> *</em>
<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * @since 0.2</em>
<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> */</em>
<a name="71" href="#71">71</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/shiro/mgt/DefaultSecurityManager.html">DefaultSecurityManager</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/shiro/mgt/SessionsSecurityManager.html">SessionsSecurityManager</a> {
<a name="72" href="#72">72</a>
<a name="73" href="#73">73</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(DefaultSecurityManager.<strong class="jxr_keyword">class</strong>);
<a name="74" href="#74">74</a>
<a name="75" href="#75">75</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/mgt/RememberMeManager.html">RememberMeManager</a> rememberMeManager;
<a name="76" href="#76">76</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/mgt/SubjectDAO.html">SubjectDAO</a> subjectDAO;
<a name="77" href="#77">77</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/mgt/SubjectFactory.html">SubjectFactory</a> subjectFactory;
<a name="78" href="#78">78</a>
<a name="79" href="#79">79</a> <em class="jxr_javadoccomment">/**</em>
<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * Default no-arg constructor.</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> <a href="../../../../org/apache/shiro/mgt/DefaultSecurityManager.html">DefaultSecurityManager</a>() {
<a name="83" href="#83">83</a> <strong class="jxr_keyword">super</strong>();
<a name="84" href="#84">84</a> <strong class="jxr_keyword">this</strong>.subjectFactory = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/mgt/DefaultSubjectFactory.html">DefaultSubjectFactory</a>();
<a name="85" href="#85">85</a> <strong class="jxr_keyword">this</strong>.subjectDAO = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/mgt/DefaultSubjectDAO.html">DefaultSubjectDAO</a>();
<a name="86" href="#86">86</a> }
<a name="87" href="#87">87</a>
<a name="88" href="#88">88</a> <em class="jxr_javadoccomment">/**</em>
<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * Supporting constructor for a single-realm application.</em>
<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> *</em>
<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * @param singleRealm the single realm used by this SecurityManager.</em>
<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> */</em>
<a name="93" href="#93">93</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/mgt/DefaultSecurityManager.html">DefaultSecurityManager</a>(<a href="../../../../org/apache/shiro/realm/Realm.html">Realm</a> singleRealm) {
<a name="94" href="#94">94</a> <strong class="jxr_keyword">this</strong>();
<a name="95" href="#95">95</a> setRealm(singleRealm);
<a name="96" href="#96">96</a> }
<a name="97" href="#97">97</a>
<a name="98" href="#98">98</a> <em class="jxr_javadoccomment">/**</em>
<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * Supporting constructor for multiple {@link #setRealms realms}.</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 realms the realm instances backing this SecurityManager.</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> */</em>
<a name="103" href="#103">103</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/mgt/DefaultSecurityManager.html">DefaultSecurityManager</a>(Collection&lt;Realm&gt; realms) {
<a name="104" href="#104">104</a> <strong class="jxr_keyword">this</strong>();
<a name="105" href="#105">105</a> setRealms(realms);
<a name="106" href="#106">106</a> }
<a name="107" href="#107">107</a>
<a name="108" href="#108">108</a> <em class="jxr_javadoccomment">/**</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * Returns the {@code SubjectFactory} responsible for creating {@link Subject} instances exposed to the application.</em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> *</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * @return the {@code SubjectFactory} responsible for creating {@link Subject} instances exposed to the application.</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> */</em>
<a name="113" href="#113">113</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/mgt/SubjectFactory.html">SubjectFactory</a> getSubjectFactory() {
<a name="114" href="#114">114</a> <strong class="jxr_keyword">return</strong> subjectFactory;
<a name="115" href="#115">115</a> }
<a name="116" href="#116">116</a>
<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">/**</em>
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * Sets the {@code SubjectFactory} responsible for creating {@link Subject} instances exposed to the application.</em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> *</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * @param subjectFactory the {@code SubjectFactory} responsible for creating {@link Subject} instances exposed to the application.</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> */</em>
<a name="122" href="#122">122</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSubjectFactory(<a href="../../../../org/apache/shiro/mgt/SubjectFactory.html">SubjectFactory</a> subjectFactory) {
<a name="123" href="#123">123</a> <strong class="jxr_keyword">this</strong>.subjectFactory = subjectFactory;
<a name="124" href="#124">124</a> }
<a name="125" href="#125">125</a>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">/**</em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * Returns the {@code SubjectDAO} responsible for persisting Subject state, typically used after login or when an</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * Subject identity is discovered (eg after RememberMe services). Unless configured otherwise, the default</em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * implementation is a {@link DefaultSubjectDAO}.</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> *</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * @return the {@code SubjectDAO} responsible for persisting Subject state, typically used after login or when an</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * Subject identity is discovered (eg after RememberMe services).</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * @see DefaultSubjectDAO</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> */</em>
<a name="136" href="#136">136</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/mgt/SubjectDAO.html">SubjectDAO</a> getSubjectDAO() {
<a name="137" href="#137">137</a> <strong class="jxr_keyword">return</strong> subjectDAO;
<a name="138" href="#138">138</a> }
<a name="139" href="#139">139</a>
<a name="140" href="#140">140</a> <em class="jxr_javadoccomment">/**</em>
<a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> * Sets the {@code SubjectDAO} responsible for persisting Subject state, typically used after login or when an</em>
<a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * Subject identity is discovered (eg after RememberMe services). Unless configured otherwise, the default</em>
<a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * implementation is a {@link DefaultSubjectDAO}.</em>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> *</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * @param subjectDAO the {@code SubjectDAO} responsible for persisting Subject state, typically used after login or when an</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * Subject identity is discovered (eg after RememberMe services).</em>
<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * @see DefaultSubjectDAO</em>
<a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> */</em>
<a name="150" href="#150">150</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSubjectDAO(<a href="../../../../org/apache/shiro/mgt/SubjectDAO.html">SubjectDAO</a> subjectDAO) {
<a name="151" href="#151">151</a> <strong class="jxr_keyword">this</strong>.subjectDAO = subjectDAO;
<a name="152" href="#152">152</a> }
<a name="153" href="#153">153</a>
<a name="154" href="#154">154</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/mgt/RememberMeManager.html">RememberMeManager</a> getRememberMeManager() {
<a name="155" href="#155">155</a> <strong class="jxr_keyword">return</strong> rememberMeManager;
<a name="156" href="#156">156</a> }
<a name="157" href="#157">157</a>
<a name="158" href="#158">158</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRememberMeManager(<a href="../../../../org/apache/shiro/mgt/RememberMeManager.html">RememberMeManager</a> rememberMeManager) {
<a name="159" href="#159">159</a> <strong class="jxr_keyword">this</strong>.rememberMeManager = rememberMeManager;
<a name="160" href="#160">160</a> }
<a name="161" href="#161">161</a>
<a name="162" href="#162">162</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> createSubjectContext() {
<a name="163" href="#163">163</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/subject/support/DefaultSubjectContext.html">DefaultSubjectContext</a>();
<a name="164" href="#164">164</a> }
<a name="165" href="#165">165</a>
<a name="166" href="#166">166</a> <em class="jxr_javadoccomment">/**</em>
<a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * Creates a {@code Subject} instance for the user represented by the given method arguments.</em>
<a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> *</em>
<a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> * @param token the {@code AuthenticationToken} submitted for the successful authentication.</em>
<a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * @param info the {@code AuthenticationInfo} of a newly authenticated user.</em>
<a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * @param existing the existing {@code Subject} instance that initiated the authentication attempt</em>
<a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> * @return the {@code Subject} instance that represents the context and session data for the newly</em>
<a name="173" href="#173">173</a> <em class="jxr_javadoccomment"> * authenticated subject.</em>
<a name="174" href="#174">174</a> <em class="jxr_javadoccomment"> */</em>
<a name="175" href="#175">175</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> createSubject(<a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token, <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info, <a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> existing) {
<a name="176" href="#176">176</a> <a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> context = createSubjectContext();
<a name="177" href="#177">177</a> context.setAuthenticated(<strong class="jxr_keyword">true</strong>);
<a name="178" href="#178">178</a> context.setAuthenticationToken(token);
<a name="179" href="#179">179</a> context.setAuthenticationInfo(info);
<a name="180" href="#180">180</a> <strong class="jxr_keyword">if</strong> (existing != <strong class="jxr_keyword">null</strong>) {
<a name="181" href="#181">181</a> context.setSubject(existing);
<a name="182" href="#182">182</a> }
<a name="183" href="#183">183</a> <strong class="jxr_keyword">return</strong> createSubject(context);
<a name="184" href="#184">184</a> }
<a name="185" href="#185">185</a>
<a name="186" href="#186">186</a> <em class="jxr_javadoccomment">/**</em>
<a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * Binds a {@code Subject} instance created after authentication to the application for later use.</em>
<a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * As of Shiro 1.2, this method has been deprecated in favor of {@link #save(org.apache.shiro.subject.Subject)},</em>
<a name="190" href="#190">190</a> <em class="jxr_javadoccomment"> * which this implementation now calls.</em>
<a name="191" href="#191">191</a> <em class="jxr_javadoccomment"> *</em>
<a name="192" href="#192">192</a> <em class="jxr_javadoccomment"> * @param subject the {@code Subject} instance created after authentication to be bound to the application</em>
<a name="193" href="#193">193</a> <em class="jxr_javadoccomment"> * for later use.</em>
<a name="194" href="#194">194</a> <em class="jxr_javadoccomment"> * @see #save(org.apache.shiro.subject.Subject)</em>
<a name="195" href="#195">195</a> <em class="jxr_javadoccomment"> * @deprecated in favor of {@link #save(org.apache.shiro.subject.Subject) save(subject)}.</em>
<a name="196" href="#196">196</a> <em class="jxr_javadoccomment"> */</em>
<a name="197" href="#197">197</a> @Deprecated
<a name="198" href="#198">198</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> bind(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) {
<a name="199" href="#199">199</a> save(subject);
<a name="200" href="#200">200</a> }
<a name="201" href="#201">201</a>
<a name="202" href="#202">202</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> rememberMeSuccessfulLogin(<a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token, <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info, <a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) {
<a name="203" href="#203">203</a> <a href="../../../../org/apache/shiro/mgt/RememberMeManager.html">RememberMeManager</a> rmm = getRememberMeManager();
<a name="204" href="#204">204</a> <strong class="jxr_keyword">if</strong> (rmm != <strong class="jxr_keyword">null</strong>) {
<a name="205" href="#205">205</a> <strong class="jxr_keyword">try</strong> {
<a name="206" href="#206">206</a> rmm.onSuccessfulLogin(subject, token, info);
<a name="207" href="#207">207</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="208" href="#208">208</a> <strong class="jxr_keyword">if</strong> (log.isWarnEnabled()) {
<a name="209" href="#209">209</a> String msg = <span class="jxr_string">"Delegate RememberMeManager instance of type ["</span> + rmm.getClass().getName() +
<a name="210" href="#210">210</a> <span class="jxr_string">"] threw an exception during onSuccessfulLogin. RememberMe services will not be "</span> +
<a name="211" href="#211">211</a> <span class="jxr_string">"performed for account ["</span> + info + <span class="jxr_string">"]."</span>;
<a name="212" href="#212">212</a> log.warn(msg, e);
<a name="213" href="#213">213</a> }
<a name="214" href="#214">214</a> }
<a name="215" href="#215">215</a> } <strong class="jxr_keyword">else</strong> {
<a name="216" href="#216">216</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) {
<a name="217" href="#217">217</a> log.trace(<span class="jxr_string">"This "</span> + getClass().getName() + <span class="jxr_string">" instance does not have a "</span> +
<a name="218" href="#218">218</a> <span class="jxr_string">"["</span> + RememberMeManager.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">"] instance configured. RememberMe services "</span> +
<a name="219" href="#219">219</a> <span class="jxr_string">"will not be performed for account ["</span> + info + <span class="jxr_string">"]."</span>);
<a name="220" href="#220">220</a> }
<a name="221" href="#221">221</a> }
<a name="222" href="#222">222</a> }
<a name="223" href="#223">223</a>
<a name="224" href="#224">224</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> rememberMeFailedLogin(<a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token, <a href="../../../../org/apache/shiro/authc/AuthenticationException.html">AuthenticationException</a> ex, <a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) {
<a name="225" href="#225">225</a> <a href="../../../../org/apache/shiro/mgt/RememberMeManager.html">RememberMeManager</a> rmm = getRememberMeManager();
<a name="226" href="#226">226</a> <strong class="jxr_keyword">if</strong> (rmm != <strong class="jxr_keyword">null</strong>) {
<a name="227" href="#227">227</a> <strong class="jxr_keyword">try</strong> {
<a name="228" href="#228">228</a> rmm.onFailedLogin(subject, token, ex);
<a name="229" href="#229">229</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="230" href="#230">230</a> <strong class="jxr_keyword">if</strong> (log.isWarnEnabled()) {
<a name="231" href="#231">231</a> String msg = <span class="jxr_string">"Delegate RememberMeManager instance of type ["</span> + rmm.getClass().getName() +
<a name="232" href="#232">232</a> <span class="jxr_string">"] threw an exception during onFailedLogin for AuthenticationToken ["</span> +
<a name="233" href="#233">233</a> token + <span class="jxr_string">"]."</span>;
<a name="234" href="#234">234</a> log.warn(msg, e);
<a name="235" href="#235">235</a> }
<a name="236" href="#236">236</a> }
<a name="237" href="#237">237</a> }
<a name="238" href="#238">238</a> }
<a name="239" href="#239">239</a>
<a name="240" href="#240">240</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> rememberMeLogout(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) {
<a name="241" href="#241">241</a> <a href="../../../../org/apache/shiro/mgt/RememberMeManager.html">RememberMeManager</a> rmm = getRememberMeManager();
<a name="242" href="#242">242</a> <strong class="jxr_keyword">if</strong> (rmm != <strong class="jxr_keyword">null</strong>) {
<a name="243" href="#243">243</a> <strong class="jxr_keyword">try</strong> {
<a name="244" href="#244">244</a> rmm.onLogout(subject);
<a name="245" href="#245">245</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="246" href="#246">246</a> <strong class="jxr_keyword">if</strong> (log.isWarnEnabled()) {
<a name="247" href="#247">247</a> String msg = <span class="jxr_string">"Delegate RememberMeManager instance of type ["</span> + rmm.getClass().getName() +
<a name="248" href="#248">248</a> <span class="jxr_string">"] threw an exception during onLogout for subject with principals ["</span> +
<a name="249" href="#249">249</a> (subject != <strong class="jxr_keyword">null</strong> ? subject.getPrincipals() : <strong class="jxr_keyword">null</strong>) + <span class="jxr_string">"]"</span>;
<a name="250" href="#250">250</a> log.warn(msg, e);
<a name="251" href="#251">251</a> }
<a name="252" href="#252">252</a> }
<a name="253" href="#253">253</a> }
<a name="254" href="#254">254</a> }
<a name="255" href="#255">255</a>
<a name="256" href="#256">256</a> <em class="jxr_javadoccomment">/**</em>
<a name="257" href="#257">257</a> <em class="jxr_javadoccomment"> * First authenticates the {@code AuthenticationToken} argument, and if successful, constructs a</em>
<a name="258" href="#258">258</a> <em class="jxr_javadoccomment"> * {@code Subject} instance representing the authenticated account's identity.</em>
<a name="259" href="#259">259</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="260" href="#260">260</a> <em class="jxr_javadoccomment"> * Once constructed, the {@code Subject} instance is then {@link #bind bound} to the application for</em>
<a name="261" href="#261">261</a> <em class="jxr_javadoccomment"> * subsequent access before being returned to the caller.</em>
<a name="262" href="#262">262</a> <em class="jxr_javadoccomment"> *</em>
<a name="263" href="#263">263</a> <em class="jxr_javadoccomment"> * @param token the authenticationToken to process for the login attempt.</em>
<a name="264" href="#264">264</a> <em class="jxr_javadoccomment"> * @return a Subject representing the authenticated user.</em>
<a name="265" href="#265">265</a> <em class="jxr_javadoccomment"> * @throws AuthenticationException if there is a problem authenticating the specified {@code token}.</em>
<a name="266" href="#266">266</a> <em class="jxr_javadoccomment"> */</em>
<a name="267" href="#267">267</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> login(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject, <a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token) <strong class="jxr_keyword">throws</strong> AuthenticationException {
<a name="268" href="#268">268</a> <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info;
<a name="269" href="#269">269</a> <strong class="jxr_keyword">try</strong> {
<a name="270" href="#270">270</a> info = authenticate(token);
<a name="271" href="#271">271</a> } <strong class="jxr_keyword">catch</strong> (AuthenticationException ae) {
<a name="272" href="#272">272</a> <strong class="jxr_keyword">try</strong> {
<a name="273" href="#273">273</a> onFailedLogin(token, ae, subject);
<a name="274" href="#274">274</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="275" href="#275">275</a> <strong class="jxr_keyword">if</strong> (log.isInfoEnabled()) {
<a name="276" href="#276">276</a> log.info(<span class="jxr_string">"onFailedLogin method threw an "</span> +
<a name="277" href="#277">277</a> <span class="jxr_string">"exception. Logging and propagating original AuthenticationException."</span>, e);
<a name="278" href="#278">278</a> }
<a name="279" href="#279">279</a> }
<a name="280" href="#280">280</a> <strong class="jxr_keyword">throw</strong> ae; <em class="jxr_comment">//propagate</em>
<a name="281" href="#281">281</a> }
<a name="282" href="#282">282</a>
<a name="283" href="#283">283</a> <a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> loggedIn = createSubject(token, info, subject);
<a name="284" href="#284">284</a>
<a name="285" href="#285">285</a> onSuccessfulLogin(token, info, loggedIn);
<a name="286" href="#286">286</a>
<a name="287" href="#287">287</a> <strong class="jxr_keyword">return</strong> loggedIn;
<a name="288" href="#288">288</a> }
<a name="289" href="#289">289</a>
<a name="290" href="#290">290</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> onSuccessfulLogin(<a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token, <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info, <a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) {
<a name="291" href="#291">291</a> rememberMeSuccessfulLogin(token, info, subject);
<a name="292" href="#292">292</a> }
<a name="293" href="#293">293</a>
<a name="294" href="#294">294</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> onFailedLogin(<a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token, <a href="../../../../org/apache/shiro/authc/AuthenticationException.html">AuthenticationException</a> ae, <a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) {
<a name="295" href="#295">295</a> rememberMeFailedLogin(token, ae, subject);
<a name="296" href="#296">296</a> }
<a name="297" href="#297">297</a>
<a name="298" href="#298">298</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> beforeLogout(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) {
<a name="299" href="#299">299</a> rememberMeLogout(subject);
<a name="300" href="#300">300</a> }
<a name="301" href="#301">301</a>
<a name="302" href="#302">302</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> copy(<a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> subjectContext) {
<a name="303" href="#303">303</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/subject/support/DefaultSubjectContext.html">DefaultSubjectContext</a>(subjectContext);
<a name="304" href="#304">304</a> }
<a name="305" href="#305">305</a>
<a name="306" href="#306">306</a> <em class="jxr_javadoccomment">/**</em>
<a name="307" href="#307">307</a> <em class="jxr_javadoccomment"> * This implementation functions as follows:</em>
<a name="308" href="#308">308</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="309" href="#309">309</a> <em class="jxr_javadoccomment"> * &lt;ol&gt;</em>
<a name="310" href="#310">310</a> <em class="jxr_javadoccomment"> * &lt;li&gt;Ensures the {@code SubjectContext} is as populated as it can be, using heuristics to acquire</em>
<a name="311" href="#311">311</a> <em class="jxr_javadoccomment"> * data that may not have already been available to it (such as a referenced session or remembered principals).&lt;/li&gt;</em>
<a name="312" href="#312">312</a> <em class="jxr_javadoccomment"> * &lt;li&gt;Calls {@link #doCreateSubject(org.apache.shiro.subject.SubjectContext)} to actually perform the</em>
<a name="313" href="#313">313</a> <em class="jxr_javadoccomment"> * {@code Subject} instance creation.&lt;/li&gt;</em>
<a name="314" href="#314">314</a> <em class="jxr_javadoccomment"> * &lt;li&gt;calls {@link #save(org.apache.shiro.subject.Subject) save(subject)} to ensure the constructed</em>
<a name="315" href="#315">315</a> <em class="jxr_javadoccomment"> * {@code Subject}'s state is accessible for future requests/invocations if necessary.&lt;/li&gt;</em>
<a name="316" href="#316">316</a> <em class="jxr_javadoccomment"> * &lt;li&gt;returns the constructed {@code Subject} instance.&lt;/li&gt;</em>
<a name="317" href="#317">317</a> <em class="jxr_javadoccomment"> * &lt;/ol&gt;</em>
<a name="318" href="#318">318</a> <em class="jxr_javadoccomment"> *</em>
<a name="319" href="#319">319</a> <em class="jxr_javadoccomment"> * @param subjectContext any data needed to direct how the Subject should be constructed.</em>
<a name="320" href="#320">320</a> <em class="jxr_javadoccomment"> * @return the {@code Subject} instance reflecting the specified contextual data.</em>
<a name="321" href="#321">321</a> <em class="jxr_javadoccomment"> * @see #ensureSecurityManager(org.apache.shiro.subject.SubjectContext)</em>
<a name="322" href="#322">322</a> <em class="jxr_javadoccomment"> * @see #resolveSession(org.apache.shiro.subject.SubjectContext)</em>
<a name="323" href="#323">323</a> <em class="jxr_javadoccomment"> * @see #resolvePrincipals(org.apache.shiro.subject.SubjectContext)</em>
<a name="324" href="#324">324</a> <em class="jxr_javadoccomment"> * @see #doCreateSubject(org.apache.shiro.subject.SubjectContext)</em>
<a name="325" href="#325">325</a> <em class="jxr_javadoccomment"> * @see #save(org.apache.shiro.subject.Subject)</em>
<a name="326" href="#326">326</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a name="327" href="#327">327</a> <em class="jxr_javadoccomment"> */</em>
<a name="328" href="#328">328</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> createSubject(<a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> subjectContext) {
<a name="329" href="#329">329</a> <em class="jxr_comment">//create a copy so we don't modify the argument's backing map:</em>
<a name="330" href="#330">330</a> <a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> context = copy(subjectContext);
<a name="331" href="#331">331</a>
<a name="332" href="#332">332</a> <em class="jxr_comment">//ensure that the context has a SecurityManager instance, and if not, add one:</em>
<a name="333" href="#333">333</a> context = ensureSecurityManager(context);
<a name="334" href="#334">334</a>
<a name="335" href="#335">335</a> <em class="jxr_comment">//Resolve an associated Session (usually based on a referenced session ID), and place it in the context before</em>
<a name="336" href="#336">336</a> <em class="jxr_comment">//sending to the SubjectFactory. The SubjectFactory should not need to know how to acquire sessions as the</em>
<a name="337" href="#337">337</a> <em class="jxr_comment">//process is often environment specific - better to shield the SF from these details:</em>
<a name="338" href="#338">338</a> context = resolveSession(context);
<a name="339" href="#339">339</a>
<a name="340" href="#340">340</a> <em class="jxr_comment">//Similarly, the SubjectFactory should not require any concept of RememberMe - translate that here first</em>
<a name="341" href="#341">341</a> <em class="jxr_comment">//if possible before handing off to the SubjectFactory:</em>
<a name="342" href="#342">342</a> context = resolvePrincipals(context);
<a name="343" href="#343">343</a>
<a name="344" href="#344">344</a> <a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject = doCreateSubject(context);
<a name="345" href="#345">345</a>
<a name="346" href="#346">346</a> <em class="jxr_comment">//save this subject for future reference if necessary:</em>
<a name="347" href="#347">347</a> <em class="jxr_comment">//(this is needed here in case rememberMe principals were resolved and they need to be stored in the</em>
<a name="348" href="#348">348</a> <em class="jxr_comment">//session, so we don't constantly rehydrate the rememberMe PrincipalCollection on every operation).</em>
<a name="349" href="#349">349</a> <em class="jxr_comment">//Added in 1.2:</em>
<a name="350" href="#350">350</a> save(subject);
<a name="351" href="#351">351</a>
<a name="352" href="#352">352</a> <strong class="jxr_keyword">return</strong> subject;
<a name="353" href="#353">353</a> }
<a name="354" href="#354">354</a>
<a name="355" href="#355">355</a> <em class="jxr_javadoccomment">/**</em>
<a name="356" href="#356">356</a> <em class="jxr_javadoccomment"> * Actually creates a {@code Subject} instance by delegating to the internal</em>
<a name="357" href="#357">357</a> <em class="jxr_javadoccomment"> * {@link #getSubjectFactory() subjectFactory}. By the time this method is invoked, all possible</em>
<a name="358" href="#358">358</a> <em class="jxr_javadoccomment"> * {@code SubjectContext} data (session, principals, et. al.) has been made accessible using all known heuristics</em>
<a name="359" href="#359">359</a> <em class="jxr_javadoccomment"> * and will be accessible to the {@code subjectFactory} via the {@code subjectContext.resolve*} methods.</em>
<a name="360" href="#360">360</a> <em class="jxr_javadoccomment"> *</em>
<a name="361" href="#361">361</a> <em class="jxr_javadoccomment"> * @param context the populated context (data map) to be used by the {@code SubjectFactory} when creating a</em>
<a name="362" href="#362">362</a> <em class="jxr_javadoccomment"> * {@code Subject} instance.</em>
<a name="363" href="#363">363</a> <em class="jxr_javadoccomment"> * @return a {@code Subject} instance reflecting the data in the specified {@code SubjectContext} data map.</em>
<a name="364" href="#364">364</a> <em class="jxr_javadoccomment"> * @see #getSubjectFactory()</em>
<a name="365" href="#365">365</a> <em class="jxr_javadoccomment"> * @see SubjectFactory#createSubject(org.apache.shiro.subject.SubjectContext)</em>
<a name="366" href="#366">366</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a name="367" href="#367">367</a> <em class="jxr_javadoccomment"> */</em>
<a name="368" href="#368">368</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> doCreateSubject(<a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> context) {
<a name="369" href="#369">369</a> <strong class="jxr_keyword">return</strong> getSubjectFactory().createSubject(context);
<a name="370" href="#370">370</a> }
<a name="371" href="#371">371</a>
<a name="372" href="#372">372</a> <em class="jxr_javadoccomment">/**</em>
<a name="373" href="#373">373</a> <em class="jxr_javadoccomment"> * Saves the subject's state to a persistent location for future reference if necessary.</em>
<a name="374" href="#374">374</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="375" href="#375">375</a> <em class="jxr_javadoccomment"> * This implementation merely delegates to the internal {@link #setSubjectDAO(SubjectDAO) subjectDAO} and calls</em>
<a name="376" href="#376">376</a> <em class="jxr_javadoccomment"> * {@link SubjectDAO#save(org.apache.shiro.subject.Subject) subjectDAO.save(subject)}.</em>
<a name="377" href="#377">377</a> <em class="jxr_javadoccomment"> *</em>
<a name="378" href="#378">378</a> <em class="jxr_javadoccomment"> * @param subject the subject for which state will potentially be persisted</em>
<a name="379" href="#379">379</a> <em class="jxr_javadoccomment"> * @see SubjectDAO#save(org.apache.shiro.subject.Subject)</em>
<a name="380" href="#380">380</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a name="381" href="#381">381</a> <em class="jxr_javadoccomment"> */</em>
<a name="382" href="#382">382</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> save(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) {
<a name="383" href="#383">383</a> <strong class="jxr_keyword">this</strong>.subjectDAO.save(subject);
<a name="384" href="#384">384</a> }
<a name="385" href="#385">385</a>
<a name="386" href="#386">386</a> <em class="jxr_javadoccomment">/**</em>
<a name="387" href="#387">387</a> <em class="jxr_javadoccomment"> * Removes (or 'unbinds') the Subject's state from the application, typically called during {@link #logout}..</em>
<a name="388" href="#388">388</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="389" href="#389">389</a> <em class="jxr_javadoccomment"> * This implementation merely delegates to the internal {@link #setSubjectDAO(SubjectDAO) subjectDAO} and calls</em>
<a name="390" href="#390">390</a> <em class="jxr_javadoccomment"> * {@link SubjectDAO#delete(org.apache.shiro.subject.Subject) delete(subject)}.</em>
<a name="391" href="#391">391</a> <em class="jxr_javadoccomment"> *</em>
<a name="392" href="#392">392</a> <em class="jxr_javadoccomment"> * @param subject the subject for which state will be removed</em>
<a name="393" href="#393">393</a> <em class="jxr_javadoccomment"> * @see SubjectDAO#delete(org.apache.shiro.subject.Subject)</em>
<a name="394" href="#394">394</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a name="395" href="#395">395</a> <em class="jxr_javadoccomment"> */</em>
<a name="396" href="#396">396</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> delete(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) {
<a name="397" href="#397">397</a> <strong class="jxr_keyword">this</strong>.subjectDAO.delete(subject);
<a name="398" href="#398">398</a> }
<a name="399" href="#399">399</a>
<a name="400" href="#400">400</a> <em class="jxr_javadoccomment">/**</em>
<a name="401" href="#401">401</a> <em class="jxr_javadoccomment"> * Determines if there is a {@code SecurityManager} instance in the context, and if not, adds 'this' to the</em>
<a name="402" href="#402">402</a> <em class="jxr_javadoccomment"> * context. This ensures the SubjectFactory instance will have access to a SecurityManager during Subject</em>
<a name="403" href="#403">403</a> <em class="jxr_javadoccomment"> * construction if necessary.</em>
<a name="404" href="#404">404</a> <em class="jxr_javadoccomment"> *</em>
<a name="405" href="#405">405</a> <em class="jxr_javadoccomment"> * @param context the subject context data that may contain a SecurityManager instance.</em>
<a name="406" href="#406">406</a> <em class="jxr_javadoccomment"> * @return The SubjectContext to use to pass to a {@link SubjectFactory} for subject creation.</em>
<a name="407" href="#407">407</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a name="408" href="#408">408</a> <em class="jxr_javadoccomment"> */</em>
<a name="409" href="#409">409</a> @SuppressWarnings({<span class="jxr_string">"unchecked"</span>})
<a name="410" href="#410">410</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> ensureSecurityManager(<a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> context) {
<a name="411" href="#411">411</a> <strong class="jxr_keyword">if</strong> (context.resolveSecurityManager() != <strong class="jxr_keyword">null</strong>) {
<a name="412" href="#412">412</a> log.trace(<span class="jxr_string">"Context already contains a SecurityManager instance. Returning."</span>);
<a name="413" href="#413">413</a> <strong class="jxr_keyword">return</strong> context;
<a name="414" href="#414">414</a> }
<a name="415" href="#415">415</a> log.trace(<span class="jxr_string">"No SecurityManager found in context. Adding self reference."</span>);
<a name="416" href="#416">416</a> context.setSecurityManager(<strong class="jxr_keyword">this</strong>);
<a name="417" href="#417">417</a> <strong class="jxr_keyword">return</strong> context;
<a name="418" href="#418">418</a> }
<a name="419" href="#419">419</a>
<a name="420" href="#420">420</a> <em class="jxr_javadoccomment">/**</em>
<a name="421" href="#421">421</a> <em class="jxr_javadoccomment"> * Attempts to resolve any associated session based on the context and returns a</em>
<a name="422" href="#422">422</a> <em class="jxr_javadoccomment"> * context that represents this resolved {@code Session} to ensure it may be referenced if necessary by the</em>
<a name="423" href="#423">423</a> <em class="jxr_javadoccomment"> * invoked {@link SubjectFactory} that performs actual {@link Subject} construction.</em>
<a name="424" href="#424">424</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="425" href="#425">425</a> <em class="jxr_javadoccomment"> * If there is a {@code Session} already in the context because that is what the caller wants to be used for</em>
<a name="426" href="#426">426</a> <em class="jxr_javadoccomment"> * {@code Subject} construction, or if no session is resolved, this method effectively does nothing</em>
<a name="427" href="#427">427</a> <em class="jxr_javadoccomment"> * returns the context method argument unaltered.</em>
<a name="428" href="#428">428</a> <em class="jxr_javadoccomment"> *</em>
<a name="429" href="#429">429</a> <em class="jxr_javadoccomment"> * @param context the subject context data that may resolve a Session instance.</em>
<a name="430" href="#430">430</a> <em class="jxr_javadoccomment"> * @return The context to use to pass to a {@link SubjectFactory} for subject creation.</em>
<a name="431" href="#431">431</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a name="432" href="#432">432</a> <em class="jxr_javadoccomment"> */</em>
<a name="433" href="#433">433</a> @SuppressWarnings({<span class="jxr_string">"unchecked"</span>})
<a name="434" href="#434">434</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> resolveSession(<a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> context) {
<a name="435" href="#435">435</a> <strong class="jxr_keyword">if</strong> (context.resolveSession() != <strong class="jxr_keyword">null</strong>) {
<a name="436" href="#436">436</a> log.debug(<span class="jxr_string">"Context already contains a session. Returning."</span>);
<a name="437" href="#437">437</a> <strong class="jxr_keyword">return</strong> context;
<a name="438" href="#438">438</a> }
<a name="439" href="#439">439</a> <strong class="jxr_keyword">try</strong> {
<a name="440" href="#440">440</a> <em class="jxr_comment">//Context couldn't resolve it directly, let's see if we can since we have direct access to </em>
<a name="441" href="#441">441</a> <em class="jxr_comment">//the session manager:</em>
<a name="442" href="#442">442</a> <a href="../../../../org/apache/shiro/session/Session.html">Session</a> session = resolveContextSession(context);
<a name="443" href="#443">443</a> <strong class="jxr_keyword">if</strong> (session != <strong class="jxr_keyword">null</strong>) {
<a name="444" href="#444">444</a> context.setSession(session);
<a name="445" href="#445">445</a> }
<a name="446" href="#446">446</a> } <strong class="jxr_keyword">catch</strong> (InvalidSessionException e) {
<a name="447" href="#447">447</a> log.debug(<span class="jxr_string">"Resolved SubjectContext context session is invalid. Ignoring and creating an anonymous "</span> +
<a name="448" href="#448">448</a> <span class="jxr_string">"(session-less) Subject instance."</span>, e);
<a name="449" href="#449">449</a> }
<a name="450" href="#450">450</a> <strong class="jxr_keyword">return</strong> context;
<a name="451" href="#451">451</a> }
<a name="452" href="#452">452</a>
<a name="453" href="#453">453</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/session/Session.html">Session</a> resolveContextSession(<a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> context) <strong class="jxr_keyword">throws</strong> InvalidSessionException {
<a name="454" href="#454">454</a> <a href="../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key = getSessionKey(context);
<a name="455" href="#455">455</a> <strong class="jxr_keyword">if</strong> (key != <strong class="jxr_keyword">null</strong>) {
<a name="456" href="#456">456</a> <strong class="jxr_keyword">return</strong> getSession(key);
<a name="457" href="#457">457</a> }
<a name="458" href="#458">458</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="459" href="#459">459</a> }
<a name="460" href="#460">460</a>
<a name="461" href="#461">461</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> getSessionKey(<a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> context) {
<a name="462" href="#462">462</a> Serializable sessionId = context.getSessionId();
<a name="463" href="#463">463</a> <strong class="jxr_keyword">if</strong> (sessionId != <strong class="jxr_keyword">null</strong>) {
<a name="464" href="#464">464</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/session/mgt/DefaultSessionKey.html">DefaultSessionKey</a>(sessionId);
<a name="465" href="#465">465</a> }
<a name="466" href="#466">466</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="467" href="#467">467</a> }
<a name="468" href="#468">468</a>
<a name="469" href="#469">469</a> <em class="jxr_javadoccomment">/**</em>
<a name="470" href="#470">470</a> <em class="jxr_javadoccomment"> * Attempts to resolve an identity (a {@link PrincipalCollection}) for the context using heuristics. This</em>
<a name="471" href="#471">471</a> <em class="jxr_javadoccomment"> * implementation functions as follows:</em>
<a name="472" href="#472">472</a> <em class="jxr_javadoccomment"> * &lt;ol&gt;</em>
<a name="473" href="#473">473</a> <em class="jxr_javadoccomment"> * &lt;li&gt;Check the context to see if it can already {@link SubjectContext#resolvePrincipals resolve an identity}. If</em>
<a name="474" href="#474">474</a> <em class="jxr_javadoccomment"> * so, this method does nothing and returns the method argument unaltered.&lt;/li&gt;</em>
<a name="475" href="#475">475</a> <em class="jxr_javadoccomment"> * &lt;li&gt;Check for a RememberMe identity by calling {@link #getRememberedIdentity}. If that method returns a</em>
<a name="476" href="#476">476</a> <em class="jxr_javadoccomment"> * non-null value, place the remembered {@link PrincipalCollection} in the context.&lt;/li&gt;</em>
<a name="477" href="#477">477</a> <em class="jxr_javadoccomment"> * &lt;/ol&gt;</em>
<a name="478" href="#478">478</a> <em class="jxr_javadoccomment"> *</em>
<a name="479" href="#479">479</a> <em class="jxr_javadoccomment"> * @param context the subject context data that may provide (directly or indirectly through one of its values) a</em>
<a name="480" href="#480">480</a> <em class="jxr_javadoccomment"> * {@link PrincipalCollection} identity.</em>
<a name="481" href="#481">481</a> <em class="jxr_javadoccomment"> * @return The Subject context to use to pass to a {@link SubjectFactory} for subject creation.</em>
<a name="482" href="#482">482</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a name="483" href="#483">483</a> <em class="jxr_javadoccomment"> */</em>
<a name="484" href="#484">484</a> @SuppressWarnings({<span class="jxr_string">"unchecked"</span>})
<a name="485" href="#485">485</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> resolvePrincipals(<a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> context) {
<a name="486" href="#486">486</a>
<a name="487" href="#487">487</a> <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals = context.resolvePrincipals();
<a name="488" href="#488">488</a>
<a name="489" href="#489">489</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(principals)) {
<a name="490" href="#490">490</a> log.trace(<span class="jxr_string">"No identity (PrincipalCollection) found in the context. Looking for a remembered identity."</span>);
<a name="491" href="#491">491</a>
<a name="492" href="#492">492</a> principals = getRememberedIdentity(context);
<a name="493" href="#493">493</a>
<a name="494" href="#494">494</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(principals)) {
<a name="495" href="#495">495</a> log.debug(<span class="jxr_string">"Found remembered PrincipalCollection. Adding to the context to be used "</span> +
<a name="496" href="#496">496</a> <span class="jxr_string">"for subject construction by the SubjectFactory."</span>);
<a name="497" href="#497">497</a>
<a name="498" href="#498">498</a> context.setPrincipals(principals);
<a name="499" href="#499">499</a>
<a name="500" href="#500">500</a> <em class="jxr_comment">// The following call was removed (commented out) in Shiro 1.2 because it uses the session as an</em>
<a name="501" href="#501">501</a> <em class="jxr_comment">// implementation strategy. Session use for Shiro's own needs should be controlled in a single place</em>
<a name="502" href="#502">502</a> <em class="jxr_comment">// to be more manageable for end-users: there are a number of stateless (e.g. REST) applications that</em>
<a name="503" href="#503">503</a> <em class="jxr_comment">// use Shiro that need to ensure that sessions are only used when desirable. If Shiro's internal</em>
<a name="504" href="#504">504</a> <em class="jxr_comment">// implementations used Subject sessions (setting attributes) whenever we wanted, it would be much</em>
<a name="505" href="#505">505</a> <em class="jxr_comment">// harder for end-users to control when/where that occurs.</em>
<a name="506" href="#506">506</a> <em class="jxr_comment">//</em>
<a name="507" href="#507">507</a> <em class="jxr_comment">// Because of this, the SubjectDAO was created as the single point of control, and session state logic</em>
<a name="508" href="#508">508</a> <em class="jxr_comment">// has been moved to the DefaultSubjectDAO implementation.</em>
<a name="509" href="#509">509</a>
<a name="510" href="#510">510</a> <em class="jxr_comment">// Removed in Shiro 1.2. SHIRO-157 is still satisfied by the new DefaultSubjectDAO implementation</em>
<a name="511" href="#511">511</a> <em class="jxr_comment">// introduced in 1.2</em>
<a name="512" href="#512">512</a> <em class="jxr_comment">// Satisfies SHIRO-157:</em>
<a name="513" href="#513">513</a> <em class="jxr_comment">// bindPrincipalsToSession(principals, context);</em>
<a name="514" href="#514">514</a>
<a name="515" href="#515">515</a> } <strong class="jxr_keyword">else</strong> {
<a name="516" href="#516">516</a> log.trace(<span class="jxr_string">"No remembered identity found. Returning original context."</span>);
<a name="517" href="#517">517</a> }
<a name="518" href="#518">518</a> }
<a name="519" href="#519">519</a>
<a name="520" href="#520">520</a> <strong class="jxr_keyword">return</strong> context;
<a name="521" href="#521">521</a> }
<a name="522" href="#522">522</a>
<a name="523" href="#523">523</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/session/mgt/SessionContext.html">SessionContext</a> createSessionContext(<a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> subjectContext) {
<a name="524" href="#524">524</a> <a href="../../../../org/apache/shiro/session/mgt/DefaultSessionContext.html">DefaultSessionContext</a> sessionContext = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/session/mgt/DefaultSessionContext.html">DefaultSessionContext</a>();
<a name="525" href="#525">525</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(subjectContext)) {
<a name="526" href="#526">526</a> sessionContext.putAll(subjectContext);
<a name="527" href="#527">527</a> }
<a name="528" href="#528">528</a> Serializable sessionId = subjectContext.getSessionId();
<a name="529" href="#529">529</a> <strong class="jxr_keyword">if</strong> (sessionId != <strong class="jxr_keyword">null</strong>) {
<a name="530" href="#530">530</a> sessionContext.setSessionId(sessionId);
<a name="531" href="#531">531</a> }
<a name="532" href="#532">532</a> String host = subjectContext.resolveHost();
<a name="533" href="#533">533</a> <strong class="jxr_keyword">if</strong> (host != <strong class="jxr_keyword">null</strong>) {
<a name="534" href="#534">534</a> sessionContext.setHost(host);
<a name="535" href="#535">535</a> }
<a name="536" href="#536">536</a> <strong class="jxr_keyword">return</strong> sessionContext;
<a name="537" href="#537">537</a> }
<a name="538" href="#538">538</a>
<a name="539" href="#539">539</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> logout(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) {
<a name="540" href="#540">540</a>
<a name="541" href="#541">541</a> <strong class="jxr_keyword">if</strong> (subject == <strong class="jxr_keyword">null</strong>) {
<a name="542" href="#542">542</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Subject method argument cannot be null."</span>);
<a name="543" href="#543">543</a> }
<a name="544" href="#544">544</a>
<a name="545" href="#545">545</a> beforeLogout(subject);
<a name="546" href="#546">546</a>
<a name="547" href="#547">547</a> <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals = subject.getPrincipals();
<a name="548" href="#548">548</a> <strong class="jxr_keyword">if</strong> (principals != <strong class="jxr_keyword">null</strong> &amp;&amp; !principals.isEmpty()) {
<a name="549" href="#549">549</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a name="550" href="#550">550</a> log.debug(<span class="jxr_string">"Logging out subject with primary principal {}"</span>, principals.getPrimaryPrincipal());
<a name="551" href="#551">551</a> }
<a name="552" href="#552">552</a> <a href="../../../../org/apache/shiro/authc/Authenticator.html">Authenticator</a> authc = getAuthenticator();
<a name="553" href="#553">553</a> <strong class="jxr_keyword">if</strong> (authc instanceof LogoutAware) {
<a name="554" href="#554">554</a> ((<a href="../../../../org/apache/shiro/authc/LogoutAware.html">LogoutAware</a>) authc).onLogout(principals);
<a name="555" href="#555">555</a> }
<a name="556" href="#556">556</a> }
<a name="557" href="#557">557</a>
<a name="558" href="#558">558</a> <strong class="jxr_keyword">try</strong> {
<a name="559" href="#559">559</a> delete(subject);
<a name="560" href="#560">560</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="561" href="#561">561</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a name="562" href="#562">562</a> String msg = <span class="jxr_string">"Unable to cleanly unbind Subject. Ignoring (logging out)."</span>;
<a name="563" href="#563">563</a> log.debug(msg, e);
<a name="564" href="#564">564</a> }
<a name="565" href="#565">565</a> } <strong class="jxr_keyword">finally</strong> {
<a name="566" href="#566">566</a> <strong class="jxr_keyword">try</strong> {
<a name="567" href="#567">567</a> stopSession(subject);
<a name="568" href="#568">568</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="569" href="#569">569</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a name="570" href="#570">570</a> String msg = <span class="jxr_string">"Unable to cleanly stop Session for Subject ["</span> + subject.getPrincipal() + <span class="jxr_string">"] "</span> +
<a name="571" href="#571">571</a> <span class="jxr_string">"Ignoring (logging out)."</span>;
<a name="572" href="#572">572</a> log.debug(msg, e);
<a name="573" href="#573">573</a> }
<a name="574" href="#574">574</a> }
<a name="575" href="#575">575</a> }
<a name="576" href="#576">576</a> }
<a name="577" href="#577">577</a>
<a name="578" href="#578">578</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> stopSession(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) {
<a name="579" href="#579">579</a> <a href="../../../../org/apache/shiro/session/Session.html">Session</a> s = subject.getSession(false);
<a name="580" href="#580">580</a> <strong class="jxr_keyword">if</strong> (s != <strong class="jxr_keyword">null</strong>) {
<a name="581" href="#581">581</a> s.stop();
<a name="582" href="#582">582</a> }
<a name="583" href="#583">583</a> }
<a name="584" href="#584">584</a>
<a name="585" href="#585">585</a> <em class="jxr_javadoccomment">/**</em>
<a name="586" href="#586">586</a> <em class="jxr_javadoccomment"> * Unbinds or removes the Subject's state from the application, typically called during {@link #logout}.</em>
<a name="587" href="#587">587</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="588" href="#588">588</a> <em class="jxr_javadoccomment"> * This has been deprecated in Shiro 1.2 in favor of the {@link #delete(org.apache.shiro.subject.Subject) delete}</em>
<a name="589" href="#589">589</a> <em class="jxr_javadoccomment"> * method. The implementation has been updated to invoke that method.</em>
<a name="590" href="#590">590</a> <em class="jxr_javadoccomment"> *</em>
<a name="591" href="#591">591</a> <em class="jxr_javadoccomment"> * @param subject the subject to unbind from the application as it will no longer be used.</em>
<a name="592" href="#592">592</a> <em class="jxr_javadoccomment"> * @deprecated in Shiro 1.2 in favor of {@link #delete(org.apache.shiro.subject.Subject)}</em>
<a name="593" href="#593">593</a> <em class="jxr_javadoccomment"> */</em>
<a name="594" href="#594">594</a> @Deprecated
<a name="595" href="#595">595</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>})
<a name="596" href="#596">596</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> unbind(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject) {
<a name="597" href="#597">597</a> delete(subject);
<a name="598" href="#598">598</a> }
<a name="599" href="#599">599</a>
<a name="600" href="#600">600</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> getRememberedIdentity(<a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> subjectContext) {
<a name="601" href="#601">601</a> <a href="../../../../org/apache/shiro/mgt/RememberMeManager.html">RememberMeManager</a> rmm = getRememberMeManager();
<a name="602" href="#602">602</a> <strong class="jxr_keyword">if</strong> (rmm != <strong class="jxr_keyword">null</strong>) {
<a name="603" href="#603">603</a> <strong class="jxr_keyword">try</strong> {
<a name="604" href="#604">604</a> <strong class="jxr_keyword">return</strong> rmm.getRememberedPrincipals(subjectContext);
<a name="605" href="#605">605</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="606" href="#606">606</a> <strong class="jxr_keyword">if</strong> (log.isWarnEnabled()) {
<a name="607" href="#607">607</a> String msg = <span class="jxr_string">"Delegate RememberMeManager instance of type ["</span> + rmm.getClass().getName() +
<a name="608" href="#608">608</a> <span class="jxr_string">"] threw an exception during getRememberedPrincipals()."</span>;
<a name="609" href="#609">609</a> log.warn(msg, e);
<a name="610" href="#610">610</a> }
<a name="611" href="#611">611</a> }
<a name="612" href="#612">612</a> }
<a name="613" href="#613">613</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="614" href="#614">614</a> }
<a name="615" href="#615">615</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>