| <!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>Subject xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/shiro/subject/Subject.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; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.SecurityUtils; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationException; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationToken; |
| <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.mgt.SecurityManager; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.mgt.SubjectFactory; |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.Session; |
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.support.DefaultSubjectContext; |
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.CollectionUtils; |
| <a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils; |
| <a name="32" href="#32">32</a> |
| <a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> java.io.Serializable; |
| <a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> java.util.Collection; |
| <a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> java.util.List; |
| <a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.Callable; |
| <a name="37" href="#37">37</a> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * A {@code Subject} represents state and security operations for a <em>single</em> application user.</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * These operations include authentication (login/logout), authorization (access control), and</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * session access. It is Shiro's primary mechanism for single-user security functionality.</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * <h3>Acquiring a Subject</h3></em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * To acquire the currently-executing {@code Subject}, application developers will almost always use</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * {@code SecurityUtils}:</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * {@link SecurityUtils SecurityUtils}.{@link org.apache.shiro.SecurityUtils#getSubject() getSubject()}</pre></em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * Almost all security operations should be performed with the {@code Subject} returned from this method.</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * <h3>Permission methods</h3></em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * Note that there are many *Permission methods in this interface overloaded to accept String arguments instead of</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * {@link Permission Permission} instances. They are a convenience allowing the caller to use a String representation of</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * a {@link Permission Permission} if desired. The underlying Authorization subsystem implementations will usually</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * simply convert these String values to {@link Permission Permission} instances and then just call the corresponding</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * type-safe method. (Shiro's default implementations do String-to-Permission conversion for these methods using</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authz.permission.PermissionResolver PermissionResolver}s.)</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * These overloaded *Permission methods forgo type-saftey for the benefit of convenience and simplicity,</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * so you should choose which ones to use based on your preferences and needs.</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * @since 0.1</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="61" href="#61">61</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> { |
| <a name="62" href="#62">62</a> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * Returns this Subject's application-wide uniquely identifying principal, or {@code null} if this</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * Subject is anonymous because it doesn't yet have any associated account data (for example,</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * if they haven't logged in).</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * The term <em>principal</em> is just a fancy security term for any identifying attribute(s) of an application</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * user, such as a username, or user id, or public key, or anything else you might use in your application to</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * identify a user.</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * <h4>Uniqueness</h4></em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * Although given names and family names (first/last) are technically considered principals as well,</em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * Shiro expects the object returned from this method to be an identifying attribute unique across</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * your entire application.</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * This implies that things like given names and family names are usually poor</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * candidates as return values since they are rarely guaranteed to be unique; Things often used for this value:</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * <li>A {@code long} RDBMS surrogate primary key</li></em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * <li>An application-unique username</li></em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * <li>A {@link java.util.UUID UUID}</li></em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * <li>An LDAP Unique ID</li></em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * or any other similar suitable unique mechanism valuable to your application.</em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * Most implementations will simply return</em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * <code>{@link #getPrincipals()}.{@link org.apache.shiro.subject.PrincipalCollection#getPrimaryPrincipal() getPrimaryPrincipal()}</code></em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * @return this Subject's application-specific unique identity.</em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.subject.PrincipalCollection#getPrimaryPrincipal()</em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="92" href="#92">92</a> Object getPrincipal(); |
| <a name="93" href="#93">93</a> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * Returns this Subject's principals (identifying attributes) in the form of a {@code PrincipalCollection} or</em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * {@code null} if this Subject is anonymous because it doesn't yet have any associated account data (for example,</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * if they haven't logged in).</em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * The word &quot;principals&quot; is nothing more than a fancy security term for identifying attributes associated</em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * with a Subject, aka, application user. For example, user id, a surname (family/last name), given (first) name,</em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * social security number, nickname, username, etc, are all examples of a principal.</em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * @return all of this Subject's principals (identifying attributes).</em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * @see #getPrincipal()</em> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.subject.PrincipalCollection#getPrimaryPrincipal()</em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="107" href="#107">107</a> <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> getPrincipals(); |
| <a name="108" href="#108">108</a> |
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * Returns {@code true} if this Subject is permitted to perform an action or access a resource summarized by the</em> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * specified permission string.</em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * This is an overloaded method for the corresponding type-safe {@link Permission Permission} variant.</em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * Please see the class-level JavaDoc for more information on these String-based permission methods.</em> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * @param permission the String representation of a Permission that is being checked.</em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * @return true if this Subject is permitted, false otherwise.</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * @see #isPermitted(Permission permission)</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="121" href="#121">121</a> <strong class="jxr_keyword">boolean</strong> isPermitted(String permission); |
| <a name="122" href="#122">122</a> |
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * Returns {@code true} if this Subject is permitted to perform an action or access a resource summarized by the</em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * specified permission.</em> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * More specifically, this method determines if any {@code Permission}s associated</em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * with the subject {@link Permission#implies(Permission) imply} the specified permission.</em> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * @param permission the permission that is being checked.</em> |
| <a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * @return true if this Subject is permitted, false otherwise.</em> |
| <a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="133" href="#133">133</a> <strong class="jxr_keyword">boolean</strong> isPermitted(<a href="../../../../org/apache/shiro/authz/Permission.html">Permission</a> permission); |
| <a name="134" href="#134">134</a> |
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * Checks if this Subject implies the given permission strings and returns a boolean array indicating which</em> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * permissions are implied.</em> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * This is an overloaded method for the corresponding type-safe {@link Permission Permission} variant.</em> |
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * Please see the class-level JavaDoc for more information on these String-based permission methods.</em> |
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * @param permissions the String representations of the Permissions that are being checked.</em> |
| <a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * @return a boolean array where indices correspond to the index of the</em> |
| <a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * permissions in the given list. A true value at an index indicates this Subject is permitted for</em> |
| <a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * for the associated {@code Permission} string in the list. A false value at an index</em> |
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * indicates otherwise.</em> |
| <a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="149" href="#149">149</a> <strong class="jxr_keyword">boolean</strong>[] isPermitted(String... permissions); |
| <a name="150" href="#150">150</a> |
| <a name="151" href="#151">151</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * Checks if this Subject implies the given Permissions and returns a boolean array indicating which permissions</em> |
| <a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * are implied.</em> |
| <a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * More specifically, this method should determine if each {@code Permission} in</em> |
| <a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * the array is {@link Permission#implies(Permission) implied} by permissions</em> |
| <a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * already associated with the subject.</em> |
| <a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * This is primarily a performance-enhancing method to help reduce the number of</em> |
| <a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * {@link #isPermitted} invocations over the wire in client/server systems.</em> |
| <a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * @param permissions the permissions that are being checked.</em> |
| <a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * @return a boolean array where indices correspond to the index of the</em> |
| <a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * permissions in the given list. A true value at an index indicates this Subject is permitted for</em> |
| <a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * for the associated {@code Permission} object in the list. A false value at an index</em> |
| <a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * indicates otherwise.</em> |
| <a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="168" href="#168">168</a> <strong class="jxr_keyword">boolean</strong>[] isPermitted(List<Permission> permissions); |
| <a name="169" href="#169">169</a> |
| <a name="170" href="#170">170</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * Returns {@code true} if this Subject implies all of the specified permission strings, {@code false} otherwise.</em> |
| <a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="173" href="#173">173</a> <em class="jxr_javadoccomment"> * This is an overloaded method for the corresponding type-safe {@link org.apache.shiro.authz.Permission Permission}</em> |
| <a name="174" href="#174">174</a> <em class="jxr_javadoccomment"> * variant. Please see the class-level JavaDoc for more information on these String-based permission methods.</em> |
| <a name="175" href="#175">175</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="176" href="#176">176</a> <em class="jxr_javadoccomment"> * @param permissions the String representations of the Permissions that are being checked.</em> |
| <a name="177" href="#177">177</a> <em class="jxr_javadoccomment"> * @return true if this Subject has all of the specified permissions, false otherwise.</em> |
| <a name="178" href="#178">178</a> <em class="jxr_javadoccomment"> * @see #isPermittedAll(Collection)</em> |
| <a name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="181" href="#181">181</a> <strong class="jxr_keyword">boolean</strong> isPermittedAll(String... permissions); |
| <a name="182" href="#182">182</a> |
| <a name="183" href="#183">183</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="184" href="#184">184</a> <em class="jxr_javadoccomment"> * Returns {@code true} if this Subject implies all of the specified permissions, {@code false} otherwise.</em> |
| <a name="185" href="#185">185</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * More specifically, this method determines if all of the given {@code Permission}s are</em> |
| <a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * {@link Permission#implies(Permission) implied by} permissions already associated with this Subject.</em> |
| <a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * @param permissions the permissions to check.</em> |
| <a name="190" href="#190">190</a> <em class="jxr_javadoccomment"> * @return true if this Subject has all of the specified permissions, false otherwise.</em> |
| <a name="191" href="#191">191</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="192" href="#192">192</a> <strong class="jxr_keyword">boolean</strong> isPermittedAll(Collection<Permission> permissions); |
| <a name="193" href="#193">193</a> |
| <a name="194" href="#194">194</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="195" href="#195">195</a> <em class="jxr_javadoccomment"> * Ensures this Subject implies the specified permission String.</em> |
| <a name="196" href="#196">196</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> * If this subject's existing associated permissions do not {@link Permission#implies(Permission)} imply}</em> |
| <a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * the given permission, an {@link org.apache.shiro.authz.AuthorizationException} will be thrown.</em> |
| <a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> * This is an overloaded method for the corresponding type-safe {@link Permission Permission} variant.</em> |
| <a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> * Please see the class-level JavaDoc for more information on these String-based permission methods.</em> |
| <a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> * @param permission the String representation of the Permission to check.</em> |
| <a name="204" href="#204">204</a> <em class="jxr_javadoccomment"> * @throws org.apache.shiro.authz.AuthorizationException</em> |
| <a name="205" href="#205">205</a> <em class="jxr_javadoccomment"> * if the user does not have the permission.</em> |
| <a name="206" href="#206">206</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="207" href="#207">207</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="208" href="#208">208</a> <strong class="jxr_keyword">void</strong> checkPermission(String permission) <strong class="jxr_keyword">throws</strong> AuthorizationException; |
| <a name="209" href="#209">209</a> |
| <a name="210" href="#210">210</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="211" href="#211">211</a> <em class="jxr_javadoccomment"> * Ensures this Subject {@link Permission#implies(Permission) implies} the specified {@code Permission}.</em> |
| <a name="212" href="#212">212</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="213" href="#213">213</a> <em class="jxr_javadoccomment"> * If this subject's existing associated permissions do not {@link Permission#implies(Permission) imply}</em> |
| <a name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * the given permission, an {@link org.apache.shiro.authz.AuthorizationException} will be thrown.</em> |
| <a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * @param permission the Permission to check.</em> |
| <a name="217" href="#217">217</a> <em class="jxr_javadoccomment"> * @throws org.apache.shiro.authz.AuthorizationException</em> |
| <a name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * if this Subject does not have the permission.</em> |
| <a name="219" href="#219">219</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="220" href="#220">220</a> <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="221" href="#221">221</a> |
| <a name="222" href="#222">222</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="223" href="#223">223</a> <em class="jxr_javadoccomment"> * Ensures this Subject</em> |
| <a name="224" href="#224">224</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authz.Permission#implies(org.apache.shiro.authz.Permission) implies} all of the</em> |
| <a name="225" href="#225">225</a> <em class="jxr_javadoccomment"> * specified permission strings.</em> |
| <a name="226" href="#226">226</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="227" href="#227">227</a> <em class="jxr_javadoccomment"> * If this subject's existing associated permissions do not</em> |
| <a name="228" href="#228">228</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authz.Permission#implies(org.apache.shiro.authz.Permission) imply} all of the given permissions,</em> |
| <a name="229" href="#229">229</a> <em class="jxr_javadoccomment"> * an {@link org.apache.shiro.authz.AuthorizationException} will be thrown.</em> |
| <a name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * This is an overloaded method for the corresponding type-safe {@link Permission Permission} variant.</em> |
| <a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * Please see the class-level JavaDoc for more information on these String-based permission methods.</em> |
| <a name="233" href="#233">233</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="234" href="#234">234</a> <em class="jxr_javadoccomment"> * @param permissions the string representations of Permissions to check.</em> |
| <a name="235" href="#235">235</a> <em class="jxr_javadoccomment"> * @throws AuthorizationException if this Subject does not have all of the given permissions.</em> |
| <a name="236" href="#236">236</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="237" href="#237">237</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="238" href="#238">238</a> <strong class="jxr_keyword">void</strong> checkPermissions(String... permissions) <strong class="jxr_keyword">throws</strong> AuthorizationException; |
| <a name="239" href="#239">239</a> |
| <a name="240" href="#240">240</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="241" href="#241">241</a> <em class="jxr_javadoccomment"> * Ensures this Subject</em> |
| <a name="242" href="#242">242</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authz.Permission#implies(org.apache.shiro.authz.Permission) implies} all of the</em> |
| <a name="243" href="#243">243</a> <em class="jxr_javadoccomment"> * specified permission strings.</em> |
| <a name="244" href="#244">244</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="245" href="#245">245</a> <em class="jxr_javadoccomment"> * If this subject's existing associated permissions do not</em> |
| <a name="246" href="#246">246</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authz.Permission#implies(org.apache.shiro.authz.Permission) imply} all of the given permissions,</em> |
| <a name="247" href="#247">247</a> <em class="jxr_javadoccomment"> * an {@link org.apache.shiro.authz.AuthorizationException} will be thrown.</em> |
| <a name="248" href="#248">248</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="249" href="#249">249</a> <em class="jxr_javadoccomment"> * @param permissions the Permissions to check.</em> |
| <a name="250" href="#250">250</a> <em class="jxr_javadoccomment"> * @throws AuthorizationException if this Subject does not have all of the given permissions.</em> |
| <a name="251" href="#251">251</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="252" href="#252">252</a> <strong class="jxr_keyword">void</strong> checkPermissions(Collection<Permission> permissions) <strong class="jxr_keyword">throws</strong> AuthorizationException; |
| <a name="253" href="#253">253</a> |
| <a name="254" href="#254">254</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="255" href="#255">255</a> <em class="jxr_javadoccomment"> * Returns {@code true} if this Subject has the specified role, {@code false} otherwise.</em> |
| <a name="256" href="#256">256</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="257" href="#257">257</a> <em class="jxr_javadoccomment"> * @param roleIdentifier the application-specific role identifier (usually a role id or role name).</em> |
| <a name="258" href="#258">258</a> <em class="jxr_javadoccomment"> * @return {@code true} if this Subject has the specified role, {@code false} otherwise.</em> |
| <a name="259" href="#259">259</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="260" href="#260">260</a> <strong class="jxr_keyword">boolean</strong> hasRole(String roleIdentifier); |
| <a name="261" href="#261">261</a> |
| <a name="262" href="#262">262</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="263" href="#263">263</a> <em class="jxr_javadoccomment"> * Checks if this Subject has the specified roles, returning a boolean array indicating</em> |
| <a name="264" href="#264">264</a> <em class="jxr_javadoccomment"> * which roles are associated.</em> |
| <a name="265" href="#265">265</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="266" href="#266">266</a> <em class="jxr_javadoccomment"> * This is primarily a performance-enhancing method to help reduce the number of</em> |
| <a name="267" href="#267">267</a> <em class="jxr_javadoccomment"> * {@link #hasRole} invocations over the wire in client/server systems.</em> |
| <a name="268" href="#268">268</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="269" href="#269">269</a> <em class="jxr_javadoccomment"> * @param roleIdentifiers the application-specific role identifiers to check (usually role ids or role names).</em> |
| <a name="270" href="#270">270</a> <em class="jxr_javadoccomment"> * @return a boolean array where indices correspond to the index of the</em> |
| <a name="271" href="#271">271</a> <em class="jxr_javadoccomment"> * roles in the given identifiers. A true value indicates this Subject has the</em> |
| <a name="272" href="#272">272</a> <em class="jxr_javadoccomment"> * role at that index. False indicates this Subject does not have the role at that index.</em> |
| <a name="273" href="#273">273</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="274" href="#274">274</a> <strong class="jxr_keyword">boolean</strong>[] hasRoles(List<String> roleIdentifiers); |
| <a name="275" href="#275">275</a> |
| <a name="276" href="#276">276</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="277" href="#277">277</a> <em class="jxr_javadoccomment"> * Returns {@code true} if this Subject has all of the specified roles, {@code false} otherwise.</em> |
| <a name="278" href="#278">278</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="279" href="#279">279</a> <em class="jxr_javadoccomment"> * @param roleIdentifiers the application-specific role identifiers to check (usually role ids or role names).</em> |
| <a name="280" href="#280">280</a> <em class="jxr_javadoccomment"> * @return true if this Subject has all the roles, false otherwise.</em> |
| <a name="281" href="#281">281</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="282" href="#282">282</a> <strong class="jxr_keyword">boolean</strong> hasAllRoles(Collection<String> roleIdentifiers); |
| <a name="283" href="#283">283</a> |
| <a name="284" href="#284">284</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="285" href="#285">285</a> <em class="jxr_javadoccomment"> * Asserts this Subject has the specified role by returning quietly if they do or throwing an</em> |
| <a name="286" href="#286">286</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authz.AuthorizationException} if they do not.</em> |
| <a name="287" href="#287">287</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="288" href="#288">288</a> <em class="jxr_javadoccomment"> * @param roleIdentifier the application-specific role identifier (usually a role id or role name ).</em> |
| <a name="289" href="#289">289</a> <em class="jxr_javadoccomment"> * @throws org.apache.shiro.authz.AuthorizationException</em> |
| <a name="290" href="#290">290</a> <em class="jxr_javadoccomment"> * if this Subject does not have the role.</em> |
| <a name="291" href="#291">291</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="292" href="#292">292</a> <strong class="jxr_keyword">void</strong> checkRole(String roleIdentifier) <strong class="jxr_keyword">throws</strong> AuthorizationException; |
| <a name="293" href="#293">293</a> |
| <a name="294" href="#294">294</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="295" href="#295">295</a> <em class="jxr_javadoccomment"> * Asserts this Subject has all of the specified roles by returning quietly if they do or throwing an</em> |
| <a name="296" href="#296">296</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authz.AuthorizationException} if they do not.</em> |
| <a name="297" href="#297">297</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="298" href="#298">298</a> <em class="jxr_javadoccomment"> * @param roleIdentifiers the application-specific role identifiers to check (usually role ids or role names).</em> |
| <a name="299" href="#299">299</a> <em class="jxr_javadoccomment"> * @throws org.apache.shiro.authz.AuthorizationException</em> |
| <a name="300" href="#300">300</a> <em class="jxr_javadoccomment"> * if this Subject does not have all of the specified roles.</em> |
| <a name="301" href="#301">301</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="302" href="#302">302</a> <strong class="jxr_keyword">void</strong> checkRoles(Collection<String> roleIdentifiers) <strong class="jxr_keyword">throws</strong> AuthorizationException; |
| <a name="303" href="#303">303</a> |
| <a name="304" href="#304">304</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="305" href="#305">305</a> <em class="jxr_javadoccomment"> * Same as {@link #checkRoles(Collection<String> roleIdentifiers) checkRoles(Collection<String> roleIdentifiers)} but</em> |
| <a name="306" href="#306">306</a> <em class="jxr_javadoccomment"> * doesn't require a collection as a an argument.</em> |
| <a name="307" href="#307">307</a> <em class="jxr_javadoccomment"> * Asserts this Subject has all of the specified roles by returning quietly if they do or throwing an</em> |
| <a name="308" href="#308">308</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authz.AuthorizationException} if they do not.</em> |
| <a name="309" href="#309">309</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="310" href="#310">310</a> <em class="jxr_javadoccomment"> * @param roleIdentifiers roleIdentifiers the application-specific role identifiers to check (usually role ids or role names).</em> |
| <a name="311" href="#311">311</a> <em class="jxr_javadoccomment"> * @throws AuthorizationException org.apache.shiro.authz.AuthorizationException</em> |
| <a name="312" href="#312">312</a> <em class="jxr_javadoccomment"> * if this Subject does not have all of the specified roles.</em> |
| <a name="313" href="#313">313</a> <em class="jxr_javadoccomment"> * @since 1.1.0</em> |
| <a name="314" href="#314">314</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="315" href="#315">315</a> <strong class="jxr_keyword">void</strong> checkRoles(String... roleIdentifiers) <strong class="jxr_keyword">throws</strong> AuthorizationException; |
| <a name="316" href="#316">316</a> |
| <a name="317" href="#317">317</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="318" href="#318">318</a> <em class="jxr_javadoccomment"> * Performs a login attempt for this Subject/user. If unsuccessful,</em> |
| <a name="319" href="#319">319</a> <em class="jxr_javadoccomment"> * an {@link AuthenticationException} is thrown, the subclass of which identifies why the attempt failed.</em> |
| <a name="320" href="#320">320</a> <em class="jxr_javadoccomment"> * If successful, the account data associated with the submitted principals/credentials will be</em> |
| <a name="321" href="#321">321</a> <em class="jxr_javadoccomment"> * associated with this {@code Subject} and the method will return quietly.</em> |
| <a name="322" href="#322">322</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="323" href="#323">323</a> <em class="jxr_javadoccomment"> * Upon returning quietly, this {@code Subject} instance can be considered</em> |
| <a name="324" href="#324">324</a> <em class="jxr_javadoccomment"> * authenticated and {@link #getPrincipal() getPrincipal()} will be non-null and</em> |
| <a name="325" href="#325">325</a> <em class="jxr_javadoccomment"> * {@link #isAuthenticated() isAuthenticated()} will be {@code true}.</em> |
| <a name="326" href="#326">326</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="327" href="#327">327</a> <em class="jxr_javadoccomment"> * @param token the token encapsulating the subject's principals and credentials to be passed to the</em> |
| <a name="328" href="#328">328</a> <em class="jxr_javadoccomment"> * Authentication subsystem for verification.</em> |
| <a name="329" href="#329">329</a> <em class="jxr_javadoccomment"> * @throws org.apache.shiro.authc.AuthenticationException</em> |
| <a name="330" href="#330">330</a> <em class="jxr_javadoccomment"> * if the authentication attempt fails.</em> |
| <a name="331" href="#331">331</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="332" href="#332">332</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="333" href="#333">333</a> <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="334" href="#334">334</a> |
| <a name="335" href="#335">335</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="336" href="#336">336</a> <em class="jxr_javadoccomment"> * Returns {@code true} if this Subject/user proved their identity <em>during their current session</em></em> |
| <a name="337" href="#337">337</a> <em class="jxr_javadoccomment"> * by providing valid credentials matching those known to the system, {@code false} otherwise.</em> |
| <a name="338" href="#338">338</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="339" href="#339">339</a> <em class="jxr_javadoccomment"> * Note that even if this Subject's identity has been remembered via 'remember me' services, this method will</em> |
| <a name="340" href="#340">340</a> <em class="jxr_javadoccomment"> * still return {@code false} unless the user has actually logged in with proper credentials <em>during their</em> |
| <a name="341" href="#341">341</a> <em class="jxr_javadoccomment"> * current session</em>. See the {@link #isRemembered() isRemembered()} method JavaDoc for more.</em> |
| <a name="342" href="#342">342</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="343" href="#343">343</a> <em class="jxr_javadoccomment"> * @return {@code true} if this Subject proved their identity during their current session</em> |
| <a name="344" href="#344">344</a> <em class="jxr_javadoccomment"> * by providing valid credentials matching those known to the system, {@code false} otherwise.</em> |
| <a name="345" href="#345">345</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="346" href="#346">346</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="347" href="#347">347</a> <strong class="jxr_keyword">boolean</strong> isAuthenticated(); |
| <a name="348" href="#348">348</a> |
| <a name="349" href="#349">349</a> |
| <a name="350" href="#350">350</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="351" href="#351">351</a> <em class="jxr_javadoccomment"> * Returns {@code true} if this {@code Subject} has an identity (it is not anonymous) and the identity</em> |
| <a name="352" href="#352">352</a> <em class="jxr_javadoccomment"> * (aka {@link #getPrincipals() principals}) is remembered from a successful authentication during a previous</em> |
| <a name="353" href="#353">353</a> <em class="jxr_javadoccomment"> * session.</em> |
| <a name="354" href="#354">354</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="355" href="#355">355</a> <em class="jxr_javadoccomment"> * Although the underlying implementation determines exactly how this method functions, most implementations have</em> |
| <a name="356" href="#356">356</a> <em class="jxr_javadoccomment"> * this method act as the logical equivalent to this code:</em> |
| <a name="357" href="#357">357</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="358" href="#358">358</a> <em class="jxr_javadoccomment"> * {@link #getPrincipal() getPrincipal()} != null && !{@link #isAuthenticated() isAuthenticated()}</pre></em> |
| <a name="359" href="#359">359</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="360" href="#360">360</a> <em class="jxr_javadoccomment"> * Note as indicated by the above code example, if a {@code Subject} is remembered, they are</em> |
| <a name="361" href="#361">361</a> <em class="jxr_javadoccomment"> * <em>NOT</em> considered authenticated. A check against {@link #isAuthenticated() isAuthenticated()} is a more</em> |
| <a name="362" href="#362">362</a> <em class="jxr_javadoccomment"> * strict check than that reflected by this method. For example, a check to see if a subject can access financial</em> |
| <a name="363" href="#363">363</a> <em class="jxr_javadoccomment"> * information should almost always depend on {@link #isAuthenticated() isAuthenticated()} to <em>guarantee</em> a</em> |
| <a name="364" href="#364">364</a> <em class="jxr_javadoccomment"> * verified identity, and not this method.</em> |
| <a name="365" href="#365">365</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="366" href="#366">366</a> <em class="jxr_javadoccomment"> * Once the subject is authenticated, they are no longer considered only remembered because their identity would</em> |
| <a name="367" href="#367">367</a> <em class="jxr_javadoccomment"> * have been verified during the current session.</em> |
| <a name="368" href="#368">368</a> <em class="jxr_javadoccomment"> * <h4>Remembered vs Authenticated</h4></em> |
| <a name="369" href="#369">369</a> <em class="jxr_javadoccomment"> * Authentication is the process of <em>proving</em> you are who you say you are. When a user is only remembered,</em> |
| <a name="370" href="#370">370</a> <em class="jxr_javadoccomment"> * the remembered identity gives the system an idea who that user probably is, but in reality, has no way of</em> |
| <a name="371" href="#371">371</a> <em class="jxr_javadoccomment"> * absolutely <em>guaranteeing</em> if the remembered {@code Subject} represents the user currently</em> |
| <a name="372" href="#372">372</a> <em class="jxr_javadoccomment"> * using the application.</em> |
| <a name="373" href="#373">373</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="374" href="#374">374</a> <em class="jxr_javadoccomment"> * So although many parts of the application can still perform user-specific logic based on the remembered</em> |
| <a name="375" href="#375">375</a> <em class="jxr_javadoccomment"> * {@link #getPrincipals() principals}, such as customized views, it should never perform highly-sensitive</em> |
| <a name="376" href="#376">376</a> <em class="jxr_javadoccomment"> * operations until the user has legitimately verified their identity by executing a successful authentication</em> |
| <a name="377" href="#377">377</a> <em class="jxr_javadoccomment"> * attempt.</em> |
| <a name="378" href="#378">378</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="379" href="#379">379</a> <em class="jxr_javadoccomment"> * We see this paradigm all over the web, and we will use <a href="<a href="http://www.amazon.com" target="alexandria_uri">http://www.amazon.com</a>">Amazon.com</a> as an</em> |
| <a name="380" href="#380">380</a> <em class="jxr_javadoccomment"> * example:</em> |
| <a name="381" href="#381">381</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="382" href="#382">382</a> <em class="jxr_javadoccomment"> * When you visit Amazon.com and perform a login and ask it to 'remember me', it will set a cookie with your</em> |
| <a name="383" href="#383">383</a> <em class="jxr_javadoccomment"> * identity. If you don't log out and your session expires, and you come back, say the next day, Amazon still knows</em> |
| <a name="384" href="#384">384</a> <em class="jxr_javadoccomment"> * who you <em>probably</em> are: you still see all of your book and movie recommendations and similar user-specific</em> |
| <a name="385" href="#385">385</a> <em class="jxr_javadoccomment"> * features since these are based on your (remembered) user id.</em> |
| <a name="386" href="#386">386</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="387" href="#387">387</a> <em class="jxr_javadoccomment"> * BUT, if you try to do something sensitive, such as access your account's billing data, Amazon forces you</em> |
| <a name="388" href="#388">388</a> <em class="jxr_javadoccomment"> * to do an actual log-in, requiring your username and password.</em> |
| <a name="389" href="#389">389</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="390" href="#390">390</a> <em class="jxr_javadoccomment"> * This is because although amazon.com assumed your identity from 'remember me', it recognized that you were not</em> |
| <a name="391" href="#391">391</a> <em class="jxr_javadoccomment"> * actually authenticated. The only way to really guarantee you are who you say you are, and therefore allow you</em> |
| <a name="392" href="#392">392</a> <em class="jxr_javadoccomment"> * access to sensitive account data, is to force you to perform an actual successful authentication. You can</em> |
| <a name="393" href="#393">393</a> <em class="jxr_javadoccomment"> * check this guarantee via the {@link #isAuthenticated() isAuthenticated()} method and not via this method.</em> |
| <a name="394" href="#394">394</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="395" href="#395">395</a> <em class="jxr_javadoccomment"> * @return {@code true} if this {@code Subject}'s identity (aka {@link #getPrincipals() principals}) is</em> |
| <a name="396" href="#396">396</a> <em class="jxr_javadoccomment"> * remembered from a successful authentication during a previous session, {@code false} otherwise.</em> |
| <a name="397" href="#397">397</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="398" href="#398">398</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="399" href="#399">399</a> <strong class="jxr_keyword">boolean</strong> isRemembered(); |
| <a name="400" href="#400">400</a> |
| <a name="401" href="#401">401</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="402" href="#402">402</a> <em class="jxr_javadoccomment"> * Returns the application {@code Session} associated with this Subject. If no session exists when this</em> |
| <a name="403" href="#403">403</a> <em class="jxr_javadoccomment"> * method is called, a new session will be created, associated with this Subject, and then returned.</em> |
| <a name="404" href="#404">404</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="405" href="#405">405</a> <em class="jxr_javadoccomment"> * @return the application {@code Session} associated with this Subject.</em> |
| <a name="406" href="#406">406</a> <em class="jxr_javadoccomment"> * @see #getSession(boolean)</em> |
| <a name="407" href="#407">407</a> <em class="jxr_javadoccomment"> * @since 0.2</em> |
| <a name="408" href="#408">408</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="409" href="#409">409</a> <a href="../../../../org/apache/shiro/session/Session.html">Session</a> getSession(); |
| <a name="410" href="#410">410</a> |
| <a name="411" href="#411">411</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="412" href="#412">412</a> <em class="jxr_javadoccomment"> * Returns the application {@code Session} associated with this Subject. Based on the boolean argument,</em> |
| <a name="413" href="#413">413</a> <em class="jxr_javadoccomment"> * this method functions as follows:</em> |
| <a name="414" href="#414">414</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a name="415" href="#415">415</a> <em class="jxr_javadoccomment"> * <li>If there is already an existing session associated with this {@code Subject}, it is returned and</em> |
| <a name="416" href="#416">416</a> <em class="jxr_javadoccomment"> * the {@code create} argument is ignored.</li></em> |
| <a name="417" href="#417">417</a> <em class="jxr_javadoccomment"> * <li>If no session exists and {@code create} is {@code true}, a new session will be created, associated with</em> |
| <a name="418" href="#418">418</a> <em class="jxr_javadoccomment"> * this {@code Subject} and then returned.</li></em> |
| <a name="419" href="#419">419</a> <em class="jxr_javadoccomment"> * <li>If no session exists and {@code create} is {@code false}, {@code null} is returned.</li></em> |
| <a name="420" href="#420">420</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a name="421" href="#421">421</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="422" href="#422">422</a> <em class="jxr_javadoccomment"> * @param create boolean argument determining if a new session should be created or not if there is no existing session.</em> |
| <a name="423" href="#423">423</a> <em class="jxr_javadoccomment"> * @return the application {@code Session} associated with this {@code Subject} or {@code null} based</em> |
| <a name="424" href="#424">424</a> <em class="jxr_javadoccomment"> * on the above described logic.</em> |
| <a name="425" href="#425">425</a> <em class="jxr_javadoccomment"> * @since 0.2</em> |
| <a name="426" href="#426">426</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="427" href="#427">427</a> <a href="../../../../org/apache/shiro/session/Session.html">Session</a> getSession(<strong class="jxr_keyword">boolean</strong> create); |
| <a name="428" href="#428">428</a> |
| <a name="429" href="#429">429</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="430" href="#430">430</a> <em class="jxr_javadoccomment"> * Logs out this Subject and invalidates and/or removes any associated entities,</em> |
| <a name="431" href="#431">431</a> <em class="jxr_javadoccomment"> * such as a {@link Session Session} and authorization data. After this method is called, the Subject is</em> |
| <a name="432" href="#432">432</a> <em class="jxr_javadoccomment"> * considered 'anonymous' and may continue to be used for another log-in if desired.</em> |
| <a name="433" href="#433">433</a> <em class="jxr_javadoccomment"> * <h3>Web Environment Warning</h3></em> |
| <a name="434" href="#434">434</a> <em class="jxr_javadoccomment"> * Calling this method in web environments will usually remove any associated session cookie as part of</em> |
| <a name="435" href="#435">435</a> <em class="jxr_javadoccomment"> * session invalidation. Because cookies are part of the HTTP header, and headers can only be set before the</em> |
| <a name="436" href="#436">436</a> <em class="jxr_javadoccomment"> * response body (html, image, etc) is sent, this method in web environments must be called before <em>any</em></em> |
| <a name="437" href="#437">437</a> <em class="jxr_javadoccomment"> * content has been rendered.</em> |
| <a name="438" href="#438">438</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="439" href="#439">439</a> <em class="jxr_javadoccomment"> * The typical approach most applications use in this scenario is to redirect the user to a different</em> |
| <a name="440" href="#440">440</a> <em class="jxr_javadoccomment"> * location (e.g. home page) immediately after calling this method. This is an effect of the HTTP protocol</em> |
| <a name="441" href="#441">441</a> <em class="jxr_javadoccomment"> * itself and not a reflection of Shiro's implementation.</em> |
| <a name="442" href="#442">442</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="443" href="#443">443</a> <em class="jxr_javadoccomment"> * Non-HTTP environments may of course use a logged-out subject for login again if desired.</em> |
| <a name="444" href="#444">444</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="445" href="#445">445</a> <strong class="jxr_keyword">void</strong> logout(); |
| <a name="446" href="#446">446</a> |
| <a name="447" href="#447">447</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="448" href="#448">448</a> <em class="jxr_javadoccomment"> * Associates the specified {@code Callable} with this {@code Subject} instance and then executes it on the</em> |
| <a name="449" href="#449">449</a> <em class="jxr_javadoccomment"> * currently running thread. If you want to execute the {@code Callable} on a different thread, it is better to</em> |
| <a name="450" href="#450">450</a> <em class="jxr_javadoccomment"> * use the {@link #associateWith(Callable)} method instead.</em> |
| <a name="451" href="#451">451</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="452" href="#452">452</a> <em class="jxr_javadoccomment"> * @param callable the Callable to associate with this subject and then execute.</em> |
| <a name="453" href="#453">453</a> <em class="jxr_javadoccomment"> * @param <V> the type of return value the {@code Callable} will return</em> |
| <a name="454" href="#454">454</a> <em class="jxr_javadoccomment"> * @return the resulting object returned by the {@code Callable}'s execution.</em> |
| <a name="455" href="#455">455</a> <em class="jxr_javadoccomment"> * @throws ExecutionException if the {@code Callable}'s {@link Callable#call call} method throws an exception.</em> |
| <a name="456" href="#456">456</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="457" href="#457">457</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="458" href="#458">458</a> <V> V execute(Callable<V> callable) <strong class="jxr_keyword">throws</strong> ExecutionException; |
| <a name="459" href="#459">459</a> |
| <a name="460" href="#460">460</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="461" href="#461">461</a> <em class="jxr_javadoccomment"> * Associates the specified {@code Runnable} with this {@code Subject} instance and then executes it on the</em> |
| <a name="462" href="#462">462</a> <em class="jxr_javadoccomment"> * currently running thread. If you want to execute the {@code Runnable} on a different thread, it is better to</em> |
| <a name="463" href="#463">463</a> <em class="jxr_javadoccomment"> * use the {@link #associateWith(Runnable)} method instead.</em> |
| <a name="464" href="#464">464</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="465" href="#465">465</a> <em class="jxr_javadoccomment"> * <b>Note</b>: This method is primarily provided to execute existing/legacy Runnable implementations. It is better</em> |
| <a name="466" href="#466">466</a> <em class="jxr_javadoccomment"> * for new code to use {@link #execute(Callable)} since that supports the ability to return values and catch</em> |
| <a name="467" href="#467">467</a> <em class="jxr_javadoccomment"> * exceptions.</em> |
| <a name="468" href="#468">468</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="469" href="#469">469</a> <em class="jxr_javadoccomment"> * @param runnable the {@code Runnable} to associate with this {@code Subject} and then execute.</em> |
| <a name="470" href="#470">470</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="471" href="#471">471</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="472" href="#472">472</a> <strong class="jxr_keyword">void</strong> execute(Runnable runnable); |
| <a name="473" href="#473">473</a> |
| <a name="474" href="#474">474</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="475" href="#475">475</a> <em class="jxr_javadoccomment"> * Returns a {@code Callable} instance matching the given argument while additionally ensuring that it will</em> |
| <a name="476" href="#476">476</a> <em class="jxr_javadoccomment"> * retain and execute under this Subject's identity. The returned object can be used with an</em> |
| <a name="477" href="#477">477</a> <em class="jxr_javadoccomment"> * {@link java.util.concurrent.ExecutorService ExecutorService} to execute as this Subject.</em> |
| <a name="478" href="#478">478</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="479" href="#479">479</a> <em class="jxr_javadoccomment"> * This will effectively ensure that any calls to</em> |
| <a name="480" href="#480">480</a> <em class="jxr_javadoccomment"> * {@code SecurityUtils}.{@link SecurityUtils#getSubject() getSubject()} and related functionality will continue</em> |
| <a name="481" href="#481">481</a> <em class="jxr_javadoccomment"> * to function properly on any thread that executes the returned {@code Callable} instance.</em> |
| <a name="482" href="#482">482</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="483" href="#483">483</a> <em class="jxr_javadoccomment"> * @param callable the callable to execute as this {@code Subject}</em> |
| <a name="484" href="#484">484</a> <em class="jxr_javadoccomment"> * @param <V> the {@code Callable}s return value type</em> |
| <a name="485" href="#485">485</a> <em class="jxr_javadoccomment"> * @return a {@code Callable} that can be run as this {@code Subject}.</em> |
| <a name="486" href="#486">486</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="487" href="#487">487</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="488" href="#488">488</a> <V> Callable<V> associateWith(Callable<V> callable); |
| <a name="489" href="#489">489</a> |
| <a name="490" href="#490">490</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="491" href="#491">491</a> <em class="jxr_javadoccomment"> * Returns a {@code Runnable} instance matching the given argument while additionally ensuring that it will</em> |
| <a name="492" href="#492">492</a> <em class="jxr_javadoccomment"> * retain and execute under this Subject's identity. The returned object can be used with an</em> |
| <a name="493" href="#493">493</a> <em class="jxr_javadoccomment"> * {@link java.util.concurrent.Executor Executor} or another thread to execute as this Subject.</em> |
| <a name="494" href="#494">494</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="495" href="#495">495</a> <em class="jxr_javadoccomment"> * This will effectively ensure that any calls to</em> |
| <a name="496" href="#496">496</a> <em class="jxr_javadoccomment"> * {@code SecurityUtils}.{@link SecurityUtils#getSubject() getSubject()} and related functionality will continue</em> |
| <a name="497" href="#497">497</a> <em class="jxr_javadoccomment"> * to function properly on any thread that executes the returned {@code Runnable} instance.</em> |
| <a name="498" href="#498">498</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="499" href="#499">499</a> <em class="jxr_javadoccomment"> * *Note that if you need a return value to be returned as a result of the runnable's execution or if you need to</em> |
| <a name="500" href="#500">500</a> <em class="jxr_javadoccomment"> * react to any Exceptions, it is highly recommended to use the</em> |
| <a name="501" href="#501">501</a> <em class="jxr_javadoccomment"> * {@link #associateWith(java.util.concurrent.Callable) createCallable} method instead of this one.</em> |
| <a name="502" href="#502">502</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="503" href="#503">503</a> <em class="jxr_javadoccomment"> * @param runnable the runnable to execute as this {@code Subject}</em> |
| <a name="504" href="#504">504</a> <em class="jxr_javadoccomment"> * @return a {@code Runnable} that can be run as this {@code Subject} on another thread.</em> |
| <a name="505" href="#505">505</a> <em class="jxr_javadoccomment"> * @see #associateWith (java.util.concurrent.Callable)</em> |
| <a name="506" href="#506">506</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="507" href="#507">507</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="508" href="#508">508</a> Runnable associateWith(Runnable runnable); |
| <a name="509" href="#509">509</a> |
| <a name="510" href="#510">510</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="511" href="#511">511</a> <em class="jxr_javadoccomment"> * Allows this subject to 'run as' or 'assume' another identity indefinitely. This can only be</em> |
| <a name="512" href="#512">512</a> <em class="jxr_javadoccomment"> * called when the {@code Subject} instance already has an identity (i.e. they are remembered from a previous</em> |
| <a name="513" href="#513">513</a> <em class="jxr_javadoccomment"> * log-in or they have authenticated during their current session).</em> |
| <a name="514" href="#514">514</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="515" href="#515">515</a> <em class="jxr_javadoccomment"> * Some notes about {@code runAs}:</em> |
| <a name="516" href="#516">516</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a name="517" href="#517">517</a> <em class="jxr_javadoccomment"> * <li>You can tell if a {@code Subject} is 'running as' another identity by calling the</em> |
| <a name="518" href="#518">518</a> <em class="jxr_javadoccomment"> * {@link #isRunAs() isRunAs()} method.</li></em> |
| <a name="519" href="#519">519</a> <em class="jxr_javadoccomment"> * <li>If running as another identity, you can determine what the previous 'pre run as' identity</em> |
| <a name="520" href="#520">520</a> <em class="jxr_javadoccomment"> * was by calling the {@link #getPreviousPrincipals() getPreviousPrincipals()} method.</li></em> |
| <a name="521" href="#521">521</a> <em class="jxr_javadoccomment"> * <li>When you want a {@code Subject} to stop running as another identity, you can return to its previous</em> |
| <a name="522" href="#522">522</a> <em class="jxr_javadoccomment"> * 'pre run as' identity by calling the {@link #releaseRunAs() releaseRunAs()} method.</li></em> |
| <a name="523" href="#523">523</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a name="524" href="#524">524</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="525" href="#525">525</a> <em class="jxr_javadoccomment"> * @param principals the identity to 'run as', aka the identity to <em>assume</em> indefinitely.</em> |
| <a name="526" href="#526">526</a> <em class="jxr_javadoccomment"> * @throws NullPointerException if the specified principals collection is {@code null} or empty.</em> |
| <a name="527" href="#527">527</a> <em class="jxr_javadoccomment"> * @throws IllegalStateException if this {@code Subject} does not yet have an identity of its own.</em> |
| <a name="528" href="#528">528</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="529" href="#529">529</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="530" href="#530">530</a> <strong class="jxr_keyword">void</strong> runAs(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals) <strong class="jxr_keyword">throws</strong> NullPointerException, IllegalStateException; |
| <a name="531" href="#531">531</a> |
| <a name="532" href="#532">532</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="533" href="#533">533</a> <em class="jxr_javadoccomment"> * Returns {@code true} if this {@code Subject} is 'running as' another identity other than its original one or</em> |
| <a name="534" href="#534">534</a> <em class="jxr_javadoccomment"> * {@code false} otherwise (normal {@code Subject} state). See the {@link #runAs runAs} method for more</em> |
| <a name="535" href="#535">535</a> <em class="jxr_javadoccomment"> * information.</em> |
| <a name="536" href="#536">536</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="537" href="#537">537</a> <em class="jxr_javadoccomment"> * @return {@code true} if this {@code Subject} is 'running as' another identity other than its original one or</em> |
| <a name="538" href="#538">538</a> <em class="jxr_javadoccomment"> * {@code false} otherwise (normal {@code Subject} state).</em> |
| <a name="539" href="#539">539</a> <em class="jxr_javadoccomment"> * @see #runAs</em> |
| <a name="540" href="#540">540</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="541" href="#541">541</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="542" href="#542">542</a> <strong class="jxr_keyword">boolean</strong> isRunAs(); |
| <a name="543" href="#543">543</a> |
| <a name="544" href="#544">544</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="545" href="#545">545</a> <em class="jxr_javadoccomment"> * Returns the previous 'pre run as' identity of this {@code Subject} before assuming the current</em> |
| <a name="546" href="#546">546</a> <em class="jxr_javadoccomment"> * {@link #runAs runAs} identity, or {@code null} if this {@code Subject} is not operating under an assumed</em> |
| <a name="547" href="#547">547</a> <em class="jxr_javadoccomment"> * identity (normal state). See the {@link #runAs runAs} method for more information.</em> |
| <a name="548" href="#548">548</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="549" href="#549">549</a> <em class="jxr_javadoccomment"> * @return the previous 'pre run as' identity of this {@code Subject} before assuming the current</em> |
| <a name="550" href="#550">550</a> <em class="jxr_javadoccomment"> * {@link #runAs runAs} identity, or {@code null} if this {@code Subject} is not operating under an assumed</em> |
| <a name="551" href="#551">551</a> <em class="jxr_javadoccomment"> * identity (normal state).</em> |
| <a name="552" href="#552">552</a> <em class="jxr_javadoccomment"> * @see #runAs</em> |
| <a name="553" href="#553">553</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="554" href="#554">554</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="555" href="#555">555</a> <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> getPreviousPrincipals(); |
| <a name="556" href="#556">556</a> |
| <a name="557" href="#557">557</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="558" href="#558">558</a> <em class="jxr_javadoccomment"> * Releases the current 'run as' (assumed) identity and reverts back to the previous 'pre run as'</em> |
| <a name="559" href="#559">559</a> <em class="jxr_javadoccomment"> * identity that existed before {@code #runAs runAs} was called.</em> |
| <a name="560" href="#560">560</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="561" href="#561">561</a> <em class="jxr_javadoccomment"> * This method returne 'run as' (assumed) identity being released or {@code null} if this {@code Subject} is not</em> |
| <a name="562" href="#562">562</a> <em class="jxr_javadoccomment"> * operating under an assumed identity.</em> |
| <a name="563" href="#563">563</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="564" href="#564">564</a> <em class="jxr_javadoccomment"> * @return the 'run as' (assumed) identity being released or {@code null} if this {@code Subject} is not operating</em> |
| <a name="565" href="#565">565</a> <em class="jxr_javadoccomment"> * under an assumed identity.</em> |
| <a name="566" href="#566">566</a> <em class="jxr_javadoccomment"> * @see #runAs</em> |
| <a name="567" href="#567">567</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="568" href="#568">568</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="569" href="#569">569</a> <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> releaseRunAs(); |
| <a name="570" href="#570">570</a> |
| <a name="571" href="#571">571</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="572" href="#572">572</a> <em class="jxr_javadoccomment"> * Builder design pattern implementation for creating {@link Subject} instances in a simplified way without</em> |
| <a name="573" href="#573">573</a> <em class="jxr_javadoccomment"> * requiring knowledge of Shiro's construction techniques.</em> |
| <a name="574" href="#574">574</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="575" href="#575">575</a> <em class="jxr_javadoccomment"> * <b>NOTE</b>: This is provided for framework development support only and should typically never be used by</em> |
| <a name="576" href="#576">576</a> <em class="jxr_javadoccomment"> * application developers. {@code Subject} instances should generally be acquired by using</em> |
| <a name="577" href="#577">577</a> <em class="jxr_javadoccomment"> * <code>SecurityUtils.{@link SecurityUtils#getSubject() getSubject()}</code></em> |
| <a name="578" href="#578">578</a> <em class="jxr_javadoccomment"> * <h4>Usage</h4></em> |
| <a name="579" href="#579">579</a> <em class="jxr_javadoccomment"> * The simplest usage of this builder is to construct an anonymous, session-less {@code Subject} instance:</em> |
| <a name="580" href="#580">580</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="581" href="#581">581</a> <em class="jxr_javadoccomment"> * Subject subject = new Subject.{@link #Builder() Builder}().{@link #buildSubject() buildSubject()};</pre></em> |
| <a name="582" href="#582">582</a> <em class="jxr_javadoccomment"> * The default, no-arg {@code Subject.Builder()} constructor shown above will use the application's</em> |
| <a name="583" href="#583">583</a> <em class="jxr_javadoccomment"> * currently accessible {@code SecurityManager} via</em> |
| <a name="584" href="#584">584</a> <em class="jxr_javadoccomment"> * <code>SecurityUtils.{@link SecurityUtils#getSecurityManager() getSecurityManager()}</code>. You may also</em> |
| <a name="585" href="#585">585</a> <em class="jxr_javadoccomment"> * specify the exact {@code SecurityManager} instance to be used by the additional</em> |
| <a name="586" href="#586">586</a> <em class="jxr_javadoccomment"> * <code>Subject.{@link #Builder(org.apache.shiro.mgt.SecurityManager) Builder(securityManager)}</code></em> |
| <a name="587" href="#587">587</a> <em class="jxr_javadoccomment"> * constructor if desired.</em> |
| <a name="588" href="#588">588</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="589" href="#589">589</a> <em class="jxr_javadoccomment"> * All other methods may be called before the {@link #buildSubject() buildSubject()} method to</em> |
| <a name="590" href="#590">590</a> <em class="jxr_javadoccomment"> * provide context on how to construct the {@code Subject} instance. For example, if you have a session id and</em> |
| <a name="591" href="#591">591</a> <em class="jxr_javadoccomment"> * want to acquire the {@code Subject} that 'owns' that session (assuming the session exists and is not expired):</em> |
| <a name="592" href="#592">592</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="593" href="#593">593</a> <em class="jxr_javadoccomment"> * Subject subject = new Subject.Builder().sessionId(sessionId).buildSubject();</pre></em> |
| <a name="594" href="#594">594</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="595" href="#595">595</a> <em class="jxr_javadoccomment"> * Similarly, if you want a {@code Subject} instance reflecting a certain identity:</em> |
| <a name="596" href="#596">596</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="597" href="#597">597</a> <em class="jxr_javadoccomment"> * PrincipalCollection principals = new SimplePrincipalCollection("username", <em>yourRealmName</em>);</em> |
| <a name="598" href="#598">598</a> <em class="jxr_javadoccomment"> * Subject subject = new Subject.Builder().principals(principals).build();</pre></em> |
| <a name="599" href="#599">599</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="600" href="#600">600</a> <em class="jxr_javadoccomment"> * <b>Note*</b> that the returned {@code Subject} instance is <b>not</b> automatically bound to the application (thread)</em> |
| <a name="601" href="#601">601</a> <em class="jxr_javadoccomment"> * for further use. That is,</em> |
| <a name="602" href="#602">602</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.SecurityUtils SecurityUtils}.{@link org.apache.shiro.SecurityUtils#getSubject() getSubject()}</em> |
| <a name="603" href="#603">603</a> <em class="jxr_javadoccomment"> * will not automatically return the same instance as what is returned by the builder. It is up to the framework</em> |
| <a name="604" href="#604">604</a> <em class="jxr_javadoccomment"> * developer to bind the built {@code Subject} for continued use if desired.</em> |
| <a name="605" href="#605">605</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="606" href="#606">606</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="607" href="#607">607</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="608" href="#608">608</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/shiro/subject/Subject.html">Builder</a> { |
| <a name="609" href="#609">609</a> |
| <a name="610" href="#610">610</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="611" href="#611">611</a> <em class="jxr_javadoccomment"> * Hold all contextual data via the Builder instance's method invocations to be sent to the</em> |
| <a name="612" href="#612">612</a> <em class="jxr_javadoccomment"> * {@code SecurityManager} during the {@link #buildSubject} call.</em> |
| <a name="613" href="#613">613</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="614" href="#614">614</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> subjectContext; |
| <a name="615" href="#615">615</a> |
| <a name="616" href="#616">616</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="617" href="#617">617</a> <em class="jxr_javadoccomment"> * The SecurityManager to invoke during the {@link #buildSubject} call.</em> |
| <a name="618" href="#618">618</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="619" href="#619">619</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/shiro/mgt/SecurityManager.html">SecurityManager</a> securityManager; |
| <a name="620" href="#620">620</a> |
| <a name="621" href="#621">621</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="622" href="#622">622</a> <em class="jxr_javadoccomment"> * Constructs a new {@link Subject.Builder} instance, using the {@code SecurityManager} instance available</em> |
| <a name="623" href="#623">623</a> <em class="jxr_javadoccomment"> * to the calling code as determined by a call to {@link org.apache.shiro.SecurityUtils#getSecurityManager()}</em> |
| <a name="624" href="#624">624</a> <em class="jxr_javadoccomment"> * to build the {@code Subject} instance.</em> |
| <a name="625" href="#625">625</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="626" href="#626">626</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/subject/Subject.html">Builder</a>() { |
| <a name="627" href="#627">627</a> <strong class="jxr_keyword">this</strong>(SecurityUtils.getSecurityManager()); |
| <a name="628" href="#628">628</a> } |
| <a name="629" href="#629">629</a> |
| <a name="630" href="#630">630</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="631" href="#631">631</a> <em class="jxr_javadoccomment"> * Constructs a new {@link Subject.Builder} instance which will use the specified {@code SecurityManager} when</em> |
| <a name="632" href="#632">632</a> <em class="jxr_javadoccomment"> * building the {@code Subject} instance.</em> |
| <a name="633" href="#633">633</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="634" href="#634">634</a> <em class="jxr_javadoccomment"> * @param securityManager the {@code SecurityManager} to use when building the {@code Subject} instance.</em> |
| <a name="635" href="#635">635</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="636" href="#636">636</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/subject/Subject.html">Builder</a>(<a href="../../../../org/apache/shiro/mgt/SecurityManager.html">SecurityManager</a> securityManager) { |
| <a name="637" href="#637">637</a> <strong class="jxr_keyword">if</strong> (securityManager == <strong class="jxr_keyword">null</strong>) { |
| <a name="638" href="#638">638</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"SecurityManager method argument cannot be null."</span>); |
| <a name="639" href="#639">639</a> } |
| <a name="640" href="#640">640</a> <strong class="jxr_keyword">this</strong>.securityManager = securityManager; |
| <a name="641" href="#641">641</a> <strong class="jxr_keyword">this</strong>.subjectContext = newSubjectContextInstance(); |
| <a name="642" href="#642">642</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.subjectContext == <strong class="jxr_keyword">null</strong>) { |
| <a name="643" href="#643">643</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"Subject instance returned from 'newSubjectContextInstance' "</span> + |
| <a name="644" href="#644">644</a> <span class="jxr_string">"cannot be null."</span>); |
| <a name="645" href="#645">645</a> } |
| <a name="646" href="#646">646</a> <strong class="jxr_keyword">this</strong>.subjectContext.setSecurityManager(securityManager); |
| <a name="647" href="#647">647</a> } |
| <a name="648" href="#648">648</a> |
| <a name="649" href="#649">649</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="650" href="#650">650</a> <em class="jxr_javadoccomment"> * Creates a new {@code SubjectContext} instance to be used to populate with subject contextual data that</em> |
| <a name="651" href="#651">651</a> <em class="jxr_javadoccomment"> * will then be sent to the {@code SecurityManager} to create a new {@code Subject} instance.</em> |
| <a name="652" href="#652">652</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="653" href="#653">653</a> <em class="jxr_javadoccomment"> * @return a new {@code SubjectContext} instance</em> |
| <a name="654" href="#654">654</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="655" href="#655">655</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> newSubjectContextInstance() { |
| <a name="656" href="#656">656</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="657" href="#657">657</a> } |
| <a name="658" href="#658">658</a> |
| <a name="659" href="#659">659</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="660" href="#660">660</a> <em class="jxr_javadoccomment"> * Returns the backing context used to build the {@code Subject} instance, available to subclasses</em> |
| <a name="661" href="#661">661</a> <em class="jxr_javadoccomment"> * since the {@code context} class attribute is marked as {@code private}.</em> |
| <a name="662" href="#662">662</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="663" href="#663">663</a> <em class="jxr_javadoccomment"> * @return the backing context used to build the {@code Subject} instance, available to subclasses.</em> |
| <a name="664" href="#664">664</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="665" href="#665">665</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> getSubjectContext() { |
| <a name="666" href="#666">666</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.subjectContext; |
| <a name="667" href="#667">667</a> } |
| <a name="668" href="#668">668</a> |
| <a name="669" href="#669">669</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="670" href="#670">670</a> <em class="jxr_javadoccomment"> * Enables building a {@link Subject Subject} instance that owns the {@link Session Session} with the</em> |
| <a name="671" href="#671">671</a> <em class="jxr_javadoccomment"> * specified {@code sessionId}.</em> |
| <a name="672" href="#672">672</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="673" href="#673">673</a> <em class="jxr_javadoccomment"> * Usually when specifying a {@code sessionId}, no other {@code Builder} methods would be specified because</em> |
| <a name="674" href="#674">674</a> <em class="jxr_javadoccomment"> * everything else (principals, inet address, etc) can usually be reconstructed based on the referenced</em> |
| <a name="675" href="#675">675</a> <em class="jxr_javadoccomment"> * session alone. In other words, this is almost always sufficient:</em> |
| <a name="676" href="#676">676</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="677" href="#677">677</a> <em class="jxr_javadoccomment"> * new Subject.Builder().sessionId(sessionId).buildSubject();</pre></em> |
| <a name="678" href="#678">678</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="679" href="#679">679</a> <em class="jxr_javadoccomment"> * <b>Although simple in concept, this method provides very powerful functionality previously absent in almost</em> |
| <a name="680" href="#680">680</a> <em class="jxr_javadoccomment"> * all Java environments:</b></em> |
| <a name="681" href="#681">681</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="682" href="#682">682</a> <em class="jxr_javadoccomment"> * The ability to reference a {@code Subject} and their server-side session</em> |
| <a name="683" href="#683">683</a> <em class="jxr_javadoccomment"> * <em>across clients of different mediums</em> such as web applications, Java applets,</em> |
| <a name="684" href="#684">684</a> <em class="jxr_javadoccomment"> * standalone C# clients over XML-RPC and/or SOAP, and many others. This is a <em>huge</em></em> |
| <a name="685" href="#685">685</a> <em class="jxr_javadoccomment"> * benefit in heterogeneous enterprise applications.</em> |
| <a name="686" href="#686">686</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="687" href="#687">687</a> <em class="jxr_javadoccomment"> * To maintain session integrity across client mediums, the {@code sessionId} <b>must</b> be transmitted</em> |
| <a name="688" href="#688">688</a> <em class="jxr_javadoccomment"> * to all client mediums securely (e.g. over SSL) to prevent man-in-the-middle attacks. This</em> |
| <a name="689" href="#689">689</a> <em class="jxr_javadoccomment"> * is nothing new - all web applications are susceptible to the same problem when transmitting</em> |
| <a name="690" href="#690">690</a> <em class="jxr_javadoccomment"> * {@code Cookie}s or when using URL rewriting. As long as the</em> |
| <a name="691" href="#691">691</a> <em class="jxr_javadoccomment"> * {@code sessionId} is transmitted securely, session integrity can be maintained.</em> |
| <a name="692" href="#692">692</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="693" href="#693">693</a> <em class="jxr_javadoccomment"> * @param sessionId the id of the session that backs the desired Subject being acquired.</em> |
| <a name="694" href="#694">694</a> <em class="jxr_javadoccomment"> * @return this {@code Builder} instance for method chaining.</em> |
| <a name="695" href="#695">695</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="696" href="#696">696</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/subject/Subject.html">Builder</a> sessionId(Serializable sessionId) { |
| <a name="697" href="#697">697</a> <strong class="jxr_keyword">if</strong> (sessionId != <strong class="jxr_keyword">null</strong>) { |
| <a name="698" href="#698">698</a> <strong class="jxr_keyword">this</strong>.subjectContext.setSessionId(sessionId); |
| <a name="699" href="#699">699</a> } |
| <a name="700" href="#700">700</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a name="701" href="#701">701</a> } |
| <a name="702" href="#702">702</a> |
| <a name="703" href="#703">703</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="704" href="#704">704</a> <em class="jxr_javadoccomment"> * Ensures the {@code Subject} being built will reflect the specified host name or IP as its originating</em> |
| <a name="705" href="#705">705</a> <em class="jxr_javadoccomment"> * location.</em> |
| <a name="706" href="#706">706</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="707" href="#707">707</a> <em class="jxr_javadoccomment"> * @param host the host name or IP address to use as the {@code Subject}'s originating location.</em> |
| <a name="708" href="#708">708</a> <em class="jxr_javadoccomment"> * @return this {@code Builder} instance for method chaining.</em> |
| <a name="709" href="#709">709</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="710" href="#710">710</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/subject/Subject.html">Builder</a> host(String host) { |
| <a name="711" href="#711">711</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(host)) { |
| <a name="712" href="#712">712</a> <strong class="jxr_keyword">this</strong>.subjectContext.setHost(host); |
| <a name="713" href="#713">713</a> } |
| <a name="714" href="#714">714</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a name="715" href="#715">715</a> } |
| <a name="716" href="#716">716</a> |
| <a name="717" href="#717">717</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="718" href="#718">718</a> <em class="jxr_javadoccomment"> * Ensures the {@code Subject} being built will use the specified {@link Session} instance. Note that it is</em> |
| <a name="719" href="#719">719</a> <em class="jxr_javadoccomment"> * more common to use the {@link #sessionId sessionId} builder method rather than having to construct a</em> |
| <a name="720" href="#720">720</a> <em class="jxr_javadoccomment"> * {@code Session} instance for this method.</em> |
| <a name="721" href="#721">721</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="722" href="#722">722</a> <em class="jxr_javadoccomment"> * @param session the session to use as the {@code Subject}'s {@link Session}</em> |
| <a name="723" href="#723">723</a> <em class="jxr_javadoccomment"> * @return this {@code Builder} instance for method chaining.</em> |
| <a name="724" href="#724">724</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="725" href="#725">725</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/subject/Subject.html">Builder</a> session(<a href="../../../../org/apache/shiro/session/Session.html">Session</a> session) { |
| <a name="726" href="#726">726</a> <strong class="jxr_keyword">if</strong> (session != <strong class="jxr_keyword">null</strong>) { |
| <a name="727" href="#727">727</a> <strong class="jxr_keyword">this</strong>.subjectContext.setSession(session); |
| <a name="728" href="#728">728</a> } |
| <a name="729" href="#729">729</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a name="730" href="#730">730</a> } |
| <a name="731" href="#731">731</a> |
| <a name="732" href="#732">732</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="733" href="#733">733</a> <em class="jxr_javadoccomment"> * Ensures the {@code Subject} being built will reflect the specified principals (aka identity).</em> |
| <a name="734" href="#734">734</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="735" href="#735">735</a> <em class="jxr_javadoccomment"> * For example, if your application's unique identifier for users is a {@code String} username, and you wanted</em> |
| <a name="736" href="#736">736</a> <em class="jxr_javadoccomment"> * to create a {@code Subject} instance that reflected a user whose username is</em> |
| <a name="737" href="#737">737</a> <em class="jxr_javadoccomment"> * '{@code jsmith}', and you knew the Realm that could acquire {@code jsmith}'s principals based on the username</em> |
| <a name="738" href="#738">738</a> <em class="jxr_javadoccomment"> * was named &quot;{@code myRealm}&quot;, you might create the '{@code jsmith} {@code Subject} instance this</em> |
| <a name="739" href="#739">739</a> <em class="jxr_javadoccomment"> * way:</em> |
| <a name="740" href="#740">740</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="741" href="#741">741</a> <em class="jxr_javadoccomment"> * PrincipalCollection identity = new {@link org.apache.shiro.subject.SimplePrincipalCollection#SimplePrincipalCollection(Object, String) SimplePrincipalCollection}(&quot;jsmith&quot;, &quot;myRealm&quot;);</em> |
| <a name="742" href="#742">742</a> <em class="jxr_javadoccomment"> * Subject jsmith = new Subject.Builder().principals(identity).buildSubject();</pre></em> |
| <a name="743" href="#743">743</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="744" href="#744">744</a> <em class="jxr_javadoccomment"> * Similarly, if your application's unique identifier for users is a {@code long} value (such as might be used</em> |
| <a name="745" href="#745">745</a> <em class="jxr_javadoccomment"> * as a primary key in a relational database) and you were using a {@code JDBC}</em> |
| <a name="746" href="#746">746</a> <em class="jxr_javadoccomment"> * {@code Realm} named, (unimaginatively) &quot;jdbcRealm&quot;, you might create the Subject</em> |
| <a name="747" href="#747">747</a> <em class="jxr_javadoccomment"> * instance this way:</em> |
| <a name="748" href="#748">748</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="749" href="#749">749</a> <em class="jxr_javadoccomment"> * long userId = //get user ID from somewhere</em> |
| <a name="750" href="#750">750</a> <em class="jxr_javadoccomment"> * PrincipalCollection userIdentity = new {@link org.apache.shiro.subject.SimplePrincipalCollection#SimplePrincipalCollection(Object, String) SimplePrincipalCollection}(<em>userId</em>, &quot;jdbcRealm&quot;);</em> |
| <a name="751" href="#751">751</a> <em class="jxr_javadoccomment"> * Subject user = new Subject.Builder().principals(identity).buildSubject();</pre></em> |
| <a name="752" href="#752">752</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="753" href="#753">753</a> <em class="jxr_javadoccomment"> * @param principals the principals to use as the {@code Subject}'s identity.</em> |
| <a name="754" href="#754">754</a> <em class="jxr_javadoccomment"> * @return this {@code Builder} instance for method chaining.</em> |
| <a name="755" href="#755">755</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="756" href="#756">756</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/subject/Subject.html">Builder</a> principals(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals) { |
| <a name="757" href="#757">757</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(principals)) { |
| <a name="758" href="#758">758</a> <strong class="jxr_keyword">this</strong>.subjectContext.setPrincipals(principals); |
| <a name="759" href="#759">759</a> } |
| <a name="760" href="#760">760</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a name="761" href="#761">761</a> } |
| <a name="762" href="#762">762</a> |
| <a name="763" href="#763">763</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="764" href="#764">764</a> <em class="jxr_javadoccomment"> * Configures whether or not the created Subject instance can create a new {@code Session} if one does not</em> |
| <a name="765" href="#765">765</a> <em class="jxr_javadoccomment"> * already exist. If set to {@code false}, any application calls to</em> |
| <a name="766" href="#766">766</a> <em class="jxr_javadoccomment"> * {@code subject.getSession()} or {@code subject.getSession(true))} will result in a SessionException.</em> |
| <a name="767" href="#767">767</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="768" href="#768">768</a> <em class="jxr_javadoccomment"> * This setting is {@code true} by default, as most applications find value in sessions.</em> |
| <a name="769" href="#769">769</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="770" href="#770">770</a> <em class="jxr_javadoccomment"> * @param enabled whether or not the created Subject instance can create a new {@code Session} if one does not</em> |
| <a name="771" href="#771">771</a> <em class="jxr_javadoccomment"> * already exist.</em> |
| <a name="772" href="#772">772</a> <em class="jxr_javadoccomment"> * @return this {@code Builder} instance for method chaining.</em> |
| <a name="773" href="#773">773</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="774" href="#774">774</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="775" href="#775">775</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/subject/Subject.html">Builder</a> sessionCreationEnabled(<strong class="jxr_keyword">boolean</strong> enabled) { |
| <a name="776" href="#776">776</a> <strong class="jxr_keyword">this</strong>.subjectContext.setSessionCreationEnabled(enabled); |
| <a name="777" href="#777">777</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a name="778" href="#778">778</a> } |
| <a name="779" href="#779">779</a> |
| <a name="780" href="#780">780</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="781" href="#781">781</a> <em class="jxr_javadoccomment"> * Ensures the {@code Subject} being built will be considered</em> |
| <a name="782" href="#782">782</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.subject.Subject#isAuthenticated() authenticated}. Per the</em> |
| <a name="783" href="#783">783</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.subject.Subject#isAuthenticated() isAuthenticated()} JavaDoc, be careful</em> |
| <a name="784" href="#784">784</a> <em class="jxr_javadoccomment"> * when specifying {@code true} - you should know what you are doing and have a good reason for ignoring Shiro's</em> |
| <a name="785" href="#785">785</a> <em class="jxr_javadoccomment"> * default authentication state mechanisms.</em> |
| <a name="786" href="#786">786</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="787" href="#787">787</a> <em class="jxr_javadoccomment"> * @param authenticated whether or not the built {@code Subject} will be considered authenticated.</em> |
| <a name="788" href="#788">788</a> <em class="jxr_javadoccomment"> * @return this {@code Builder} instance for method chaining.</em> |
| <a name="789" href="#789">789</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.subject.Subject#isAuthenticated()</em> |
| <a name="790" href="#790">790</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="791" href="#791">791</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/subject/Subject.html">Builder</a> authenticated(<strong class="jxr_keyword">boolean</strong> authenticated) { |
| <a name="792" href="#792">792</a> <strong class="jxr_keyword">this</strong>.subjectContext.setAuthenticated(authenticated); |
| <a name="793" href="#793">793</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a name="794" href="#794">794</a> } |
| <a name="795" href="#795">795</a> |
| <a name="796" href="#796">796</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="797" href="#797">797</a> <em class="jxr_javadoccomment"> * Allows custom attributes to be added to the underlying context {@code Map} used to construct the</em> |
| <a name="798" href="#798">798</a> <em class="jxr_javadoccomment"> * {@link Subject} instance.</em> |
| <a name="799" href="#799">799</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="800" href="#800">800</a> <em class="jxr_javadoccomment"> * A {@code null} key throws an {@link IllegalArgumentException}. A {@code null} value effectively removes</em> |
| <a name="801" href="#801">801</a> <em class="jxr_javadoccomment"> * any previously stored attribute under the given key from the context map.</em> |
| <a name="802" href="#802">802</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="803" href="#803">803</a> <em class="jxr_javadoccomment"> * <b>*NOTE*:</b> This method is only useful when configuring Shiro with a custom {@link SubjectFactory}</em> |
| <a name="804" href="#804">804</a> <em class="jxr_javadoccomment"> * implementation. This method allows end-users to append additional data to the context map which the</em> |
| <a name="805" href="#805">805</a> <em class="jxr_javadoccomment"> * {@code SubjectFactory} implementation can use when building custom Subject instances. As such, this method</em> |
| <a name="806" href="#806">806</a> <em class="jxr_javadoccomment"> * is only useful when a custom {@code SubjectFactory} implementation has been configured.</em> |
| <a name="807" href="#807">807</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="808" href="#808">808</a> <em class="jxr_javadoccomment"> * @param attributeKey the key under which the corresponding value will be stored in the context {@code Map}.</em> |
| <a name="809" href="#809">809</a> <em class="jxr_javadoccomment"> * @param attributeValue the value to store in the context map under the specified {@code attributeKey}.</em> |
| <a name="810" href="#810">810</a> <em class="jxr_javadoccomment"> * @return this {@code Builder} instance for method chaining.</em> |
| <a name="811" href="#811">811</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if the {@code attributeKey} is {@code null}.</em> |
| <a name="812" href="#812">812</a> <em class="jxr_javadoccomment"> * @see SubjectFactory#createSubject(SubjectContext)</em> |
| <a name="813" href="#813">813</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="814" href="#814">814</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/subject/Subject.html">Builder</a> contextAttribute(String attributeKey, Object attributeValue) { |
| <a name="815" href="#815">815</a> <strong class="jxr_keyword">if</strong> (attributeKey == <strong class="jxr_keyword">null</strong>) { |
| <a name="816" href="#816">816</a> String msg = <span class="jxr_string">"Subject context map key cannot be null."</span>; |
| <a name="817" href="#817">817</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(msg); |
| <a name="818" href="#818">818</a> } |
| <a name="819" href="#819">819</a> <strong class="jxr_keyword">if</strong> (attributeValue == <strong class="jxr_keyword">null</strong>) { |
| <a name="820" href="#820">820</a> <strong class="jxr_keyword">this</strong>.subjectContext.remove(attributeKey); |
| <a name="821" href="#821">821</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="822" href="#822">822</a> <strong class="jxr_keyword">this</strong>.subjectContext.put(attributeKey, attributeValue); |
| <a name="823" href="#823">823</a> } |
| <a name="824" href="#824">824</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a name="825" href="#825">825</a> } |
| <a name="826" href="#826">826</a> |
| <a name="827" href="#827">827</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="828" href="#828">828</a> <em class="jxr_javadoccomment"> * Creates and returns a new {@code Subject} instance reflecting the cumulative state acquired by the</em> |
| <a name="829" href="#829">829</a> <em class="jxr_javadoccomment"> * other methods in this class.</em> |
| <a name="830" href="#830">830</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="831" href="#831">831</a> <em class="jxr_javadoccomment"> * This {@code Builder} instance will still retain the underlying state after this method is called - it</em> |
| <a name="832" href="#832">832</a> <em class="jxr_javadoccomment"> * will not clear it; repeated calls to this method will return multiple {@link Subject} instances, all</em> |
| <a name="833" href="#833">833</a> <em class="jxr_javadoccomment"> * reflecting the exact same state. If a new (different) {@code Subject} is to be constructed, a new</em> |
| <a name="834" href="#834">834</a> <em class="jxr_javadoccomment"> * {@code Builder} instance must be created.</em> |
| <a name="835" href="#835">835</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="836" href="#836">836</a> <em class="jxr_javadoccomment"> * <b>Note</b> that the returned {@code Subject} instance is <b>not</b> automatically bound to the application</em> |
| <a name="837" href="#837">837</a> <em class="jxr_javadoccomment"> * (thread) for further use. That is,</em> |
| <a name="838" href="#838">838</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.SecurityUtils SecurityUtils}.{@link org.apache.shiro.SecurityUtils#getSubject() getSubject()}</em> |
| <a name="839" href="#839">839</a> <em class="jxr_javadoccomment"> * will not automatically return the same instance as what is returned by the builder. It is up to the</em> |
| <a name="840" href="#840">840</a> <em class="jxr_javadoccomment"> * framework developer to bind the returned {@code Subject} for continued use if desired.</em> |
| <a name="841" href="#841">841</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="842" href="#842">842</a> <em class="jxr_javadoccomment"> * @return a new {@code Subject} instance reflecting the cumulative state acquired by the</em> |
| <a name="843" href="#843">843</a> <em class="jxr_javadoccomment"> * other methods in this class.</em> |
| <a name="844" href="#844">844</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="845" href="#845">845</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> buildSubject() { |
| <a name="846" href="#846">846</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.securityManager.createSubject(<strong class="jxr_keyword">this</strong>.subjectContext); |
| <a name="847" href="#847">847</a> } |
| <a name="848" href="#848">848</a> } |
| <a name="849" href="#849">849</a> |
| <a name="850" href="#850">850</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
| |
