You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by sb...@apache.org on 2016/10/25 21:52:07 UTC
[10/51] [abbrv] [partial] incubator-geode git commit: Adding javadocs
for the 1.0.0-incubating release
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/cache/CacheFactory.html
----------------------------------------------------------------------
diff --git a/releases/latest/javadoc/org/apache/geode/cache/CacheFactory.html b/releases/latest/javadoc/org/apache/geode/cache/CacheFactory.html
new file mode 100644
index 0000000..57ae350
--- /dev/null
+++ b/releases/latest/javadoc/org/apache/geode/cache/CacheFactory.html
@@ -0,0 +1,716 @@
+<!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>CacheFactory (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="CacheFactory (Apache Geode (incubating) 1.0.0-incubating)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":10,"i1":41,"i2":9,"i3":9,"i4":9,"i5":9,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10};
+var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/CacheExistsException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/geode/cache/CacheListener.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/CacheFactory.html" target="_top">Frames</a></li>
+<li><a href="CacheFactory.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><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#constructor.detail">Constr</a> | </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="Class CacheFactory" class="title">Class CacheFactory</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.geode.cache.CacheFactory</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public class <span class="typeNameLabel">CacheFactory</span>
+extends java.lang.Object</pre>
+<div class="block">Factory class used to create the singleton <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>cache</code></a> and connect to the GemFire singleton <a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed"><code>distributed system</code></a>. If the application wants to connect to GemFire as a client it should use <a href="../../../../org/apache/geode/cache/client/ClientCacheFactory.html" title="class in org.apache.geode.cache.client"><code>ClientCacheFactory</code></a> instead.
+<p> Once the factory has been configured using its <a href="../../../../org/apache/geode/cache/CacheFactory.html#set-java.lang.String-java.lang.String-"><code>set(String, String)</code></a> method you produce a <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>Cache</code></a> by calling the <a href="../../../../org/apache/geode/cache/CacheFactory.html#create--"><code>create()</code></a> method.
+ <p>
+ To get the existing unclosed singleton cache instance call <a href="../../../../org/apache/geode/cache/CacheFactory.html#getAnyInstance--"><code>getAnyInstance()</code></a>.
+ <p>
+ If an instance of <a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed"><code>DistributedSystem</code></a> already exists when this factory
+ creates a cache, that instance will be used if it is compatible with this factory.
+<p>
+The following examples illustrate bootstrapping the cache using region shortcuts:
+<p>
+Example 1: Create a cache and a replicate region named customers.
+<PRE>
+ Cache c = new CacheFactory().create();
+ Region r = c.createRegionFactory(REPLICATE).create("customers");
+</PRE>
+Example 2: Create a cache and a partition region with redundancy
+<PRE>
+ Cache c = new CacheFactory().create();
+ Region r = c.createRegionFactory(PARTITION_REDUNDANT).create("customers");
+</PRE>
+Example 3: Construct the cache region declaratively in cache.xml
+<PRE>
+ <!DOCTYPE cache PUBLIC
+ "-//GemStone Systems, Inc.//GemFire Declarative Caching 8.0//EN"
+ "http://www.gemstone.com/dtd/cache8_0.dtd">
+ <cache>
+ <region name="myRegion" refid="REPLICATE"/>
+ <!-- you can override or add to the REPLICATE attributes by adding
+ a region-attributes sub element here -->
+ </cache>
+</PRE>
+Now, create the cache telling it to read your cache.xml file:
+<PRE>
+ Cache c = new CacheFactory()
+ .set("cache-xml-file", "myCache.xml")
+ .create();
+ Region r = c.getRegion("myRegion");
+</PRE>
+
+<p> For a complete list of all region shortcuts see <a href="../../../../org/apache/geode/cache/RegionShortcut.html" title="enum in org.apache.geode.cache"><code>RegionShortcut</code></a>.
+Applications that need to explicitly control the individual region attributes can do this declaratively in XML or using APIs.</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">
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/CacheFactory.html#CacheFactory--">CacheFactory</a></span>()</code>
+<div class="block">Creates a default cache factory.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/CacheFactory.html#CacheFactory-java.util.Properties-">CacheFactory</a></span>(java.util.Properties props)</code>
+<div class="block">Create a CacheFactory initialized with the given gemfire properties.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/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/CacheFactory.html#create--">create</a></span>()</code>
+<div class="block">Creates a new cache that uses the configured distributed system.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>static <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/CacheFactory.html#create-org.apache.geode.distributed.DistributedSystem-">create</a></span>(<a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed">DistributedSystem</a> system)</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/CacheFactory.html#CacheFactory-java.util.Properties-"><code>CacheFactory(Properties)</code></a> instead.</span></div>
+</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>static <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/CacheFactory.html#getAnyInstance--">getAnyInstance</a></span>()</code>
+<div class="block">Gets an arbitrary open instance of <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>Cache</code></a> produced by an
+ earlier call to <a href="../../../../org/apache/geode/cache/CacheFactory.html#create--"><code>create()</code></a>.</div>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>static <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/CacheFactory.html#getInstance-org.apache.geode.distributed.DistributedSystem-">getInstance</a></span>(<a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed">DistributedSystem</a> system)</code>
+<div class="block">Gets the instance of <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>Cache</code></a> produced by an
+ earlier call to <a href="../../../../org/apache/geode/cache/CacheFactory.html#create--"><code>create()</code></a>.</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>static <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/CacheFactory.html#getInstanceCloseOk-org.apache.geode.distributed.DistributedSystem-">getInstanceCloseOk</a></span>(<a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed">DistributedSystem</a> system)</code>
+<div class="block">Gets the instance of <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>Cache</code></a> produced by an
+ earlier call to <a href="../../../../org/apache/geode/cache/CacheFactory.html#create--"><code>create()</code></a> even if it has been closed.</div>
+</td>
+</tr>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code>static java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/CacheFactory.html#getVersion--">getVersion</a></span>()</code>
+<div class="block">Returns the version of the cache implementation.</div>
+</td>
+</tr>
+<tr id="i6" class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/CacheFactory.html" title="class in org.apache.geode.cache">CacheFactory</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/CacheFactory.html#set-java.lang.String-java.lang.String-">set</a></span>(java.lang.String name,
+ java.lang.String value)</code>
+<div class="block">Sets a gemfire property that will be used when creating the Cache.</div>
+</td>
+</tr>
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/CacheFactory.html" title="class in org.apache.geode.cache">CacheFactory</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/CacheFactory.html#setPdxDiskStore-java.lang.String-">setPdxDiskStore</a></span>(java.lang.String diskStoreName)</code>
+<div class="block">Set the disk store that is used for PDX meta data.</div>
+</td>
+</tr>
+<tr id="i8" class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/CacheFactory.html" title="class in org.apache.geode.cache">CacheFactory</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/CacheFactory.html#setPdxIgnoreUnreadFields-boolean-">setPdxIgnoreUnreadFields</a></span>(boolean ignore)</code>
+<div class="block">Control whether pdx ignores fields that were unread during deserialization.</div>
+</td>
+</tr>
+<tr id="i9" class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/CacheFactory.html" title="class in org.apache.geode.cache">CacheFactory</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/CacheFactory.html#setPdxPersistent-boolean-">setPdxPersistent</a></span>(boolean isPersistent)</code>
+<div class="block">Control whether the type metadata for PDX objects is persisted to disk.</div>
+</td>
+</tr>
+<tr id="i10" class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/CacheFactory.html" title="class in org.apache.geode.cache">CacheFactory</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/CacheFactory.html#setPdxReadSerialized-boolean-">setPdxReadSerialized</a></span>(boolean readSerialized)</code>
+<div class="block">Sets the object preference to PdxInstance type.</div>
+</td>
+</tr>
+<tr id="i11" class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/CacheFactory.html" title="class in org.apache.geode.cache">CacheFactory</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/CacheFactory.html#setPdxSerializer-org.apache.geode.pdx.PdxSerializer-">setPdxSerializer</a></span>(<a href="../../../../org/apache/geode/pdx/PdxSerializer.html" title="interface in org.apache.geode.pdx">PdxSerializer</a> serializer)</code>
+<div class="block">Set the PDX serializer for the cache.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.Object</h3>
+<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="CacheFactory--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>CacheFactory</h4>
+<pre>public CacheFactory()</pre>
+<div class="block">Creates a default cache factory.</div>
+<dl>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>GemFire 6.5</dd>
+</dl>
+</li>
+</ul>
+<a name="CacheFactory-java.util.Properties-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>CacheFactory</h4>
+<pre>public CacheFactory(java.util.Properties props)</pre>
+<div class="block">Create a CacheFactory initialized with the given gemfire properties.
+ For a list of valid GemFire properties and their meanings
+ see <a href="../../../../org/apache/geode/distributed/ConfigurationProperties.html" title="interface in org.apache.geode.distributed">ConfigurationProperties</a>.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>props</code> - the gemfire properties to initialize the factory with.</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>GemFire 6.5</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="set-java.lang.String-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>set</h4>
+<pre>public <a href="../../../../org/apache/geode/cache/CacheFactory.html" title="class in org.apache.geode.cache">CacheFactory</a> set(java.lang.String name,
+ java.lang.String value)</pre>
+<div class="block">Sets a gemfire property that will be used when creating the Cache.
+ For a list of valid GemFire properties and their meanings
+ see <a href="../../../../org/apache/geode/distributed/ConfigurationProperties.html" title="interface in org.apache.geode.distributed"><code>ConfigurationProperties</code></a>.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>name</code> - the name of the gemfire property</dd>
+<dd><code>value</code> - the value of the gemfire property</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a reference to this CacheFactory object</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>GemFire 6.5</dd>
+</dl>
+</li>
+</ul>
+<a name="create-org.apache.geode.distributed.DistributedSystem-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>create</h4>
+<pre>@Deprecated
+public static <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a> create(<a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed">DistributedSystem</a> system)
+ throws <a href="../../../../org/apache/geode/cache/CacheExistsException.html" title="class in org.apache.geode.cache">CacheExistsException</a>,
+ <a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a>,
+ <a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a>,
+ <a href="../../../../org/apache/geode/cache/GatewayException.html" title="class in org.apache.geode.cache">GatewayException</a>,
+ <a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a></pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/CacheFactory.html#CacheFactory-java.util.Properties-"><code>CacheFactory(Properties)</code></a> instead.</span></div>
+<div class="block">Creates a new cache that uses the specified <code>system</code>.
+
+ <p>
+
+ The <code>system</code> can specify a <A
+ href="../distributed/DistributedSystem.html#cache-xml-file">"cache-xml-file"</a>
+ property which will cause this creation to also create the
+ regions, objects, and attributes declared in the file. The
+ contents of the file must comply with the
+ <code>"doc-files/cache8_0.dtd"></code> file.
+ Note that when parsing the XML file <a href="../../../../org/apache/geode/cache/Declarable.html" title="interface in org.apache.geode.cache"><code>Declarable</code></a> classes
+ are loaded using the current thread's context class loader.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>system</code> - a <code>DistributedSystem</code> obtained by calling
+ <a href="../../../../org/apache/geode/distributed/DistributedSystem.html#connect-java.util.Properties-"><code>DistributedSystem.connect(java.util.Properties)</code></a>.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a <code>Cache</code> that uses the specified
+ <code>system</code> for distribution.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - If <code>system</code> is not <a href="../../../../org/apache/geode/distributed/DistributedSystem.html#isConnected--"><code>connected</code></a>.</dd>
+<dd><code><a href="../../../../org/apache/geode/cache/CacheExistsException.html" title="class in org.apache.geode.cache">CacheExistsException</a></code> - If an open cache already exists.</dd>
+<dd><code><a href="../../../../org/apache/geode/cache/CacheXmlException.html" title="class in org.apache.geode.cache">CacheXmlException</a></code> - If a problem occurs while parsing the declarative caching
+ XML file.</dd>
+<dd><code><a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></code> - If a <a href="../../../../org/apache/geode/cache/Region.html#put-K-V-"><code>Region.put(Object, Object)</code></a> times out while initializing the
+ cache.</dd>
+<dd><code><a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></code> - If a <code>CacheWriterException</code> is thrown while
+ initializing the cache.</dd>
+<dd><code><a href="../../../../org/apache/geode/cache/GatewayException.html" title="class in org.apache.geode.cache">GatewayException</a></code> - If a <code>GatewayException</code> is thrown while
+ initializing the cache.</dd>
+<dd><code><a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a></code> - If the declarative caching XML file describes a region
+ that already exists (including the root region).</dd>
+</dl>
+</li>
+</ul>
+<a name="create--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>create</h4>
+<pre>public <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a> create()
+ throws <a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a>,
+ <a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a>,
+ <a href="../../../../org/apache/geode/cache/GatewayException.html" title="class in org.apache.geode.cache">GatewayException</a>,
+ <a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a></pre>
+<div class="block">Creates a new cache that uses the configured distributed system.
+ If a connected distributed system already exists it will be used
+ if it is compatible with the properties on this factory.
+ Otherwise a a distributed system will be created with the configured properties.
+ If a cache already exists it will be returned.
+ <p>If the cache does need to be created it will also be initialized from
+ cache.xml if it exists.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the created or already existing singleton cache</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../org/apache/geode/cache/CacheXmlException.html" title="class in org.apache.geode.cache">CacheXmlException</a></code> - If a problem occurs while parsing the declarative caching
+ XML file.</dd>
+<dd><code><a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></code> - If a <a href="../../../../org/apache/geode/cache/Region.html#put-K-V-"><code>Region.put(Object, Object)</code></a> times out while initializing the
+ cache.</dd>
+<dd><code><a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></code> - If a <code>CacheWriterException</code> is thrown while
+ initializing the cache.</dd>
+<dd><code><a href="../../../../org/apache/geode/cache/GatewayException.html" title="class in org.apache.geode.cache">GatewayException</a></code> - If a <code>GatewayException</code> is thrown while
+ initializing the cache.</dd>
+<dd><code><a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a></code> - If the declarative caching XML file describes a region
+ that already exists (including the root region).</dd>
+<dd><code>java.lang.IllegalStateException</code> - if cache already exists and is not compatible
+ with the new configuration.</dd>
+<dd><code>AuthenticationFailedException</code> - if authentication fails.</dd>
+<dd><code>AuthenticationRequiredException</code> - if the distributed system is in secure mode
+ and this new member is not configured with security credentials.</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>GemFire 6.5</dd>
+</dl>
+</li>
+</ul>
+<a name="getInstance-org.apache.geode.distributed.DistributedSystem-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getInstance</h4>
+<pre>public static <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a> getInstance(<a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed">DistributedSystem</a> system)</pre>
+<div class="block">Gets the instance of <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>Cache</code></a> produced by an
+ earlier call to <a href="../../../../org/apache/geode/cache/CacheFactory.html#create--"><code>create()</code></a>.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>system</code> - the <code>DistributedSystem</code> the cache was created with.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>Cache</code></a> associated with the specified system.</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 a cache has not been created
+ or the created one is <a href="../../../../org/apache/geode/cache/RegionService.html#isClosed--"><code>closed</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="getInstanceCloseOk-org.apache.geode.distributed.DistributedSystem-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getInstanceCloseOk</h4>
+<pre>public static <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a> getInstanceCloseOk(<a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed">DistributedSystem</a> system)</pre>
+<div class="block">Gets the instance of <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>Cache</code></a> produced by an
+ earlier call to <a href="../../../../org/apache/geode/cache/CacheFactory.html#create--"><code>create()</code></a> even if it has been closed.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>system</code> - the <code>DistributedSystem</code> the cache was created with.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>Cache</code></a> associated with the specified system.</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 a cache has not been created</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>GemFire 3.5</dd>
+</dl>
+</li>
+</ul>
+<a name="getAnyInstance--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getAnyInstance</h4>
+<pre>public static <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a> getAnyInstance()</pre>
+<div class="block">Gets an arbitrary open instance of <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>Cache</code></a> produced by an
+ earlier call to <a href="../../../../org/apache/geode/cache/CacheFactory.html#create--"><code>create()</code></a>.</div>
+<dl>
+<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 a cache has not been created
+ or the only created one is <a href="../../../../org/apache/geode/cache/RegionService.html#isClosed--"><code>closed</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="getVersion--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getVersion</h4>
+<pre>public static java.lang.String getVersion()</pre>
+<div class="block">Returns the version of the cache implementation.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the version of the cache implementation as a <code>String</code></dd>
+</dl>
+</li>
+</ul>
+<a name="setPdxReadSerialized-boolean-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setPdxReadSerialized</h4>
+<pre>public <a href="../../../../org/apache/geode/cache/CacheFactory.html" title="class in org.apache.geode.cache">CacheFactory</a> setPdxReadSerialized(boolean readSerialized)</pre>
+<div class="block">Sets the object preference to PdxInstance type.
+ When a cached object that was serialized as a PDX is read
+ from the cache a <a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx"><code>PdxInstance</code></a> will be returned instead of the actual domain class.
+ The PdxInstance is an interface that provides run time access to
+ the fields of a PDX without deserializing the entire PDX.
+ The PdxInstance implementation is a light weight wrapper
+ that simply refers to the raw bytes of the PDX that are kept
+ in the cache. Using this method applications can choose to
+ access PdxInstance instead of Java object.
+ <p>Note that a PdxInstance is only returned if a serialized PDX is found in the cache.
+ If the cache contains a deserialized PDX, then a domain class instance is returned instead of a PdxInstance.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>readSerialized</code> - true to prefer PdxInstance</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>this CacheFactory</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>GemFire 6.6</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx"><code>PdxInstance</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="setPdxSerializer-org.apache.geode.pdx.PdxSerializer-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setPdxSerializer</h4>
+<pre>public <a href="../../../../org/apache/geode/cache/CacheFactory.html" title="class in org.apache.geode.cache">CacheFactory</a> setPdxSerializer(<a href="../../../../org/apache/geode/pdx/PdxSerializer.html" title="interface in org.apache.geode.pdx">PdxSerializer</a> serializer)</pre>
+<div class="block">Set the PDX serializer for the cache. If this serializer is set,
+ it will be consulted to see if it can serialize any domain classes which are
+ added to the cache in portable data exchange format.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>serializer</code> - the serializer to use</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>this CacheFactory</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>GemFire 6.6</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../org/apache/geode/pdx/PdxSerializer.html" title="interface in org.apache.geode.pdx"><code>PdxSerializer</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="setPdxDiskStore-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setPdxDiskStore</h4>
+<pre>public <a href="../../../../org/apache/geode/cache/CacheFactory.html" title="class in org.apache.geode.cache">CacheFactory</a> setPdxDiskStore(java.lang.String diskStoreName)</pre>
+<div class="block">Set the disk store that is used for PDX meta data. When
+ serializing objects in the PDX format, the type definitions
+ are persisted to disk. This setting controls which disk store
+ is used for that persistence.
+
+ If not set, the metadata will go in the default disk store.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>diskStoreName</code> - the name of the disk store to use
+ for the PDX metadata.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>this CacheFactory</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>GemFire 6.6</dd>
+</dl>
+</li>
+</ul>
+<a name="setPdxPersistent-boolean-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setPdxPersistent</h4>
+<pre>public <a href="../../../../org/apache/geode/cache/CacheFactory.html" title="class in org.apache.geode.cache">CacheFactory</a> setPdxPersistent(boolean isPersistent)</pre>
+<div class="block">Control whether the type metadata for PDX objects is persisted to disk. The
+ default for this setting is false. If you are using persistent regions with
+ PDX then you must set this to true. If you are using a
+ <code>GatewaySender</code> or <code>AsyncEventQueue</code> with PDX then
+ you should set this to true.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>isPersistent</code> - true if the metadata should be persistent</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>this CacheFactory</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>GemFire 6.6</dd>
+</dl>
+</li>
+</ul>
+<a name="setPdxIgnoreUnreadFields-boolean-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>setPdxIgnoreUnreadFields</h4>
+<pre>public <a href="../../../../org/apache/geode/cache/CacheFactory.html" title="class in org.apache.geode.cache">CacheFactory</a> setPdxIgnoreUnreadFields(boolean ignore)</pre>
+<div class="block">Control whether pdx ignores fields that were unread during deserialization.
+ The default is to preserve unread fields be including their data during serialization.
+ But if you configure the cache to ignore unread fields then their data will be lost
+ during serialization.
+ <P>You should only set this attribute to <code>true</code> if you know this member
+ will only be reading cache data. In this use case you do not need to pay the cost
+ of preserving the unread fields since you will never be reserializing pdx data.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>ignore</code> - <code>true</code> if fields not read during pdx deserialization should be ignored;
+ <code>false</code>, the default, if they should be preserved.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>this CacheFactory</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>GemFire 6.6</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/CacheExistsException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/geode/cache/CacheListener.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/CacheFactory.html" target="_top">Frames</a></li>
+<li><a href="CacheFactory.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><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#constructor.detail">Constr</a> | </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/CacheListener.html
----------------------------------------------------------------------
diff --git a/releases/latest/javadoc/org/apache/geode/cache/CacheListener.html b/releases/latest/javadoc/org/apache/geode/cache/CacheListener.html
new file mode 100644
index 0000000..bd43a15
--- /dev/null
+++ b/releases/latest/javadoc/org/apache/geode/cache/CacheListener.html
@@ -0,0 +1,505 @@
+<!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>CacheListener (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="CacheListener (Apache Geode (incubating) 1.0.0-incubating)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":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/CacheFactory.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/geode/cache/CacheLoader.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/CacheListener.html" target="_top">Frames</a></li>
+<li><a href="CacheListener.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 CacheListener" class="title">Interface CacheListener<K,V></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/cache/CacheCallback.html" title="interface in org.apache.geode.cache">CacheCallback</a></dd>
+</dl>
+<dl>
+<dt>All Known Subinterfaces:</dt>
+<dd><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></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/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/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/modules/session/catalina/callback/SessionExpirationCacheListener.html" title="class in org.apache.geode.modules.session.catalina.callback">SessionExpirationCacheListener</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public interface <span class="typeNameLabel">CacheListener<K,V></span>
+extends <a href="../../../../org/apache/geode/cache/CacheCallback.html" title="interface in org.apache.geode.cache">CacheCallback</a></pre>
+<div class="block"><p>
+ A listener to handle region or entry related events.
+ </p>
+
+ <p>
+ Instead of implementing this interface it is recommended that you extend the
+ <a href="../../../../org/apache/geode/cache/util/CacheListenerAdapter.html" title="class in org.apache.geode.cache.util"><code>CacheListenerAdapter</code></a> class.
+ </p>
+
+ <h4>Avoiding the risk of deadlock</h4>
+ <p>
+ The methods on a <code>CacheListener</code> are invoked while holding a lock
+ on the entry described by the <a href="../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache"><code>EntryEvent</code></a>, as a result if the listener
+ method takes a long time to execute then it will cause the operation that
+ caused it to be invoked to take a long time. In addition, listener code which
+ calls <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> methods could result in a deadlock. For example, in
+ <a href="../../../../org/apache/geode/cache/CacheListener.html#afterUpdate-org.apache.geode.cache.EntryEvent-"><code>afterUpdate(EntryEvent)</code></a> for entry key k1,
+ <a href="../../../../org/apache/geode/cache/Region.html#put-K-V-"><code>put(k2, someVal)</code></a> is called at the same
+ time <a href="../../../../org/apache/geode/cache/CacheListener.html#afterUpdate-org.apache.geode.cache.EntryEvent-"><code>afterUpdate(EntryEvent)</code></a> for entry key k2 calls
+ <a href="../../../../org/apache/geode/cache/Region.html#put-K-V-"><code>put(k1, someVal)</code></a> a deadlock may result.
+ This co-key dependency example can be extended to a co-Region dependency
+ where listener code in Region "A" performs Region operations on "B" and
+ listener code in Region "B" performs Region operations on "A". Deadlocks may
+ be either java-level or distributed multi-VM dead locks depending on Region
+ configuration. To be assured of no deadlocks, listener code should cause some
+ other thread to access the region and must not wait for that thread to
+ complete the task.
+ </p>
+
+ <h4>Concurrency</h4>
+ <p>
+ Multiple events, on different entries, can cause concurrent invocation of
+ <code>CacheListener</code> methods. Any exceptions thrown by the listener are
+ caught by GemFire and logged.
+ </p>
+
+ <h4>Declaring instances in Cache XML files</h4>
+ <p>
+ To declare a CacheListener in a Cache XML file, it must also implement
+ <a href="../../../../org/apache/geode/cache/Declarable.html" title="interface in org.apache.geode.cache"><code>Declarable</code></a>
+ </p></div>
+<dl>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>GemFire 3.0</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#addCacheListener-org.apache.geode.cache.CacheListener-"><code>AttributesFactory.addCacheListener(org.apache.geode.cache.CacheListener<K, V>)</code></a>,
+<a href="../../../../org/apache/geode/cache/AttributesFactory.html#initCacheListeners-org.apache.geode.cache.CacheListener:A-"><code>AttributesFactory.initCacheListeners(org.apache.geode.cache.CacheListener<K, V>[])</code></a>,
+<a href="../../../../org/apache/geode/cache/RegionAttributes.html#getCacheListeners--"><code>RegionAttributes.getCacheListeners()</code></a>,
+<a href="../../../../org/apache/geode/cache/AttributesMutator.html#addCacheListener-org.apache.geode.cache.CacheListener-"><code>AttributesMutator.addCacheListener(org.apache.geode.cache.CacheListener<K, V>)</code></a>,
+<a href="../../../../org/apache/geode/cache/AttributesMutator.html#removeCacheListener-org.apache.geode.cache.CacheListener-"><code>AttributesMutator.removeCacheListener(org.apache.geode.cache.CacheListener<K, V>)</code></a>,
+<a href="../../../../org/apache/geode/cache/AttributesMutator.html#initCacheListeners-org.apache.geode.cache.CacheListener:A-"><code>AttributesMutator.initCacheListeners(org.apache.geode.cache.CacheListener<K, V>[])</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></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/CacheListener.html#afterCreate-org.apache.geode.cache.EntryEvent-">afterCreate</a></span>(<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a><<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">K</a>,<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">V</a>> event)</code>
+<div class="block">Handles the event of new key being added to a region.</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/CacheListener.html#afterDestroy-org.apache.geode.cache.EntryEvent-">afterDestroy</a></span>(<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a><<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">K</a>,<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">V</a>> event)</code>
+<div class="block">Handles the event of an entry being destroyed.</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/cache/CacheListener.html#afterInvalidate-org.apache.geode.cache.EntryEvent-">afterInvalidate</a></span>(<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a><<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">K</a>,<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">V</a>> event)</code>
+<div class="block">Handles the event of an entry's value being invalidated.</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/cache/CacheListener.html#afterRegionClear-org.apache.geode.cache.RegionEvent-">afterRegionClear</a></span>(<a href="../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">K</a>,<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">V</a>> event)</code>
+<div class="block">Handles the event of a region being cleared.</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/CacheListener.html#afterRegionCreate-org.apache.geode.cache.RegionEvent-">afterRegionCreate</a></span>(<a href="../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">K</a>,<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">V</a>> event)</code>
+<div class="block">Handles the event of a region being created.</div>
+</td>
+</tr>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/CacheListener.html#afterRegionDestroy-org.apache.geode.cache.RegionEvent-">afterRegionDestroy</a></span>(<a href="../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">K</a>,<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">V</a>> event)</code>
+<div class="block">Handles the event of a region being destroyed.</div>
+</td>
+</tr>
+<tr id="i6" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/CacheListener.html#afterRegionInvalidate-org.apache.geode.cache.RegionEvent-">afterRegionInvalidate</a></span>(<a href="../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">K</a>,<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">V</a>> event)</code>
+<div class="block">Handles the event of a region being invalidated.</div>
+</td>
+</tr>
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/CacheListener.html#afterRegionLive-org.apache.geode.cache.RegionEvent-">afterRegionLive</a></span>(<a href="../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">K</a>,<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">V</a>> event)</code>
+<div class="block">Handles the event of a region being live after receiving the marker from the server.</div>
+</td>
+</tr>
+<tr id="i8" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/CacheListener.html#afterUpdate-org.apache.geode.cache.EntryEvent-">afterUpdate</a></span>(<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a><<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">K</a>,<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">V</a>> event)</code>
+<div class="block">Handles the event of an entry's value being modified in a region.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.cache.CacheCallback">
+<!-- -->
+</a>
+<h3>Methods inherited from interface org.apache.geode.cache.<a href="../../../../org/apache/geode/cache/CacheCallback.html" title="interface in org.apache.geode.cache">CacheCallback</a></h3>
+<code><a href="../../../../org/apache/geode/cache/CacheCallback.html#close--">close</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="afterCreate-org.apache.geode.cache.EntryEvent-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>afterCreate</h4>
+<pre>void afterCreate(<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a><<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">K</a>,<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">V</a>> event)</pre>
+<div class="block">Handles the event of new key being added to a region. The entry did not
+ previously exist in this region in the local cache (even with a null
+ value).</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>event</code> - the EntryEvent</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../org/apache/geode/cache/Region.html#create-K-V-"><code>Region.create(Object, Object)</code></a>,
+<a href="../../../../org/apache/geode/cache/Region.html#put-K-V-"><code>Region.put(Object, Object)</code></a>,
+<a href="../../../../org/apache/geode/cache/Region.html#get-java.lang.Object-"><code>Region.get(Object)</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="afterUpdate-org.apache.geode.cache.EntryEvent-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>afterUpdate</h4>
+<pre>void afterUpdate(<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a><<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">K</a>,<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">V</a>> event)</pre>
+<div class="block">Handles the event of an entry's value being modified in a region. This
+ entry previously existed in this region in the local cache, but its
+ previous value may have been null.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>event</code> - the EntryEvent</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../org/apache/geode/cache/Region.html#put-K-V-"><code>Region.put(Object, Object)</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="afterInvalidate-org.apache.geode.cache.EntryEvent-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>afterInvalidate</h4>
+<pre>void afterInvalidate(<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a><<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">K</a>,<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">V</a>> event)</pre>
+<div class="block">Handles the event of an entry's value being invalidated.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>event</code> - the EntryEvent</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../org/apache/geode/cache/Region.html#invalidate-java.lang.Object-"><code>Region.invalidate(Object)</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="afterDestroy-org.apache.geode.cache.EntryEvent-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>afterDestroy</h4>
+<pre>void afterDestroy(<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a><<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">K</a>,<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">V</a>> event)</pre>
+<div class="block">Handles the event of an entry being destroyed.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>event</code> - the EntryEvent</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../org/apache/geode/cache/Region.html#destroy-java.lang.Object-"><code>Region.destroy(Object)</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="afterRegionInvalidate-org.apache.geode.cache.RegionEvent-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>afterRegionInvalidate</h4>
+<pre>void afterRegionInvalidate(<a href="../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">K</a>,<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">V</a>> event)</pre>
+<div class="block">Handles the event of a region being invalidated. Events are not invoked for
+ each individual value that is invalidated as a result of the region being
+ invalidated. Each subregion, however, gets its own
+ <code>regionInvalidated</code> event invoked on its listener.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>event</code> - the RegionEvent</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../org/apache/geode/cache/Region.html#invalidateRegion--"><code>Region.invalidateRegion()</code></a>,
+<a href="../../../../org/apache/geode/cache/Region.html#localInvalidateRegion--"><code>Region.localInvalidateRegion()</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="afterRegionDestroy-org.apache.geode.cache.RegionEvent-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>afterRegionDestroy</h4>
+<pre>void afterRegionDestroy(<a href="../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">K</a>,<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">V</a>> event)</pre>
+<div class="block">Handles the event of a region being destroyed. Events are not invoked for
+ each individual entry that is destroyed as a result of the region being
+ destroyed. Each subregion, however, gets its own
+ <code>afterRegionDestroyed</code> event invoked on its listener.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>event</code> - the RegionEvent</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../org/apache/geode/cache/Region.html#destroyRegion--"><code>Region.destroyRegion()</code></a>,
+<a href="../../../../org/apache/geode/cache/Region.html#localDestroyRegion--"><code>Region.localDestroyRegion()</code></a>,
+<a href="../../../../org/apache/geode/cache/Region.html#close--"><code>Region.close()</code></a>,
+<a href="../../../../org/apache/geode/cache/RegionService.html#close--"><code>RegionService.close()</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="afterRegionClear-org.apache.geode.cache.RegionEvent-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>afterRegionClear</h4>
+<pre>void afterRegionClear(<a href="../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">K</a>,<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">V</a>> event)</pre>
+<div class="block">Handles the event of a region being cleared. Events are not invoked for
+ each individual entry that is removed as a result of the region being
+ cleared.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>event</code> - the RegionEvent</dd>
+<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/cache/Region.html#clear--"><code>Region.clear()</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="afterRegionCreate-org.apache.geode.cache.RegionEvent-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>afterRegionCreate</h4>
+<pre>void afterRegionCreate(<a href="../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">K</a>,<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">V</a>> event)</pre>
+<div class="block">Handles the event of a region being created. Events are invoked for
+ each individual region that is created.
+ <p>Note that this method is only called
+ for creates done in the local vm. To be notified of creates done in remote
+ vms use <a href="../../../../org/apache/geode/cache/RegionMembershipListener.html#afterRemoteRegionCreate-org.apache.geode.cache.RegionEvent-"><code>RegionMembershipListener.afterRemoteRegionCreate(org.apache.geode.cache.RegionEvent<K, V>)</code></a>.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>event</code> - the RegionEvent</dd>
+<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/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="afterRegionLive-org.apache.geode.cache.RegionEvent-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>afterRegionLive</h4>
+<pre>void afterRegionLive(<a href="../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">K</a>,<a href="../../../../org/apache/geode/cache/CacheListener.html" title="type parameter in CacheListener">V</a>> event)</pre>
+<div class="block">Handles the event of a region being live after receiving the marker from the server.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>event</code> - the RegionEvent</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>GemFire 5.5</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../org/apache/geode/cache/Cache.html#readyForEvents--"><code>Cache.readyForEvents()</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/CacheFactory.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/geode/cache/CacheLoader.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/CacheListener.html" target="_top">Frames</a></li>
+<li><a href="CacheListener.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/CacheLoader.html
----------------------------------------------------------------------
diff --git a/releases/latest/javadoc/org/apache/geode/cache/CacheLoader.html b/releases/latest/javadoc/org/apache/geode/cache/CacheLoader.html
new file mode 100644
index 0000000..dc815d1
--- /dev/null
+++ b/releases/latest/javadoc/org/apache/geode/cache/CacheLoader.html
@@ -0,0 +1,281 @@
+<!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>CacheLoader (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="CacheLoader (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/CacheListener.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/geode/cache/CacheLoaderException.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/CacheLoader.html" target="_top">Frames</a></li>
+<li><a href="CacheLoader.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 CacheLoader" class="title">Interface CacheLoader<K,V></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/cache/CacheCallback.html" title="interface in org.apache.geode.cache">CacheCallback</a></dd>
+</dl>
+<dl>
+<dt>All Known Implementing Classes:</dt>
+<dd><a href="../../../../org/apache/geode/modules/session/catalina/callback/LocalSessionCacheLoader.html" title="class in org.apache.geode.modules.session.catalina.callback">LocalSessionCacheLoader</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public interface <span class="typeNameLabel">CacheLoader<K,V></span>
+extends <a href="../../../../org/apache/geode/cache/CacheCallback.html" title="interface in org.apache.geode.cache">CacheCallback</a></pre>
+<div class="block">Allows data from outside of the VM to be placed into a region.
+ When <a href="../../../../org/apache/geode/cache/Region.html#get-java.lang.Object-"><code>Region.get(Object)</code></a> is called for a region
+ entry that has a <code>null</code> value, the
+ <a href="../../../../org/apache/geode/cache/CacheLoader.html#load-org.apache.geode.cache.LoaderHelper-"><code>load</code></a> method of the
+ region's cache loader is invoked. The <code>load</code> method
+ creates the value for the desired key by performing an operation such
+ as a database query. The <code>load</code> may also perform a
+ <a href="../../../../org/apache/geode/cache/LoaderHelper.html#netSearch-boolean-">net search</a>
+ that will look for the value in a cache instance hosted by
+ another member of the distributed system.</p></div>
+<dl>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>GemFire 2.0</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setCacheLoader-org.apache.geode.cache.CacheLoader-"><code>AttributesFactory.setCacheLoader(org.apache.geode.cache.CacheLoader<K, V>)</code></a>,
+<a href="../../../../org/apache/geode/cache/RegionAttributes.html#getCacheLoader--"><code>RegionAttributes.getCacheLoader()</code></a>,
+<a href="../../../../org/apache/geode/cache/AttributesMutator.html#setCacheLoader-org.apache.geode.cache.CacheLoader-"><code>AttributesMutator.setCacheLoader(org.apache.geode.cache.CacheLoader<K, V>)</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></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/CacheLoader.html" title="type parameter in CacheLoader">V</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/CacheLoader.html#load-org.apache.geode.cache.LoaderHelper-">load</a></span>(<a href="../../../../org/apache/geode/cache/LoaderHelper.html" title="interface in org.apache.geode.cache">LoaderHelper</a><<a href="../../../../org/apache/geode/cache/CacheLoader.html" title="type parameter in CacheLoader">K</a>,<a href="../../../../org/apache/geode/cache/CacheLoader.html" title="type parameter in CacheLoader">V</a>> helper)</code>
+<div class="block">Loads a value.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.cache.CacheCallback">
+<!-- -->
+</a>
+<h3>Methods inherited from interface org.apache.geode.cache.<a href="../../../../org/apache/geode/cache/CacheCallback.html" title="interface in org.apache.geode.cache">CacheCallback</a></h3>
+<code><a href="../../../../org/apache/geode/cache/CacheCallback.html#close--">close</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="load-org.apache.geode.cache.LoaderHelper-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>load</h4>
+<pre><a href="../../../../org/apache/geode/cache/CacheLoader.html" title="type parameter in CacheLoader">V</a> load(<a href="../../../../org/apache/geode/cache/LoaderHelper.html" title="interface in org.apache.geode.cache">LoaderHelper</a><<a href="../../../../org/apache/geode/cache/CacheLoader.html" title="type parameter in CacheLoader">K</a>,<a href="../../../../org/apache/geode/cache/CacheLoader.html" title="type parameter in CacheLoader">V</a>> helper)
+throws <a href="../../../../org/apache/geode/cache/CacheLoaderException.html" title="class in org.apache.geode.cache">CacheLoaderException</a></pre>
+<div class="block">Loads a value. Application writers should implement this
+ method to customize the loading of a value. This method is called
+ by the caching service when the requested value is not in the cache.
+ Any exception (including an unchecked exception) thrown by this
+ method is propagated back to and thrown by the invocation of
+ <a href="../../../../org/apache/geode/cache/Region.html#get-java.lang.Object-java.lang.Object-"><code>Region.get(Object, Object)</code></a> that triggered this load.
+ <p></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>helper</code> - a LoaderHelper object that is passed in from cache service
+ and provides access to the key, region, argument, and <code>netSearch</code>.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the value supplied for this key, or null if no value can be
+ supplied. A local loader will always be invoked if one exists.
+ Otherwise one remote loader is invoked.
+ Returning <code>null</code> causes
+ <a href="../../../../org/apache/geode/cache/Region.html#get-java.lang.Object-java.lang.Object-"><code>Region.get(Object, Object)</code></a> to return <code>null</code>.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>CacheLoaderException,</code> - if an error occurs. This exception or any
+ other exception thrown by this method will be propagated back to the
+ application from the get method.</dd>
+<dd><code><a href="../../../../org/apache/geode/cache/CacheLoaderException.html" title="class in org.apache.geode.cache">CacheLoaderException</a></code></dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../org/apache/geode/cache/Region.html#get-java.lang.Object-java.lang.Object-"><code>Region.get</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/CacheListener.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/geode/cache/CacheLoaderException.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/CacheLoader.html" target="_top">Frames</a></li>
+<li><a href="CacheLoader.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>