http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/admin/SystemMemberCache.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/admin/SystemMemberCache.html b/releases/latest/javadoc/org/apache/geode/admin/SystemMemberCache.html new file mode 100644 index 0000000..d63735d --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/admin/SystemMemberCache.html @@ -0,0 +1,677 @@ +<!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 (1.8.0_45) on Sat Oct 15 16:23:30 PDT 2016 --> +<title>SystemMemberCache (Apache Geode (incubating) 1.0.0-incubating)</title> +<meta name="date" content="2016-10-15"> +<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="SystemMemberCache (Apache Geode (incubating) 1.0.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":38,"i1":38,"i2":38,"i3":38,"i4":38,"i5":38,"i6":38,"i7":38,"i8":38,"i9":38,"i10":38,"i11":38,"i12":38,"i13":38,"i14":38,"i15":38,"i16":38,"i17":38,"i18":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/SystemMemberBridgeServer.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/admin/SystemMemberCacheEvent.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/geode/admin/SystemMemberCache.html" target="_top">Frames</a></li> +<li><a href="SystemMemberCache.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 SystemMemberCache" class="title">Interface SystemMemberCache</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<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>public interface <span class="typeNameLabel">SystemMemberCache</span></pre> +<div class="block">Administrative interface that represent's the <a href="../../../../org/apache/geode/admin/SystemMember.html" title="interface in org.apache.geode.admin"><code>SystemMember</code></a>'s view + of its <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>Cache</code></a>.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 3.5</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </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><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html" title="interface in org.apache.geode.admin">SystemMemberCacheServer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#addCacheServer--">addCacheServer</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Adds a new, unstarted cache server that will serve the contents + of this cache to clients.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/admin/SystemMemberRegion.html" title="interface in org.apache.geode.admin">SystemMemberRegion</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#createRegion-java.lang.String-org.apache.geode.cache.RegionAttributes-">createRegion</a></span>(java.lang.String name, + <a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a> attrs)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Creates a root <code>Region</code> in this cache.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/admin/SystemMemberRegion.html" title="interface in org.apache.geode.admin">SystemMemberRegion</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#createVMRegion-java.lang.String-org.apache.geode.cache.RegionAttributes-">createVMRegion</a></span>(java.lang.String name, + <a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a> attrs)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/admin/SystemMemberCache.html#createRegion-java.lang.String-org.apache.geode.cache.RegionAttributes-"><code>createRegion(java.lang.String, org.apache.geode.cache.RegionAttributes)</code></a> instead</span></div> +</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html" title="interface in org.apache.geode.admin">SystemMemberCacheServer</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#getCacheServers--">getCacheServers</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns the cache servers that run in this member's VM.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#getId--">getId</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Value that uniquely identifies an instance of a cache for a given member.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#getLockLease--">getLockLease</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Gets the length, in seconds, of distributed lock leases obtained + by this cache.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#getLockTimeout--">getLockTimeout</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Gets the number of seconds a cache operation will wait to obtain + a distributed lock lease.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#getName--">getName</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">The name of the cache.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/admin/SystemMemberRegion.html" title="interface in org.apache.geode.admin">SystemMemberRegion</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#getRegion-java.lang.String-">getRegion</a></span>(java.lang.String path)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Return the existing region (or subregion) with the specified + path that already exists in the cache.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>java.util.Set</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#getRootRegionNames--">getRootRegionNames</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns the names of all the root regions currently in this cache.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#getSearchTimeout--">getSearchTimeout</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Gets the number of seconds a cache + <a href="../../../../org/apache/geode/cache/Region.html#get-java.lang.Object-"><code>get</code></a> operation + can spend searching for a value before it times out.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/admin/Statistic.html" title="interface in org.apache.geode.admin">Statistic</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#getStatistics--">getStatistics</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns statistics related to this cache's performance.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#getUpTime--">getUpTime</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns number of seconds since this member's cache has been created.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#isClosed--">isClosed</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Indicates if this cache has been closed.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#isServer--">isServer</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns whether or not this cache acts as a server.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#refresh--">refresh</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Updates the state of this cache instance.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#setLockLease-int-">setLockLease</a></span>(int seconds)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the length, in seconds, of distributed lock leases obtained + by this cache.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#setLockTimeout-int-">setLockTimeout</a></span>(int seconds)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the number of seconds a cache operation may wait to obtain a + distributed lock lease before timing out.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html#setSearchTimeout-int-">setSearchTimeout</a></span>(int seconds)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the number of seconds a cache get operation can spend searching + for a 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="getName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>java.lang.String getName()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">The name of the cache.</div> +</li> +</ul> +<a name="getId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getId</h4> +<pre>int getId()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Value that uniquely identifies an instance of a cache for a given member.</div> +</li> +</ul> +<a name="isClosed--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isClosed</h4> +<pre>boolean isClosed()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Indicates if this cache has been closed.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true, if this cache is closed; false, otherwise</dd> +</dl> +</li> +</ul> +<a name="getLockTimeout--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLockTimeout</h4> +<pre>int getLockTimeout()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Gets the number of seconds a cache operation will wait to obtain + a distributed lock lease.</div> +</li> +</ul> +<a name="setLockTimeout-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLockTimeout</h4> +<pre>void setLockTimeout(int seconds) + throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the number of seconds a cache operation may wait to obtain a + distributed lock lease before timing out.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - If a problem is encountered while setting the lock + timeout</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/geode/cache/Cache.html#setLockTimeout-int-"><code>Cache.setLockTimeout(int)</code></a></dd> +</dl> +</li> +</ul> +<a name="getLockLease--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLockLease</h4> +<pre>int getLockLease()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Gets the length, in seconds, of distributed lock leases obtained + by this cache.</div> +</li> +</ul> +<a name="setLockLease-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLockLease</h4> +<pre>void setLockLease(int seconds) + throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the length, in seconds, of distributed lock leases obtained + by this cache.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - If a problem is encountered while setting the lock + lease</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/geode/cache/Cache.html#setLockLease-int-"><code>Cache.setLockLease(int)</code></a></dd> +</dl> +</li> +</ul> +<a name="getSearchTimeout--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSearchTimeout</h4> +<pre>int getSearchTimeout()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Gets the number of seconds a cache + <a href="../../../../org/apache/geode/cache/Region.html#get-java.lang.Object-"><code>get</code></a> operation + can spend searching for a value before it times out. + The search includes any time spent loading the object. + When the search times out it causes the get to fail by throwing + an exception.</div> +</li> +</ul> +<a name="setSearchTimeout-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSearchTimeout</h4> +<pre>void setSearchTimeout(int seconds) + throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the number of seconds a cache get operation can spend searching + for a value.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - If a problem is encountered while setting the search + timeout</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/geode/cache/Cache.html#setSearchTimeout-int-"><code>Cache.setSearchTimeout(int)</code></a></dd> +</dl> +</li> +</ul> +<a name="getUpTime--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUpTime</h4> +<pre>int getUpTime()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns number of seconds since this member's cache has been created. + Returns <code>-1</code> if this member does not have a cache or its cache + has been closed.</div> +</li> +</ul> +<a name="getRootRegionNames--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRootRegionNames</h4> +<pre>java.util.Set getRootRegionNames()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns the names of all the root regions currently in this cache.</div> +</li> +</ul> +<a name="getStatistics--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStatistics</h4> +<pre><a href="../../../../org/apache/geode/admin/Statistic.html" title="interface in org.apache.geode.admin">Statistic</a>[] getStatistics()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns statistics related to this cache's performance.</div> +</li> +</ul> +<a name="getRegion-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRegion</h4> +<pre><a href="../../../../org/apache/geode/admin/SystemMemberRegion.html" title="interface in org.apache.geode.admin">SystemMemberRegion</a> getRegion(java.lang.String path) + throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Return the existing region (or subregion) with the specified + path that already exists in the cache. + Whether or not the path starts with a forward slash it is interpreted as a + full path starting at a root.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>path</code> - the path to the region</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the Region or null if not found</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if path is null, the empty string, or "/"</dd> +<dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code></dd> +</dl> +</li> +</ul> +<a name="createVMRegion-java.lang.String-org.apache.geode.cache.RegionAttributes-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createVMRegion</h4> +<pre>@Deprecated +<a href="../../../../org/apache/geode/admin/SystemMemberRegion.html" title="interface in org.apache.geode.admin">SystemMemberRegion</a> createVMRegion(java.lang.String name, + <a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a> attrs) + throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/admin/SystemMemberCache.html#createRegion-java.lang.String-org.apache.geode.cache.RegionAttributes-"><code>createRegion(java.lang.String, org.apache.geode.cache.RegionAttributes)</code></a> instead</span></div> +<div class="block">Creates a VM root <code>Region</code> in this cache.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The name of the region to create</dd> +<dd><code>attrs</code> - The attributes of the root region</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - If the region cannot be created</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 4.0</dd> +</dl> +</li> +</ul> +<a name="createRegion-java.lang.String-org.apache.geode.cache.RegionAttributes-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createRegion</h4> +<pre><a href="../../../../org/apache/geode/admin/SystemMemberRegion.html" title="interface in org.apache.geode.admin">SystemMemberRegion</a> createRegion(java.lang.String name, + <a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a> attrs) + throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Creates a root <code>Region</code> in this cache.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The name of the region to create</dd> +<dd><code>attrs</code> - The attributes of the root region</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - If the region cannot be created</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 5.0</dd> +</dl> +</li> +</ul> +<a name="refresh--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>refresh</h4> +<pre>void refresh()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Updates the state of this cache instance. Note that once a cache + instance is closed refresh will never change the state of that instance.</div> +</li> +</ul> +<a name="addCacheServer--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addCacheServer</h4> +<pre><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html" title="interface in org.apache.geode.admin">SystemMemberCacheServer</a> addCacheServer() + throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Adds a new, unstarted cache server that will serve the contents + of this cache to clients.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code></dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 5.7</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/geode/cache/Cache.html#addCacheServer--"><code>Cache.addCacheServer()</code></a></dd> +</dl> +</li> +</ul> +<a name="getCacheServers--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCacheServers</h4> +<pre><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html" title="interface in org.apache.geode.admin">SystemMemberCacheServer</a>[] getCacheServers() + throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns the cache servers that run in this member's VM. Note + that this list will not be updated until <a href="../../../../org/apache/geode/admin/SystemMemberCache.html#refresh--"><code>refresh()</code></a> is + called.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code></dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 5.7</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/geode/cache/Cache.html#getCacheServers--"><code>Cache.getCacheServers()</code></a></dd> +</dl> +</li> +</ul> +<a name="isServer--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isServer</h4> +<pre>boolean isServer() + throws <a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns whether or not this cache acts as a server. This method + will always return <code>true</code> for the + <code>SystemMemberCache</code> obtained from a <a href="../../../../org/apache/geode/admin/CacheServer.html" title="interface in org.apache.geode.admin"><code>CacheServer</code></a>. Note that this value will not be updated until + <a href="../../../../org/apache/geode/admin/SystemMemberCache.html#refresh--"><code>refresh()</code></a> is invoked.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code></dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 4.0</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/SystemMemberBridgeServer.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/admin/SystemMemberCacheEvent.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/geode/admin/SystemMemberCache.html" target="_top">Frames</a></li> +<li><a href="SystemMemberCache.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/admin/SystemMemberCacheEvent.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/admin/SystemMemberCacheEvent.html b/releases/latest/javadoc/org/apache/geode/admin/SystemMemberCacheEvent.html new file mode 100644 index 0000000..cf83f9c --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/admin/SystemMemberCacheEvent.html @@ -0,0 +1,250 @@ +<!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 (1.8.0_45) on Sat Oct 15 16:23:30 PDT 2016 --> +<title>SystemMemberCacheEvent (Apache Geode (incubating) 1.0.0-incubating)</title> +<meta name="date" content="2016-10-15"> +<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="SystemMemberCacheEvent (Apache Geode (incubating) 1.0.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/SystemMemberCache.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/admin/SystemMemberCacheListener.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/geode/admin/SystemMemberCacheEvent.html" target="_top">Frames</a></li> +<li><a href="SystemMemberCacheEvent.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 SystemMemberCacheEvent" class="title">Interface SystemMemberCacheEvent</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../org/apache/geode/admin/SystemMembershipEvent.html" title="interface in org.apache.geode.admin">SystemMembershipEvent</a></dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../org/apache/geode/admin/SystemMemberRegionEvent.html" title="interface in org.apache.geode.admin">SystemMemberRegionEvent</a></dd> +</dl> +<hr> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<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>public interface <span class="typeNameLabel">SystemMemberCacheEvent</span> +extends <a href="../../../../org/apache/geode/admin/SystemMembershipEvent.html" title="interface in org.apache.geode.admin">SystemMembershipEvent</a></pre> +<div class="block">An event that describes an operation on a cache. + Instances of this are delivered to a <a href="../../../../org/apache/geode/admin/SystemMemberCacheListener.html" title="interface in org.apache.geode.admin"><code>SystemMemberCacheListener</code></a> when a + a cache is created or closed.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 5.0</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </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><a href="../../../../org/apache/geode/cache/Operation.html" title="class in org.apache.geode.cache">Operation</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/SystemMemberCacheEvent.html#getOperation--">getOperation</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns the actual operation that caused this event.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.admin.SystemMembershipEvent"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.geode.admin.<a href="../../../../org/apache/geode/admin/SystemMembershipEvent.html" title="interface in org.apache.geode.admin">SystemMembershipEvent</a></h3> +<code><a href="../../../../org/apache/geode/admin/SystemMembershipEvent.html#getDistributedMember--">getDistributedMember</a>, <a href="../../../../org/apache/geode/admin/SystemMembershipEvent.html#getMemberId--">getMemberId</a></code></li> +</ul> +</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="getOperation--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getOperation</h4> +<pre><a href="../../../../org/apache/geode/cache/Operation.html" title="class in org.apache.geode.cache">Operation</a> getOperation()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns the actual operation that caused this event.</div> +</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/SystemMemberCache.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/admin/SystemMemberCacheListener.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/geode/admin/SystemMemberCacheEvent.html" target="_top">Frames</a></li> +<li><a href="SystemMemberCacheEvent.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/admin/SystemMemberCacheListener.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/admin/SystemMemberCacheListener.html b/releases/latest/javadoc/org/apache/geode/admin/SystemMemberCacheListener.html new file mode 100644 index 0000000..7372457 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/admin/SystemMemberCacheListener.html @@ -0,0 +1,326 @@ +<!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 (1.8.0_45) on Sat Oct 15 16:23:30 PDT 2016 --> +<title>SystemMemberCacheListener (Apache Geode (incubating) 1.0.0-incubating)</title> +<meta name="date" content="2016-10-15"> +<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 (incubating) 1.0.0-incubating)"; + } + } + 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 Class</span></a></li> +<li><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Next 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 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> +<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>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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </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> event)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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> event)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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> event)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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> event)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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 afterRegionCreate(<a href="../../../../org/apache/geode/admin/SystemMemberRegionEvent.html" title="interface in org.apache.geode.admin">SystemMemberRegionEvent</a> event)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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-org.apache.geode.distributed.DistributedSystem-"><code>CacheFactory.create(org.apache.geode.distributed.DistributedSystem)</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<K, V>)</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<SK, SV>)</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 afterRegionLoss(<a href="../../../../org/apache/geode/admin/SystemMemberRegionEvent.html" title="interface in org.apache.geode.admin">SystemMemberRegionEvent</a> event)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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 afterCacheCreate(<a href="../../../../org/apache/geode/admin/SystemMemberCacheEvent.html" title="interface in org.apache.geode.admin">SystemMemberCacheEvent</a> event)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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-org.apache.geode.distributed.DistributedSystem-"><code>CacheFactory.create(org.apache.geode.distributed.DistributedSystem)</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 afterCacheClose(<a href="../../../../org/apache/geode/admin/SystemMemberCacheEvent.html" title="interface in org.apache.geode.admin">SystemMemberCacheEvent</a> event)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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 Class</span></a></li> +<li><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Next 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 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
