| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="fr"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Jan 24 17:07:14 CET 2020 --> |
| <title>RealmSecurityManager (Apache Shiro 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="RealmSecurityManager (Apache Shiro 1.5.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/RealmSecurityManager.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>Field | </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>Field | </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 RealmSecurityManager" class="title">Class RealmSecurityManager</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>org.apache.shiro.mgt.RealmSecurityManager</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><a href="../cache/CacheManagerAware.html" title="interface in org.apache.shiro.cache">CacheManagerAware</a></code>, <code><a href="../event/EventBusAware.html" title="interface in org.apache.shiro.event">EventBusAware</a></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><a href="../util/Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="AuthenticatingSecurityManager.html" title="class in org.apache.shiro.mgt">AuthenticatingSecurityManager</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <a href="../../../../src-html/org/apache/shiro/mgt/RealmSecurityManager.html#line.39">RealmSecurityManager</a> |
| extends <a href="CachingSecurityManager.html" title="class in org.apache.shiro.mgt">CachingSecurityManager</a></pre> |
| <div class="block">Shiro support of a <a href="SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> class hierarchy based around a collection of |
| <a href="../realm/Realm.html" title="interface in org.apache.shiro.realm"><code>Realm</code></a>s. All actual <code>SecurityManager</code> method implementations are left to |
| subclasses.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.9</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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()">RealmSecurityManager</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Default no-arg constructor.</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></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="#afterCacheManagerSet()">afterCacheManagerSet</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Simply calls <a href="#applyCacheManagerToRealms()"><code>applyCacheManagerToRealms()</code></a> to allow the |
| newly set <a href="../cache/CacheManager.html" title="interface in org.apache.shiro.cache"><code>CacheManager</code></a> to be propagated to the internal collection of <code>Realm</code> |
| that would need to use it.</div> |
| </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="#afterEventBusSet()">afterEventBusSet</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Template callback to notify subclasses that an <a href="../event/EventBus.html" title="interface in org.apache.shiro.event"><code>EventBus</code></a> has been set and is available for use |
| via the <a href="CachingSecurityManager.html#getEventBus()"><code>getEventBus()</code></a> method.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#afterRealmsSet()">afterRealmsSet</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#applyCacheManagerToRealms()">applyCacheManagerToRealms</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the internal <a href="CachingSecurityManager.html#getCacheManager()"><code>CacheManager</code></a> on any internal configured |
| <a href="#getRealms()"><code>Realms</code></a> that implement the <a href="../cache/CacheManagerAware.html" title="interface in org.apache.shiro.cache"><code>CacheManagerAware</code></a> interface.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#applyEventBusToRealms()">applyEventBusToRealms</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the internal <a href="CachingSecurityManager.html#getEventBus()"><code>EventBus</code></a> on any internal configured |
| <a href="#getRealms()"><code>Realms</code></a> that implement the <a href="../event/EventBusAware.html" title="interface in org.apache.shiro.event"><code>EventBusAware</code></a> interface.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#destroy()">destroy</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Destroys the <a href="CachingSecurityManager.html#getCacheManager()"><code>cacheManager</code></a> via <a href="../util/LifecycleUtils.html#destroy(java.lang.Object)"><code>LifecycleUtils.destroy</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><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>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRealms()">getRealms</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the <a href="../realm/Realm.html" title="interface in org.apache.shiro.realm"><code>Realm</code></a>s managed by this SecurityManager instance.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRealm(org.apache.shiro.realm.Realm)">setRealm</a></span>​(<a href="../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm)</code></th> |
| <td class="colLast"> |
| <div class="block">Convenience method for applications using a single realm that merely wraps the realm in a list and then invokes |
| the <a href="#setRealms(java.util.Collection)"><code>setRealms(java.util.Collection<org.apache.shiro.realm.Realm>)</code></a> method.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRealms(java.util.Collection)">setRealms</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">Sets the realms managed by this <tt>SecurityManager</tt> instance.</div> |
| </td> |
| </tr> |
| </table> |
| <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> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.authc.Authenticator"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.shiro.authc.<a href="../authc/Authenticator.html" title="interface in org.apache.shiro.authc">Authenticator</a></h3> |
| <code><a href="../authc/Authenticator.html#authenticate(org.apache.shiro.authc.AuthenticationToken)">authenticate</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.authz.Authorizer"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.shiro.authz.<a href="../authz/Authorizer.html" title="interface in org.apache.shiro.authz">Authorizer</a></h3> |
| <code><a href="../authz/Authorizer.html#checkPermission(org.apache.shiro.subject.PrincipalCollection,java.lang.String)">checkPermission</a>, <a href="../authz/Authorizer.html#checkPermission(org.apache.shiro.subject.PrincipalCollection,org.apache.shiro.authz.Permission)">checkPermission</a>, <a href="../authz/Authorizer.html#checkPermissions(org.apache.shiro.subject.PrincipalCollection,java.lang.String...)">checkPermissions</a>, <a href="../authz/Authorizer.html#checkPermissions(org.apache.shiro.subject.PrincipalCollection,java.util.Collection)">checkPermissions</a>, <a href="../authz/Authorizer.html#checkRole(org.apache.shiro.subject.PrincipalCollection,java.lang.String)">checkRole</a>, <a href="../authz/Authorizer.html#checkRoles(org.apache.shiro.subject.PrincipalCollection,java.lang.String...)">checkRoles</a>, <a href="../authz/Authorizer.html#checkRoles(org.apache.shiro.subject.PrincipalCollection,java.util.Collection)">checkRoles</a>, <a href="../authz/Authorizer.html#hasAllRoles(org.apache.shiro.subject.PrincipalCollection,java.util.Collection)">hasAllRoles</a>, <a href="../authz/Authorizer.html#hasRole(org.apache.shiro.subject.PrincipalCollection,java.lang.String)">hasRole</a>, <a href="../authz/Authorizer.html#hasRoles(org.apache.shiro.subject.PrincipalCollection,java.util.List)">hasRoles</a>, <a href="../authz/Authorizer.html#isPermitted(org.apache.shiro.subject.PrincipalCollection,java.lang.String)">isPermitted</a>, <a href="../authz/Authorizer.html#isPermitted(org.apache.shiro.subject.PrincipalCollection,java.lang.String...)">isPermitted</a>, <a href="../authz/Authorizer.html#isPermitted(org.apache.shiro.subject.PrincipalCollection,java.util.List)">isPermitted</a>, <a href="../authz/Authorizer.html#isPermitted(org.apache.shiro.subject.PrincipalCollection,org.apache.shiro.authz.Permission)">isPermitted</a>, <a href="../authz/Authorizer.html#isPermittedAll(org.apache.shiro.subject.PrincipalCollection,java.lang.String...)">isPermittedAll</a>, <a href="../authz/Authorizer.html#isPermittedAll(org.apache.shiro.subject.PrincipalCollection,java.util.Collection)">isPermittedAll</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.mgt.SecurityManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.shiro.mgt.<a href="SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a></h3> |
| <code><a href="SecurityManager.html#createSubject(org.apache.shiro.subject.SubjectContext)">createSubject</a>, <a href="SecurityManager.html#login(org.apache.shiro.subject.Subject,org.apache.shiro.authc.AuthenticationToken)">login</a>, <a href="SecurityManager.html#logout(org.apache.shiro.subject.Subject)">logout</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.session.mgt.SessionManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.shiro.session.mgt.<a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt">SessionManager</a></h3> |
| <code><a href="../session/mgt/SessionManager.html#getSession(org.apache.shiro.session.mgt.SessionKey)">getSession</a>, <a href="../session/mgt/SessionManager.html#start(org.apache.shiro.session.mgt.SessionContext)">start</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= 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="blockListLast"> |
| <li class="blockList"> |
| <h4>RealmSecurityManager</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/mgt/RealmSecurityManager.html#line.49">RealmSecurityManager</a>()</pre> |
| <div class="block">Default no-arg constructor.</div> |
| </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="setRealm(org.apache.shiro.realm.Realm)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRealm</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/mgt/RealmSecurityManager.html#line.60">setRealm</a>​(<a href="../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a> realm)</pre> |
| <div class="block">Convenience method for applications using a single realm that merely wraps the realm in a list and then invokes |
| the <a href="#setRealms(java.util.Collection)"><code>setRealms(java.util.Collection<org.apache.shiro.realm.Realm>)</code></a> method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>realm</code> - the realm to set for a single-realm application.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setRealms(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRealms</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/mgt/RealmSecurityManager.html#line.75">setRealms</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">Sets the realms managed by this <tt>SecurityManager</tt> instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>realms</code> - the realms managed by this <tt>SecurityManager</tt> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if the realms collection is null or empty.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="afterRealmsSet()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>afterRealmsSet</h4> |
| <pre class="methodSignature">protected void <a href="../../../../src-html/org/apache/shiro/mgt/RealmSecurityManager.html#line.86">afterRealmsSet</a>()</pre> |
| </li> |
| </ul> |
| <a id="getRealms()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRealms</h4> |
| <pre class="methodSignature">public <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>> <a href="../../../../src-html/org/apache/shiro/mgt/RealmSecurityManager.html#line.96">getRealms</a>()</pre> |
| <div class="block">Returns the <a href="../realm/Realm.html" title="interface in org.apache.shiro.realm"><code>Realm</code></a>s managed by this SecurityManager instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../realm/Realm.html" title="interface in org.apache.shiro.realm"><code>Realm</code></a>s managed by this SecurityManager instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="applyCacheManagerToRealms()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>applyCacheManagerToRealms</h4> |
| <pre class="methodSignature">protected void <a href="../../../../src-html/org/apache/shiro/mgt/RealmSecurityManager.html#line.112">applyCacheManagerToRealms</a>()</pre> |
| <div class="block">Sets the internal <a href="CachingSecurityManager.html#getCacheManager()"><code>CacheManager</code></a> on any internal configured |
| <a href="#getRealms()"><code>Realms</code></a> that implement the <a href="../cache/CacheManagerAware.html" title="interface in org.apache.shiro.cache"><code>CacheManagerAware</code></a> interface. |
| <p/> |
| This method is called after setting a cacheManager on this securityManager via the |
| <a href="CachingSecurityManager.html#setCacheManager(org.apache.shiro.cache.CacheManager)"><code>setCacheManager</code></a> method to allow it to be propagated |
| down to all the internal Realms that would need to use it. |
| <p/> |
| It is also called after setting one or more realms via the <a href="#setRealm(org.apache.shiro.realm.Realm)"><code>setRealm</code></a> or |
| <a href="#setRealms(java.util.Collection)"><code>setRealms</code></a> methods to allow these newly available realms to be given the cache manager |
| already in use.</div> |
| </li> |
| </ul> |
| <a id="applyEventBusToRealms()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>applyEventBusToRealms</h4> |
| <pre class="methodSignature">protected void <a href="../../../../src-html/org/apache/shiro/mgt/RealmSecurityManager.html#line.138">applyEventBusToRealms</a>()</pre> |
| <div class="block">Sets the internal <a href="CachingSecurityManager.html#getEventBus()"><code>EventBus</code></a> on any internal configured |
| <a href="#getRealms()"><code>Realms</code></a> that implement the <a href="../event/EventBusAware.html" title="interface in org.apache.shiro.event"><code>EventBusAware</code></a> interface. |
| <p/> |
| This method is called after setting an eventBus on this securityManager via the |
| <a href="CachingSecurityManager.html#setEventBus(org.apache.shiro.event.EventBus)"><code>setEventBus</code></a> method to allow it to be propagated |
| down to all the internal Realms that would need to use it. |
| <p/> |
| It is also called after setting one or more realms via the <a href="#setRealm(org.apache.shiro.realm.Realm)"><code>setRealm</code></a> or |
| <a href="#setRealms(java.util.Collection)"><code>setRealms</code></a> methods to allow these newly available realms to be given the EventBus |
| already in use.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.3</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="afterCacheManagerSet()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>afterCacheManagerSet</h4> |
| <pre class="methodSignature">protected void <a href="../../../../src-html/org/apache/shiro/mgt/RealmSecurityManager.html#line.155">afterCacheManagerSet</a>()</pre> |
| <div class="block">Simply calls <a href="#applyCacheManagerToRealms()"><code>applyCacheManagerToRealms()</code></a> to allow the |
| newly set <a href="../cache/CacheManager.html" title="interface in org.apache.shiro.cache"><code>CacheManager</code></a> to be propagated to the internal collection of <code>Realm</code> |
| that would need to use it.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="CachingSecurityManager.html#afterCacheManagerSet()">afterCacheManagerSet</a></code> in class <code><a href="CachingSecurityManager.html" title="class in org.apache.shiro.mgt">CachingSecurityManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="afterEventBusSet()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>afterEventBusSet</h4> |
| <pre class="methodSignature">protected void <a href="../../../../src-html/org/apache/shiro/mgt/RealmSecurityManager.html#line.160">afterEventBusSet</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="CachingSecurityManager.html#afterEventBusSet()">CachingSecurityManager</a></code></span></div> |
| <div class="block">Template callback to notify subclasses that an <a href="../event/EventBus.html" title="interface in org.apache.shiro.event"><code>EventBus</code></a> has been set and is available for use |
| via the <a href="CachingSecurityManager.html#getEventBus()"><code>getEventBus()</code></a> method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="CachingSecurityManager.html#afterEventBusSet()">afterEventBusSet</a></code> in class <code><a href="CachingSecurityManager.html" title="class in org.apache.shiro.mgt">CachingSecurityManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="destroy()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>destroy</h4> |
| <pre class="methodSignature">public void <a href="../../../../src-html/org/apache/shiro/mgt/RealmSecurityManager.html#line.166">destroy</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="CachingSecurityManager.html#destroy()">CachingSecurityManager</a></code></span></div> |
| <div class="block">Destroys the <a href="CachingSecurityManager.html#getCacheManager()"><code>cacheManager</code></a> via <a href="../util/LifecycleUtils.html#destroy(java.lang.Object)"><code>LifecycleUtils.destroy</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../util/Destroyable.html#destroy()">destroy</a></code> in interface <code><a href="../util/Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="CachingSecurityManager.html#destroy()">destroy</a></code> in class <code><a href="CachingSecurityManager.html" title="class in org.apache.shiro.mgt">CachingSecurityManager</a></code></dd> |
| </dl> |
| </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/RealmSecurityManager.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>Field | </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>Field | </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> |
