| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="fr"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Jan 24 17:11:59 CET 2020 --> |
| <title>DefaultSecurityManager (Apache Shiro :: Core 1.5.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-01-24"> |
| <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="DefaultSecurityManager (Apache Shiro :: Core 1.5.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":42,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":42}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/DefaultSecurityManager.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>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.mgt</a></div> |
| <h2 title="Class DefaultSecurityManager" class="title">Class DefaultSecurityManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><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">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="CachingSecurityManager.html" title="class in org.apache.shiro.mgt">org.apache.shiro.mgt.CachingSecurityManager</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="RealmSecurityManager.html" title="class in org.apache.shiro.mgt">org.apache.shiro.mgt.RealmSecurityManager</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="AuthenticatingSecurityManager.html" title="class in org.apache.shiro.mgt">org.apache.shiro.mgt.AuthenticatingSecurityManager</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="AuthorizingSecurityManager.html" title="class in org.apache.shiro.mgt">org.apache.shiro.mgt.AuthorizingSecurityManager</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="SessionsSecurityManager.html" title="class in org.apache.shiro.mgt">org.apache.shiro.mgt.SessionsSecurityManager</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.shiro.mgt.DefaultSecurityManager</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../authc/Authenticator.html" title="interface in org.apache.shiro.authc">Authenticator</a></code>, <code><a href="../authz/Authorizer.html" title="interface in org.apache.shiro.authz">Authorizer</a></code>, <code>org.apache.shiro.cache.CacheManagerAware</code>, <code>org.apache.shiro.event.EventBusAware</code>, <code><a href="SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a></code>, <code><a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt">SessionManager</a></code>, <code>org.apache.shiro.util.Destroyable</code></dd> |
| </dl> |
| <hr> |
| <pre>public class <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.75">DefaultSecurityManager</a> |
| extends <a href="SessionsSecurityManager.html" title="class in org.apache.shiro.mgt">SessionsSecurityManager</a></pre> |
| <div class="block">The Shiro framework's default concrete implementation of the <a href="SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> interface, |
| based around a collection of <a href="../realm/Realm.html" title="interface in org.apache.shiro.realm"><code>Realm</code></a>s. This implementation delegates its |
| authentication, authorization, and session operations to wrapped <a href="../authc/Authenticator.html" title="interface in org.apache.shiro.authc"><code>Authenticator</code></a>, <a href="../authz/Authorizer.html" title="interface in org.apache.shiro.authz"><code>Authorizer</code></a>, and |
| <a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt"><code>SessionManager</code></a> instances respectively via superclass |
| implementation. |
| <p/> |
| To greatly reduce and simplify configuration, this implementation (and its superclasses) will |
| create suitable defaults for all of its required dependencies, <em>except</em> the required one or more |
| <a href="../realm/Realm.html" title="interface in org.apache.shiro.realm"><code>Realm</code></a>s. Because <code>Realm</code> implementations usually interact with an application's data model, |
| they are almost always application specific; you will want to specify at least one custom |
| <code>Realm</code> implementation that 'knows' about your application's data/security model |
| (via <a href="RealmSecurityManager.html#setRealm(org.apache.shiro.realm.Realm)"><code>RealmSecurityManager.setRealm(org.apache.shiro.realm.Realm)</code></a> or one of the overloaded constructors). All other attributes in this class hierarchy |
| will have suitable defaults for most enterprise applications. |
| <p/> |
| <b>RememberMe notice</b>: This class supports the ability to configure a |
| <a href="#setRememberMeManager(org.apache.shiro.mgt.RememberMeManager)"><code>RememberMeManager</code></a> |
| for <code>RememberMe</code> identity services for login/logout, BUT, a default instance <em>will not</em> be created |
| for this attribute at startup. |
| <p/> |
| Because RememberMe services are inherently client tier-specific and |
| therefore aplication-dependent, if you want <code>RememberMe</code> services enabled, you will have to specify an |
| instance yourself via the <a href="#setRememberMeManager(org.apache.shiro.mgt.RememberMeManager)"><code>setRememberMeManager</code></a> |
| mutator. However if you're reading this JavaDoc with the |
| expectation of operating in a Web environment, take a look at the |
| <code>org.apache.shiro.web.DefaultWebSecurityManager</code> implementation, which |
| <em>does</em> support <code>RememberMe</code> services by default at startup.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.2</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="RememberMeManager.html" title="interface in org.apache.shiro.mgt">RememberMeManager</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rememberMeManager">rememberMeManager</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="SubjectDAO.html" title="interface in org.apache.shiro.mgt">SubjectDAO</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#subjectDAO">subjectDAO</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="SubjectFactory.html" title="interface in org.apache.shiro.mgt">SubjectFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#subjectFactory">subjectFactory</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">DefaultSecurityManager</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Default no-arg constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Collection)">DefaultSecurityManager</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a>> realms)</code></th> |
| <td class="colLast"> |
| <div class="block">Supporting constructor for multiple <a href="RealmSecurityManager.html#setRealms(java.util.Collection)"><code>realms</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.shiro.realm.Realm)">DefaultSecurityManager</a></span>​(<a href="../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> singleRealm)</code></th> |
| <td class="colLast"> |
| <div class="block">Supporting constructor for a single-realm application.</div> |
| </td> |
| </tr> |
| </table> |
| </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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#beforeLogout(org.apache.shiro.subject.Subject)">beforeLogout</a></span>​(<a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bind(org.apache.shiro.subject.Subject)">bind</a></span>​(<a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">in favor of <a href="#save(org.apache.shiro.subject.Subject)"><code>save(subject)</code></a>.</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copy(org.apache.shiro.subject.SubjectContext)">copy</a></span>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> subjectContext)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../session/mgt/SessionContext.html" title="interface in org.apache.shiro.session.mgt">SessionContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSessionContext(org.apache.shiro.subject.SubjectContext)">createSessionContext</a></span>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> subjectContext)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSubject(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo,org.apache.shiro.subject.Subject)">createSubject</a></span>​(<a href="../authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, |
| <a href="../authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info, |
| <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> existing)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a <code>Subject</code> instance for the user represented by the given method arguments.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSubject(org.apache.shiro.subject.SubjectContext)">createSubject</a></span>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> subjectContext)</code></th> |
| <td class="colLast"> |
| <div class="block">This implementation functions as follows:</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSubjectContext()">createSubjectContext</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#delete(org.apache.shiro.subject.Subject)">delete</a></span>​(<a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code></th> |
| <td class="colLast"> |
| <div class="block">Removes (or 'unbinds') the Subject's state from the application, typically called during <a href="#logout(org.apache.shiro.subject.Subject)"><code>logout(org.apache.shiro.subject.Subject)</code></a>..</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doCreateSubject(org.apache.shiro.subject.SubjectContext)">doCreateSubject</a></span>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> context)</code></th> |
| <td class="colLast"> |
| <div class="block">Actually creates a <code>Subject</code> instance by delegating to the internal |
| <a href="#getSubjectFactory()"><code>subjectFactory</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ensureSecurityManager(org.apache.shiro.subject.SubjectContext)">ensureSecurityManager</a></span>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> context)</code></th> |
| <td class="colLast"> |
| <div class="block">Determines if there is a <code>SecurityManager</code> instance in the context, and if not, adds 'this' to the |
| context.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRememberedIdentity(org.apache.shiro.subject.SubjectContext)">getRememberedIdentity</a></span>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> subjectContext)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="RememberMeManager.html" title="interface in org.apache.shiro.mgt">RememberMeManager</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRememberMeManager()">getRememberMeManager</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionKey(org.apache.shiro.subject.SubjectContext)">getSessionKey</a></span>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> context)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="SubjectDAO.html" title="interface in org.apache.shiro.mgt">SubjectDAO</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSubjectDAO()">getSubjectDAO</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the <code>SubjectDAO</code> responsible for persisting Subject state, typically used after login or when an |
| Subject identity is discovered (eg after RememberMe services).</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="SubjectFactory.html" title="interface in org.apache.shiro.mgt">SubjectFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSubjectFactory()">getSubjectFactory</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the <code>SubjectFactory</code> responsible for creating <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instances exposed to the application.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#login(org.apache.shiro.subject.Subject,org.apache.shiro.authc.AuthenticationToken)">login</a></span>​(<a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, |
| <a href="../authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token)</code></th> |
| <td class="colLast"> |
| <div class="block">First authenticates the <code>AuthenticationToken</code> argument, and if successful, constructs a |
| <code>Subject</code> instance representing the authenticated account's identity.</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="#logout(org.apache.shiro.subject.Subject)">logout</a></span>​(<a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code></th> |
| <td class="colLast"> |
| <div class="block">Logs out the specified Subject from the system.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onFailedLogin(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationException,org.apache.shiro.subject.Subject)">onFailedLogin</a></span>​(<a href="../authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, |
| <a href="../authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a> ae, |
| <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onSuccessfulLogin(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo,org.apache.shiro.subject.Subject)">onSuccessfulLogin</a></span>​(<a href="../authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, |
| <a href="../authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info, |
| <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rememberMeFailedLogin(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationException,org.apache.shiro.subject.Subject)">rememberMeFailedLogin</a></span>​(<a href="../authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, |
| <a href="../authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a> ex, |
| <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rememberMeLogout(org.apache.shiro.subject.Subject)">rememberMeLogout</a></span>​(<a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rememberMeSuccessfulLogin(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo,org.apache.shiro.subject.Subject)">rememberMeSuccessfulLogin</a></span>​(<a href="../authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, |
| <a href="../authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info, |
| <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>protected <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="#resolveContextSession(org.apache.shiro.subject.SubjectContext)">resolveContextSession</a></span>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> context)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolvePrincipals(org.apache.shiro.subject.SubjectContext)">resolvePrincipals</a></span>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> context)</code></th> |
| <td class="colLast"> |
| <div class="block">Attempts to resolve an identity (a <a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject"><code>PrincipalCollection</code></a>) for the context using heuristics.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolveSession(org.apache.shiro.subject.SubjectContext)">resolveSession</a></span>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> context)</code></th> |
| <td class="colLast"> |
| <div class="block">Attempts to resolve any associated session based on the context and returns a |
| context that represents this resolved <code>Session</code> to ensure it may be referenced if necessary by the |
| invoked <a href="SubjectFactory.html" title="interface in org.apache.shiro.mgt"><code>SubjectFactory</code></a> that performs actual <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> construction.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#save(org.apache.shiro.subject.Subject)">save</a></span>​(<a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code></th> |
| <td class="colLast"> |
| <div class="block">Saves the subject's state to a persistent location for future reference if necessary.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRememberMeManager(org.apache.shiro.mgt.RememberMeManager)">setRememberMeManager</a></span>​(<a href="RememberMeManager.html" title="interface in org.apache.shiro.mgt">RememberMeManager</a> rememberMeManager)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSubjectDAO(org.apache.shiro.mgt.SubjectDAO)">setSubjectDAO</a></span>​(<a href="SubjectDAO.html" title="interface in org.apache.shiro.mgt">SubjectDAO</a> subjectDAO)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the <code>SubjectDAO</code> responsible for persisting Subject state, typically used after login or when an |
| Subject identity is discovered (eg after RememberMe services).</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSubjectFactory(org.apache.shiro.mgt.SubjectFactory)">setSubjectFactory</a></span>​(<a href="SubjectFactory.html" title="interface in org.apache.shiro.mgt">SubjectFactory</a> subjectFactory)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the <code>SubjectFactory</code> responsible for creating <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instances exposed to the application.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stopSession(org.apache.shiro.subject.Subject)">stopSession</a></span>​(<a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unbind(org.apache.shiro.subject.Subject)">unbind</a></span>​(<a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">in Shiro 1.2 in favor of <a href="#delete(org.apache.shiro.subject.Subject)"><code>delete(org.apache.shiro.subject.Subject)</code></a></div> |
| </div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.mgt.SessionsSecurityManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.shiro.mgt.<a href="SessionsSecurityManager.html" title="class in org.apache.shiro.mgt">SessionsSecurityManager</a></h3> |
| <code><a href="SessionsSecurityManager.html#afterCacheManagerSet()">afterCacheManagerSet</a>, <a href="SessionsSecurityManager.html#afterEventBusSet()">afterEventBusSet</a>, <a href="SessionsSecurityManager.html#afterSessionManagerSet()">afterSessionManagerSet</a>, <a href="SessionsSecurityManager.html#applyCacheManagerToSessionManager()">applyCacheManagerToSessionManager</a>, <a href="SessionsSecurityManager.html#applyEventBusToSessionManager()">applyEventBusToSessionManager</a>, <a href="SessionsSecurityManager.html#destroy()">destroy</a>, <a href="SessionsSecurityManager.html#getSession(org.apache.shiro.session.mgt.SessionKey)">getSession</a>, <a href="SessionsSecurityManager.html#getSessionManager()">getSessionManager</a>, <a href="SessionsSecurityManager.html#setSessionManager(org.apache.shiro.session.mgt.SessionManager)">setSessionManager</a>, <a href="SessionsSecurityManager.html#start(org.apache.shiro.session.mgt.SessionContext)">start</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.mgt.AuthorizingSecurityManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.shiro.mgt.<a href="AuthorizingSecurityManager.html" title="class in org.apache.shiro.mgt">AuthorizingSecurityManager</a></h3> |
| <code><a href="AuthorizingSecurityManager.html#afterRealmsSet()">afterRealmsSet</a>, <a href="AuthorizingSecurityManager.html#checkPermission(org.apache.shiro.subject.PrincipalCollection,java.lang.String)">checkPermission</a>, <a href="AuthorizingSecurityManager.html#checkPermission(org.apache.shiro.subject.PrincipalCollection,org.apache.shiro.authz.Permission)">checkPermission</a>, <a href="AuthorizingSecurityManager.html#checkPermissions(org.apache.shiro.subject.PrincipalCollection,java.lang.String...)">checkPermissions</a>, <a href="AuthorizingSecurityManager.html#checkPermissions(org.apache.shiro.subject.PrincipalCollection,java.util.Collection)">checkPermissions</a>, <a href="AuthorizingSecurityManager.html#checkRole(org.apache.shiro.subject.PrincipalCollection,java.lang.String)">checkRole</a>, <a href="AuthorizingSecurityManager.html#checkRoles(org.apache.shiro.subject.PrincipalCollection,java.lang.String...)">checkRoles</a>, <a href="AuthorizingSecurityManager.html#checkRoles(org.apache.shiro.subject.PrincipalCollection,java.util.Collection)">checkRoles</a>, <a href="AuthorizingSecurityManager.html#getAuthorizer()">getAuthorizer</a>, <a href="AuthorizingSecurityManager.html#hasAllRoles(org.apache.shiro.subject.PrincipalCollection,java.util.Collection)">hasAllRoles</a>, <a href="AuthorizingSecurityManager.html#hasRole(org.apache.shiro.subject.PrincipalCollection,java.lang.String)">hasRole</a>, <a href="AuthorizingSecurityManager.html#hasRoles(org.apache.shiro.subject.PrincipalCollection,java.util.List)">hasRoles</a>, <a href="AuthorizingSecurityManager.html#isPermitted(org.apache.shiro.subject.PrincipalCollection,java.lang.String)">isPermitted</a>, <a href="AuthorizingSecurityManager.html#isPermitted(org.apache.shiro.subject.PrincipalCollection,java.lang.String...)">isPermitted</a>, <a href="AuthorizingSecurityManager.html#isPermitted(org.apache.shiro.subject.PrincipalCollection,java.util.List)">isPermitted</a>, <a href="AuthorizingSecurityManager.html#isPermitted(org.apache.shiro.subject.PrincipalCollection,org.apache.shiro.authz.Permission)">isPermitted</a>, <a href="AuthorizingSecurityManager.html#isPermittedAll(org.apache.shiro.subject.PrincipalCollection,java.lang.String...)">isPermittedAll</a>, <a href="AuthorizingSecurityManager.html#isPermittedAll(org.apache.shiro.subject.PrincipalCollection,java.util.Collection)">isPermittedAll</a>, <a href="AuthorizingSecurityManager.html#setAuthorizer(org.apache.shiro.authz.Authorizer)">setAuthorizer</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.mgt.AuthenticatingSecurityManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.shiro.mgt.<a href="AuthenticatingSecurityManager.html" title="class in org.apache.shiro.mgt">AuthenticatingSecurityManager</a></h3> |
| <code><a href="AuthenticatingSecurityManager.html#authenticate(org.apache.shiro.authc.AuthenticationToken)">authenticate</a>, <a href="AuthenticatingSecurityManager.html#getAuthenticator()">getAuthenticator</a>, <a href="AuthenticatingSecurityManager.html#setAuthenticator(org.apache.shiro.authc.Authenticator)">setAuthenticator</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.mgt.RealmSecurityManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.shiro.mgt.<a href="RealmSecurityManager.html" title="class in org.apache.shiro.mgt">RealmSecurityManager</a></h3> |
| <code><a href="RealmSecurityManager.html#applyCacheManagerToRealms()">applyCacheManagerToRealms</a>, <a href="RealmSecurityManager.html#applyEventBusToRealms()">applyEventBusToRealms</a>, <a href="RealmSecurityManager.html#getRealms()">getRealms</a>, <a href="RealmSecurityManager.html#setRealm(org.apache.shiro.realm.Realm)">setRealm</a>, <a href="RealmSecurityManager.html#setRealms(java.util.Collection)">setRealms</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.mgt.CachingSecurityManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.shiro.mgt.<a href="CachingSecurityManager.html" title="class in org.apache.shiro.mgt">CachingSecurityManager</a></h3> |
| <code><a href="CachingSecurityManager.html#applyEventBusToCacheManager()">applyEventBusToCacheManager</a>, <a href="CachingSecurityManager.html#getCacheManager()">getCacheManager</a>, <a href="CachingSecurityManager.html#getEventBus()">getEventBus</a>, <a href="CachingSecurityManager.html#setCacheManager(org.apache.shiro.cache.CacheManager)">setCacheManager</a>, <a href="CachingSecurityManager.html#setEventBus(org.apache.shiro.event.EventBus)">setEventBus</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<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></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="rememberMeManager"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rememberMeManager</h4> |
| <pre>protected <a href="RememberMeManager.html" title="interface in org.apache.shiro.mgt">RememberMeManager</a> <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.79">rememberMeManager</a></pre> |
| </li> |
| </ul> |
| <a id="subjectDAO"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>subjectDAO</h4> |
| <pre>protected <a href="SubjectDAO.html" title="interface in org.apache.shiro.mgt">SubjectDAO</a> <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.80">subjectDAO</a></pre> |
| </li> |
| </ul> |
| <a id="subjectFactory"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>subjectFactory</h4> |
| <pre>protected <a href="SubjectFactory.html" title="interface in org.apache.shiro.mgt">SubjectFactory</a> <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.81">subjectFactory</a></pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DefaultSecurityManager</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.86">DefaultSecurityManager</a>()</pre> |
| <div class="block">Default no-arg constructor.</div> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.shiro.realm.Realm)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DefaultSecurityManager</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.97">DefaultSecurityManager</a>​(<a href="../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> singleRealm)</pre> |
| <div class="block">Supporting constructor for a single-realm application.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>singleRealm</code> - the single realm used by this SecurityManager.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DefaultSecurityManager</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.107">DefaultSecurityManager</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a>> realms)</pre> |
| <div class="block">Supporting constructor for multiple <a href="RealmSecurityManager.html#setRealms(java.util.Collection)"><code>realms</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>realms</code> - the realm instances backing this SecurityManager.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getSubjectFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSubjectFactory</h4> |
| <pre class="methodSignature">public <a href="SubjectFactory.html" title="interface in org.apache.shiro.mgt">SubjectFactory</a> <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.117">getSubjectFactory</a>()</pre> |
| <div class="block">Returns the <code>SubjectFactory</code> responsible for creating <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instances exposed to the application.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>SubjectFactory</code> responsible for creating <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instances exposed to the application.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSubjectFactory(org.apache.shiro.mgt.SubjectFactory)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSubjectFactory</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.126">setSubjectFactory</a>​(<a href="SubjectFactory.html" title="interface in org.apache.shiro.mgt">SubjectFactory</a> subjectFactory)</pre> |
| <div class="block">Sets the <code>SubjectFactory</code> responsible for creating <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instances exposed to the application.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subjectFactory</code> - the <code>SubjectFactory</code> responsible for creating <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instances exposed to the application.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSubjectDAO()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSubjectDAO</h4> |
| <pre class="methodSignature">public <a href="SubjectDAO.html" title="interface in org.apache.shiro.mgt">SubjectDAO</a> <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.140">getSubjectDAO</a>()</pre> |
| <div class="block">Returns the <code>SubjectDAO</code> responsible for persisting Subject state, typically used after login or when an |
| Subject identity is discovered (eg after RememberMe services). Unless configured otherwise, the default |
| implementation is a <a href="DefaultSubjectDAO.html" title="class in org.apache.shiro.mgt"><code>DefaultSubjectDAO</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>SubjectDAO</code> responsible for persisting Subject state, typically used after login or when an |
| Subject identity is discovered (eg after RememberMe services).</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="DefaultSubjectDAO.html" title="class in org.apache.shiro.mgt"><code>DefaultSubjectDAO</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSubjectDAO(org.apache.shiro.mgt.SubjectDAO)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSubjectDAO</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.154">setSubjectDAO</a>​(<a href="SubjectDAO.html" title="interface in org.apache.shiro.mgt">SubjectDAO</a> subjectDAO)</pre> |
| <div class="block">Sets the <code>SubjectDAO</code> responsible for persisting Subject state, typically used after login or when an |
| Subject identity is discovered (eg after RememberMe services). Unless configured otherwise, the default |
| implementation is a <a href="DefaultSubjectDAO.html" title="class in org.apache.shiro.mgt"><code>DefaultSubjectDAO</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subjectDAO</code> - the <code>SubjectDAO</code> responsible for persisting Subject state, typically used after login or when an |
| Subject identity is discovered (eg after RememberMe services).</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="DefaultSubjectDAO.html" title="class in org.apache.shiro.mgt"><code>DefaultSubjectDAO</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRememberMeManager()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRememberMeManager</h4> |
| <pre class="methodSignature">public <a href="RememberMeManager.html" title="interface in org.apache.shiro.mgt">RememberMeManager</a> <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.158">getRememberMeManager</a>()</pre> |
| </li> |
| </ul> |
| <a id="setRememberMeManager(org.apache.shiro.mgt.RememberMeManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRememberMeManager</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.162">setRememberMeManager</a>​(<a href="RememberMeManager.html" title="interface in org.apache.shiro.mgt">RememberMeManager</a> rememberMeManager)</pre> |
| </li> |
| </ul> |
| <a id="createSubjectContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSubjectContext</h4> |
| <pre class="methodSignature">protected <a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.166">createSubjectContext</a>()</pre> |
| </li> |
| </ul> |
| <a id="createSubject(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo,org.apache.shiro.subject.Subject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSubject</h4> |
| <pre class="methodSignature">protected <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.179">createSubject</a>​(<a href="../authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, |
| <a href="../authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info, |
| <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> existing)</pre> |
| <div class="block">Creates a <code>Subject</code> instance for the user represented by the given method arguments.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>token</code> - the <code>AuthenticationToken</code> submitted for the successful authentication.</dd> |
| <dd><code>info</code> - the <code>AuthenticationInfo</code> of a newly authenticated user.</dd> |
| <dd><code>existing</code> - the existing <code>Subject</code> instance that initiated the authentication attempt</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>Subject</code> instance that represents the context and session data for the newly |
| authenticated subject.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="bind(org.apache.shiro.subject.Subject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bind</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| protected void <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.202">bind</a>​(<a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">in favor of <a href="#save(org.apache.shiro.subject.Subject)"><code>save(subject)</code></a>.</div> |
| </div> |
| <div class="block">Binds a <code>Subject</code> instance created after authentication to the application for later use. |
| <p/> |
| As of Shiro 1.2, this method has been deprecated in favor of <a href="#save(org.apache.shiro.subject.Subject)"><code>save(org.apache.shiro.subject.Subject)</code></a>, |
| which this implementation now calls.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subject</code> - the <code>Subject</code> instance created after authentication to be bound to the application |
| for later use.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#save(org.apache.shiro.subject.Subject)"><code>save(org.apache.shiro.subject.Subject)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="rememberMeSuccessfulLogin(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo,org.apache.shiro.subject.Subject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rememberMeSuccessfulLogin</h4> |
| <pre class="methodSignature">protected void <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.207">rememberMeSuccessfulLogin</a>​(<a href="../authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, |
| <a href="../authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info, |
| <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</pre> |
| </li> |
| </ul> |
| <a id="rememberMeFailedLogin(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationException,org.apache.shiro.subject.Subject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rememberMeFailedLogin</h4> |
| <pre class="methodSignature">protected void <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.229">rememberMeFailedLogin</a>​(<a href="../authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, |
| <a href="../authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a> ex, |
| <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</pre> |
| </li> |
| </ul> |
| <a id="rememberMeLogout(org.apache.shiro.subject.Subject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rememberMeLogout</h4> |
| <pre class="methodSignature">protected void <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.245">rememberMeLogout</a>​(<a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</pre> |
| </li> |
| </ul> |
| <a id="login(org.apache.shiro.subject.Subject,org.apache.shiro.authc.AuthenticationToken)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>login</h4> |
| <pre class="methodSignature">public <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.272">login</a>​(<a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, |
| <a href="../authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token) |
| throws <a href="../authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a></pre> |
| <div class="block">First authenticates the <code>AuthenticationToken</code> argument, and if successful, constructs a |
| <code>Subject</code> instance representing the authenticated account's identity. |
| <p/> |
| Once constructed, the <code>Subject</code> instance is then <a href="#bind(org.apache.shiro.subject.Subject)"><code>bound</code></a> to the application for |
| subsequent access before being returned to the caller.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>token</code> - the authenticationToken to process for the login attempt.</dd> |
| <dd><code>subject</code> - the subject against which the authentication attempt will occur</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Subject representing the authenticated user.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a></code> - if there is a problem authenticating the specified <code>token</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onSuccessfulLogin(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo,org.apache.shiro.subject.Subject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onSuccessfulLogin</h4> |
| <pre class="methodSignature">protected void <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.295">onSuccessfulLogin</a>​(<a href="../authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, |
| <a href="../authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</a> info, |
| <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</pre> |
| </li> |
| </ul> |
| <a id="onFailedLogin(org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationException,org.apache.shiro.subject.Subject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onFailedLogin</h4> |
| <pre class="methodSignature">protected void <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.299">onFailedLogin</a>​(<a href="../authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</a> token, |
| <a href="../authc/AuthenticationException.html" title="class in org.apache.shiro.authc">AuthenticationException</a> ae, |
| <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</pre> |
| </li> |
| </ul> |
| <a id="beforeLogout(org.apache.shiro.subject.Subject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beforeLogout</h4> |
| <pre class="methodSignature">protected void <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.303">beforeLogout</a>​(<a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</pre> |
| </li> |
| </ul> |
| <a id="copy(org.apache.shiro.subject.SubjectContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre class="methodSignature">protected <a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.307">copy</a>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> subjectContext)</pre> |
| </li> |
| </ul> |
| <a id="createSubject(org.apache.shiro.subject.SubjectContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSubject</h4> |
| <pre class="methodSignature">public <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.333">createSubject</a>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> subjectContext)</pre> |
| <div class="block">This implementation functions as follows: |
| <p/> |
| <ol> |
| <li>Ensures the <code>SubjectContext</code> is as populated as it can be, using heuristics to acquire |
| data that may not have already been available to it (such as a referenced session or remembered principals).</li> |
| <li>Calls <a href="#doCreateSubject(org.apache.shiro.subject.SubjectContext)"><code>doCreateSubject(org.apache.shiro.subject.SubjectContext)</code></a> to actually perform the |
| <code>Subject</code> instance creation.</li> |
| <li>calls <a href="#save(org.apache.shiro.subject.Subject)"><code>save(subject)</code></a> to ensure the constructed |
| <code>Subject</code>'s state is accessible for future requests/invocations if necessary.</li> |
| <li>returns the constructed <code>Subject</code> instance.</li> |
| </ol></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subjectContext</code> - any data needed to direct how the Subject should be constructed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>Subject</code> instance reflecting the specified contextual data.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#ensureSecurityManager(org.apache.shiro.subject.SubjectContext)"><code>ensureSecurityManager(org.apache.shiro.subject.SubjectContext)</code></a>, |
| <a href="#resolveSession(org.apache.shiro.subject.SubjectContext)"><code>resolveSession(org.apache.shiro.subject.SubjectContext)</code></a>, |
| <a href="#resolvePrincipals(org.apache.shiro.subject.SubjectContext)"><code>resolvePrincipals(org.apache.shiro.subject.SubjectContext)</code></a>, |
| <a href="#doCreateSubject(org.apache.shiro.subject.SubjectContext)"><code>doCreateSubject(org.apache.shiro.subject.SubjectContext)</code></a>, |
| <a href="#save(org.apache.shiro.subject.Subject)"><code>save(org.apache.shiro.subject.Subject)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="doCreateSubject(org.apache.shiro.subject.SubjectContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doCreateSubject</h4> |
| <pre class="methodSignature">protected <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.373">doCreateSubject</a>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> context)</pre> |
| <div class="block">Actually creates a <code>Subject</code> instance by delegating to the internal |
| <a href="#getSubjectFactory()"><code>subjectFactory</code></a>. By the time this method is invoked, all possible |
| <code>SubjectContext</code> data (session, principals, et. al.) has been made accessible using all known heuristics |
| and will be accessible to the <code>subjectFactory</code> via the <code>subjectContext.resolve*</code> methods.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - the populated context (data map) to be used by the <code>SubjectFactory</code> when creating a |
| <code>Subject</code> instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>Subject</code> instance reflecting the data in the specified <code>SubjectContext</code> data map.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getSubjectFactory()"><code>getSubjectFactory()</code></a>, |
| <a href="SubjectFactory.html#createSubject(org.apache.shiro.subject.SubjectContext)"><code>SubjectFactory.createSubject(org.apache.shiro.subject.SubjectContext)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="save(org.apache.shiro.subject.Subject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>save</h4> |
| <pre class="methodSignature">protected void <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.387">save</a>​(<a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</pre> |
| <div class="block">Saves the subject's state to a persistent location for future reference if necessary. |
| <p/> |
| This implementation merely delegates to the internal <a href="#setSubjectDAO(org.apache.shiro.mgt.SubjectDAO)"><code>subjectDAO</code></a> and calls |
| <a href="SubjectDAO.html#save(org.apache.shiro.subject.Subject)"><code>subjectDAO.save(subject)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subject</code> - the subject for which state will potentially be persisted</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="SubjectDAO.html#save(org.apache.shiro.subject.Subject)"><code>SubjectDAO.save(org.apache.shiro.subject.Subject)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="delete(org.apache.shiro.subject.Subject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>delete</h4> |
| <pre class="methodSignature">protected void <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.401">delete</a>​(<a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</pre> |
| <div class="block">Removes (or 'unbinds') the Subject's state from the application, typically called during <a href="#logout(org.apache.shiro.subject.Subject)"><code>logout(org.apache.shiro.subject.Subject)</code></a>.. |
| <p/> |
| This implementation merely delegates to the internal <a href="#setSubjectDAO(org.apache.shiro.mgt.SubjectDAO)"><code>subjectDAO</code></a> and calls |
| <a href="SubjectDAO.html#delete(org.apache.shiro.subject.Subject)"><code>delete(subject)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subject</code> - the subject for which state will be removed</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="SubjectDAO.html#delete(org.apache.shiro.subject.Subject)"><code>SubjectDAO.delete(org.apache.shiro.subject.Subject)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="ensureSecurityManager(org.apache.shiro.subject.SubjectContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ensureSecurityManager</h4> |
| <pre class="methodSignature">protected <a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.414">ensureSecurityManager</a>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> context)</pre> |
| <div class="block">Determines if there is a <code>SecurityManager</code> instance in the context, and if not, adds 'this' to the |
| context. This ensures the SubjectFactory instance will have access to a SecurityManager during Subject |
| construction if necessary.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - the subject context data that may contain a SecurityManager instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The SubjectContext to use to pass to a <a href="SubjectFactory.html" title="interface in org.apache.shiro.mgt"><code>SubjectFactory</code></a> for subject creation.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="resolveSession(org.apache.shiro.subject.SubjectContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveSession</h4> |
| <pre class="methodSignature">protected <a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.438">resolveSession</a>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> context)</pre> |
| <div class="block">Attempts to resolve any associated session based on the context and returns a |
| context that represents this resolved <code>Session</code> to ensure it may be referenced if necessary by the |
| invoked <a href="SubjectFactory.html" title="interface in org.apache.shiro.mgt"><code>SubjectFactory</code></a> that performs actual <a href="../subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> construction. |
| <p/> |
| If there is a <code>Session</code> already in the context because that is what the caller wants to be used for |
| <code>Subject</code> construction, or if no session is resolved, this method effectively does nothing |
| returns the context method argument unaltered.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - the subject context data that may resolve a Session instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The context to use to pass to a <a href="SubjectFactory.html" title="interface in org.apache.shiro.mgt"><code>SubjectFactory</code></a> for subject creation.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="resolveContextSession(org.apache.shiro.subject.SubjectContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveContextSession</h4> |
| <pre class="methodSignature">protected <a href="../session/Session.html" title="interface in org.apache.shiro.session">Session</a> <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.458">resolveContextSession</a>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> context) |
| throws <a href="../session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSessionKey(org.apache.shiro.subject.SubjectContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionKey</h4> |
| <pre class="methodSignature">protected <a href="../session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.466">getSessionKey</a>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> context)</pre> |
| </li> |
| </ul> |
| <a id="resolvePrincipals(org.apache.shiro.subject.SubjectContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolvePrincipals</h4> |
| <pre class="methodSignature">protected <a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.493">resolvePrincipals</a>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> context)</pre> |
| <div class="block">Attempts to resolve an identity (a <a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject"><code>PrincipalCollection</code></a>) for the context using heuristics. This |
| implementation functions as follows: |
| <ol> |
| <li>Check the context to see if it can already <a href="../subject/SubjectContext.html#resolvePrincipals()"><code>resolve an identity</code></a>. If |
| so, this method does nothing and returns the method argument unaltered.</li> |
| <li>Check for a RememberMe identity by calling <a href="#getRememberedIdentity(org.apache.shiro.subject.SubjectContext)"><code>getRememberedIdentity(org.apache.shiro.subject.SubjectContext)</code></a>. If that method returns a |
| non-null value, place the remembered <a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject"><code>PrincipalCollection</code></a> in the context.</li> |
| </ol></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - the subject context data that may provide (directly or indirectly through one of its values) a |
| <a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject"><code>PrincipalCollection</code></a> identity.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The Subject context to use to pass to a <a href="SubjectFactory.html" title="interface in org.apache.shiro.mgt"><code>SubjectFactory</code></a> for subject creation.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createSessionContext(org.apache.shiro.subject.SubjectContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSessionContext</h4> |
| <pre class="methodSignature">protected <a href="../session/mgt/SessionContext.html" title="interface in org.apache.shiro.session.mgt">SessionContext</a> <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.532">createSessionContext</a>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> subjectContext)</pre> |
| </li> |
| </ul> |
| <a id="logout(org.apache.shiro.subject.Subject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>logout</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.548">logout</a>​(<a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="SecurityManager.html#logout(org.apache.shiro.subject.Subject)">SecurityManager</a></code></span></div> |
| <div class="block">Logs out the specified Subject from the system. |
| <p/> |
| Note that most application developers should not call this method unless they have a good reason for doing |
| so. The preferred way to logout a Subject is to call |
| <code><a href="../subject/Subject.html#logout()"><code>Subject.logout()</code></a></code>, not the |
| <code>SecurityManager</code> directly. |
| <p/> |
| Framework developers on the other hand might find calling this method directly useful in certain cases.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subject</code> - the subject to log out.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="stopSession(org.apache.shiro.subject.Subject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stopSession</h4> |
| <pre class="methodSignature">protected void <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.587">stopSession</a>​(<a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</pre> |
| </li> |
| </ul> |
| <a id="unbind(org.apache.shiro.subject.Subject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unbind</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| protected void <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.603">unbind</a>​(<a href="../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">in Shiro 1.2 in favor of <a href="#delete(org.apache.shiro.subject.Subject)"><code>delete(org.apache.shiro.subject.Subject)</code></a></div> |
| </div> |
| <div class="block">Unbinds or removes the Subject's state from the application, typically called during <a href="#logout(org.apache.shiro.subject.Subject)"><code>logout(org.apache.shiro.subject.Subject)</code></a>. |
| <p/> |
| This has been deprecated in Shiro 1.2 in favor of the <a href="#delete(org.apache.shiro.subject.Subject)"><code>delete</code></a> |
| method. The implementation has been updated to invoke that method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subject</code> - the subject to unbind from the application as it will no longer be used.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRememberedIdentity(org.apache.shiro.subject.SubjectContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getRememberedIdentity</h4> |
| <pre class="methodSignature">protected <a href="../subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a> <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSecurityManager.html#line.609">getRememberedIdentity</a>​(<a href="../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> subjectContext)</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/DefaultSecurityManager.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>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |
