Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.7.0 / shiro-cache / apidocs / index-all.html
blob: 20b8b46109e051295e911b4087be1ac7c39b775c [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="fr">
<head>
<!-- Generated by javadoc (11.0.8) on Wed Oct 28 15:57:14 CET 2020 -->
<title>Index (Apache Shiro :: Cache 1.7.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-10-28">
<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="Index (Apache Shiro :: Cache 1.7.0 API)";
}
}
catch(err) {
}
//-->
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="org/apache/shiro/cache/package-summary.html">Package</a></li>
<li>Class</li>
<li>Use</li>
<li><a href="org/apache/shiro/cache/package-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</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&nbsp;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>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="contentContainer"><a href="#I:A">A</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:D">D</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:K">K</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:T">T</a>&nbsp;<a href="#I:V">V</a>&nbsp;<br><a href="allclasses-index.html">All&nbsp;Classes</a>&nbsp;<a href="allpackages-index.html">All&nbsp;Packages</a><a id="I:A">
<!-- -->
</a>
<h2 class="title">A</h2>
<dl>
<dt><a href="org/apache/shiro/cache/AbstractCacheManager.html" title="class in org.apache.shiro.cache"><span class="typeNameLink">AbstractCacheManager</span></a> - Class in <a href="org/apache/shiro/cache/package-summary.html">org.apache.shiro.cache</a></dt>
<dd>
<div class="block">Very simple abstract <code>CacheManager</code> implementation that retains all created <a href="org/apache/shiro/cache/Cache.html" title="interface in org.apache.shiro.cache"><code>Cache</code></a> instances in
an in-memory <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>ConcurrentMap</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/AbstractCacheManager.html#%3Cinit%3E()">AbstractCacheManager()</a></span> - Constructor for class org.apache.shiro.cache.<a href="org/apache/shiro/cache/AbstractCacheManager.html" title="class in org.apache.shiro.cache">AbstractCacheManager</a></dt>
<dd>
<div class="block">Default no-arg constructor that instantiates an internal name-to-cache <code>ConcurrentMap</code>.</div>
</dd>
</dl>
<a id="I:C">
<!-- -->
</a>
<h2 class="title">C</h2>
<dl>
<dt><a href="org/apache/shiro/cache/Cache.html" title="interface in org.apache.shiro.cache"><span class="typeNameLink">Cache</span></a>&lt;<a href="org/apache/shiro/cache/Cache.html" title="type parameter in Cache">K</a>,&#8203;<a href="org/apache/shiro/cache/Cache.html" title="type parameter in Cache">V</a>&gt; - Interface in <a href="org/apache/shiro/cache/package-summary.html">org.apache.shiro.cache</a></dt>
<dd>
<div class="block">A Cache efficiently stores temporary objects primarily to improve an application's performance.</div>
</dd>
<dt><a href="org/apache/shiro/cache/CacheException.html" title="class in org.apache.shiro.cache"><span class="typeNameLink">CacheException</span></a> - Exception in <a href="org/apache/shiro/cache/package-summary.html">org.apache.shiro.cache</a></dt>
<dd>
<div class="block">Root class of all Shiro exceptions related to caching operations.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/CacheException.html#%3Cinit%3E()">CacheException()</a></span> - Constructor for exception org.apache.shiro.cache.<a href="org/apache/shiro/cache/CacheException.html" title="class in org.apache.shiro.cache">CacheException</a></dt>
<dd>
<div class="block">Creates a new <code>CacheException</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/CacheException.html#%3Cinit%3E(java.lang.String)">CacheException(String)</a></span> - Constructor for exception org.apache.shiro.cache.<a href="org/apache/shiro/cache/CacheException.html" title="class in org.apache.shiro.cache">CacheException</a></dt>
<dd>
<div class="block">Creates a new <code>CacheException</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/CacheException.html#%3Cinit%3E(java.lang.String,java.lang.Throwable)">CacheException(String, Throwable)</a></span> - Constructor for exception org.apache.shiro.cache.<a href="org/apache/shiro/cache/CacheException.html" title="class in org.apache.shiro.cache">CacheException</a></dt>
<dd>
<div class="block">Creates a new <code>CacheException</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/CacheException.html#%3Cinit%3E(java.lang.Throwable)">CacheException(Throwable)</a></span> - Constructor for exception org.apache.shiro.cache.<a href="org/apache/shiro/cache/CacheException.html" title="class in org.apache.shiro.cache">CacheException</a></dt>
<dd>
<div class="block">Creates a new <code>CacheException</code>.</div>
</dd>
<dt><a href="org/apache/shiro/cache/CacheManager.html" title="interface in org.apache.shiro.cache"><span class="typeNameLink">CacheManager</span></a> - Interface in <a href="org/apache/shiro/cache/package-summary.html">org.apache.shiro.cache</a></dt>
<dd>
<div class="block">A CacheManager provides and maintains the lifecycles of <a href="org/apache/shiro/cache/Cache.html" title="interface in org.apache.shiro.cache"><code>Cache</code></a> instances.</div>
</dd>
<dt><a href="org/apache/shiro/cache/CacheManagerAware.html" title="interface in org.apache.shiro.cache"><span class="typeNameLink">CacheManagerAware</span></a> - Interface in <a href="org/apache/shiro/cache/package-summary.html">org.apache.shiro.cache</a></dt>
<dd>
<div class="block">Interface implemented by components that utilize a CacheManager and wish that CacheManager to be supplied if
one is available.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/Cache.html#clear()">clear()</a></span> - Method in interface org.apache.shiro.cache.<a href="org/apache/shiro/cache/Cache.html" title="interface in org.apache.shiro.cache">Cache</a></dt>
<dd>
<div class="block">Clear all entries from the cache.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/MapCache.html#clear()">clear()</a></span> - Method in class org.apache.shiro.cache.<a href="org/apache/shiro/cache/MapCache.html" title="class in org.apache.shiro.cache">MapCache</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/AbstractCacheManager.html#createCache(java.lang.String)">createCache(String)</a></span> - Method in class org.apache.shiro.cache.<a href="org/apache/shiro/cache/AbstractCacheManager.html" title="class in org.apache.shiro.cache">AbstractCacheManager</a></dt>
<dd>
<div class="block">Creates a new <code>Cache</code> instance associated with the specified <code>name</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/MemoryConstrainedCacheManager.html#createCache(java.lang.String)">createCache(String)</a></span> - Method in class org.apache.shiro.cache.<a href="org/apache/shiro/cache/MemoryConstrainedCacheManager.html" title="class in org.apache.shiro.cache">MemoryConstrainedCacheManager</a></dt>
<dd>
<div class="block">Returns a new <a href="org/apache/shiro/cache/MapCache.html" title="class in org.apache.shiro.cache"><code>MapCache</code></a> instance backed by a <code>SoftHashMap</code>.</div>
</dd>
</dl>
<a id="I:D">
<!-- -->
</a>
<h2 class="title">D</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/AbstractCacheManager.html#destroy()">destroy()</a></span> - Method in class org.apache.shiro.cache.<a href="org/apache/shiro/cache/AbstractCacheManager.html" title="class in org.apache.shiro.cache">AbstractCacheManager</a></dt>
<dd>
<div class="block">Cleanup method that first <code>destroys</code> all of it's managed caches and then
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#clear()" title="class or interface in java.util" class="externalLink"><code>clears</code></a> out the internally referenced cache map.</div>
</dd>
</dl>
<a id="I:G">
<!-- -->
</a>
<h2 class="title">G</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/Cache.html#get(K)">get(K)</a></span> - Method in interface org.apache.shiro.cache.<a href="org/apache/shiro/cache/Cache.html" title="interface in org.apache.shiro.cache">Cache</a></dt>
<dd>
<div class="block">Returns the Cached value stored under the specified <code>key</code> or
<code>null</code> if there is no Cache entry for that <code>key</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/MapCache.html#get(K)">get(K)</a></span> - Method in class org.apache.shiro.cache.<a href="org/apache/shiro/cache/MapCache.html" title="class in org.apache.shiro.cache">MapCache</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/AbstractCacheManager.html#getCache(java.lang.String)">getCache(String)</a></span> - Method in class org.apache.shiro.cache.<a href="org/apache/shiro/cache/AbstractCacheManager.html" title="class in org.apache.shiro.cache">AbstractCacheManager</a></dt>
<dd>
<div class="block">Returns the cache with the specified <code>name</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/CacheManager.html#getCache(java.lang.String)">getCache(String)</a></span> - Method in interface org.apache.shiro.cache.<a href="org/apache/shiro/cache/CacheManager.html" title="interface in org.apache.shiro.cache">CacheManager</a></dt>
<dd>
<div class="block">Acquires the cache with the specified <code>name</code>.</div>
</dd>
</dl>
<a id="I:K">
<!-- -->
</a>
<h2 class="title">K</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/Cache.html#keys()">keys()</a></span> - Method in interface org.apache.shiro.cache.<a href="org/apache/shiro/cache/Cache.html" title="interface in org.apache.shiro.cache">Cache</a></dt>
<dd>
<div class="block">Returns a view of all the keys for entries contained in this cache.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/MapCache.html#keys()">keys()</a></span> - Method in class org.apache.shiro.cache.<a href="org/apache/shiro/cache/MapCache.html" title="class in org.apache.shiro.cache">MapCache</a></dt>
<dd>&nbsp;</dd>
</dl>
<a id="I:M">
<!-- -->
</a>
<h2 class="title">M</h2>
<dl>
<dt><a href="org/apache/shiro/cache/MapCache.html" title="class in org.apache.shiro.cache"><span class="typeNameLink">MapCache</span></a>&lt;<a href="org/apache/shiro/cache/MapCache.html" title="type parameter in MapCache">K</a>,&#8203;<a href="org/apache/shiro/cache/MapCache.html" title="type parameter in MapCache">V</a>&gt; - Class in <a href="org/apache/shiro/cache/package-summary.html">org.apache.shiro.cache</a></dt>
<dd>
<div class="block">A <code>MapCache</code> is a <a href="org/apache/shiro/cache/Cache.html" title="interface in org.apache.shiro.cache"><code>Cache</code></a> implementation that uses a backing <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a> instance to store
and retrieve cached data.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/MapCache.html#%3Cinit%3E(java.lang.String,java.util.Map)">MapCache(String, Map&lt;K, V&gt;)</a></span> - Constructor for class org.apache.shiro.cache.<a href="org/apache/shiro/cache/MapCache.html" title="class in org.apache.shiro.cache">MapCache</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/shiro/cache/MemoryConstrainedCacheManager.html" title="class in org.apache.shiro.cache"><span class="typeNameLink">MemoryConstrainedCacheManager</span></a> - Class in <a href="org/apache/shiro/cache/package-summary.html">org.apache.shiro.cache</a></dt>
<dd>
<div class="block">Simple memory-only based <a href="org/apache/shiro/cache/CacheManager.html" title="interface in org.apache.shiro.cache"><code>CacheManager</code></a> implementation usable in production
environments.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/MemoryConstrainedCacheManager.html#%3Cinit%3E()">MemoryConstrainedCacheManager()</a></span> - Constructor for class org.apache.shiro.cache.<a href="org/apache/shiro/cache/MemoryConstrainedCacheManager.html" title="class in org.apache.shiro.cache">MemoryConstrainedCacheManager</a></dt>
<dd>&nbsp;</dd>
</dl>
<a id="I:O">
<!-- -->
</a>
<h2 class="title">O</h2>
<dl>
<dt><a href="org/apache/shiro/cache/package-summary.html">org.apache.shiro.cache</a> - package org.apache.shiro.cache</dt>
<dd>
<div class="block">Caching support used to enhance performance for security operations.</div>
</dd>
</dl>
<a id="I:P">
<!-- -->
</a>
<h2 class="title">P</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/Cache.html#put(K,V)">put(K, V)</a></span> - Method in interface org.apache.shiro.cache.<a href="org/apache/shiro/cache/Cache.html" title="interface in org.apache.shiro.cache">Cache</a></dt>
<dd>
<div class="block">Adds a Cache entry.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/MapCache.html#put(K,V)">put(K, V)</a></span> - Method in class org.apache.shiro.cache.<a href="org/apache/shiro/cache/MapCache.html" title="class in org.apache.shiro.cache">MapCache</a></dt>
<dd>&nbsp;</dd>
</dl>
<a id="I:R">
<!-- -->
</a>
<h2 class="title">R</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/Cache.html#remove(K)">remove(K)</a></span> - Method in interface org.apache.shiro.cache.<a href="org/apache/shiro/cache/Cache.html" title="interface in org.apache.shiro.cache">Cache</a></dt>
<dd>
<div class="block">Remove the cache entry corresponding to the specified key.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/MapCache.html#remove(K)">remove(K)</a></span> - Method in class org.apache.shiro.cache.<a href="org/apache/shiro/cache/MapCache.html" title="class in org.apache.shiro.cache">MapCache</a></dt>
<dd>&nbsp;</dd>
</dl>
<a id="I:S">
<!-- -->
</a>
<h2 class="title">S</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/CacheManagerAware.html#setCacheManager(org.apache.shiro.cache.CacheManager)">setCacheManager(CacheManager)</a></span> - Method in interface org.apache.shiro.cache.<a href="org/apache/shiro/cache/CacheManagerAware.html" title="interface in org.apache.shiro.cache">CacheManagerAware</a></dt>
<dd>
<div class="block">Sets the available CacheManager instance on this component.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/Cache.html#size()">size()</a></span> - Method in interface org.apache.shiro.cache.<a href="org/apache/shiro/cache/Cache.html" title="interface in org.apache.shiro.cache">Cache</a></dt>
<dd>
<div class="block">Returns the number of entries in the cache.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/MapCache.html#size()">size()</a></span> - Method in class org.apache.shiro.cache.<a href="org/apache/shiro/cache/MapCache.html" title="class in org.apache.shiro.cache">MapCache</a></dt>
<dd>&nbsp;</dd>
</dl>
<a id="I:T">
<!-- -->
</a>
<h2 class="title">T</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/AbstractCacheManager.html#toString()">toString()</a></span> - Method in class org.apache.shiro.cache.<a href="org/apache/shiro/cache/AbstractCacheManager.html" title="class in org.apache.shiro.cache">AbstractCacheManager</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/MapCache.html#toString()">toString()</a></span> - Method in class org.apache.shiro.cache.<a href="org/apache/shiro/cache/MapCache.html" title="class in org.apache.shiro.cache">MapCache</a></dt>
<dd>&nbsp;</dd>
</dl>
<a id="I:V">
<!-- -->
</a>
<h2 class="title">V</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/Cache.html#values()">values()</a></span> - Method in interface org.apache.shiro.cache.<a href="org/apache/shiro/cache/Cache.html" title="interface in org.apache.shiro.cache">Cache</a></dt>
<dd>
<div class="block">Returns a view of all of the values contained in this cache.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/MapCache.html#values()">values()</a></span> - Method in class org.apache.shiro.cache.<a href="org/apache/shiro/cache/MapCache.html" title="class in org.apache.shiro.cache">MapCache</a></dt>
<dd>&nbsp;</dd>
</dl>
<a href="#I:A">A</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:D">D</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:K">K</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:T">T</a>&nbsp;<a href="#I:V">V</a>&nbsp;<br><a href="allclasses-index.html">All&nbsp;Classes</a>&nbsp;<a href="allpackages-index.html">All&nbsp;Packages</a></div>
</main>
<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="org/apache/shiro/cache/package-summary.html">Package</a></li>
<li>Class</li>
<li>Use</li>
<li><a href="org/apache/shiro/cache/package-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</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&nbsp;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>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>