blob: f6652c6021b7ddcd353ba63cf243a0eb811f1417 [file]
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>grails.plugin.cache (Grails 7.0.9)</title>
<meta name="keywords" content="grails.plugin.cache package">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" title="Style">
<link href="../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
<link href="../../../groovy.ico" type="image/x-icon" rel="icon">
<script type="text/javascript">
function windowTitle()
{
parent.document.title="grails.plugin.cache (Grails 7.0.9)";
}
</script>
<noscript>
</noscript>
</head>
<body class="center" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<a name="navbar_top_firstrow"><!-- --></a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</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">
<li><a href="../../../index.html?grails/plugin/cache/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No Frames</a></li>
</ul>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 class="title">Package grails.plugin.cache</h1>
</div>
<div class="contentContainer">
<div class="summary">
<ul class="blockList">
<li class="blockList">
<table border="0" cellpadding="3" cellspacing="0" summary="Interface Summary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tbody>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colOne">
<strong><a href="GrailsCache.html" title="class in grails/plugin/cache">
GrailsCache
</a></strong>
</td>
<td> <DL><DT><B>Authors:</B></DT><DD>Burt Beckwith</DD></DL></td>
</tr>
<tr class="altColor">
<td class="colOne">
<strong><a href="GrailsCacheKeyGenerator.html" title="class in grails/plugin/cache">
GrailsCacheKeyGenerator
</a></strong>
</td>
<td>Generates a cache key for the given arguments</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<table border="0" cellpadding="3" cellspacing="0" summary="Class Summary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tbody>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colOne">
<strong><a href="CacheGrailsPlugin.html" title="class in grails/plugin/cache">
CacheGrailsPlugin
</a></strong>
</td>
<td></td>
</tr>
<tr class="altColor">
<td class="colOne">
<strong><a href="CachePluginConfiguration.html" title="class in grails/plugin/cache">
CachePluginConfiguration
</a></strong>
</td>
<td>Configuration properties for the cache plugin</td>
</tr>
<tr class="altColor">
<td class="colOne">
<strong><a href="CachePluginConfiguration.CacheConfig.html" title="class in grails/plugin/cache">
CachePluginConfiguration.CacheConfig
</a></strong>
</td>
<td></td>
</tr>
<tr class="altColor">
<td class="colOne">
<strong><a href="CustomCacheKeyGenerator.html" title="class in grails/plugin/cache">
CustomCacheKeyGenerator
</a></strong>
</td>
<td>Includes the hashcode, method signature, and class name of the target (caller) in the cache key</td>
</tr>
<tr class="altColor">
<td class="colOne">
<strong><a href="GrailsCacheAdminService.html" title="class in grails/plugin/cache">
GrailsCacheAdminService
</a></strong>
</td>
<td></td>
</tr>
<tr class="altColor">
<td class="colOne">
<strong><a href="GrailsConcurrentLinkedMapCache.html" title="class in grails/plugin/cache">
GrailsConcurrentLinkedMapCache
</a></strong>
</td>
<td> <DL><DT><B>Authors:</B></DT><DD>Jakob Drangmeister</DD></DL></td>
</tr>
<tr class="altColor">
<td class="colOne">
<strong><a href="GrailsConcurrentLinkedMapCacheManager.html" title="class in grails/plugin/cache">
GrailsConcurrentLinkedMapCacheManager
</a></strong>
</td>
<td>Based on com.googlecode.concurrentlinkedhashmap.ConcurrentLinkedHashMap.</td>
</tr>
<tr class="altColor">
<td class="colOne">
<strong><a href="GrailsConcurrentMapCache.html" title="class in grails/plugin/cache">
GrailsConcurrentMapCache
</a></strong>
</td>
<td>Extends the default implementation to return GrailsValueWrapper instances instead of
SimpleValueWrapper. </td>
</tr>
<tr class="altColor">
<td class="colOne">
<strong><a href="GrailsConcurrentMapCacheManager.html" title="class in grails/plugin/cache">
GrailsConcurrentMapCacheManager
</a></strong>
</td>
<td>Based on org.springframework.cache.concurrent.ConcurrentMapCacheManager.</td>
</tr>
<tr class="altColor">
<td class="colOne">
<strong><a href="GrailsValueWrapper.html" title="class in grails/plugin/cache">
GrailsValueWrapper
</a></strong>
</td>
<td>Extends the standard implementation to also include the native wrapper instance.</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<table border="0" cellpadding="3" cellspacing="0" summary="Exception Summary">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tbody>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colOne">
<strong><a href="CacheException.html" title="class in grails/plugin/cache">
CacheException
</a></strong>
</td>
<td>A runtime Cache Exception.
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<table border="0" cellpadding="3" cellspacing="0" summary="Annotation Type Summary">
<caption><span>Annotation Type Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tbody>
<tr>
<th class="colFirst" scope="col">Annotation Type</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colOne">
<strong><a href="CacheEvict.html" title="class in grails/plugin/cache">
CacheEvict
</a></strong>
</td>
<td>Indicates that a method (or all methods on a class) trigger(s)
a cache invalidate operation.</td>
</tr>
<tr class="altColor">
<td class="colOne">
<strong><a href="CacheOperation.html" title="class in grails/plugin/cache">
CacheOperation
</a></strong>
</td>
<td>An annotation added to all methods or types that produce a cache operation.</td>
</tr>
<tr class="altColor">
<td class="colOne">
<strong><a href="CachePut.html" title="class in grails/plugin/cache">
CachePut
</a></strong>
</td>
<td>Indicates that a method (or all methods on a class) trigger(s)
aCache#put(Object, Object) operation. </td>
</tr>
<tr class="altColor">
<td class="colOne">
<strong><a href="Cacheable.html" title="class in grails/plugin/cache">
Cacheable
</a></strong>
</td>
<td>Indicates that a method (or all the methods on a class) can be cached.</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</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">
<div>
<ul class="navList">
<li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li>
<li><a href="deprecated-list.html" target="_top">No Frames</a></li>
</ul>
</div>
<div class="aboutLanguage"><em><!-- Matomo -->
<script>
var _paq = window._paq = window._paq || [];
/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
_paq.push(["setDoNotTrack", true]);
_paq.push(["disableCookies"]);
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
var u="https://analytics.apache.org/";
_paq.push(['setTrackerUrl', u+'matomo.php']);
_paq.push(['setSiteId', '79']);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
})();
</script>
<!-- End Matomo Code --></em></div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>