You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@shiro.apache.org by bd...@apache.org on 2018/05/04 19:40:09 UTC
svn commit: r1830941 - in /shiro/site/publish: cachemanager.html
caching.html realm.html
Author: bdemers
Date: Fri May 4 19:40:09 2018
New Revision: 1830941
URL: http://svn.apache.org/viewvc?rev=1830941&view=rev
Log:
merging shiro site pr-36
Modified:
shiro/site/publish/cachemanager.html
shiro/site/publish/caching.html
shiro/site/publish/realm.html
Modified: shiro/site/publish/cachemanager.html
URL: http://svn.apache.org/viewvc/shiro/site/publish/cachemanager.html?rev=1830941&r1=1830940&r2=1830941&view=diff
==============================================================================
--- shiro/site/publish/cachemanager.html (original)
+++ shiro/site/publish/cachemanager.html Fri May 4 19:40:09 2018
@@ -220,7 +220,7 @@
</nav>
- <h1><a href="#cache-manger" name="cache-manger">Cache Manger</a></h1>
+ <h1><a href="#cache-manager" name="cache-manager">Cache Manager</a></h1>
<p>Shiro has three important cache interfaces:</p>
<ul>
<li>
@@ -232,7 +232,7 @@
</ul>
<p>A <code>CacheManager</code> returns <code>Cache</code> instances and various Shiro components use those <code>Cache<</code> instances to cache data as necessary. Any Shiro<br clear="none"><br/>component that implements <code>CacheManager</code> will automatically receive a configured <code>CacheManager</code>, where it can be used to acquire <code>Cache</code> instances.</p>
<p>The Shiro <a href="securitymanager.html"><code>SecurityManager</code></a> implementations and all <a href="static/current/apidocs/org/apache/shiro/realm/AuthorizingRealm.html"><code>AuthorizingRealm</code></a> implementations implement CacheManagerAware. If you set the <code>CacheManager</code> on the <code>SecurityManager</code>, it will in turn set it on the various Realms that implement CacheManagerAware as well (OO delegation). For example, in shiro.ini:</p>
-<p><strong>example shiro.ini CacheManger configuration</strong></p>
+<p><strong>example shiro.ini CacheManager configuration</strong></p>
<pre><code class="ini"><br/>securityManager.realms = $myRealm1, $myRealm2, ..., $myRealmN
...
cacheManager = my.implementation.of.CacheManager
Modified: shiro/site/publish/caching.html
URL: http://svn.apache.org/viewvc/shiro/site/publish/caching.html?rev=1830941&r1=1830940&r2=1830941&view=diff
==============================================================================
--- shiro/site/publish/caching.html (original)
+++ shiro/site/publish/caching.html Fri May 4 19:40:09 2018
@@ -234,7 +234,7 @@
</ul>
<p>A <code>CacheManager</code> returns <code>Cache</code> instances and various Shiro components use those <code>Cache</code> instances to cache data as necessary. Any Shiro<br/>component that implements <code>CacheManagerAware</code> will automatically receive a configured <code>CacheManager</code>, where it can be used to acquire <code>Cache</code> instances.</p>
<p>The Shiro <a href="securitymanager.html" title="SecurityManager">SecurityManager</a> implementations and all <a href="static/current/apidocs/org/apache/shiro/realm/AuthenticatingRealm.html"><code>AuthenticatingRealm</code></a> and <a href="static/current/apidocs/org/apache/shiro/realm/AuthorizingRealm.html"><code>AuthorizingRealm</code></a> implementations implement CacheManagerAware. If you set the <code>CacheManager</code> on the <code>SecurityManager</code>, it will in turn set it on the various Realms that implement CacheManagerAware as well (OO delegation). For example, in shiro.ini:</p>
-<p><strong>example shiro.ini CacheManger configuration</strong></p>
+<p><strong>example shiro.ini CacheManager configuration</strong></p>
<pre><code class="ini">securityManager.realms = $myRealm1, $myRealm2, ..., $myRealmN
...
cacheManager = my.implementation.of.CacheManager
@@ -251,7 +251,7 @@ securityManager.cacheManager = $cacheMan
<p>The <a href="static/current/apidocs/org/apache/shiro/cache/MemoryConstrainedCacheManager.html"><code>MemoryConstrainedCacheManager</code></a> is a <code>CacheManager</code> implementation suitable for single-JVM production environments. It is not clustered/distributed, so if your application spans across more than one JVM (e.g. web app running on multiple web servers), and you want cache entries to be accessible across JVMs, you will need to use a distributed cache implementation instead.</p>
<p>The <code>MemoryConstrainedCacheManager</code> manages <a href="static/current/apidocs/org/apache/shiro/cache/MapCache.html"><code>MapCache</code></a> instances, one <code>MapCache</code> instance per named cache. Each <code>MapCache</code> instance is backed by a Shiro <a href="static/current/apidocs/org/apache/shiro/util/SoftHashMap.html"><code>SoftHashMap</code></a> which can auto-resize itself based on an application’s runtime memory constraints/needs (by leveraging JDK <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/ref/SoftReference.html"><code>SoftReference</code></a> instances).</p>
<p>Because the <code>MemoryConstrainedCacheManager</code> can auto-resize itself based on an application’s memory profile, it is safe to use in a single-JVM production application as well as for testing needs. However, it does not have more advanced features suche as cache entry Time-to-Live or Time-to-Expire settings. For these more advanced cache management features, you’ll likely want to use one of the more advanced <code>CacheManager</code> offerings below.</p>
-<p><strong>MemoryConstrainedCacheManger shiro.ini configuration example</strong></p>
+<p><strong>MemoryConstrainedCacheManager shiro.ini configuration example</strong></p>
<pre><code class="ini">...
cacheManager = org.apache.shiro.cache.MemoryConstrainedCacheManager
...
Modified: shiro/site/publish/realm.html
URL: http://svn.apache.org/viewvc/shiro/site/publish/realm.html?rev=1830941&r1=1830940&r2=1830941&view=diff
==============================================================================
--- shiro/site/publish/realm.html (original)
+++ shiro/site/publish/realm.html Fri May 4 19:40:09 2018
@@ -423,8 +423,8 @@ myRealm.credentialsMatcher = $credential
<h5><a href="#role-based-authorization" name="role-based-authorization">Role based Authorization</a></h5>
<p>When one of the overloaded method hasRoles or checkRoles method is called on Subject</p>
<ol>
- <li><code>Subject</code> delegates to <code>SecurityManger</code> for identifying if the given Role is assigned</li>
- <li><code>SecurityManger</code> then delegates to <code>Authorizer</code></li>
+ <li><code>Subject</code> delegates to <code>SecurityManager</code> for identifying if the given Role is assigned</li>
+ <li><code>SecurityManager</code> then delegates to <code>Authorizer</code></li>
<li><a href="static/current/apidocs/org/apache/shiro/authz/Authorizer.html">Authorizer</a> then referrers to all the Authorizing Realms one by one until it found given role assigned to the subject. Deny access by returning false if no none of the Realm grants Subject given Role</li>
<li>Authorizing Realm <a href="static/current/apidocs/org/apache/shiro/authz/AuthorizationInfo.html">AuthorizationInfo</a> getRoles() method to get all Roles assigned to Subject</li>
<li>Grant access if it found the given Role in list of roles returned from AuthorizationInfo.getRoles call.</li>
@@ -433,8 +433,8 @@ myRealm.credentialsMatcher = $credential
<h5><a href="#permission-based-authorization" name="permission-based-authorization">Permission based Authorization</a></h5>
<p>When one of the overloaded method <code>isPermitted()</code> or <code>checkPermission()</code> method are called on Subject:</p>
<ol>
- <li><code>Subject</code> delegates the task to grant or deny Permission to SecurityManger</li>
- <li><code>SecurityManger</code> then delegates to Authorizer</li>
+ <li><code>Subject</code> delegates the task to grant or deny Permission to SecurityManager</li>
+ <li><code>SecurityManager</code> then delegates to Authorizer</li>
<li>Authorizer then referrers to all of the Authorizer Realms one by one until it Permission is granted<br/>If Permission is not granted by any of the Authorizing Realm, Subject is denied Permission</li>
<li>Authorizing Realm does the following in order to check if a Subject is permitted:
<p>a. First it gets identify all Permissions assigned to Subject directly by calling getObjectPermissions() and getStringPermissions methods on <a href="static/current/apidocs/org/apache/shiro/authz/AuthorizationInfo.html">AuthorizationInfo</a> and aggregating the results.</p>