| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.7) on Mon Aug 17 10:30:05 EDT 2020 --> |
| <title>SubjectContext (Apache Shiro 1.6.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-08-17"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SubjectContext (Apache Shiro 1.6.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SubjectContext.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.shiro.subject</a></div> |
| <h2 title="Interface SubjectContext" class="title">Interface SubjectContext</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="../web/subject/WebSubjectContext.html" title="interface in org.apache.shiro.web.subject">WebSubjectContext</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="support/DefaultSubjectContext.html" title="class in org.apache.shiro.subject.support">DefaultSubjectContext</a></code>, <code><a href="../web/subject/support/DefaultWebSubjectContext.html" title="class in org.apache.shiro.web.subject.support">DefaultWebSubjectContext</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.59">SubjectContext</a> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>></pre> |
| <div class="block">A <code>SubjectContext</code> is a 'bucket' of data presented to a <a href="../mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> which interprets |
| this data to construct <a href="Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instances. It is essentially a Map of data |
| with a few additional type-safe methods for easy retrieval of objects commonly used to construct Subject instances. |
| <p/> |
| While this interface contains type-safe setters and getters for common data types, the map can contain anything |
| additional that might be needed by the <a href="../mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> or |
| <a href="../mgt/SubjectFactory.html" title="interface in org.apache.shiro.mgt"><code>SubjectFactory</code></a> implementation to construct <code>Subject</code> instances. |
| <h2>Data Resolution</h2> |
| The <a href="SubjectContext.html" title="interface in org.apache.shiro.subject"><code>SubjectContext</code></a> interface also allows for heuristic resolution of data used to construct a subject |
| instance. That is, if an attribute has not been explicitly provided via a setter method, the <code>resolve*</code> |
| methods can use heuristics to obtain that data in another way from other attributes. |
| <p/> |
| For example, if one calls <a href="#getPrincipals()"><code>getPrincipals()</code></a> and no principals are returned, perhaps the principals exist |
| in the <a href="#getSession()"><code>session</code></a> or another attribute in the context. The <a href="#resolvePrincipals()"><code>resolvePrincipals()</code></a> will know |
| how to resolve the principals based on heuristics. If the <code>resolve*</code> methods return <code>null</code> then the |
| data could not be achieved by any heuristics and must be considered as not available in the context. |
| <p/> |
| The general idea is that the normal getters can be called to see if the value was explicitly set. The |
| <code>resolve*</code> methods should be used when actually constructing the <code>Subject</code> instance to ensure the most |
| specific/accurate data can be used. |
| <p/> |
| <b>USAGE</b>: Most Shiro end-users will never use a <code>SubjectContext</code> instance directly and instead will use a |
| <a href="Subject.Builder.html" title="class in org.apache.shiro.subject"><code>Subject.Builder</code></a> (which internally uses a <code>SubjectContext</code>) and build <code>Subject</code> instances that |
| way.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../mgt/SecurityManager.html#createSubject(org.apache.shiro.subject.SubjectContext)"><code>SecurityManager.createSubject</code></a>, |
| <a href="../mgt/SubjectFactory.html" title="interface in org.apache.shiro.mgt"><code>SubjectFactory</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.java.util.Map"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface java.util.<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util" class="externalLink">Map.Entry</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util" class="externalLink">K</a> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util" class="externalLink">V</a> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAuthenticationInfo()">getAuthenticationInfo</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAuthenticationToken()">getAuthenticationToken</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHost()">getHost</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the host name or IP that should reflect the constructed <code>Subject</code>'s originating location.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPrincipals()">getPrincipals</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the principals (aka identity) that the constructed <code>Subject</code> should reflect.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSecurityManager()">getSecurityManager</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the SecurityManager instance that should be used to back the constructed <a href="Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instance or |
| <code>null</code> if one has not yet been provided to this context.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSession()">getSession</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the <code>Session</code> to use when building the <code>Subject</code> instance.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionId()">getSessionId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the session id of the session that should be associated with the constructed <a href="Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="Subject.html" title="interface in org.apache.shiro.subject">Subject</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSubject()">getSubject</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns any existing <code>Subject</code> that may be in use at the time the new <code>Subject</code> instance is |
| being created.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAuthenticated()">isAuthenticated</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns <code>true</code> if the constructed <code>Subject</code> should be considered authenticated, <code>false</code> |
| otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSessionCreationEnabled()">isSessionCreationEnabled</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns <code>true</code> if the constructed <code>Subject</code> should be allowed to create a session, <code>false</code> |
| otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolveAuthenticated()">resolveAuthenticated</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolveHost()">resolveHost</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolvePrincipals()">resolvePrincipals</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolveSecurityManager()">resolveSecurityManager</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Resolves the <code>SecurityManager</code> instance that should be used to back the constructed <a href="Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> |
| instance (typically used to support <a href="support/DelegatingSubject.html" title="class in org.apache.shiro.subject.support"><code>DelegatingSubject</code></a> implementations).</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolveSession()">resolveSession</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAuthenticated(boolean)">setAuthenticated</a></span>​(boolean authc)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets whether or not the constructed <code>Subject</code> instance should be considered as authenticated.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAuthenticationInfo(org.apache.shiro.authc.AuthenticationInfo)">setAuthenticationInfo</a></span>​(<a href="../authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAuthenticationToken(org.apache.shiro.authc.AuthenticationToken)">setAuthenticationToken</a></span>​(<a href="../authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHost(java.lang.String)">setHost</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> host)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the host name or IP that should reflect the constructed <code>Subject</code>'s originating location.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPrincipals(org.apache.shiro.subject.PrincipalCollection)">setPrincipals</a></span>​(<a href="PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the principals (aka identity) that the constructed <code>Subject</code> should reflect.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSecurityManager(org.apache.shiro.mgt.SecurityManager)">setSecurityManager</a></span>​(<a href="../mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a> securityManager)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the SecurityManager instance that should be used to back the constructed <a href="Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instance |
| (typically used to support <a href="support/DelegatingSubject.html" title="class in org.apache.shiro.subject.support"><code>DelegatingSubject</code></a> implementations).</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSession(org.apache.shiro.session.Session)">setSession</a></span>​(<a href="../session/Session.html" title="interface in org.apache.shiro.session">Session</a> session)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the <code>Session</code> to use when building the <code>Subject</code> instance.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSessionCreationEnabled(boolean)">setSessionCreationEnabled</a></span>​(boolean enabled)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets whether or not the constructed <code>Subject</code> instance should be allowed to create a session, |
| <code>false</code> otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSessionId(java.io.Serializable)">setSessionId</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a> sessionId)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the session id of the session that should be associated with the constructed <a href="Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSubject(org.apache.shiro.subject.Subject)">setSubject</a></span>​(<a href="Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the existing <code>Subject</code> that may be in use at the time the new <code>Subject</code> instance is |
| being created.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.util.Map"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.util.<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#clear()" title="class or interface in java.util" class="externalLink">clear</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#compute(K,java.util.function.BiFunction)" title="class or interface in java.util" class="externalLink">compute</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#computeIfAbsent(K,java.util.function.Function)" title="class or interface in java.util" class="externalLink">computeIfAbsent</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#computeIfPresent(K,java.util.function.BiFunction)" title="class or interface in java.util" class="externalLink">computeIfPresent</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#containsKey(java.lang.Object)" title="class or interface in java.util" class="externalLink">containsKey</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#containsValue(java.lang.Object)" title="class or interface in java.util" class="externalLink">containsValue</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#entrySet()" title="class or interface in java.util" class="externalLink">entrySet</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.util" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#forEach(java.util.function.BiConsumer)" title="class or interface in java.util" class="externalLink">forEach</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#get(java.lang.Object)" title="class or interface in java.util" class="externalLink">get</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#getOrDefault(java.lang.Object,V)" title="class or interface in java.util" class="externalLink">getOrDefault</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#hashCode()" title="class or interface in java.util" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#isEmpty()" title="class or interface in java.util" class="externalLink">isEmpty</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#keySet()" title="class or interface in java.util" class="externalLink">keySet</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#merge(K,V,java.util.function.BiFunction)" title="class or interface in java.util" class="externalLink">merge</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#put(K,V)" title="class or interface in java.util" class="externalLink">put</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#putAll(java.util.Map)" title="class or interface in java.util" class="externalLink">putAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#putIfAbsent(K,V)" title="class or interface in java.util" class="externalLink">putIfAbsent</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#remove(java.lang.Object)" title="class or interface in java.util" class="externalLink">remove</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#remove(java.lang.Object,java.lang.Object)" title="class or interface in java.util" class="externalLink">remove</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#replace(K,V)" title="class or interface in java.util" class="externalLink">replace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#replace(K,V,V)" title="class or interface in java.util" class="externalLink">replace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#replaceAll(java.util.function.BiFunction)" title="class or interface in java.util" class="externalLink">replaceAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#size()" title="class or interface in java.util" class="externalLink">size</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#values()" title="class or interface in java.util" class="externalLink">values</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getSecurityManager()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSecurityManager</h4> |
| <pre class="methodSignature"><a href="../mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a> <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.68">getSecurityManager</a>()</pre> |
| <div class="block">Returns the SecurityManager instance that should be used to back the constructed <a href="Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instance or |
| <code>null</code> if one has not yet been provided to this context.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the SecurityManager instance that should be used to back the constructed <a href="Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instance or |
| <code>null</code> if one has not yet been provided to this context.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSecurityManager(org.apache.shiro.mgt.SecurityManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSecurityManager</h4> |
| <pre class="methodSignature">void <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.77">setSecurityManager</a>​(<a href="../mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a> securityManager)</pre> |
| <div class="block">Sets the SecurityManager instance that should be used to back the constructed <a href="Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instance |
| (typically used to support <a href="support/DelegatingSubject.html" title="class in org.apache.shiro.subject.support"><code>DelegatingSubject</code></a> implementations).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>securityManager</code> - the SecurityManager instance that should be used to back the constructed <a href="Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> |
| instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="resolveSecurityManager()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveSecurityManager</h4> |
| <pre class="methodSignature"><a href="../mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a> <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.86">resolveSecurityManager</a>()</pre> |
| <div class="block">Resolves the <code>SecurityManager</code> instance that should be used to back the constructed <a href="Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> |
| instance (typically used to support <a href="support/DelegatingSubject.html" title="class in org.apache.shiro.subject.support"><code>DelegatingSubject</code></a> implementations).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>SecurityManager</code> instance that should be used to back the constructed <a href="Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> |
| instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSessionId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionId</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a> <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.96">getSessionId</a>()</pre> |
| <div class="block">Returns the session id of the session that should be associated with the constructed <a href="Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instance. |
| <p/> |
| The construction process is expected to resolve the session with the specified id and then construct the Subject |
| instance based on the resolved session.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the session id of the session that should be associated with the constructed <a href="Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSessionId(java.io.Serializable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSessionId</h4> |
| <pre class="methodSignature">void <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.107">setSessionId</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a> sessionId)</pre> |
| <div class="block">Sets the session id of the session that should be associated with the constructed <a href="Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instance. |
| <p/> |
| The construction process is expected to resolve the session with the specified id and then construct the Subject |
| instance based on the resolved session.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sessionId</code> - the session id of the session that should be associated with the constructed <a href="Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> |
| instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSubject()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSubject</h4> |
| <pre class="methodSignature"><a href="Subject.html" title="interface in org.apache.shiro.subject">Subject</a> <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.121">getSubject</a>()</pre> |
| <div class="block">Returns any existing <code>Subject</code> that may be in use at the time the new <code>Subject</code> instance is |
| being created. |
| <p/> |
| This is typically used in the case where the existing <code>Subject</code> instance returned by |
| this method is unauthenticated and a new <code>Subject</code> instance is being created to reflect a successful |
| authentication - you want to return most of the state of the previous <code>Subject</code> instance when creating the |
| newly authenticated instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>any existing <code>Subject</code> that may be in use at the time the new <code>Subject</code> instance is |
| being created.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSubject(org.apache.shiro.subject.Subject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSubject</h4> |
| <pre class="methodSignature">void <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.135">setSubject</a>​(<a href="Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</pre> |
| <div class="block">Sets the existing <code>Subject</code> that may be in use at the time the new <code>Subject</code> instance is |
| being created. |
| <p/> |
| This is typically used in the case where the existing <code>Subject</code> instance returned by |
| this method is unauthenticated and a new <code>Subject</code> instance is being created to reflect a successful |
| authentication - you want to return most of the state of the previous <code>Subject</code> instance when creating the |
| newly authenticated instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subject</code> - the existing <code>Subject</code> that may be in use at the time the new <code>Subject</code> instance is |
| being created.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPrincipals()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrincipals</h4> |
| <pre class="methodSignature"><a href="PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.142">getPrincipals</a>()</pre> |
| <div class="block">Returns the principals (aka identity) that the constructed <code>Subject</code> should reflect.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the principals (aka identity) that the constructed <code>Subject</code> should reflect.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="resolvePrincipals()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolvePrincipals</h4> |
| <pre class="methodSignature"><a href="PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.144">resolvePrincipals</a>()</pre> |
| </li> |
| </ul> |
| <a id="setPrincipals(org.apache.shiro.subject.PrincipalCollection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrincipals</h4> |
| <pre class="methodSignature">void <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.151">setPrincipals</a>​(<a href="PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> principals)</pre> |
| <div class="block">Sets the principals (aka identity) that the constructed <code>Subject</code> should reflect.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>principals</code> - the principals (aka identity) that the constructed <code>Subject</code> should reflect.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSession()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre class="methodSignature"><a href="../session/Session.html" title="interface in org.apache.shiro.session">Session</a> <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.160">getSession</a>()</pre> |
| <div class="block">Returns the <code>Session</code> to use when building the <code>Subject</code> instance. Note that it is more |
| common to specify a <a href="#setSessionId(java.io.Serializable)"><code>sessionId</code></a> to acquire the desired session rather than having to |
| construct a <code>Session</code> to be returned by this method.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>Session</code> to use when building the <code>Subject</code> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSession(org.apache.shiro.session.Session)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSession</h4> |
| <pre class="methodSignature">void <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.169">setSession</a>​(<a href="../session/Session.html" title="interface in org.apache.shiro.session">Session</a> session)</pre> |
| <div class="block">Sets the <code>Session</code> to use when building the <code>Subject</code> instance. Note that it is more |
| common to specify a <a href="#setSessionId(java.io.Serializable)"><code>sessionId</code></a> to automatically resolve the desired session rather than |
| constructing a <code>Session</code> to call this method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the <code>Session</code> to use when building the <code>Subject</code> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="resolveSession()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveSession</h4> |
| <pre class="methodSignature"><a href="../session/Session.html" title="interface in org.apache.shiro.session">Session</a> <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.171">resolveSession</a>()</pre> |
| </li> |
| </ul> |
| <a id="isAuthenticated()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAuthenticated</h4> |
| <pre class="methodSignature">boolean <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.181">isAuthenticated</a>()</pre> |
| <div class="block">Returns <code>true</code> if the constructed <code>Subject</code> should be considered authenticated, <code>false</code> |
| otherwise. Be careful setting this value to <code>true</code> - you should know what you are doing and have a good |
| reason for ignoring Shiro's default authentication state mechanisms.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the constructed <code>Subject</code> should be considered authenticated, <code>false</code> |
| otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setAuthenticated(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAuthenticated</h4> |
| <pre class="methodSignature">void <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.190">setAuthenticated</a>​(boolean authc)</pre> |
| <div class="block">Sets whether or not the constructed <code>Subject</code> instance should be considered as authenticated. Be careful |
| when specifying <code>true</code> - you should know what you are doing and have a good reason for ignoring Shiro's |
| default authentication state mechanisms.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>authc</code> - whether or not the constructed <code>Subject</code> instance should be considered as authenticated.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isSessionCreationEnabled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSessionCreationEnabled</h4> |
| <pre class="methodSignature">boolean <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.200">isSessionCreationEnabled</a>()</pre> |
| <div class="block">Returns <code>true</code> if the constructed <code>Subject</code> should be allowed to create a session, <code>false</code> |
| otherwise. Shiro's configuration defaults to <code>true</code> as most applications find value in Sessions.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the constructed <code>Subject</code> should be allowed to create sessions, <code>false</code> |
| otherwise.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSessionCreationEnabled(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSessionCreationEnabled</h4> |
| <pre class="methodSignature">void <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.210">setSessionCreationEnabled</a>​(boolean enabled)</pre> |
| <div class="block">Sets whether or not the constructed <code>Subject</code> instance should be allowed to create a session, |
| <code>false</code> otherwise.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>enabled</code> - whether or not the constructed <code>Subject</code> instance should be allowed to create a session, |
| <code>false</code> otherwise.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="resolveAuthenticated()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveAuthenticated</h4> |
| <pre class="methodSignature">boolean <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.212">resolveAuthenticated</a>()</pre> |
| </li> |
| </ul> |
| <a id="getAuthenticationInfo()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAuthenticationInfo</h4> |
| <pre class="methodSignature"><a href="../authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.214">getAuthenticationInfo</a>()</pre> |
| </li> |
| </ul> |
| <a id="setAuthenticationInfo(org.apache.shiro.authc.AuthenticationInfo)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAuthenticationInfo</h4> |
| <pre class="methodSignature">void <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.216">setAuthenticationInfo</a>​(<a href="../authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info)</pre> |
| </li> |
| </ul> |
| <a id="getAuthenticationToken()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAuthenticationToken</h4> |
| <pre class="methodSignature"><a href="../authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.218">getAuthenticationToken</a>()</pre> |
| </li> |
| </ul> |
| <a id="setAuthenticationToken(org.apache.shiro.authc.AuthenticationToken)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAuthenticationToken</h4> |
| <pre class="methodSignature">void <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.220">setAuthenticationToken</a>​(<a href="../authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</pre> |
| </li> |
| </ul> |
| <a id="getHost()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHost</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.227">getHost</a>()</pre> |
| <div class="block">Returns the host name or IP that should reflect the constructed <code>Subject</code>'s originating location.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the host name or IP that should reflect the constructed <code>Subject</code>'s originating location.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setHost(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHost</h4> |
| <pre class="methodSignature">void <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.234">setHost</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> host)</pre> |
| <div class="block">Sets the host name or IP that should reflect the constructed <code>Subject</code>'s originating location.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>host</code> - the host name or IP that should reflect the constructed <code>Subject</code>'s originating location.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="resolveHost()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>resolveHost</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.236">resolveHost</a>()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SubjectContext.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2004–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
