Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.8.0 / shiro-web / xref / org / apache / shiro / web / mgt / DefaultWebSubjectFactory.html
blob: 6c765502dedea5152cbe5e095f618f69e037d798 [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=UTF-8" />
<title>DefaultWebSubjectFactory xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/web/mgt/DefaultWebSubjectFactory.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.web.mgt;
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.mgt.DefaultSubjectFactory;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.mgt.SecurityManager;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.Session;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.PrincipalCollection;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.Subject;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.SubjectContext;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.subject.WebSubjectContext;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.subject.support.WebDelegatingSubject;
<a class="jxr_linenumber" name="L29" href="#L29">29</a>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletRequest;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletResponse;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.subject.WebSubject;
<a class="jxr_linenumber" name="L33" href="#L33">33</a>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * A {@code SubjectFactory} implementation that creates {@link WebDelegatingSubject} instances.</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * {@code WebDelegatingSubject} instances are required if Request/Response objects are to be maintained across</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * threads when using the {@code Subject} {@link Subject#associateWith(java.util.concurrent.Callable) createCallable}</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * and {@link Subject#associateWith(Runnable) createRunnable} methods.</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="DefaultWebSubjectFactory" href="../../../../../org/apache/shiro/web/mgt/DefaultWebSubjectFactory.html#DefaultWebSubjectFactory">DefaultWebSubjectFactory</a> <strong class="jxr_keyword">extends</strong> DefaultSubjectFactory {
<a class="jxr_linenumber" name="L44" href="#L44">44</a>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">public</strong> <a name="DefaultWebSubjectFactory" href="../../../../../org/apache/shiro/web/mgt/DefaultWebSubjectFactory.html#DefaultWebSubjectFactory">DefaultWebSubjectFactory</a>() {
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">super</strong>();
<a class="jxr_linenumber" name="L47" href="#L47">47</a> }
<a class="jxr_linenumber" name="L48" href="#L48">48</a>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">public</strong> Subject createSubject(SubjectContext context) {
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_comment">//SHIRO-646</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_comment">//Check if the existing subject is NOT a WebSubject. If it isn't, then call super.createSubject instead.</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_comment">//Creating a WebSubject from a non-web Subject will cause the ServletRequest and ServletResponse to be null, which wil fail when creating a session.</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">boolean</strong> isNotBasedOnWebSubject = context.getSubject() != <strong class="jxr_keyword">null</strong> &amp;&amp; !(context.getSubject() instanceof <a name="WebSubject" href="../../../../../org/apache/shiro/web/subject/WebSubject.html#WebSubject">WebSubject</a>);
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">if</strong> (!(context instanceof <a name="WebSubjectContext" href="../../../../../org/apache/shiro/web/subject/WebSubjectContext.html#WebSubjectContext">WebSubjectContext</a>) || isNotBasedOnWebSubject) {
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">super</strong>.createSubject(context);
<a class="jxr_linenumber" name="L56" href="#L56">56</a> }
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <a name="WebSubjectContex<a name="WebSubjectContext" href="../../../../../org/apache/shiro/web/subject/WebSubjectContext.html#WebSubjectContext">WebSubjectContext</a>/../../org/apache/shiro/web/subject/WebSubjectContext.html#WebSubjectContext">WebSubjectContext</a> wsc = (<a name="WebSubjectContext" href="../../../../../org/apache/shiro/web/subject/WebSubjectContext.html#WebSubjectContext">WebSubjectContext</a>) context;
<a class="jxr_linenumber" name="L58" href="#L58">58</a> SecurityManager securityManager = wsc.resolveSecurityManager();
<a class="jxr_linenumber" name="L59" href="#L59">59</a> Session session = wsc.resolveSession();
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">boolean</strong> sessionEnabled = wsc.isSessionCreationEnabled();
<a class="jxr_linenumber" name="L61" href="#L61">61</a> PrincipalCollection principals = wsc.resolvePrincipals();
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">boolean</strong> authenticated = wsc.resolveAuthenticated();
<a class="jxr_linenumber" name="L63" href="#L63">63</a> String host = wsc.resolveHost();
<a class="jxr_linenumber" name="L64" href="#L64">64</a> ServletRequest request = wsc.resolveServletRequest();
<a class="jxr_linenumber" name="L65" href="#L65">65</a> ServletResponse response = wsc.resolveServletResponse();
<a class="jxr_linenumber" name="L66" href="#L66">66</a>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a name="WebDelegatingSubject" href="../../../../../org/apache/shiro/web/subject/support/WebDelegatingSubject.html#WebDelegatingSubject">WebDelegatingSubject</a>(principals, authenticated, host, session, sessionEnabled,
<a class="jxr_linenumber" name="L68" href="#L68">68</a> request, response, securityManager);
<a class="jxr_linenumber" name="L69" href="#L69">69</a> }
<a class="jxr_linenumber" name="L70" href="#L70">70</a>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * @deprecated since 1.2 - override {@link #createSubject(org.apache.shiro.subject.SubjectContext)} directly if you</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * need to instantiate a custom {@link Subject} class.</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> @Deprecated
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">protected</strong> Subject newSubjectInstance(PrincipalCollection principals, <strong class="jxr_keyword">boolean</strong> authenticated,
<a class="jxr_linenumber" name="L77" href="#L77">77</a> String host, Session session,
<a class="jxr_linenumber" name="L78" href="#L78">78</a> ServletRequest request, ServletResponse response,
<a class="jxr_linenumber" name="L79" href="#L79">79</a> SecurityManager securityManager) {
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a name="WebDelegatingSubject" href="../../../../../org/apache/shiro/web/subject/support/WebDelegatingSubject.html#WebDelegatingSubject">WebDelegatingSubject</a>(principals, authenticated, host, session, <strong class="jxr_keyword">true</strong>,
<a class="jxr_linenumber" name="L81" href="#L81">81</a> request, response, securityManager);
<a class="jxr_linenumber" name="L82" href="#L82">82</a> }
<a class="jxr_linenumber" name="L83" href="#L83">83</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>