blob: 7be2acebdce166731b9337f61a79b354133932bb [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<link rel="canonical" href="https://ignite.apache.org/releases/2.1.0/javadoc/org/apache/ignite/cache/CacheInterceptor.html" />
<META NAME="ROBOTS" CONTENT="NOINDEX">
<!-- Generated by javadoc (version 1.7.0_80) on Thu Jul 20 19:37:41 UTC 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CacheInterceptor (Ignite 2.1.0)</title>
<meta name="date" content="2017-07-20">
<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style">
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61232409-1', 'auto');
ga('send', 'pageview');
</script></head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CacheInterceptor (Ignite 2.1.0)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= 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>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CacheInterceptor.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 class="aboutLanguage"><em>Ignite - In-Memory Data Fabric</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/ignite/cache/CacheExistsException.html" title="class in org.apache.ignite.cache"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/ignite/cache/CacheInterceptorAdapter.html" title="class in org.apache.ignite.cache"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/cache/CacheInterceptor.html" target="_top">Frames</a></li>
<li><a href="CacheInterceptor.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All 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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.ignite.cache</div>
<h2 title="Interface CacheInterceptor" class="title">Interface CacheInterceptor&lt;K,V&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/ignite/cache/CacheInterceptorAdapter.html" title="class in org.apache.ignite.cache">CacheInterceptorAdapter</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">CacheInterceptor&lt;K,V&gt;</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">Cache interceptor. Cache interceptor can be used for getting callbacks before
and after cache <code>get(...)</code>, <code>put(...)</code>, and <code>remove(...)</code>
operations. The <code>onBefore</code> callbacks can also be used to change the values
stored in cache or preventing entries from being removed from cache.
<p>
Cache interceptor is configured via <a href="../../../../org/apache/ignite/configuration/CacheConfiguration.html#getInterceptor()"><code>CacheConfiguration.getInterceptor()</code></a>
configuration property.
<p>
Any grid resource from <code>org.apache.ignite.resources</code> package can be injected
into implementation of this interface.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/cache/CacheInterceptor.html#onAfterPut(javax.cache.Cache.Entry)">onAfterPut</a></strong>(javax.cache.Cache.Entry&lt;<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">K</a>,<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">V</a>&gt;&nbsp;entry)</code>
<div class="block">This method is called after new value has been stored.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/cache/CacheInterceptor.html#onAfterRemove(javax.cache.Cache.Entry)">onAfterRemove</a></strong>(javax.cache.Cache.Entry&lt;<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">K</a>,<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">V</a>&gt;&nbsp;entry)</code>
<div class="block">This method is called after value has been removed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">V</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/cache/CacheInterceptor.html#onBeforePut(javax.cache.Cache.Entry,%20V)">onBeforePut</a></strong>(javax.cache.Cache.Entry&lt;<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">K</a>,<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">V</a>&gt;&nbsp;entry,
<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">V</a>&nbsp;newVal)</code>
<div class="block">This method is called within <a href="../../../../org/apache/ignite/IgniteCache.html#put(K,%20V)"><code>IgniteCache.put(Object, Object)</code></a>
and similar operations before new value is stored in cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/lang/IgniteBiTuple.html" title="class in org.apache.ignite.lang">IgniteBiTuple</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>,<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">V</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/cache/CacheInterceptor.html#onBeforeRemove(javax.cache.Cache.Entry)">onBeforeRemove</a></strong>(javax.cache.Cache.Entry&lt;<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">K</a>,<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">V</a>&gt;&nbsp;entry)</code>
<div class="block">This method is called within <a href="../../../../org/apache/ignite/IgniteCache.html#remove(K)"><code>IgniteCache.remove(Object)</code></a>
and similar operations to provide control over returned value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">V</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/cache/CacheInterceptor.html#onGet(K,%20V)">onGet</a></strong>(<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">K</a>&nbsp;key,
<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">V</a>&nbsp;val)</code>
<div class="block">This method is called within <a href="../../../../org/apache/ignite/IgniteCache.html#get(K)"><code>IgniteCache.get(Object)</code></a>
and similar operations to provide control over returned value.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="onGet(java.lang.Object,java.lang.Object)">
<!-- -->
</a><a name="onGet(K, V)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onGet</h4>
<pre>@Nullable
<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">V</a>&nbsp;onGet(<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">K</a>&nbsp;key,
@Nullable
<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">V</a>&nbsp;val)</pre>
<div class="block">This method is called within <a href="../../../../org/apache/ignite/IgniteCache.html#get(K)"><code>IgniteCache.get(Object)</code></a>
and similar operations to provide control over returned value.
<p>
If this method returns <code>null</code>, then <code>get()</code> operation
results in <code>null</code> as well.
<p>
This method should not throw any exception.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - Key.</dd><dd><code>val</code> - Value mapped to <code>key</code> at the moment of <code>get()</code> operation.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The new value to be returned as result of <code>get()</code> operation.</dd><dt><span class="strong">See Also:</span></dt><dd><code>Cache.get(Object)</code></dd></dl>
</li>
</ul>
<a name="onBeforePut(javax.cache.Cache.Entry,java.lang.Object)">
<!-- -->
</a><a name="onBeforePut(javax.cache.Cache.Entry, V)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onBeforePut</h4>
<pre>@Nullable
<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">V</a>&nbsp;onBeforePut(javax.cache.Cache.Entry&lt;<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">K</a>,<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">V</a>&gt;&nbsp;entry,
<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">V</a>&nbsp;newVal)</pre>
<div class="block">This method is called within <a href="../../../../org/apache/ignite/IgniteCache.html#put(K,%20V)"><code>IgniteCache.put(Object, Object)</code></a>
and similar operations before new value is stored in cache.
<p>
Implementations should not execute any complex logic,
including locking, networking or cache operations,
as it may lead to deadlock, since this method is called
from sensitive synchronization blocks.
<p>
This method should not throw any exception.
<p>
<b>IMPORTANT:</b> for this method to take affect, <code>newVal</code> and
the returned value have to be different instances. I.e., you should
not mutate <code>newVal</code> directly, but instead create a copy, update
it and then return from the interceptor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entry</code> - Old entry. If <a href="../../../../org/apache/ignite/configuration/CacheConfiguration.html#isCopyOnRead()"><code>CacheConfiguration.isCopyOnRead()</code></a> is <code>true</code>, then is copy.</dd><dd><code>newVal</code> - New value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Value to be put to cache. Returning <code>null</code> cancels the update.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/ignite/IgniteCache.html#put(K,%20V)"><code>IgniteCache.put(Object, Object)</code></a></dd></dl>
</li>
</ul>
<a name="onAfterPut(javax.cache.Cache.Entry)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onAfterPut</h4>
<pre>void&nbsp;onAfterPut(javax.cache.Cache.Entry&lt;<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">K</a>,<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">V</a>&gt;&nbsp;entry)</pre>
<div class="block">This method is called after new value has been stored.
<p>
Implementations should not execute any complex logic,
including locking, networking or cache operations,
as it may lead to deadlock, since this method is called
from sensitive synchronization blocks.
<p>
This method should not throw any exception.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entry</code> - Current entry. If <a href="../../../../org/apache/ignite/configuration/CacheConfiguration.html#isCopyOnRead()"><code>CacheConfiguration.isCopyOnRead()</code></a> is <code>true</code> then
entry is a copy.</dd></dl>
</li>
</ul>
<a name="onBeforeRemove(javax.cache.Cache.Entry)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onBeforeRemove</h4>
<pre>@Nullable
<a href="../../../../org/apache/ignite/lang/IgniteBiTuple.html" title="class in org.apache.ignite.lang">IgniteBiTuple</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>,<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">V</a>&gt;&nbsp;onBeforeRemove(javax.cache.Cache.Entry&lt;<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">K</a>,<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">V</a>&gt;&nbsp;entry)</pre>
<div class="block">This method is called within <a href="../../../../org/apache/ignite/IgniteCache.html#remove(K)"><code>IgniteCache.remove(Object)</code></a>
and similar operations to provide control over returned value.
<p>
Implementations should not execute any complex logic,
including locking, networking or cache operations,
as it may lead to deadlock, since this method is called
from sensitive synchronization blocks.
<p>
This method should not throw any exception.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entry</code> - Old entry. If <a href="../../../../org/apache/ignite/configuration/CacheConfiguration.html#isCopyOnRead()"><code>CacheConfiguration.isCopyOnRead()</code></a> is <code>true</code> then
entry is a copy.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Tuple. The first value is the flag whether remove should be cancelled or not.
The second is the value to be returned as result of <code>remove()</code> operation,
may be <code>null</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/ignite/IgniteCache.html#remove(K)"><code>IgniteCache.remove(Object)</code></a></dd></dl>
</li>
</ul>
<a name="onAfterRemove(javax.cache.Cache.Entry)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onAfterRemove</h4>
<pre>void&nbsp;onAfterRemove(javax.cache.Cache.Entry&lt;<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">K</a>,<a href="../../../../org/apache/ignite/cache/CacheInterceptor.html" title="type parameter in CacheInterceptor">V</a>&gt;&nbsp;entry)</pre>
<div class="block">This method is called after value has been removed.
<p>
Implementations should not execute any complex logic,
including locking, networking or cache operations,
as it may lead to deadlock, since this method is called
from sensitive synchronization blocks.
<p>
This method should not throw any exception.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entry</code> - Removed entry. If <a href="../../../../org/apache/ignite/configuration/CacheConfiguration.html#isCopyOnRead()"><code>CacheConfiguration.isCopyOnRead()</code></a> is <code>true</code> then
entry is a copy.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CacheInterceptor.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 class="aboutLanguage"><em>Ignite - In-Memory Data Fabric</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/ignite/cache/CacheExistsException.html" title="class in org.apache.ignite.cache"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/ignite/cache/CacheInterceptorAdapter.html" title="class in org.apache.ignite.cache"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/cache/CacheInterceptor.html" target="_top">Frames</a></li>
<li><a href="CacheInterceptor.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://ignite.apache.org"><nobr>2017 Copyright &#169; Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Ignite Fabric</b> </td> <td>:&nbsp;&nbsp; ver. <strong>2.1.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; July 20 2017 </td> </tr> </tbody> </table> </td> </tr> </table></small></p>
</body>
</html>