blob: 91969230f6856467a0cd47e75cedc41298b614d6 [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>
<!-- Generated by javadoc -->
<title>SystemMemberCacheListener (Apache Geode 1.15.1)</title>
<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="SystemMemberCacheListener (Apache Geode 1.15.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":38,"i1":38,"i2":38,"i3":38};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/geode/admin/SystemMemberCacheEvent.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/admin/SystemMemberCacheListener.html" target="_top">Frames</a></li>
<li><a href="SystemMemberCacheListener.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>
<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.geode.admin</div>
<h2 title="Interface SystemMemberCacheListener" class="title">Interface SystemMemberCacheListener</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href=
"../../../../org/apache/geode/management/package-summary.html">management</a></code>
package instead</span></div>
</div>
<br>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public interface <span class="typeNameLabel">SystemMemberCacheListener</span></pre>
<div class="block">A listener whose callback methods can be used to track the lifecycle of <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>caches</code></a> and
<a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>regions</code></a> in the GemFire distributed system.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 5.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/admin/AdminDistributedSystem.html#addCacheListener-org.apache.geode.admin.SystemMemberCacheListener-"><code>AdminDistributedSystem.addCacheListener(org.apache.geode.admin.SystemMemberCacheListener)</code></a>,
<a href="../../../../org/apache/geode/admin/AdminDistributedSystem.html#removeCacheListener-org.apache.geode.admin.SystemMemberCacheListener-"><code>AdminDistributedSystem.removeCacheListener(org.apache.geode.admin.SystemMemberCacheListener)</code></a></dd>
</dl>
</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheListener.html#afterCacheClose-org.apache.geode.admin.SystemMemberCacheEvent-">afterCacheClose</a></span>(<a href="../../../../org/apache/geode/admin/SystemMemberCacheEvent.html" title="interface in org.apache.geode.admin">SystemMemberCacheEvent</a>&nbsp;event)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Invoked after a cache is closed in any node of a distributed system.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheListener.html#afterCacheCreate-org.apache.geode.admin.SystemMemberCacheEvent-">afterCacheCreate</a></span>(<a href="../../../../org/apache/geode/admin/SystemMemberCacheEvent.html" title="interface in org.apache.geode.admin">SystemMemberCacheEvent</a>&nbsp;event)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Invoked after a cache is created in any node of a distributed system.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheListener.html#afterRegionCreate-org.apache.geode.admin.SystemMemberRegionEvent-">afterRegionCreate</a></span>(<a href="../../../../org/apache/geode/admin/SystemMemberRegionEvent.html" title="interface in org.apache.geode.admin">SystemMemberRegionEvent</a>&nbsp;event)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Invoked after a region is created in any node of distributed system.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheListener.html#afterRegionLoss-org.apache.geode.admin.SystemMemberRegionEvent-">afterRegionLoss</a></span>(<a href="../../../../org/apache/geode/admin/SystemMemberRegionEvent.html" title="interface in org.apache.geode.admin">SystemMemberRegionEvent</a>&nbsp;event)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Invoked when a region is destroyed or closed in any node of distributed system.</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="afterRegionCreate-org.apache.geode.admin.SystemMemberRegionEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterRegionCreate</h4>
<pre>void&nbsp;afterRegionCreate(<a href="../../../../org/apache/geode/admin/SystemMemberRegionEvent.html" title="interface in org.apache.geode.admin">SystemMemberRegionEvent</a>&nbsp;event)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Invoked after a region is created in any node of distributed system.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>event</code> - describes the region that was created.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/cache/CacheFactory.html#create--"><code>CacheFactory.create()</code></a>,
<a href="../../../../org/apache/geode/cache/Cache.html#createRegion-java.lang.String-org.apache.geode.cache.RegionAttributes-"><code>Cache.createRegion(java.lang.String, org.apache.geode.cache.RegionAttributes&lt;K, V&gt;)</code></a>,
<a href="../../../../org/apache/geode/cache/Region.html#createSubregion-java.lang.String-org.apache.geode.cache.RegionAttributes-"><code>Region.createSubregion(java.lang.String, org.apache.geode.cache.RegionAttributes&lt;SK, SV&gt;)</code></a></dd>
</dl>
</li>
</ul>
<a name="afterRegionLoss-org.apache.geode.admin.SystemMemberRegionEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterRegionLoss</h4>
<pre>void&nbsp;afterRegionLoss(<a href="../../../../org/apache/geode/admin/SystemMemberRegionEvent.html" title="interface in org.apache.geode.admin">SystemMemberRegionEvent</a>&nbsp;event)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Invoked when a region is destroyed or closed in any node of distributed system.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>event</code> - describes the region that was lost. The operation on this event can be used to
determine the actual operation that caused the loss. Note that <a href="../../../../org/apache/geode/cache/RegionService.html#close--"><code>RegionService.close()</code></a>
invokes this callback with <code>Operation.CACHE_CLOSE</code> for each region in the
closed cache and it invokes <a href="../../../../org/apache/geode/admin/SystemMemberCacheListener.html#afterCacheClose-org.apache.geode.admin.SystemMemberCacheEvent-"><code>afterCacheClose(org.apache.geode.admin.SystemMemberCacheEvent)</code></a>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/cache/RegionService.html#close--"><code>RegionService.close()</code></a>,
<a href="../../../../org/apache/geode/cache/Region.html#close--"><code>Region.close()</code></a>,
<a href="../../../../org/apache/geode/cache/Region.html#localDestroyRegion--"><code>Region.localDestroyRegion()</code></a>,
<a href="../../../../org/apache/geode/cache/Region.html#destroyRegion--"><code>Region.destroyRegion()</code></a></dd>
</dl>
</li>
</ul>
<a name="afterCacheCreate-org.apache.geode.admin.SystemMemberCacheEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterCacheCreate</h4>
<pre>void&nbsp;afterCacheCreate(<a href="../../../../org/apache/geode/admin/SystemMemberCacheEvent.html" title="interface in org.apache.geode.admin">SystemMemberCacheEvent</a>&nbsp;event)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Invoked after a cache is created in any node of a distributed system. Note that this callback
will be done before any regions are created in the cache.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>event</code> - describes the member that created the cache.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/cache/CacheFactory.html#create--"><code>CacheFactory.create()</code></a></dd>
</dl>
</li>
</ul>
<a name="afterCacheClose-org.apache.geode.admin.SystemMemberCacheEvent-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>afterCacheClose</h4>
<pre>void&nbsp;afterCacheClose(<a href="../../../../org/apache/geode/admin/SystemMemberCacheEvent.html" title="interface in org.apache.geode.admin">SystemMemberCacheEvent</a>&nbsp;event)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Invoked after a cache is closed in any node of a distributed system. This callback is done
after those done for each region in the cache. This callback is not done if the distributed
member that has a cache crashes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>event</code> - describes the member that closed its cache.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/cache/RegionService.html#close--"><code>RegionService.close()</code></a></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>
<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="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/geode/admin/SystemMemberCacheEvent.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/admin/SystemMemberCacheListener.html" target="_top">Frames</a></li>
<li><a href="SystemMemberCacheListener.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>
<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 ======= -->
</body>
</html>