blob: 35bb06c18e294a496127d94930c19da3decdf049 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fr">
<head>
<!-- Generated by javadoc (1.8.0_201) on Sat Feb 22 18:50:56 CET 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Index (Apache Shiro :: Cache 1.5.1 API)</title>
<meta name="date" content="2020-02-22">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.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.5.1 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="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">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?index-all.html" target="_top">Frames</a></li>
<li><a href="index-all.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<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;<a name="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/6/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent"><code>ConcurrentMap</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/cache/AbstractCacheManager.html#AbstractCacheManager--">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 name="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>,<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#CacheException--">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#CacheException-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#CacheException-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><span class="memberNameLink"><a href="org/apache/shiro/cache/CacheException.html#CacheException-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><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 name="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/6/docs/api/java/util/Map.html?is-external=true#clear--" title="class or interface in java.util"><code>clears</code></a> out the internally referenced cache map.</div>
</dd>
</dl>
<a name="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 name="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 name="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>,<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/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><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#MapCache-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#MemoryConstrainedCacheManager--">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 name="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 name="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 name="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 name="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 name="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 name="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;</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="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">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?index-all.html" target="_top">Frames</a></li>
<li><a href="index-all.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.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>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<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>
</body>
</html>