| <!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>SubjectContext xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/shiro/subject/SubjectContext.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.authc.AuthenticationInfo; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationToken; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.mgt.SecurityManager; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.Session; |
| <a name="25" href="#25">25</a> |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.io.Serializable; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <a name="28" href="#28">28</a> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * A {@code SubjectContext} is a 'bucket' of data presented to a {@link SecurityManager} which interprets</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * this data to construct {@link org.apache.shiro.subject.Subject Subject} instances. It is essentially a Map of data</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * with a few additional type-safe methods for easy retrieval of objects commonly used to construct Subject instances.</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * While this interface contains type-safe setters and getters for common data types, the map can contain anything</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * additional that might be needed by the {@link SecurityManager} or</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.mgt.SubjectFactory SubjectFactory} implementation to construct {@code Subject} instances.</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * <h2>Data Resolution</h2></em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * The {@link SubjectContext} interface also allows for heuristic resolution of data used to construct a subject</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * instance. That is, if an attribute has not been explicitly provided via a setter method, the {@code resolve*}</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * methods can use heuristics to obtain that data in another way from other attributes.</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * For example, if one calls {@link #getPrincipals()} and no principals are returned, perhaps the principals exist</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * in the {@link #getSession() session} or another attribute in the context. The {@link #resolvePrincipals()} will know</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * how to resolve the principals based on heuristics. If the {@code resolve*} methods return {@code null} then the</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * data could not be achieved by any heuristics and must be considered as not available in the context.</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * The general idea is that the normal getters can be called to see if the value was explicitly set. The</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * {@code resolve*} methods should be used when actually constructing the {@code Subject} instance to ensure the most</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * specific/accurate data can be used.</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * <b>USAGE</b>: Most Shiro end-users will never use a {@code SubjectContext} instance directly and instead will use a</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * {@link Subject.Builder} (which internally uses a {@code SubjectContext}) and build {@code Subject} instances that</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * way.</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.mgt.SecurityManager#createSubject SecurityManager.createSubject</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.mgt.SubjectFactory SubjectFactory</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="59" href="#59">59</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> <strong class="jxr_keyword">extends</strong> Map<String, Object> { |
| <a name="60" href="#60">60</a> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * Returns the SecurityManager instance that should be used to back the constructed {@link Subject} instance or</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * {@code null} if one has not yet been provided to this context.</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * @return the SecurityManager instance that should be used to back the constructed {@link Subject} instance or</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * {@code null} if one has not yet been provided to this context.</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="68" href="#68">68</a> <a href="../../../../org/apache/shiro/mgt/SecurityManager.html">SecurityManager</a> getSecurityManager(); |
| <a name="69" href="#69">69</a> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * Sets the SecurityManager instance that should be used to back the constructed {@link Subject} instance</em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * (typically used to support {@link org.apache.shiro.subject.support.DelegatingSubject DelegatingSubject} implementations).</em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * @param securityManager the SecurityManager instance that should be used to back the constructed {@link Subject}</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * instance.</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="77" href="#77">77</a> <strong class="jxr_keyword">void</strong> setSecurityManager(<a href="../../../../org/apache/shiro/mgt/SecurityManager.html">SecurityManager</a> securityManager); |
| <a name="78" href="#78">78</a> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * Resolves the {@code SecurityManager} instance that should be used to back the constructed {@link Subject}</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * instance (typically used to support {@link org.apache.shiro.subject.support.DelegatingSubject DelegatingSubject} implementations).</em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * @return the {@code SecurityManager} instance that should be used to back the constructed {@link Subject}</em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * instance</em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="86" href="#86">86</a> <a href="../../../../org/apache/shiro/mgt/SecurityManager.html">SecurityManager</a> resolveSecurityManager(); |
| <a name="87" href="#87">87</a> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * Returns the session id of the session that should be associated with the constructed {@link Subject} instance.</em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * The construction process is expected to resolve the session with the specified id and then construct the Subject</em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * instance based on the resolved session.</em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * @return the session id of the session that should be associated with the constructed {@link Subject} instance.</em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="96" href="#96">96</a> Serializable getSessionId(); |
| <a name="97" href="#97">97</a> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * Sets the session id of the session that should be associated with the constructed {@link Subject} instance.</em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * The construction process is expected to resolve the session with the specified id and then construct the Subject</em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * instance based on the resolved session.</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * @param sessionId the session id of the session that should be associated with the constructed {@link Subject}</em> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * instance.</em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="107" href="#107">107</a> <strong class="jxr_keyword">void</strong> setSessionId(Serializable sessionId); |
| <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 any existing {@code Subject} that may be in use at the time the new {@code Subject} instance is</em> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * being created.</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 typically used in the case where the existing {@code Subject} instance returned by</em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * this method is unauthenticated and a new {@code Subject} instance is being created to reflect a successful</em> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * authentication - you want to return most of the state of the previous {@code Subject} instance when creating the</em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * newly authenticated instance.</em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * @return any existing {@code Subject} that may be in use at the time the new {@code Subject} instance is</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * being created.</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="121" href="#121">121</a> <a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> getSubject(); |
| <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"> * Sets the existing {@code Subject} that may be in use at the time the new {@code Subject} instance is</em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * being created.</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"> * This is typically used in the case where the existing {@code Subject} instance returned by</em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * this method is unauthenticated and a new {@code Subject} instance is being created to reflect a successful</em> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * authentication - you want to return most of the state of the previous {@code Subject} instance when creating the</em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * newly authenticated instance.</em> |
| <a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * @param subject the existing {@code Subject} that may be in use at the time the new {@code Subject} instance is</em> |
| <a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * being created.</em> |
| <a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="135" href="#135">135</a> <strong class="jxr_keyword">void</strong> setSubject(<a href="../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject); |
| <a name="136" href="#136">136</a> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * Returns the principals (aka identity) that the constructed {@code Subject} should reflect.</em> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * @return the principals (aka identity) that the constructed {@code Subject} should reflect.</em> |
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="142" href="#142">142</a> <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> getPrincipals(); |
| <a name="143" href="#143">143</a> |
| <a name="144" href="#144">144</a> <a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> resolvePrincipals(); |
| <a name="145" href="#145">145</a> |
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * Sets the principals (aka identity) that the constructed {@code Subject} should reflect.</em> |
| <a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * @param principals the principals (aka identity) that the constructed {@code Subject} should reflect.</em> |
| <a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="151" href="#151">151</a> <strong class="jxr_keyword">void</strong> setPrincipals(<a href="../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals); |
| <a name="152" href="#152">152</a> |
| <a name="153" href="#153">153</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * Returns the {@code Session} to use when building the {@code Subject} instance. Note that it is more</em> |
| <a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * common to specify a {@link #setSessionId sessionId} to acquire the desired session rather than having to</em> |
| <a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * construct a {@code Session} to be returned by this method.</em> |
| <a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * @return the {@code Session} to use when building the {@code Subject} instance.</em> |
| <a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="160" href="#160">160</a> <a href="../../../../org/apache/shiro/session/Session.html">Session</a> getSession(); |
| <a name="161" href="#161">161</a> |
| <a name="162" href="#162">162</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * Sets the {@code Session} to use when building the {@code Subject} instance. Note that it is more</em> |
| <a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * common to specify a {@link #setSessionId sessionId} to automatically resolve the desired session rather than</em> |
| <a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * constructing a {@code Session} to call this method.</em> |
| <a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * @param session the {@code Session} to use when building the {@code Subject} instance.</em> |
| <a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="169" href="#169">169</a> <strong class="jxr_keyword">void</strong> setSession(<a href="../../../../org/apache/shiro/session/Session.html">Session</a> session); |
| <a name="170" href="#170">170</a> |
| <a name="171" href="#171">171</a> <a href="../../../../org/apache/shiro/session/Session.html">Session</a> resolveSession(); |
| <a name="172" href="#172">172</a> |
| <a name="173" href="#173">173</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="174" href="#174">174</a> <em class="jxr_javadoccomment"> * Returns {@code true} if the constructed {@code Subject} should be considered authenticated, {@code false}</em> |
| <a name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * otherwise. Be careful setting this value to {@code true} - you should know what you are doing and have a good</em> |
| <a name="176" href="#176">176</a> <em class="jxr_javadoccomment"> * reason for ignoring Shiro's default authentication state mechanisms.</em> |
| <a name="177" href="#177">177</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="178" href="#178">178</a> <em class="jxr_javadoccomment"> * @return {@code true} if the constructed {@code Subject} should be considered authenticated, {@code false}</em> |
| <a name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * otherwise.</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> isAuthenticated(); |
| <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"> * Sets whether or not the constructed {@code Subject} instance should be considered as authenticated. Be careful</em> |
| <a name="185" href="#185">185</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="186" href="#186">186</a> <em class="jxr_javadoccomment"> * default authentication state mechanisms.</em> |
| <a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> * @param authc whether or not the constructed {@code Subject} instance should be considered as authenticated.</em> |
| <a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="190" href="#190">190</a> <strong class="jxr_keyword">void</strong> setAuthenticated(<strong class="jxr_keyword">boolean</strong> authc); |
| <a name="191" href="#191">191</a> |
| <a name="192" href="#192">192</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="193" href="#193">193</a> <em class="jxr_javadoccomment"> * Returns {@code true} if the constructed {@code Subject} should be allowed to create a session, {@code false}</em> |
| <a name="194" href="#194">194</a> <em class="jxr_javadoccomment"> * otherwise. Shiro's configuration defaults to {@code true} as most applications find value in Sessions.</em> |
| <a name="195" href="#195">195</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="196" href="#196">196</a> <em class="jxr_javadoccomment"> * @return {@code true} if the constructed {@code Subject} should be allowed to create sessions, {@code false}</em> |
| <a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> * otherwise.</em> |
| <a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="200" href="#200">200</a> <strong class="jxr_keyword">boolean</strong> isSessionCreationEnabled(); |
| <a name="201" href="#201">201</a> |
| <a name="202" href="#202">202</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> * Sets whether or not the constructed {@code Subject} instance should be allowed to create a session,</em> |
| <a name="204" href="#204">204</a> <em class="jxr_javadoccomment"> * {@code false} otherwise.</em> |
| <a name="205" href="#205">205</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="206" href="#206">206</a> <em class="jxr_javadoccomment"> * @param enabled whether or not the constructed {@code Subject} instance should be allowed to create a session,</em> |
| <a name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * {@code false} otherwise.</em> |
| <a name="208" href="#208">208</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="209" href="#209">209</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="210" href="#210">210</a> <strong class="jxr_keyword">void</strong> setSessionCreationEnabled(<strong class="jxr_keyword">boolean</strong> enabled); |
| <a name="211" href="#211">211</a> |
| <a name="212" href="#212">212</a> <strong class="jxr_keyword">boolean</strong> resolveAuthenticated(); |
| <a name="213" href="#213">213</a> |
| <a name="214" href="#214">214</a> <a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> getAuthenticationInfo(); |
| <a name="215" href="#215">215</a> |
| <a name="216" href="#216">216</a> <strong class="jxr_keyword">void</strong> setAuthenticationInfo(<a href="../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info); |
| <a name="217" href="#217">217</a> |
| <a name="218" href="#218">218</a> <a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> getAuthenticationToken(); |
| <a name="219" href="#219">219</a> |
| <a name="220" href="#220">220</a> <strong class="jxr_keyword">void</strong> setAuthenticationToken(<a href="../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token); |
| <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"> * Returns the host name or IP that should reflect the constructed {@code Subject}'s originating location.</em> |
| <a name="224" href="#224">224</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="225" href="#225">225</a> <em class="jxr_javadoccomment"> * @return the host name or IP that should reflect the constructed {@code Subject}'s originating location.</em> |
| <a name="226" href="#226">226</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="227" href="#227">227</a> String getHost(); |
| <a name="228" href="#228">228</a> |
| <a name="229" href="#229">229</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * Sets the host name or IP that should reflect the constructed {@code Subject}'s originating location.</em> |
| <a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * @param host the host name or IP that should reflect the constructed {@code Subject}'s originating location.</em> |
| <a name="233" href="#233">233</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="234" href="#234">234</a> <strong class="jxr_keyword">void</strong> setHost(String host); |
| <a name="235" href="#235">235</a> |
| <a name="236" href="#236">236</a> String resolveHost(); |
| <a name="237" href="#237">237</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
| |
