http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/cache/Cache.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/cache/Cache.html b/releases/latest/javadoc/org/apache/geode/cache/Cache.html new file mode 100644 index 0000000..bf1c384 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/cache/Cache.html @@ -0,0 +1,1234 @@ +<!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:28 PDT 2016 --> +<title>Cache (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="Cache (Apache Geode (incubating) 1.0.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":38,"i2":6,"i3":6,"i4":6,"i5":38,"i6":6,"i7":6,"i8":6,"i9":6,"i10":38,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":38,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":38,"i28":6,"i29":6,"i30":6,"i31":38,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6}; +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/cache/AttributesMutator.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/cache/CacheCallback.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/geode/cache/Cache.html" target="_top">Frames</a></li> +<li><a href="Cache.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.cache</div> +<h2 title="Interface Cache" class="title">Interface Cache</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd>java.lang.AutoCloseable, <a href="../../../../org/apache/geode/cache/GemFireCache.html" title="interface in org.apache.geode.cache">GemFireCache</a>, <a href="../../../../org/apache/geode/cache/RegionService.html" title="interface in org.apache.geode.cache">RegionService</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">Cache</span> +extends <a href="../../../../org/apache/geode/cache/GemFireCache.html" title="interface in org.apache.geode.cache">GemFireCache</a></pre> +<div class="block">Caches are obtained from the <a href="../../../../org/apache/geode/cache/CacheFactory.html#create--"><code>CacheFactory.create()</code></a> method. + See <a href="../../../../org/apache/geode/cache/CacheFactory.html" title="class in org.apache.geode.cache"><code>CacheFactory</code></a> for common usage patterns for creating the cache instance. + <p> + When a cache is created a <a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed"><code>DistributedSystem</code></a> is also created. + This system tells the cache where to find other caches on the network + and how to communicate with them. + The system can also specify a + <a href="../distribution/DistributedSystem.html#cache-xml-file">"cache-xml-file"</a> + property which will cause this cache to be initialized with the contents + of that file. The contents must comply with the + <code>"doc-files/cache8_0.dtd"</code> file + and the top level element must be a <code>cache</code> element. + <p> + When a cache will no longer be used it should be <a href="../../../../org/apache/geode/cache/RegionService.html#close--"><code>closed</code></a>. + Once it <a href="../../../../org/apache/geode/cache/RegionService.html#isClosed--"><code>is closed</code></a> any attempt to use it or any <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> + obtained from it will cause a <a href="../../../../org/apache/geode/cache/CacheClosedException.html" title="class in org.apache.geode.cache"><code>CacheClosedException</code></a> to be thrown. + + <p>A cache can have multiple root regions, each with a different name.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 2.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/server/CacheServer.html" title="interface in org.apache.geode.cache.server">CacheServer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#addCacheServer--">addCacheServer</a></span>()</code> +<div class="block">Creates a new cache server, with the default configuration, + that will allow clients to access this cache.</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/cache/Cache.html#close-boolean-">close</a></span>(boolean keepalive)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/client/ClientCache.html#close-boolean-"><code>ClientCache.close(boolean)</code></a> instead.</span></div> +</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/asyncqueue/AsyncEventQueueFactory.html" title="interface in org.apache.geode.cache.asyncqueue">AsyncEventQueueFactory</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#createAsyncEventQueueFactory--">createAsyncEventQueueFactory</a></span>()</code> +<div class="block">Creates <a href="../../../../org/apache/geode/cache/asyncqueue/AsyncEventQueueFactory.html" title="interface in org.apache.geode.cache.asyncqueue"><code>AsyncEventQueueFactory</code></a> for creating a + AsyncEventQueue</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/wan/GatewayReceiverFactory.html" title="interface in org.apache.geode.cache.wan">GatewayReceiverFactory</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#createGatewayReceiverFactory--">createGatewayReceiverFactory</a></span>()</code> +<div class="block">Creates <a href="../../../../org/apache/geode/cache/wan/GatewayReceiverFactory.html" title="interface in org.apache.geode.cache.wan"><code>GatewayReceiverFactory</code></a> for creating a GatewayReceiver</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#createGatewaySenderFactory--">createGatewaySenderFactory</a></span>()</code> +<div class="block">Creates <a href="../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan"><code>GatewaySenderFactory</code></a> for creating a + SerialGatewaySender</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><K,V> <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache">Region</a><K,V></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.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><K,V> aRegionAttributes)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory-org.apache.geode.cache.RegionAttributes-"><code>createRegionFactory(RegionAttributes)</code></a> instead</span></div> +</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><K,V> <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><K,V></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory--">createRegionFactory</a></span>()</code> +<div class="block">Creates a <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache"><code>RegionFactory</code></a> which can be used to specify additional + attributes for <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> creation.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><K,V> <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><K,V></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory-org.apache.geode.cache.RegionAttributes-">createRegionFactory</a></span>(<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a><K,V> regionAttributes)</code> +<div class="block">Creates a <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache"><code>RegionFactory</code></a> for creating a <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> from + the given regionAttributes</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><K,V> <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><K,V></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory-org.apache.geode.cache.RegionShortcut-">createRegionFactory</a></span>(<a href="../../../../org/apache/geode/cache/RegionShortcut.html" title="enum in org.apache.geode.cache">RegionShortcut</a> atts)</code> +<div class="block">Creates a <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache"><code>RegionFactory</code></a> for the most commonly used <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> types + defined by <a href="../../../../org/apache/geode/cache/RegionShortcut.html" title="enum in org.apache.geode.cache"><code>RegionShortcut</code></a></div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><K,V> <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><K,V></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory-java.lang.String-">createRegionFactory</a></span>(java.lang.String regionAttributesId)</code> +<div class="block">Creates a <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache"><code>RegionFactory</code></a> for creating a <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> from + <a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache"><code>RegionAttributes</code></a> mapped to this regionAttributesId</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><K,V> <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache">Region</a><K,V></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.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><K,V> aRegionAttributes)</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/cache/Cache.html#createRegion-java.lang.String-org.apache.geode.cache.RegionAttributes-"><code>createRegion(java.lang.String, org.apache.geode.cache.RegionAttributes<K, V>)</code></a> instead.</span></div> +</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>java.util.Set<<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#getAdminMembers--">getAdminMembers</a></span>()</code> +<div class="block">Returns a set of the administrative members in the distributed system.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/asyncqueue/AsyncEventQueue.html" title="interface in org.apache.geode.cache.asyncqueue">AsyncEventQueue</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#getAsyncEventQueue-java.lang.String-">getAsyncEventQueue</a></span>(java.lang.String id)</code> +<div class="block">Returns the <a href="../../../../org/apache/geode/cache/asyncqueue/AsyncEventQueue.html" title="interface in org.apache.geode.cache.asyncqueue"><code>AsyncEventQueue</code></a> with the given id added to this Cache.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>java.util.Set<<a href="../../../../org/apache/geode/cache/asyncqueue/AsyncEventQueue.html" title="interface in org.apache.geode.cache.asyncqueue">AsyncEventQueue</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#getAsyncEventQueues--">getAsyncEventQueues</a></span>()</code> +<div class="block">Returns all <a href="../../../../org/apache/geode/cache/asyncqueue/AsyncEventQueue.html" title="interface in org.apache.geode.cache.asyncqueue"><code>AsyncEventQueue</code></a>s for this Cache</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/geode/cache/server/CacheServer.html" title="interface in org.apache.geode.cache.server">CacheServer</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#getCacheServers--">getCacheServers</a></span>()</code> +<div class="block">Returns a collection of all of the <code>CacheServer</code>s + that can serve the contents of this <code>Cache</code> to clients.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/util/GatewayConflictResolver.html" title="interface in org.apache.geode.cache.util">GatewayConflictResolver</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#getGatewayConflictResolver--">getGatewayConflictResolver</a></span>()</code> +<div class="block">Returns the current gateway event conflict resolver</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>java.util.Set<<a href="../../../../org/apache/geode/cache/wan/GatewayReceiver.html" title="interface in org.apache.geode.cache.wan">GatewayReceiver</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#getGatewayReceivers--">getGatewayReceivers</a></span>()</code> +<div class="block">Returns all <a href="../../../../org/apache/geode/cache/wan/GatewayReceiver.html" title="interface in org.apache.geode.cache.wan"><code>GatewayReceiver</code></a>s for this Cache</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/wan/GatewaySender.html" title="interface in org.apache.geode.cache.wan">GatewaySender</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#getGatewaySender-java.lang.String-">getGatewaySender</a></span>(java.lang.String id)</code> +<div class="block">Returns the <a href="../../../../org/apache/geode/cache/wan/GatewaySender.html" title="interface in org.apache.geode.cache.wan"><code>GatewaySender</code></a> with the given id added to this Cache.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>java.util.Set<<a href="../../../../org/apache/geode/cache/wan/GatewaySender.html" title="interface in org.apache.geode.cache.wan">GatewaySender</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#getGatewaySenders--">getGatewaySenders</a></span>()</code> +<div class="block">Returns all <a href="../../../../org/apache/geode/cache/wan/GatewaySender.html" title="interface in org.apache.geode.cache.wan"><code>GatewaySender</code></a>s for this Cache.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#getLockLease--">getLockLease</a></span>()</code> +<div class="block">Gets the length, in seconds, of distributed lock leases obtained + by this cache.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#getLockTimeout--">getLockTimeout</a></span>()</code> +<div class="block">Gets the number of seconds a cache operation will wait to obtain + a distributed lock lease.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/i18n/LogWriterI18n.html" title="interface in org.apache.geode.i18n">LogWriterI18n</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#getLoggerI18n--">getLoggerI18n</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of 6.5 use getLogger().convertToLogWriterI18n() instead</span></div> +</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>java.util.Set<<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#getMembers--">getMembers</a></span>()</code> +<div class="block">Returns a set of the other non-administrative members in the distributed system.</div> +</td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code>java.util.Set<<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#getMembers-org.apache.geode.cache.Region-">getMembers</a></span>(<a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache">Region</a> r)</code> +<div class="block">Returns a set of the members in the distributed system that have the + given region.</div> +</td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#getMessageSyncInterval--">getMessageSyncInterval</a></span>()</code> +<div class="block">Gets the frequency (in seconds) at which a message will be sent by the + primary cache-server to all the secondary cache-server nodes to remove the + events which have already been dispatched from the queue.</div> +</td> +</tr> +<tr id="i25" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#getReconnectedCache--">getReconnectedCache</a></span>()</code> +<div class="block">Returns the new Cache if there was an auto-reconnect and the cache was + recreated.</div> +</td> +</tr> +<tr id="i26" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#getSearchTimeout--">getSearchTimeout</a></span>()</code> +<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="i27" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/i18n/LogWriterI18n.html" title="interface in org.apache.geode.i18n">LogWriterI18n</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#getSecurityLoggerI18n--">getSecurityLoggerI18n</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of 6.5 use getSecurityLogger().convertToLogWriterI18n() instead</span></div> +</div> +</td> +</tr> +<tr id="i28" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/snapshot/CacheSnapshotService.html" title="interface in org.apache.geode.cache.snapshot">CacheSnapshotService</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#getSnapshotService--">getSnapshotService</a></span>()</code> +<div class="block">Obtains the snapshot service to allow the cache data to be imported + or exported.</div> +</td> +</tr> +<tr id="i29" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#isReconnecting--">isReconnecting</a></span>()</code> +<div class="block">Test to see whether the Cache is in the process of reconnecting + and recreating a new cache after it has been removed from the system + by other members or has shut down due to missing Roles and is reconnecting.</div> +</td> +</tr> +<tr id="i30" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#isServer--">isServer</a></span>()</code> +<div class="block">Returns whether or not this cache resides in a "cache server" VM.</div> +</td> +</tr> +<tr id="i31" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#readyForEvents--">readyForEvents</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/client/ClientCache.html#readyForEvents--"><code>ClientCache.readyForEvents()</code></a> instead.</span></div> +</div> +</td> +</tr> +<tr id="i32" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#setGatewayConflictResolver-org.apache.geode.cache.util.GatewayConflictResolver-">setGatewayConflictResolver</a></span>(<a href="../../../../org/apache/geode/cache/util/GatewayConflictResolver.html" title="interface in org.apache.geode.cache.util">GatewayConflictResolver</a> resolver)</code> +<div class="block">Adds a gateway event conflict resolution resolver.</div> +</td> +</tr> +<tr id="i33" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#setIsServer-boolean-">setIsServer</a></span>(boolean isServer)</code> +<div class="block">Sets whether or not this <code>Cache</code> resides in a + long-running "cache server" VM.</div> +</td> +</tr> +<tr id="i34" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#setLockLease-int-">setLockLease</a></span>(int seconds)</code> +<div class="block">Sets the length, in seconds, of distributed lock leases obtained + by this cache.</div> +</td> +</tr> +<tr id="i35" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#setLockTimeout-int-">setLockTimeout</a></span>(int seconds)</code> +<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="i36" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#setMessageSyncInterval-int-">setMessageSyncInterval</a></span>(int seconds)</code> +<div class="block">Sets the frequency (in seconds) at which a message will be sent by the + primary cache-server node to all the secondary cache-server nodes to remove + the events which have already been dispatched from the queue.</div> +</td> +</tr> +<tr id="i37" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#setSearchTimeout-int-">setSearchTimeout</a></span>(int seconds)</code> +<div class="block">Sets the number of seconds a cache get operation can spend searching + for a value.</div> +</td> +</tr> +<tr id="i38" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#stopReconnecting--">stopReconnecting</a></span>()</code> +<div class="block">Force the Cache to stop reconnecting.</div> +</td> +</tr> +<tr id="i39" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/Cache.html#waitUntilReconnected-long-java.util.concurrent.TimeUnit-">waitUntilReconnected</a></span>(long time, + java.util.concurrent.TimeUnit units)</code> +<div class="block">Wait for the Cache to finish reconnecting to the distributed system + and recreate a new Cache.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.cache.GemFireCache"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.geode.cache.<a href="../../../../org/apache/geode/cache/GemFireCache.html" title="interface in org.apache.geode.cache">GemFireCache</a></h3> +<code><a href="../../../../org/apache/geode/cache/GemFireCache.html#createDiskStoreFactory--">createDiskStoreFactory</a>, <a href="../../../../org/apache/geode/cache/GemFireCache.html#findDiskStore-java.lang.String-">findDiskStore</a>, <a href="../../../../org/apache/geode/cache/GemFireCache.html#getCacheTransactionManager--">getCacheTransactionManager</a>, <a href="../../../../org/apache/geode/cache/GemFireCache.html#getCopyOnRead--">getCopyOnRead</a>, <a href="../../../../org/apache/geode/cache/GemFireCache.html#getDistributedSystem--">getDistributedSystem</a>, <a href="../../../../org/apache/geode/cache/GemFireCache.html#getInitializer--">getInitializer</a>, <a href="../../../../org/apache/geode/cache/GemFireCache.html#getInitializerProps--">getInitializerProps</a>, <a href="../../../../org/apache/geode/cache/GemFireCache.html#getJNDIContext--">getJNDIContext</a>, <a href="../../../../org/apache/geode/cache/GemFireCache.html#getLogger--">getLogger</a>, <a href="../../../../org/ap ache/geode/cache/GemFireCache.html#getName--">getName</a>, <a href="../../../../org/apache/geode/cache/GemFireCache.html#getPdxDiskStore--">getPdxDiskStore</a>, <a href="../../../../org/apache/geode/cache/GemFireCache.html#getPdxIgnoreUnreadFields--">getPdxIgnoreUnreadFields</a>, <a href="../../../../org/apache/geode/cache/GemFireCache.html#getPdxPersistent--">getPdxPersistent</a>, <a href="../../../../org/apache/geode/cache/GemFireCache.html#getPdxReadSerialized--">getPdxReadSerialized</a>, <a href="../../../../org/apache/geode/cache/GemFireCache.html#getPdxSerializer--">getPdxSerializer</a>, <a href="../../../../org/apache/geode/cache/GemFireCache.html#getRegionAttributes-java.lang.String-">getRegionAttributes</a>, <a href="../../../../org/apache/geode/cache/GemFireCache.html#getResourceManager--">getResourceManager</a>, <a href="../../../../org/apache/geode/cache/GemFireCache.html#getSecurityLogger--">getSecurityLogger</a>, <a href="../../../../org/apache/geode/cache/GemFireCache .html#listRegionAttributes--">listRegionAttributes</a>, <a href="../../../../org/apache/geode/cache/GemFireCache.html#loadCacheXml-java.io.InputStream-">loadCacheXml</a>, <a href="../../../../org/apache/geode/cache/GemFireCache.html#setCopyOnRead-boolean-">setCopyOnRead</a>, <a href="../../../../org/apache/geode/cache/GemFireCache.html#setRegionAttributes-java.lang.String-org.apache.geode.cache.RegionAttributes-">setRegionAttributes</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.cache.RegionService"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.geode.cache.<a href="../../../../org/apache/geode/cache/RegionService.html" title="interface in org.apache.geode.cache">RegionService</a></h3> +<code><a href="../../../../org/apache/geode/cache/RegionService.html#close--">close</a>, <a href="../../../../org/apache/geode/cache/RegionService.html#createPdxEnum-java.lang.String-java.lang.String-int-">createPdxEnum</a>, <a href="../../../../org/apache/geode/cache/RegionService.html#createPdxInstanceFactory-java.lang.String-">createPdxInstanceFactory</a>, <a href="../../../../org/apache/geode/cache/RegionService.html#getCancelCriterion--">getCancelCriterion</a>, <a href="../../../../org/apache/geode/cache/RegionService.html#getQueryService--">getQueryService</a>, <a href="../../../../org/apache/geode/cache/RegionService.html#getRegion-java.lang.String-">getRegion</a>, <a href="../../../../org/apache/geode/cache/RegionService.html#isClosed--">isClosed</a>, <a href="../../../../org/apache/geode/cache/RegionService.html#rootRegions--">rootRegions</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="close-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>@Deprecated +void close(boolean keepalive)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/client/ClientCache.html#close-boolean-"><code>ClientCache.close(boolean)</code></a> instead.</span></div> +<div class="block">Terminates this object cache and releases all the resources. + Calls <a href="../../../../org/apache/geode/cache/Region.html#close--"><code>Region.close()</code></a> on each region in the cache. + After this cache is closed, any further + method call on this cache or any region object will throw + <a href="../../../../org/apache/geode/cache/CacheClosedException.html" title="class in org.apache.geode.cache"><code>CacheClosedException</code></a>, unless otherwise noted.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>keepalive</code> - whether the server should keep the durable client's queues alive for the timeout period</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/geode/cache/CacheClosedException.html" title="class in org.apache.geode.cache">CacheClosedException</a></code> - if the cache is already closed.</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 +<K,V> <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache">Region</a><K,V> createVMRegion(java.lang.String name, + <a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a><K,V> aRegionAttributes) + throws <a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a>, + <a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/cache/Cache.html#createRegion-java.lang.String-org.apache.geode.cache.RegionAttributes-"><code>createRegion(java.lang.String, org.apache.geode.cache.RegionAttributes<K, V>)</code></a> instead.</span></div> +<div class="block">Creates a VM region using the specified + RegionAttributes.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the region to create</dd> +<dd><code>aRegionAttributes</code> - the attributes of the root region</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the region object</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a></code> - if a region is already in + this cache</dd> +<dd><code><a href="../../../../org/apache/geode/distributed/LeaseExpiredException.html" title="class in org.apache.geode.distributed">LeaseExpiredException</a></code> - if lease expired on distributed lock for Scope.GLOBAL</dd> +<dd><code><a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></code> - if timed out getting distributed lock for Scope.GLOBAL</dd> +<dd><code><a href="../../../../org/apache/geode/cache/CacheClosedException.html" title="class in org.apache.geode.cache">CacheClosedException</a></code> - if the cache is closed</dd> +<dd><code>java.lang.IllegalStateException</code> - If the supplied RegionAttributes violate the + <a href="AttributesFactory.html#creationConstraints">region creation constraints</a> + with a region of the same name in another cache in the distributed system</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>@Deprecated +<K,V> <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache">Region</a><K,V> createRegion(java.lang.String name, + <a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a><K,V> aRegionAttributes) + throws <a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a>, + <a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory-org.apache.geode.cache.RegionAttributes-"><code>createRegionFactory(RegionAttributes)</code></a> instead</span></div> +<div class="block">Creates a region using the specified RegionAttributes.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the region to create</dd> +<dd><code>aRegionAttributes</code> - the attributes of the root region</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the region object</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a></code> - if a region is already in this cache</dd> +<dd><code><a href="../../../../org/apache/geode/distributed/LeaseExpiredException.html" title="class in org.apache.geode.distributed">LeaseExpiredException</a></code> - if lease expired on distributed lock for Scope.GLOBAL</dd> +<dd><code><a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></code> - if timed out getting distributed lock for Scope.GLOBAL</dd> +<dd><code><a href="../../../../org/apache/geode/cache/CacheClosedException.html" title="class in org.apache.geode.cache">CacheClosedException</a></code> - if the cache is closed</dd> +<dd><code>java.lang.IllegalStateException</code> - If the supplied RegionAttributes violate the + <a href="AttributesFactory.html#creationConstraints">region creation constraints</a> + with a region of the same name in another cache in the distributed system</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 5.0</dd> +</dl> +</li> +</ul> +<a name="createRegionFactory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createRegionFactory</h4> +<pre><K,V> <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><K,V> createRegionFactory()</pre> +<div class="block">Creates a <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache"><code>RegionFactory</code></a> which can be used to specify additional + attributes for <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> creation.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 6.5</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory-org.apache.geode.cache.RegionShortcut-"><code>createRegionFactory(RegionShortcut)</code></a></dd> +</dl> +</li> +</ul> +<a name="createRegionFactory-org.apache.geode.cache.RegionShortcut-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createRegionFactory</h4> +<pre><K,V> <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><K,V> createRegionFactory(<a href="../../../../org/apache/geode/cache/RegionShortcut.html" title="enum in org.apache.geode.cache">RegionShortcut</a> atts)</pre> +<div class="block">Creates a <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache"><code>RegionFactory</code></a> for the most commonly used <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> types + defined by <a href="../../../../org/apache/geode/cache/RegionShortcut.html" title="enum in org.apache.geode.cache"><code>RegionShortcut</code></a></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 6.5</dd> +</dl> +</li> +</ul> +<a name="createRegionFactory-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createRegionFactory</h4> +<pre><K,V> <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><K,V> createRegionFactory(java.lang.String regionAttributesId)</pre> +<div class="block">Creates a <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache"><code>RegionFactory</code></a> for creating a <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> from + <a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache"><code>RegionAttributes</code></a> mapped to this regionAttributesId</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>regionAttributesId</code> - the Id of RegionAttributes to be used</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 6.5</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/geode/cache/GemFireCache.html#setRegionAttributes-java.lang.String-org.apache.geode.cache.RegionAttributes-"><code>GemFireCache.setRegionAttributes(String, RegionAttributes)</code></a></dd> +</dl> +</li> +</ul> +<a name="createRegionFactory-org.apache.geode.cache.RegionAttributes-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createRegionFactory</h4> +<pre><K,V> <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><K,V> createRegionFactory(<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a><K,V> regionAttributes)</pre> +<div class="block">Creates a <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache"><code>RegionFactory</code></a> for creating a <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> from + the given regionAttributes</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>regionAttributes</code> - regionAttributes for the new region</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 6.5</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory-org.apache.geode.cache.RegionShortcut-"><code>createRegionFactory(RegionShortcut)</code></a></dd> +</dl> +</li> +</ul> +<a name="getLoggerI18n--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLoggerI18n</h4> +<pre>@Deprecated +<a href="../../../../org/apache/geode/i18n/LogWriterI18n.html" title="interface in org.apache.geode.i18n">LogWriterI18n</a> getLoggerI18n()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use getLogger().convertToLogWriterI18n() instead</span></div> +<div class="block">Internal GemStone method for accessing the internationalized + logging object for GemFire, use <a href="../../../../org/apache/geode/cache/GemFireCache.html#getLogger--"><code>GemFireCache.getLogger()</code></a> instead. + This method does not throw + <code>CacheClosedException</code> if the cache is closed.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the logging object</dd> +</dl> +</li> +</ul> +<a name="getSecurityLoggerI18n--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSecurityLoggerI18n</h4> +<pre>@Deprecated +<a href="../../../../org/apache/geode/i18n/LogWriterI18n.html" title="interface in org.apache.geode.i18n">LogWriterI18n</a> getSecurityLoggerI18n()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use getSecurityLogger().convertToLogWriterI18n() instead</span></div> +<div class="block">Internal GemStone method for accessing the internationalized + logging object for GemFire, use <a href="../../../../org/apache/geode/cache/GemFireCache.html#getSecurityLogger--"><code>GemFireCache.getSecurityLogger()</code></a> instead. + This method does not throw + <code>CacheClosedException</code> if the cache is closed.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the security logging object</dd> +</dl> +</li> +</ul> +<a name="getLockTimeout--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLockTimeout</h4> +<pre>int getLockTimeout()</pre> +<div class="block">Gets the number of seconds a cache operation will wait to obtain + a distributed lock lease. + This method does not throw + <code>CacheClosedException</code> if the cache is closed.</div> +</li> +</ul> +<a name="setLockTimeout-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLockTimeout</h4> +<pre>void setLockTimeout(int seconds)</pre> +<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>java.lang.IllegalArgumentException</code> - if <code>seconds</code> is less than zero</dd> +</dl> +</li> +</ul> +<a name="getMessageSyncInterval--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMessageSyncInterval</h4> +<pre>int getMessageSyncInterval()</pre> +<div class="block">Gets the frequency (in seconds) at which a message will be sent by the + primary cache-server to all the secondary cache-server nodes to remove the + events which have already been dispatched from the queue.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The time interval in seconds</dd> +</dl> +</li> +</ul> +<a name="setMessageSyncInterval-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMessageSyncInterval</h4> +<pre>void setMessageSyncInterval(int seconds)</pre> +<div class="block">Sets the frequency (in seconds) at which a message will be sent by the + primary cache-server node to all the secondary cache-server nodes to remove + the events which have already been dispatched from the queue.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>seconds</code> - - + the time interval in seconds</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if <code>seconds</code> is less than zero</dd> +</dl> +</li> +</ul> +<a name="getLockLease--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLockLease</h4> +<pre>int getLockLease()</pre> +<div class="block">Gets the length, in seconds, of distributed lock leases obtained + by this cache. + This method does not throw + <code>CacheClosedException</code> if the cache is closed.</div> +</li> +</ul> +<a name="setLockLease-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLockLease</h4> +<pre>void setLockLease(int seconds)</pre> +<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>java.lang.IllegalArgumentException</code> - if <code>seconds</code> is less than zero.</dd> +</dl> +</li> +</ul> +<a name="getSearchTimeout--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSearchTimeout</h4> +<pre>int getSearchTimeout()</pre> +<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. + This method does not throw + <code>CacheClosedException</code> if the cache is closed.</div> +</li> +</ul> +<a name="setSearchTimeout-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSearchTimeout</h4> +<pre>void setSearchTimeout(int seconds)</pre> +<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>java.lang.IllegalArgumentException</code> - if <code>seconds</code> is less than zero</dd> +</dl> +</li> +</ul> +<a name="addCacheServer--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addCacheServer</h4> +<pre><a href="../../../../org/apache/geode/cache/server/CacheServer.html" title="interface in org.apache.geode.cache.server">CacheServer</a> addCacheServer()</pre> +<div class="block">Creates a new cache server, with the default configuration, + that will allow clients to access this cache. + <p>For the default configuration see the constants in + <a href="../../../../org/apache/geode/cache/server/CacheServer.html" title="interface in org.apache.geode.cache.server"><code>CacheServer</code></a>.</div> +<dl> +<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/server/CacheServer.html" title="interface in org.apache.geode.cache.server"><code>CacheServer</code></a></dd> +</dl> +</li> +</ul> +<a name="getCacheServers--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCacheServers</h4> +<pre>java.util.List<<a href="../../../../org/apache/geode/cache/server/CacheServer.html" title="interface in org.apache.geode.cache.server">CacheServer</a>> getCacheServers()</pre> +<div class="block">Returns a collection of all of the <code>CacheServer</code>s + that can serve the contents of this <code>Cache</code> to clients.</div> +<dl> +<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>addCacheServer()</code></a></dd> +</dl> +</li> +</ul> +<a name="setGatewayConflictResolver-org.apache.geode.cache.util.GatewayConflictResolver-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setGatewayConflictResolver</h4> +<pre>void setGatewayConflictResolver(<a href="../../../../org/apache/geode/cache/util/GatewayConflictResolver.html" title="interface in org.apache.geode.cache.util">GatewayConflictResolver</a> resolver)</pre> +<div class="block">Adds a gateway event conflict resolution resolver. This is invoked + if an event is processed that comes from a different distributed system + than the last event to modify the affected entry. It may alter + the event or disallow the event. If it does neither the event is applied + to the cache if its timestamp is newer than what is in the cache or if + it is the same and the event's distributed system ID is larger than that + of the last event to modify the affected entry.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>resolver</code> - </dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 7.0</dd> +</dl> +</li> +</ul> +<a name="getGatewayConflictResolver--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getGatewayConflictResolver</h4> +<pre><a href="../../../../org/apache/geode/cache/util/GatewayConflictResolver.html" title="interface in org.apache.geode.cache.util">GatewayConflictResolver</a> getGatewayConflictResolver()</pre> +<div class="block">Returns the current gateway event conflict resolver</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 7.0</dd> +</dl> +</li> +</ul> +<a name="setIsServer-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIsServer</h4> +<pre>void setIsServer(boolean isServer)</pre> +<div class="block">Sets whether or not this <code>Cache</code> resides in a + long-running "cache server" VM. A cache server may be an + application VM or may be a stand-along VM launched using <a href="../../../../org/apache/geode/admin/AdminDistributedSystem.html#addCacheServer--">administration API</a> or the <code>cacheserver</code> command line + utility.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 4.0</dd> +</dl> +</li> +</ul> +<a name="isServer--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isServer</h4> +<pre>boolean isServer()</pre> +<div class="block">Returns whether or not this cache resides in a "cache server" VM.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 4.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/geode/cache/Cache.html#setIsServer-boolean-"><code>setIsServer(boolean)</code></a></dd> +</dl> +</li> +</ul> +<a name="readyForEvents--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readyForEvents</h4> +<pre>@Deprecated +void readyForEvents()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/client/ClientCache.html#readyForEvents--"><code>ClientCache.readyForEvents()</code></a> instead.</span></div> +<div class="block">Notifies the server that this client is ready to receive updates. + This method is used by durable clients to notify servers that they + are ready to receive updates. As soon as the server receives this message, + it will forward updates to this client (if necessary). + <p> + Durable clients must call this method after they are done creating regions. + If it is called before the client creates the regions then updates will be lost. + Any time a new <a href="../../../../org/apache/geode/cache/client/Pool.html" title="interface in org.apache.geode.cache.client"><code>Pool</code></a> is created and regions have been added to it then + this method needs to be called again. + <p></div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if called by a non-durable client</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 5.5</dd> +</dl> +</li> +</ul> +<a name="createGatewaySenderFactory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createGatewaySenderFactory</h4> +<pre><a href="../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan">GatewaySenderFactory</a> createGatewaySenderFactory()</pre> +<div class="block">Creates <a href="../../../../org/apache/geode/cache/wan/GatewaySenderFactory.html" title="interface in org.apache.geode.cache.wan"><code>GatewaySenderFactory</code></a> for creating a + SerialGatewaySender</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/geode/cache/GemFireCache.html#createGatewaySenderFactory--">createGatewaySenderFactory</a></code> in interface <code><a href="../../../../org/apache/geode/cache/GemFireCache.html" title="interface in org.apache.geode.cache">GemFireCache</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>SerialGatewaySenderFactory</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 7.0</dd> +</dl> +</li> +</ul> +<a name="createAsyncEventQueueFactory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createAsyncEventQueueFactory</h4> +<pre><a href="../../../../org/apache/geode/cache/asyncqueue/AsyncEventQueueFactory.html" title="interface in org.apache.geode.cache.asyncqueue">AsyncEventQueueFactory</a> createAsyncEventQueueFactory()</pre> +<div class="block">Creates <a href="../../../../org/apache/geode/cache/asyncqueue/AsyncEventQueueFactory.html" title="interface in org.apache.geode.cache.asyncqueue"><code>AsyncEventQueueFactory</code></a> for creating a + AsyncEventQueue</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>AsyncEventQueueFactory</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 7.0</dd> +</dl> +</li> +</ul> +<a name="createGatewayReceiverFactory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createGatewayReceiverFactory</h4> +<pre><a href="../../../../org/apache/geode/cache/wan/GatewayReceiverFactory.html" title="interface in org.apache.geode.cache.wan">GatewayReceiverFactory</a> createGatewayReceiverFactory()</pre> +<div class="block">Creates <a href="../../../../org/apache/geode/cache/wan/GatewayReceiverFactory.html" title="interface in org.apache.geode.cache.wan"><code>GatewayReceiverFactory</code></a> for creating a GatewayReceiver</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>GatewayReceiverFactory</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 7.0</dd> +</dl> +</li> +</ul> +<a name="getGatewaySenders--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getGatewaySenders</h4> +<pre>java.util.Set<<a href="../../../../org/apache/geode/cache/wan/GatewaySender.html" title="interface in org.apache.geode.cache.wan">GatewaySender</a>> getGatewaySenders()</pre> +<div class="block">Returns all <a href="../../../../org/apache/geode/cache/wan/GatewaySender.html" title="interface in org.apache.geode.cache.wan"><code>GatewaySender</code></a>s for this Cache.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Set of GatewaySenders</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 7.0</dd> +</dl> +</li> +</ul> +<a name="getGatewaySender-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getGatewaySender</h4> +<pre><a href="../../../../org/apache/geode/cache/wan/GatewaySender.html" title="interface in org.apache.geode.cache.wan">GatewaySender</a> getGatewaySender(java.lang.String id)</pre> +<div class="block">Returns the <a href="../../../../org/apache/geode/cache/wan/GatewaySender.html" title="interface in org.apache.geode.cache.wan"><code>GatewaySender</code></a> with the given id added to this Cache.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>GatewaySender with id</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 7.0</dd> +</dl> +</li> +</ul> +<a name="getGatewayReceivers--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getGatewayReceivers</h4> +<pre>java.util.Set<<a href="../../../../org/apache/geode/cache/wan/GatewayReceiver.html" title="interface in org.apache.geode.cache.wan">GatewayReceiver</a>> getGatewayReceivers()</pre> +<div class="block">Returns all <a href="../../../../org/apache/geode/cache/wan/GatewayReceiver.html" title="interface in org.apache.geode.cache.wan"><code>GatewayReceiver</code></a>s for this Cache</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Set of GatewaySenders</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 7.0</dd> +</dl> +</li> +</ul> +<a name="getAsyncEventQueues--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAsyncEventQueues</h4> +<pre>java.util.Set<<a href="../../../../org/apache/geode/cache/asyncqueue/AsyncEventQueue.html" title="interface in org.apache.geode.cache.asyncqueue">AsyncEventQueue</a>> getAsyncEventQueues()</pre> +<div class="block">Returns all <a href="../../../../org/apache/geode/cache/asyncqueue/AsyncEventQueue.html" title="interface in org.apache.geode.cache.asyncqueue"><code>AsyncEventQueue</code></a>s for this Cache</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Set of AsyncEventQueue</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 7.0</dd> +</dl> +</li> +</ul> +<a name="getAsyncEventQueue-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAsyncEventQueue</h4> +<pre><a href="../../../../org/apache/geode/cache/asyncqueue/AsyncEventQueue.html" title="interface in org.apache.geode.cache.asyncqueue">AsyncEventQueue</a> getAsyncEventQueue(java.lang.String id)</pre> +<div class="block">Returns the <a href="../../../../org/apache/geode/cache/asyncqueue/AsyncEventQueue.html" title="interface in org.apache.geode.cache.asyncqueue"><code>AsyncEventQueue</code></a> with the given id added to this Cache.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>AsyncEventQueue with id</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 7.0</dd> +</dl> +</li> +</ul> +<a name="getMembers--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMembers</h4> +<pre>java.util.Set<<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a>> getMembers()</pre> +<div class="block">Returns a set of the other non-administrative members in the distributed system.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 6.6</dd> +</dl> +</li> +</ul> +<a name="getAdminMembers--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdminMembers</h4> +<pre>java.util.Set<<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a>> getAdminMembers()</pre> +<div class="block">Returns a set of the administrative members in the distributed system.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 6.6</dd> +</dl> +</li> +</ul> +<a name="getMembers-org.apache.geode.cache.Region-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMembers</h4> +<pre>java.util.Set<<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a>> getMembers(<a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache">Region</a> r)</pre> +<div class="block">Returns a set of the members in the distributed system that have the + given region. For regions with local scope an empty set is returned.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>r</code> - a Region in the cache</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 6.6</dd> +</dl> +</li> +</ul> +<a name="getSnapshotService--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSnapshotService</h4> +<pre><a href="../../../../org/apache/geode/cache/snapshot/CacheSnapshotService.html" title="interface in org.apache.geode.cache.snapshot">CacheSnapshotService</a> getSnapshotService()</pre> +<div class="block">Obtains the snapshot service to allow the cache data to be imported + or exported.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the snapshot service</dd> +</dl> +</li> +</ul> +<a name="isReconnecting--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isReconnecting</h4> +<pre>boolean isReconnecting()</pre> +<div class="block">Test to see whether the Cache is in the process of reconnecting + and recreating a new cache after it has been removed from the system + by other members or has shut down due to missing Roles and is reconnecting.<p> + This will also return true if the Cache has finished reconnecting. + When reconnect has completed you can use <a href="../../../../org/apache/geode/cache/Cache.html#getReconnectedCache--"><code>getReconnectedCache()</code></a> to + retrieve the new cache instance.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the Cache is attempting to reconnect or has finished reconnecting</dd> +</dl> +</li> +</ul> +<a name="waitUntilReconnected-long-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>waitUntilReconnected</h4> +<pre>boolean waitUntilReconnected(long time, + java.util.concurrent.TimeUnit units) + throws java.lang.InterruptedException</pre> +<div class="block">Wait for the Cache to finish reconnecting to the distributed system + and recreate a new Cache.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>time</code> - amount of time to wait, or -1 to wait forever</dd> +<dd><code>units</code> - </dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the cache was reconnected</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.InterruptedException</code> - if the thread is interrupted while waiting</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/geode/cache/Cache.html#getReconnectedCache--"><code>getReconnectedCache()</code></a></dd> +</dl> +</li> +</ul> +<a name="stopReconnecting--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>stopReconnecting</h4> +<pre>void stopReconnecting()</pre> +<div class="block">Force the Cache to stop reconnecting. If the Cache + is currently connected this will disconnect and close it.</div> +</li> +</ul> +<a name="getReconnectedCache--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getReconnectedCache</h4> +<pre><a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a> getReconnectedCache()</pre> +<div class="block">Returns the new Cache if there was an auto-reconnect and the cache was + recreated.</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/cache/AttributesMutator.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/cache/CacheCallback.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/geode/cache/Cache.html" target="_top">Frames</a></li> +<li><a href="Cache.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/cache/CacheCallback.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/cache/CacheCallback.html b/releases/latest/javadoc/org/apache/geode/cache/CacheCallback.html new file mode 100644 index 0000000..e7fbba0 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/cache/CacheCallback.html @@ -0,0 +1,255 @@ +<!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:28 PDT 2016 --> +<title>CacheCallback (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="CacheCallback (Apache Geode (incubating) 1.0.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/cache/Cache.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/cache/CacheClosedException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/geode/cache/CacheCallback.html" target="_top">Frames</a></li> +<li><a href="CacheCallback.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.cache</div> +<h2 title="Interface CacheCallback" class="title">Interface CacheCallback</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../org/apache/geode/security/AccessControl.html" title="interface in org.apache.geode.security">AccessControl</a>, <a href="../../../../org/apache/geode/cache/asyncqueue/AsyncEventListener.html" title="interface in org.apache.geode.cache.asyncqueue">AsyncEventListener</a>, <a href="../../../../org/apache/geode/security/Authenticator.html" title="interface in org.apache.geode.security">Authenticator</a>, <a href="../../../../org/apache/geode/security/AuthInitialize.html" title="interface in org.apache.geode.security">AuthInitialize</a>, <a href="../../../../org/apache/geode/cache/CacheListener.html" title="interface in org.apache.geode.cache">CacheListener</a><K,V>, <a href="../../../../org/apache/geode/cache/CacheLoader.html" title="interface in org.apache.geode.cache">CacheLoader</a><K,V>, <a href="../../../../org/apache/geode/cache/CacheWriter.html" title="interface in org.apache.geode.cache">CacheWriter</a><K,V>, <a href="../../../../org/ap ache/geode/cache/query/CqListener.html" title="interface in org.apache.geode.cache.query">CqListener</a>, <a href="../../../../org/apache/geode/cache/query/CqStatusListener.html" title="interface in org.apache.geode.cache.query">CqStatusListener</a>, <a href="../../../../org/apache/geode/cache/CustomExpiry.html" title="interface in org.apache.geode.cache">CustomExpiry</a><K,V>, <a href="../../../../org/apache/geode/cache/FixedPartitionResolver.html" title="interface in org.apache.geode.cache">FixedPartitionResolver</a><K,V>, <a href="../../../../org/apache/geode/cache/wan/GatewayEventFilter.html" title="interface in org.apache.geode.cache.wan">GatewayEventFilter</a>, <a href="../../../../org/apache/geode/cache/wan/GatewayEventSubstitutionFilter.html" title="interface in org.apache.geode.cache.wan">GatewayEventSubstitutionFilter</a><K,V>, <a href="../../../../org/apache/geode/cache/wan/GatewayTransportFilter.html" title="interface in org.apache.geode.cache.wan">Gate wayTransportFilter</a>, <a href="../../../../org/apache/geode/cache/InterestRegistrationListener.html" title="interface in org.apache.geode.cache">InterestRegistrationListener</a>, <a href="../../../../org/apache/geode/cache/PartitionResolver.html" title="interface in org.apache.geode.cache">PartitionResolver</a><K,V>, <a href="../../../../org/apache/geode/cache/RegionMembershipListener.html" title="interface in org.apache.geode.cache">RegionMembershipListener</a><K,V>, <a href="../../../../org/apache/geode/cache/RegionRoleListener.html" title="interface in org.apache.geode.cache">RegionRoleListener</a><K,V>, <a href="../../../../org/apache/geode/cache/server/ServerLoadProbe.html" title="interface in org.apache.geode.cache.server">ServerLoadProbe</a>, <a href="../../../../org/apache/geode/cache/TransactionListener.html" title="interface in org.apache.geode.cache">TransactionListener</a>, <a href="../../../../org/apache/geode/cache/TransactionWriter.html" title="int erface in org.apache.geode.cache">TransactionWriter</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../org/apache/geode/cache/util/CacheListenerAdapter.html" title="class in org.apache.geode.cache.util">CacheListenerAdapter</a>, <a href="../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="class in org.apache.geode.cache.util">CacheWriterAdapter</a>, <a href="../../../../org/apache/geode/cache/util/CqListenerAdapter.html" title="class in org.apache.geode.cache.util">CqListenerAdapter</a>, <a href="../../../../org/apache/geode/modules/util/DebugCacheListener.html" title="class in org.apache.geode.modules.util">DebugCacheListener</a>, <a href="../../../../org/apache/geode/modules/gatewaydelta/GatewayDeltaEventApplicationCacheListener.html" title="class in org.apache.geode.modules.gatewaydelta">GatewayDeltaEventApplicationCacheListener</a>, <a href="../../../../org/apache/geode/modules/gatewaydelta/GatewayDeltaForwarderCacheListener.html" title="class in org.apache.geode.modules.gatewaydelta">GatewayDeltaForwarderCacheListener</a>, <a href=".. /../../../org/apache/geode/modules/session/catalina/callback/LocalSessionCacheLoader.html" title="class in org.apache.geode.modules.session.catalina.callback">LocalSessionCacheLoader</a>, <a href="../../../../org/apache/geode/modules/session/catalina/callback/LocalSessionCacheWriter.html" title="class in org.apache.geode.modules.session.catalina.callback">LocalSessionCacheWriter</a>, <a href="../../../../org/apache/geode/modules/util/RegionConfigurationCacheListener.html" title="class in org.apache.geode.modules.util">RegionConfigurationCacheListener</a>, <a href="../../../../org/apache/geode/cache/util/RegionMembershipListenerAdapter.html" title="class in org.apache.geode.cache.util">RegionMembershipListenerAdapter</a>, <a href="../../../../org/apache/geode/cache/util/RegionRoleListenerAdapter.html" title="class in org.apache.geode.cache.util">RegionRoleListenerAdapter</a>, <a href="../../../../org/apache/geode/cache/server/ServerLoadProbeAdapter.html" title="class in org.apache.ge ode.cache.server">ServerLoadProbeAdapter</a>, <a href="../../../../org/apache/geode/modules/util/SessionCustomExpiry.html" title="class in org.apache.geode.modules.util">SessionCustomExpiry</a>, <a href="../../../../org/apache/geode/modules/session/catalina/callback/SessionExpirationCacheListener.html" title="class in org.apache.geode.modules.session.catalina.callback">SessionExpirationCacheListener</a>, <a href="../../../../org/apache/geode/cache/util/TransactionListenerAdapter.html" title="class in org.apache.geode.cache.util">TransactionListenerAdapter</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">CacheCallback</span></pre> +<div class="block">User-defined objects that can be plugged into caching to receive callback + notifications.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 3.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></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/cache/CacheCallback.html#close--">close</a></span>()</code> +<div class="block">Called when the region containing this callback is closed or destroyed, when + the cache is closed, or when a callback is removed from a region + using an <code>AttributesMutator</code>.</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="close--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>void close()</pre> +<div class="block">Called when the region containing this callback is closed or destroyed, when + the cache is closed, or when a callback is removed from a region + using an <code>AttributesMutator</code>. + + <p>Implementations should cleanup any external + resources such as database connections. Any runtime exceptions this method + throws will be logged. + + <p>It is possible for this method to be called multiple times on a single + callback instance, so implementations must be tolerant of this.</div> +<dl> +<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>, +<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="interface in org.apache.geode.cache"><code>AttributesMutator</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/cache/Cache.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/cache/CacheClosedException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/geode/cache/CacheCallback.html" target="_top">Frames</a></li> +<li><a href="CacheCallback.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>