| <!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>DelegatingSubject xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/subject/support/DelegatingSubject.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.subject.support; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationException; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationToken; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.HostAuthenticationToken; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authz.AuthorizationException; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authz.Permission; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authz.UnauthenticatedException; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.mgt.SecurityManager; |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.InvalidSessionException; |
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.ProxiedSession; |
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.Session; |
| <a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.SessionException; |
| <a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.mgt.DefaultSessionContext; |
| <a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.mgt.SessionContext; |
| <a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.ExecutionException; |
| <a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.PrincipalCollection; |
| <a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.Subject; |
| <a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.CollectionUtils; |
| <a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils; |
| <a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a name="41" href="#41">41</a> |
| <a name="42" href="#42">42</a> <strong class="jxr_keyword">import</strong> java.util.Collection; |
| <a name="43" href="#43">43</a> <strong class="jxr_keyword">import</strong> java.util.List; |
| <a name="44" href="#44">44</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.Callable; |
| <a name="45" href="#45">45</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.CopyOnWriteArrayList; |
| <a name="46" href="#46">46</a> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * Implementation of the {@code Subject} interface that delegates</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * method calls to an underlying {@link org.apache.shiro.mgt.SecurityManager SecurityManager} instance for security checks.</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * It is essentially a {@code SecurityManager} proxy.</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * This implementation does not maintain state such as roles and permissions (only {@code Subject}</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * {@link #getPrincipals() principals}, such as usernames or user primary keys) for better performance in a stateless</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * architecture. It instead asks the underlying {@code SecurityManager} every time to perform</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * the authorization check.</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * A common misconception in using this implementation is that an EIS resource (RDBMS, etc) would</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * be &quot;hit&quot; every time a method is called. This is not necessarily the case and is</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * up to the implementation of the underlying {@code SecurityManager} instance. If caching of authorization</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * data is desired (to eliminate EIS round trips and therefore improve database performance), it is considered</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * much more elegant to let the underlying {@code SecurityManager} implementation or its delegate components</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * manage caching, not this class. A {@code SecurityManager} is considered a business-tier component,</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * where caching strategies are better managed.</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * Applications from large and clustered to simple and JVM-local all benefit from</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * stateless architectures. This implementation plays a part in the stateless programming</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * paradigm and should be used whenever possible.</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.1</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/subject/support/DelegatingSubject.html">DelegatingSubject</a> implements <a href="../../../../../org/apache/shiro/subject/Subject.html">Subject</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(DelegatingSubject.<strong class="jxr_keyword">class</strong>); |
| <a name="74" href="#74">74</a> |
| <a name="75" href="#75">75</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String RUN_AS_PRINCIPALS_SESSION_KEY = |
| <a name="76" href="#76">76</a> DelegatingSubject.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">".RUN_AS_PRINCIPALS_SESSION_KEY"</span>; |
| <a name="77" href="#77">77</a> |
| <a name="78" href="#78">78</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals; |
| <a name="79" href="#79">79</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> authenticated; |
| <a name="80" href="#80">80</a> <strong class="jxr_keyword">protected</strong> String host; |
| <a name="81" href="#81">81</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/session/Session.html">Session</a> session; |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="85" href="#85">85</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> sessionCreationEnabled; |
| <a name="86" href="#86">86</a> |
| <a name="87" href="#87">87</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">transient</strong> <a href="../../../../../org/apache/shiro/mgt/SecurityManager.html">SecurityManager</a> securityManager; |
| <a name="88" href="#88">88</a> |
| <a name="89" href="#89">89</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/subject/support/DelegatingSubject.html">DelegatingSubject</a>(<a href="../../../../../org/apache/shiro/mgt/SecurityManager.html">SecurityManager</a> securityManager) { |
| <a name="90" href="#90">90</a> <strong class="jxr_keyword">this</strong>(<strong class="jxr_keyword">null</strong>, false, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>, securityManager); |
| <a name="91" href="#91">91</a> } |
| <a name="92" href="#92">92</a> |
| <a name="93" href="#93">93</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/subject/support/DelegatingSubject.html">DelegatingSubject</a>(<a href="../../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals, <strong class="jxr_keyword">boolean</strong> authenticated, String host, |
| <a name="94" href="#94">94</a> <a href="../../../../../org/apache/shiro/session/Session.html">Session</a> session, <a href="../../../../../org/apache/shiro/mgt/SecurityManager.html">SecurityManager</a> securityManager) { |
| <a name="95" href="#95">95</a> <strong class="jxr_keyword">this</strong>(principals, authenticated, host, session, <strong class="jxr_keyword">true</strong>, securityManager); |
| <a name="96" href="#96">96</a> } |
| <a name="97" href="#97">97</a> |
| <a name="98" href="#98">98</a> <em class="jxr_comment">//since 1.2</em> |
| <a name="99" href="#99">99</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/subject/support/DelegatingSubject.html">DelegatingSubject</a>(<a href="../../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals, <strong class="jxr_keyword">boolean</strong> authenticated, String host, |
| <a name="100" href="#100">100</a> <a href="../../../../../org/apache/shiro/session/Session.html">Session</a> session, <strong class="jxr_keyword">boolean</strong> sessionCreationEnabled, <a href="../../../../../org/apache/shiro/mgt/SecurityManager.html">SecurityManager</a> securityManager) { |
| <a name="101" href="#101">101</a> <strong class="jxr_keyword">if</strong> (securityManager == <strong class="jxr_keyword">null</strong>) { |
| <a name="102" href="#102">102</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"SecurityManager argument cannot be null."</span>); |
| <a name="103" href="#103">103</a> } |
| <a name="104" href="#104">104</a> <strong class="jxr_keyword">this</strong>.securityManager = securityManager; |
| <a name="105" href="#105">105</a> <strong class="jxr_keyword">this</strong>.principals = principals; |
| <a name="106" href="#106">106</a> <strong class="jxr_keyword">this</strong>.authenticated = authenticated; |
| <a name="107" href="#107">107</a> <strong class="jxr_keyword">this</strong>.host = host; |
| <a name="108" href="#108">108</a> <strong class="jxr_keyword">if</strong> (session != <strong class="jxr_keyword">null</strong>) { |
| <a name="109" href="#109">109</a> <strong class="jxr_keyword">this</strong>.session = decorate(session); |
| <a name="110" href="#110">110</a> } |
| <a name="111" href="#111">111</a> <strong class="jxr_keyword">this</strong>.sessionCreationEnabled = sessionCreationEnabled; |
| <a name="112" href="#112">112</a> } |
| <a name="113" href="#113">113</a> |
| <a name="114" href="#114">114</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/session/Session.html">Session</a> decorate(<a href="../../../../../org/apache/shiro/session/Session.html">Session</a> session) { |
| <a name="115" href="#115">115</a> <strong class="jxr_keyword">if</strong> (session == <strong class="jxr_keyword">null</strong>) { |
| <a name="116" href="#116">116</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"session cannot be null"</span>); |
| <a name="117" href="#117">117</a> } |
| <a name="118" href="#118">118</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/subject/support/DelegatingSubject.html">StoppingAwareProxiedSession</a>(session, <strong class="jxr_keyword">this</strong>); |
| <a name="119" href="#119">119</a> } |
| <a name="120" href="#120">120</a> |
| <a name="121" href="#121">121</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/mgt/SecurityManager.html">SecurityManager</a> getSecurityManager() { |
| <a name="122" href="#122">122</a> <strong class="jxr_keyword">return</strong> securityManager; |
| <a name="123" href="#123">123</a> } |
| <a name="124" href="#124">124</a> |
| <a name="125" href="#125">125</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> hasPrincipals() { |
| <a name="126" href="#126">126</a> <strong class="jxr_keyword">return</strong> !CollectionUtils.isEmpty(getPrincipals()); |
| <a name="127" href="#127">127</a> } |
| <a name="128" href="#128">128</a> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * Returns the host name or IP associated with the client who created/is interacting with this Subject.</em> |
| <a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * @return the host name or IP associated with the client who created/is interacting with this Subject.</em> |
| <a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="134" href="#134">134</a> <strong class="jxr_keyword">public</strong> String getHost() { |
| <a name="135" href="#135">135</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.host; |
| <a name="136" href="#136">136</a> } |
| <a name="137" href="#137">137</a> |
| <a name="138" href="#138">138</a> <strong class="jxr_keyword">private</strong> Object getPrimaryPrincipal(<a href="../../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals) { |
| <a name="139" href="#139">139</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(principals)) { |
| <a name="140" href="#140">140</a> <strong class="jxr_keyword">return</strong> principals.getPrimaryPrincipal(); |
| <a name="141" href="#141">141</a> } |
| <a name="142" href="#142">142</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a name="143" href="#143">143</a> } |
| <a name="144" href="#144">144</a> |
| <a name="145" href="#145">145</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * @see Subject#getPrincipal()</em> |
| <a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="148" href="#148">148</a> <strong class="jxr_keyword">public</strong> Object getPrincipal() { |
| <a name="149" href="#149">149</a> <strong class="jxr_keyword">return</strong> getPrimaryPrincipal(getPrincipals()); |
| <a name="150" href="#150">150</a> } |
| <a name="151" href="#151">151</a> |
| <a name="152" href="#152">152</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> getPrincipals() { |
| <a name="153" href="#153">153</a> List<PrincipalCollection> runAsPrincipals = getRunAsPrincipalsStack(); |
| <a name="154" href="#154">154</a> <strong class="jxr_keyword">return</strong> CollectionUtils.isEmpty(runAsPrincipals) ? <strong class="jxr_keyword">this</strong>.principals : runAsPrincipals.get(0); |
| <a name="155" href="#155">155</a> } |
| <a name="156" href="#156">156</a> |
| <a name="157" href="#157">157</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isPermitted(String permission) { |
| <a name="158" href="#158">158</a> <strong class="jxr_keyword">return</strong> hasPrincipals() && securityManager.isPermitted(getPrincipals(), permission); |
| <a name="159" href="#159">159</a> } |
| <a name="160" href="#160">160</a> |
| <a name="161" href="#161">161</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isPermitted(<a href="../../../../../org/apache/shiro/authz/Permission.html">Permission</a> permission) { |
| <a name="162" href="#162">162</a> <strong class="jxr_keyword">return</strong> hasPrincipals() && securityManager.isPermitted(getPrincipals(), permission); |
| <a name="163" href="#163">163</a> } |
| <a name="164" href="#164">164</a> |
| <a name="165" href="#165">165</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong>[] isPermitted(String... permissions) { |
| <a name="166" href="#166">166</a> <strong class="jxr_keyword">if</strong> (hasPrincipals()) { |
| <a name="167" href="#167">167</a> <strong class="jxr_keyword">return</strong> securityManager.isPermitted(getPrincipals(), permissions); |
| <a name="168" href="#168">168</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="169" href="#169">169</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <strong class="jxr_keyword">boolean</strong>[permissions.length]; |
| <a name="170" href="#170">170</a> } |
| <a name="171" href="#171">171</a> } |
| <a name="172" href="#172">172</a> |
| <a name="173" href="#173">173</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong>[] isPermitted(List<Permission> permissions) { |
| <a name="174" href="#174">174</a> <strong class="jxr_keyword">if</strong> (hasPrincipals()) { |
| <a name="175" href="#175">175</a> <strong class="jxr_keyword">return</strong> securityManager.isPermitted(getPrincipals(), permissions); |
| <a name="176" href="#176">176</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="177" href="#177">177</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <strong class="jxr_keyword">boolean</strong>[permissions.size()]; |
| <a name="178" href="#178">178</a> } |
| <a name="179" href="#179">179</a> } |
| <a name="180" href="#180">180</a> |
| <a name="181" href="#181">181</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isPermittedAll(String... permissions) { |
| <a name="182" href="#182">182</a> <strong class="jxr_keyword">return</strong> hasPrincipals() && securityManager.isPermittedAll(getPrincipals(), permissions); |
| <a name="183" href="#183">183</a> } |
| <a name="184" href="#184">184</a> |
| <a name="185" href="#185">185</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isPermittedAll(Collection<Permission> permissions) { |
| <a name="186" href="#186">186</a> <strong class="jxr_keyword">return</strong> hasPrincipals() && securityManager.isPermittedAll(getPrincipals(), permissions); |
| <a name="187" href="#187">187</a> } |
| <a name="188" href="#188">188</a> |
| <a name="189" href="#189">189</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> assertAuthzCheckPossible() <strong class="jxr_keyword">throws</strong> AuthorizationException { |
| <a name="190" href="#190">190</a> <strong class="jxr_keyword">if</strong> (!hasPrincipals()) { |
| <a name="191" href="#191">191</a> String msg = <span class="jxr_string">"This subject is anonymous - it does not have any identifying principals and "</span> + |
| <a name="192" href="#192">192</a> <span class="jxr_string">"authorization operations require an identity to check against. A Subject instance will "</span> + |
| <a name="193" href="#193">193</a> <span class="jxr_string">"acquire these identifying principals automatically after a successful login is performed "</span> + |
| <a name="194" href="#194">194</a> <span class="jxr_string">"be executing "</span> + Subject.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">".login(AuthenticationToken) or when 'Remember Me' "</span> + |
| <a name="195" href="#195">195</a> <span class="jxr_string">"functionality is enabled by the SecurityManager. This exception can also occur when a "</span> + |
| <a name="196" href="#196">196</a> <span class="jxr_string">"previously logged-in Subject has logged out which "</span> + |
| <a name="197" href="#197">197</a> <span class="jxr_string">"makes it anonymous again. Because an identity is currently not known due to any of these "</span> + |
| <a name="198" href="#198">198</a> <span class="jxr_string">"conditions, authorization is denied."</span>; |
| <a name="199" href="#199">199</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/authz/UnauthenticatedException.html">UnauthenticatedException</a>(msg); |
| <a name="200" href="#200">200</a> } |
| <a name="201" href="#201">201</a> } |
| <a name="202" href="#202">202</a> |
| <a name="203" href="#203">203</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> checkPermission(String permission) <strong class="jxr_keyword">throws</strong> AuthorizationException { |
| <a name="204" href="#204">204</a> assertAuthzCheckPossible(); |
| <a name="205" href="#205">205</a> securityManager.checkPermission(getPrincipals(), permission); |
| <a name="206" href="#206">206</a> } |
| <a name="207" href="#207">207</a> |
| <a name="208" href="#208">208</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> checkPermission(<a href="../../../../../org/apache/shiro/authz/Permission.html">Permission</a> permission) <strong class="jxr_keyword">throws</strong> AuthorizationException { |
| <a name="209" href="#209">209</a> assertAuthzCheckPossible(); |
| <a name="210" href="#210">210</a> securityManager.checkPermission(getPrincipals(), permission); |
| <a name="211" href="#211">211</a> } |
| <a name="212" href="#212">212</a> |
| <a name="213" href="#213">213</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> checkPermissions(String... permissions) <strong class="jxr_keyword">throws</strong> AuthorizationException { |
| <a name="214" href="#214">214</a> assertAuthzCheckPossible(); |
| <a name="215" href="#215">215</a> securityManager.checkPermissions(getPrincipals(), permissions); |
| <a name="216" href="#216">216</a> } |
| <a name="217" href="#217">217</a> |
| <a name="218" href="#218">218</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> checkPermissions(Collection<Permission> permissions) <strong class="jxr_keyword">throws</strong> AuthorizationException { |
| <a name="219" href="#219">219</a> assertAuthzCheckPossible(); |
| <a name="220" href="#220">220</a> securityManager.checkPermissions(getPrincipals(), permissions); |
| <a name="221" href="#221">221</a> } |
| <a name="222" href="#222">222</a> |
| <a name="223" href="#223">223</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> hasRole(String roleIdentifier) { |
| <a name="224" href="#224">224</a> <strong class="jxr_keyword">return</strong> hasPrincipals() && securityManager.hasRole(getPrincipals(), roleIdentifier); |
| <a name="225" href="#225">225</a> } |
| <a name="226" href="#226">226</a> |
| <a name="227" href="#227">227</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong>[] hasRoles(List<String> roleIdentifiers) { |
| <a name="228" href="#228">228</a> <strong class="jxr_keyword">if</strong> (hasPrincipals()) { |
| <a name="229" href="#229">229</a> <strong class="jxr_keyword">return</strong> securityManager.hasRoles(getPrincipals(), roleIdentifiers); |
| <a name="230" href="#230">230</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="231" href="#231">231</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <strong class="jxr_keyword">boolean</strong>[roleIdentifiers.size()]; |
| <a name="232" href="#232">232</a> } |
| <a name="233" href="#233">233</a> } |
| <a name="234" href="#234">234</a> |
| <a name="235" href="#235">235</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> hasAllRoles(Collection<String> roleIdentifiers) { |
| <a name="236" href="#236">236</a> <strong class="jxr_keyword">return</strong> hasPrincipals() && securityManager.hasAllRoles(getPrincipals(), roleIdentifiers); |
| <a name="237" href="#237">237</a> } |
| <a name="238" href="#238">238</a> |
| <a name="239" href="#239">239</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> checkRole(String role) <strong class="jxr_keyword">throws</strong> AuthorizationException { |
| <a name="240" href="#240">240</a> assertAuthzCheckPossible(); |
| <a name="241" href="#241">241</a> securityManager.checkRole(getPrincipals(), role); |
| <a name="242" href="#242">242</a> } |
| <a name="243" href="#243">243</a> |
| <a name="244" href="#244">244</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> checkRoles(String... roleIdentifiers) <strong class="jxr_keyword">throws</strong> AuthorizationException { |
| <a name="245" href="#245">245</a> assertAuthzCheckPossible(); |
| <a name="246" href="#246">246</a> securityManager.checkRoles(getPrincipals(), roleIdentifiers); |
| <a name="247" href="#247">247</a> } |
| <a name="248" href="#248">248</a> |
| <a name="249" href="#249">249</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> checkRoles(Collection<String> roles) <strong class="jxr_keyword">throws</strong> AuthorizationException { |
| <a name="250" href="#250">250</a> assertAuthzCheckPossible(); |
| <a name="251" href="#251">251</a> securityManager.checkRoles(getPrincipals(), roles); |
| <a name="252" href="#252">252</a> } |
| <a name="253" href="#253">253</a> |
| <a name="254" href="#254">254</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> login(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token) <strong class="jxr_keyword">throws</strong> AuthenticationException { |
| <a name="255" href="#255">255</a> clearRunAsIdentitiesInternal(); |
| <a name="256" href="#256">256</a> <a href="../../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject = securityManager.login(<strong class="jxr_keyword">this</strong>, token); |
| <a name="257" href="#257">257</a> |
| <a name="258" href="#258">258</a> <a href="../../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals; |
| <a name="259" href="#259">259</a> |
| <a name="260" href="#260">260</a> String host = <strong class="jxr_keyword">null</strong>; |
| <a name="261" href="#261">261</a> |
| <a name="262" href="#262">262</a> <strong class="jxr_keyword">if</strong> (subject instanceof DelegatingSubject) { |
| <a name="263" href="#263">263</a> <a href="../../../../../org/apache/shiro/subject/support/DelegatingSubject.html">DelegatingSubject</a> delegating = (DelegatingSubject) subject; |
| <a name="264" href="#264">264</a> <em class="jxr_comment">//we have to do this in case there are assumed identities - we don't want to lose the 'real' principals:</em> |
| <a name="265" href="#265">265</a> principals = delegating.principals; |
| <a name="266" href="#266">266</a> host = delegating.host; |
| <a name="267" href="#267">267</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="268" href="#268">268</a> principals = subject.getPrincipals(); |
| <a name="269" href="#269">269</a> } |
| <a name="270" href="#270">270</a> |
| <a name="271" href="#271">271</a> <strong class="jxr_keyword">if</strong> (principals == <strong class="jxr_keyword">null</strong> || principals.isEmpty()) { |
| <a name="272" href="#272">272</a> String msg = <span class="jxr_string">"Principals returned from securityManager.login( token ) returned a null or "</span> + |
| <a name="273" href="#273">273</a> <span class="jxr_string">"empty value. This value must be non null and populated with one or more elements."</span>; |
| <a name="274" href="#274">274</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(msg); |
| <a name="275" href="#275">275</a> } |
| <a name="276" href="#276">276</a> <strong class="jxr_keyword">this</strong>.principals = principals; |
| <a name="277" href="#277">277</a> <strong class="jxr_keyword">this</strong>.authenticated = <strong class="jxr_keyword">true</strong>; |
| <a name="278" href="#278">278</a> <strong class="jxr_keyword">if</strong> (token instanceof HostAuthenticationToken) { |
| <a name="279" href="#279">279</a> host = ((HostAuthenticationToken) token).getHost(); |
| <a name="280" href="#280">280</a> } |
| <a name="281" href="#281">281</a> <strong class="jxr_keyword">if</strong> (host != <strong class="jxr_keyword">null</strong>) { |
| <a name="282" href="#282">282</a> <strong class="jxr_keyword">this</strong>.host = host; |
| <a name="283" href="#283">283</a> } |
| <a name="284" href="#284">284</a> <a href="../../../../../org/apache/shiro/session/Session.html">Session</a> session = subject.getSession(false); |
| <a name="285" href="#285">285</a> <strong class="jxr_keyword">if</strong> (session != <strong class="jxr_keyword">null</strong>) { |
| <a name="286" href="#286">286</a> <strong class="jxr_keyword">this</strong>.session = decorate(session); |
| <a name="287" href="#287">287</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="288" href="#288">288</a> <strong class="jxr_keyword">this</strong>.session = <strong class="jxr_keyword">null</strong>; |
| <a name="289" href="#289">289</a> } |
| <a name="290" href="#290">290</a> } |
| <a name="291" href="#291">291</a> |
| <a name="292" href="#292">292</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isAuthenticated() { |
| <a name="293" href="#293">293</a> <strong class="jxr_keyword">return</strong> authenticated; |
| <a name="294" href="#294">294</a> } |
| <a name="295" href="#295">295</a> |
| <a name="296" href="#296">296</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isRemembered() { |
| <a name="297" href="#297">297</a> <a href="../../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals = getPrincipals(); |
| <a name="298" href="#298">298</a> <strong class="jxr_keyword">return</strong> principals != <strong class="jxr_keyword">null</strong> && !principals.isEmpty() && !isAuthenticated(); |
| <a name="299" href="#299">299</a> } |
| <a name="300" href="#300">300</a> |
| <a name="301" href="#301">301</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="302" href="#302">302</a> <em class="jxr_javadoccomment"> * Returns {@code true} if this Subject is allowed to create sessions, {@code false} otherwise.</em> |
| <a name="303" href="#303">303</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="304" href="#304">304</a> <em class="jxr_javadoccomment"> * @return {@code true} if this Subject is allowed to create sessions, {@code false} otherwise.</em> |
| <a name="305" href="#305">305</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="306" href="#306">306</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="307" href="#307">307</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isSessionCreationEnabled() { |
| <a name="308" href="#308">308</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.sessionCreationEnabled; |
| <a name="309" href="#309">309</a> } |
| <a name="310" href="#310">310</a> |
| <a name="311" href="#311">311</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/session/Session.html">Session</a> getSession() { |
| <a name="312" href="#312">312</a> <strong class="jxr_keyword">return</strong> getSession(<strong class="jxr_keyword">true</strong>); |
| <a name="313" href="#313">313</a> } |
| <a name="314" href="#314">314</a> |
| <a name="315" href="#315">315</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/session/Session.html">Session</a> getSession(<strong class="jxr_keyword">boolean</strong> create) { |
| <a name="316" href="#316">316</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) { |
| <a name="317" href="#317">317</a> log.trace(<span class="jxr_string">"attempting to get session; create = "</span> + create + |
| <a name="318" href="#318">318</a> <span class="jxr_string">"; session is null = "</span> + (<strong class="jxr_keyword">this</strong>.session == <strong class="jxr_keyword">null</strong>) + |
| <a name="319" href="#319">319</a> <span class="jxr_string">"; session has id = "</span> + (<strong class="jxr_keyword">this</strong>.session != <strong class="jxr_keyword">null</strong> && session.getId() != <strong class="jxr_keyword">null</strong>)); |
| <a name="320" href="#320">320</a> } |
| <a name="321" href="#321">321</a> |
| <a name="322" href="#322">322</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.session == <strong class="jxr_keyword">null</strong> && create) { |
| <a name="323" href="#323">323</a> |
| <a name="324" href="#324">324</a> <em class="jxr_comment">//added in 1.2:</em> |
| <a name="325" href="#325">325</a> <strong class="jxr_keyword">if</strong> (!isSessionCreationEnabled()) { |
| <a name="326" href="#326">326</a> String msg = <span class="jxr_string">"Session creation has been disabled for the current subject. This exception indicates "</span> + |
| <a name="327" href="#327">327</a> <span class="jxr_string">"that there is either a programming error (using a session when it should never be "</span> + |
| <a name="328" href="#328">328</a> <span class="jxr_string">"used) or that Shiro's configuration needs to be adjusted to allow Sessions to be created "</span> + |
| <a name="329" href="#329">329</a> <span class="jxr_string">"for the current Subject. See the "</span> + DisabledSessionException.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">" JavaDoc "</span> + |
| <a name="330" href="#330">330</a> <span class="jxr_string">"for more."</span>; |
| <a name="331" href="#331">331</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/subject/support/DisabledSessionException.html">DisabledSessionException</a>(msg); |
| <a name="332" href="#332">332</a> } |
| <a name="333" href="#333">333</a> |
| <a name="334" href="#334">334</a> log.trace(<span class="jxr_string">"Starting session for host {}"</span>, getHost()); |
| <a name="335" href="#335">335</a> <a href="../../../../../org/apache/shiro/session/mgt/SessionContext.html">SessionContext</a> sessionContext = createSessionContext(); |
| <a name="336" href="#336">336</a> <a href="../../../../../org/apache/shiro/session/Session.html">Session</a> session = <strong class="jxr_keyword">this</strong>.securityManager.start(sessionContext); |
| <a name="337" href="#337">337</a> <strong class="jxr_keyword">this</strong>.session = decorate(session); |
| <a name="338" href="#338">338</a> } |
| <a name="339" href="#339">339</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.session; |
| <a name="340" href="#340">340</a> } |
| <a name="341" href="#341">341</a> |
| <a name="342" href="#342">342</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/session/mgt/SessionContext.html">SessionContext</a> createSessionContext() { |
| <a name="343" href="#343">343</a> <a href="../../../../../org/apache/shiro/session/mgt/SessionContext.html">SessionContext</a> sessionContext = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/session/mgt/DefaultSessionContext.html">DefaultSessionContext</a>(); |
| <a name="344" href="#344">344</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(host)) { |
| <a name="345" href="#345">345</a> sessionContext.setHost(host); |
| <a name="346" href="#346">346</a> } |
| <a name="347" href="#347">347</a> <strong class="jxr_keyword">return</strong> sessionContext; |
| <a name="348" href="#348">348</a> } |
| <a name="349" href="#349">349</a> |
| <a name="350" href="#350">350</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> clearRunAsIdentitiesInternal() { |
| <a name="351" href="#351">351</a> <em class="jxr_comment">//try/catch added for SHIRO-298</em> |
| <a name="352" href="#352">352</a> <strong class="jxr_keyword">try</strong> { |
| <a name="353" href="#353">353</a> clearRunAsIdentities(); |
| <a name="354" href="#354">354</a> } <strong class="jxr_keyword">catch</strong> (SessionException se) { |
| <a name="355" href="#355">355</a> log.debug(<span class="jxr_string">"Encountered session exception trying to clear 'runAs' identities during logout. This "</span> + |
| <a name="356" href="#356">356</a> <span class="jxr_string">"can generally safely be ignored."</span>, se); |
| <a name="357" href="#357">357</a> } |
| <a name="358" href="#358">358</a> } |
| <a name="359" href="#359">359</a> |
| <a name="360" href="#360">360</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> logout() { |
| <a name="361" href="#361">361</a> <strong class="jxr_keyword">try</strong> { |
| <a name="362" href="#362">362</a> clearRunAsIdentitiesInternal(); |
| <a name="363" href="#363">363</a> <strong class="jxr_keyword">this</strong>.securityManager.logout(<strong class="jxr_keyword">this</strong>); |
| <a name="364" href="#364">364</a> } <strong class="jxr_keyword">finally</strong> { |
| <a name="365" href="#365">365</a> <strong class="jxr_keyword">this</strong>.session = <strong class="jxr_keyword">null</strong>; |
| <a name="366" href="#366">366</a> <strong class="jxr_keyword">this</strong>.principals = <strong class="jxr_keyword">null</strong>; |
| <a name="367" href="#367">367</a> <strong class="jxr_keyword">this</strong>.authenticated = false; |
| <a name="368" href="#368">368</a> <em class="jxr_comment">//Don't set securityManager to null here - the Subject can still be</em> |
| <a name="369" href="#369">369</a> <em class="jxr_comment">//used, it is just considered anonymous at this point. The SecurityManager instance is</em> |
| <a name="370" href="#370">370</a> <em class="jxr_comment">//necessary if the subject would log in again or acquire a new session. This is in response to</em> |
| <a name="371" href="#371">371</a> <em class="jxr_comment">//https://issues.apache.org/jira/browse/JSEC-22</em> |
| <a name="372" href="#372">372</a> <em class="jxr_comment">//this.securityManager = null;</em> |
| <a name="373" href="#373">373</a> } |
| <a name="374" href="#374">374</a> } |
| <a name="375" href="#375">375</a> |
| <a name="376" href="#376">376</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> sessionStopped() { |
| <a name="377" href="#377">377</a> <strong class="jxr_keyword">this</strong>.session = <strong class="jxr_keyword">null</strong>; |
| <a name="378" href="#378">378</a> } |
| <a name="379" href="#379">379</a> |
| <a name="380" href="#380">380</a> <strong class="jxr_keyword">public</strong> <V> V execute(Callable<V> callable) <strong class="jxr_keyword">throws</strong> ExecutionException { |
| <a name="381" href="#381">381</a> Callable<V> associated = associateWith(callable); |
| <a name="382" href="#382">382</a> <strong class="jxr_keyword">try</strong> { |
| <a name="383" href="#383">383</a> <strong class="jxr_keyword">return</strong> associated.call(); |
| <a name="384" href="#384">384</a> } <strong class="jxr_keyword">catch</strong> (Throwable t) { |
| <a name="385" href="#385">385</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/subject/ExecutionException.html">ExecutionException</a>(t); |
| <a name="386" href="#386">386</a> } |
| <a name="387" href="#387">387</a> } |
| <a name="388" href="#388">388</a> |
| <a name="389" href="#389">389</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute(Runnable runnable) { |
| <a name="390" href="#390">390</a> Runnable associated = associateWith(runnable); |
| <a name="391" href="#391">391</a> associated.run(); |
| <a name="392" href="#392">392</a> } |
| <a name="393" href="#393">393</a> |
| <a name="394" href="#394">394</a> <strong class="jxr_keyword">public</strong> <V> Callable<V> associateWith(Callable<V> callable) { |
| <a name="395" href="#395">395</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> SubjectCallable<V>(<strong class="jxr_keyword">this</strong>, callable); |
| <a name="396" href="#396">396</a> } |
| <a name="397" href="#397">397</a> |
| <a name="398" href="#398">398</a> <strong class="jxr_keyword">public</strong> Runnable associateWith(Runnable runnable) { |
| <a name="399" href="#399">399</a> <strong class="jxr_keyword">if</strong> (runnable instanceof Thread) { |
| <a name="400" href="#400">400</a> String msg = <span class="jxr_string">"This implementation does not support Thread arguments because of JDK ThreadLocal "</span> + |
| <a name="401" href="#401">401</a> <span class="jxr_string">"inheritance mechanisms required by Shiro. Instead, the method argument should be a non-Thread "</span> + |
| <a name="402" href="#402">402</a> <span class="jxr_string">"Runnable and the return value from this method can then be given to an ExecutorService or "</span> + |
| <a name="403" href="#403">403</a> <span class="jxr_string">"another Thread."</span>; |
| <a name="404" href="#404">404</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> UnsupportedOperationException(msg); |
| <a name="405" href="#405">405</a> } |
| <a name="406" href="#406">406</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/subject/support/SubjectRunnable.html">SubjectRunnable</a>(<strong class="jxr_keyword">this</strong>, runnable); |
| <a name="407" href="#407">407</a> } |
| <a name="408" href="#408">408</a> |
| <a name="409" href="#409">409</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/subject/support/DelegatingSubject.html">StoppingAwareProxiedSession</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/session/ProxiedSession.html">ProxiedSession</a> { |
| <a name="410" href="#410">410</a> |
| <a name="411" href="#411">411</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/shiro/subject/support/DelegatingSubject.html">DelegatingSubject</a> owner; |
| <a name="412" href="#412">412</a> |
| <a name="413" href="#413">413</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/shiro/subject/support/DelegatingSubject.html">StoppingAwareProxiedSession</a>(<a href="../../../../../org/apache/shiro/session/Session.html">Session</a> target, <a href="../../../../../org/apache/shiro/subject/support/DelegatingSubject.html">DelegatingSubject</a> owningSubject) { |
| <a name="414" href="#414">414</a> <strong class="jxr_keyword">super</strong>(target); |
| <a name="415" href="#415">415</a> owner = owningSubject; |
| <a name="416" href="#416">416</a> } |
| <a name="417" href="#417">417</a> |
| <a name="418" href="#418">418</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> stop() <strong class="jxr_keyword">throws</strong> InvalidSessionException { |
| <a name="419" href="#419">419</a> <strong class="jxr_keyword">super</strong>.stop(); |
| <a name="420" href="#420">420</a> owner.sessionStopped(); |
| <a name="421" href="#421">421</a> } |
| <a name="422" href="#422">422</a> } |
| <a name="423" href="#423">423</a> |
| <a name="424" href="#424">424</a> |
| <a name="425" href="#425">425</a> <em class="jxr_comment">// ======================================</em> |
| <a name="426" href="#426">426</a> <em class="jxr_comment">// 'Run As' support implementations</em> |
| <a name="427" href="#427">427</a> <em class="jxr_comment">// ======================================</em> |
| <a name="428" href="#428">428</a> |
| <a name="429" href="#429">429</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> runAs(<a href="../../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals) { |
| <a name="430" href="#430">430</a> <strong class="jxr_keyword">if</strong> (!hasPrincipals()) { |
| <a name="431" href="#431">431</a> String msg = <span class="jxr_string">"This subject does not yet have an identity. Assuming the identity of another "</span> + |
| <a name="432" href="#432">432</a> <span class="jxr_string">"Subject is only allowed for Subjects with an existing identity. Try logging this subject in "</span> + |
| <a name="433" href="#433">433</a> <span class="jxr_string">"first, or using the "</span> + Subject.Builder.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">" to build ad hoc Subject instances "</span> + |
| <a name="434" href="#434">434</a> <span class="jxr_string">"with identities as necessary."</span>; |
| <a name="435" href="#435">435</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(msg); |
| <a name="436" href="#436">436</a> } |
| <a name="437" href="#437">437</a> pushIdentity(principals); |
| <a name="438" href="#438">438</a> } |
| <a name="439" href="#439">439</a> |
| <a name="440" href="#440">440</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isRunAs() { |
| <a name="441" href="#441">441</a> List<PrincipalCollection> stack = getRunAsPrincipalsStack(); |
| <a name="442" href="#442">442</a> <strong class="jxr_keyword">return</strong> !CollectionUtils.isEmpty(stack); |
| <a name="443" href="#443">443</a> } |
| <a name="444" href="#444">444</a> |
| <a name="445" href="#445">445</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> getPreviousPrincipals() { |
| <a name="446" href="#446">446</a> <a href="../../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> previousPrincipals = <strong class="jxr_keyword">null</strong>; |
| <a name="447" href="#447">447</a> List<PrincipalCollection> stack = getRunAsPrincipalsStack(); |
| <a name="448" href="#448">448</a> <strong class="jxr_keyword">int</strong> stackSize = stack != <strong class="jxr_keyword">null</strong> ? stack.size() : 0; |
| <a name="449" href="#449">449</a> <strong class="jxr_keyword">if</strong> (stackSize > 0) { |
| <a name="450" href="#450">450</a> <strong class="jxr_keyword">if</strong> (stackSize == 1) { |
| <a name="451" href="#451">451</a> previousPrincipals = <strong class="jxr_keyword">this</strong>.principals; |
| <a name="452" href="#452">452</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="453" href="#453">453</a> <em class="jxr_comment">//always get the one behind the current:</em> |
| <a name="454" href="#454">454</a> assert stack != <strong class="jxr_keyword">null</strong>; |
| <a name="455" href="#455">455</a> previousPrincipals = stack.get(1); |
| <a name="456" href="#456">456</a> } |
| <a name="457" href="#457">457</a> } |
| <a name="458" href="#458">458</a> <strong class="jxr_keyword">return</strong> previousPrincipals; |
| <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">public</strong> <a href="../../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> releaseRunAs() { |
| <a name="462" href="#462">462</a> <strong class="jxr_keyword">return</strong> popIdentity(); |
| <a name="463" href="#463">463</a> } |
| <a name="464" href="#464">464</a> |
| <a name="465" href="#465">465</a> @SuppressWarnings(<span class="jxr_string">"unchecked"</span>) |
| <a name="466" href="#466">466</a> <strong class="jxr_keyword">private</strong> List<PrincipalCollection> getRunAsPrincipalsStack() { |
| <a name="467" href="#467">467</a> <a href="../../../../../org/apache/shiro/session/Session.html">Session</a> session = getSession(false); |
| <a name="468" href="#468">468</a> <strong class="jxr_keyword">if</strong> (session != <strong class="jxr_keyword">null</strong>) { |
| <a name="469" href="#469">469</a> <strong class="jxr_keyword">return</strong> (List<PrincipalCollection>) session.getAttribute(RUN_AS_PRINCIPALS_SESSION_KEY); |
| <a name="470" href="#470">470</a> } |
| <a name="471" href="#471">471</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a name="472" href="#472">472</a> } |
| <a name="473" href="#473">473</a> |
| <a name="474" href="#474">474</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> clearRunAsIdentities() { |
| <a name="475" href="#475">475</a> <a href="../../../../../org/apache/shiro/session/Session.html">Session</a> session = getSession(false); |
| <a name="476" href="#476">476</a> <strong class="jxr_keyword">if</strong> (session != <strong class="jxr_keyword">null</strong>) { |
| <a name="477" href="#477">477</a> session.removeAttribute(RUN_AS_PRINCIPALS_SESSION_KEY); |
| <a name="478" href="#478">478</a> } |
| <a name="479" href="#479">479</a> } |
| <a name="480" href="#480">480</a> |
| <a name="481" href="#481">481</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> pushIdentity(<a href="../../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals) <strong class="jxr_keyword">throws</strong> NullPointerException { |
| <a name="482" href="#482">482</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(principals)) { |
| <a name="483" href="#483">483</a> String msg = <span class="jxr_string">"Specified Subject principals cannot be null or empty for 'run as' functionality."</span>; |
| <a name="484" href="#484">484</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(msg); |
| <a name="485" href="#485">485</a> } |
| <a name="486" href="#486">486</a> List<PrincipalCollection> stack = getRunAsPrincipalsStack(); |
| <a name="487" href="#487">487</a> <strong class="jxr_keyword">if</strong> (stack == <strong class="jxr_keyword">null</strong>) { |
| <a name="488" href="#488">488</a> stack = <strong class="jxr_keyword">new</strong> CopyOnWriteArrayList<PrincipalCollection>(); |
| <a name="489" href="#489">489</a> } |
| <a name="490" href="#490">490</a> stack.add(0, principals); |
| <a name="491" href="#491">491</a> <a href="../../../../../org/apache/shiro/session/Session.html">Session</a> session = getSession(); |
| <a name="492" href="#492">492</a> session.setAttribute(RUN_AS_PRINCIPALS_SESSION_KEY, stack); |
| <a name="493" href="#493">493</a> } |
| <a name="494" href="#494">494</a> |
| <a name="495" href="#495">495</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> popIdentity() { |
| <a name="496" href="#496">496</a> <a href="../../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> popped = <strong class="jxr_keyword">null</strong>; |
| <a name="497" href="#497">497</a> |
| <a name="498" href="#498">498</a> List<PrincipalCollection> stack = getRunAsPrincipalsStack(); |
| <a name="499" href="#499">499</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(stack)) { |
| <a name="500" href="#500">500</a> popped = stack.remove(0); |
| <a name="501" href="#501">501</a> <a href="../../../../../org/apache/shiro/session/Session.html">Session</a> session; |
| <a name="502" href="#502">502</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(stack)) { |
| <a name="503" href="#503">503</a> <em class="jxr_comment">//persist the changed stack to the session</em> |
| <a name="504" href="#504">504</a> session = getSession(); |
| <a name="505" href="#505">505</a> session.setAttribute(RUN_AS_PRINCIPALS_SESSION_KEY, stack); |
| <a name="506" href="#506">506</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="507" href="#507">507</a> <em class="jxr_comment">//stack is empty, remove it from the session:</em> |
| <a name="508" href="#508">508</a> clearRunAsIdentities(); |
| <a name="509" href="#509">509</a> } |
| <a name="510" href="#510">510</a> } |
| <a name="511" href="#511">511</a> |
| <a name="512" href="#512">512</a> <strong class="jxr_keyword">return</strong> popped; |
| <a name="513" href="#513">513</a> } |
| <a name="514" href="#514">514</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
| |
