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/03/12 01:29:53 UTC
[13/51] [partial] incubator-geode git commit: GEODE-54: Missing
javadocs
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheTransactionManager.html
----------------------------------------------------------------------
diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheTransactionManager.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheTransactionManager.html
new file mode 100644
index 0000000..095bf2c
--- /dev/null
+++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheTransactionManager.html
@@ -0,0 +1,853 @@
+<!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 Fri Mar 11 16:13:08 PST 2016 -->
+<title>CacheTransactionManager (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)</title>
+<meta name="date" content="2016-03-11">
+<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="CacheTransactionManager (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":38,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":38,"i17":6,"i18":6,"i19":6,"i20":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="../../../../com/gemstone/gemfire/cache/CacheStatistics.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/gemstone/gemfire/cache/CacheTransactionManager.html" target="_top">Frames</a></li>
+<li><a href="CacheTransactionManager.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">com.gemstone.gemfire.cache</div>
+<h2 title="Interface CacheTransactionManager" class="title">Interface CacheTransactionManager</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public interface <span class="typeNameLabel">CacheTransactionManager</span></pre>
+<div class="block"><p>The CacheTransactionManager interface allows applications to manage
+ transactions on a per <a href="../../../../com/gemstone/gemfire/cache/Cache.html" title="interface in com.gemstone.gemfire.cache"><code>Cache</code></a> basis.
+
+ <p>The life cycle of a GemFire transaction starts with a begin
+ operation. The life cycle ends with either a commit or rollback
+ operation. Between the begin and the commit/rollback are typically
+ <a href="../../../../com/gemstone/gemfire/cache/Region.html" title="interface in com.gemstone.gemfire.cache"><code>Region</code></a> operations. In general, those that either create,
+ destroy, invalidate or update <a href="../../../../com/gemstone/gemfire/cache/Region.Entry.html" title="interface in com.gemstone.gemfire.cache"><code>Region.Entry</code></a> are considered
+ transactional, that is they modify transactional state.
+
+ <p>A GemFire transaction may involve operations on multiple regions,
+ each of which may have different attributes.
+
+ <p>While a GemFire transaction and its operations are invoked in
+ the local VM, the resulting transaction state is distributed to
+ other VM's at commit time as per the attributes of each
+ participant Region.
+
+ <p>A transaction can have no more than one thread associated with
+ it and conversely a thread can only operate on one transaction at
+ any given time. Child threads will not inherit the existing
+ transaction.
+
+ <p>Each of the following methods operate on the current thread. All
+ methods throw <a href="../../../../com/gemstone/gemfire/cache/CacheClosedException.html" title="class in com.gemstone.gemfire.cache"><code>CacheClosedException</code></a> if the Cache is closed.
+
+ <p>GemFire Transactions currently only support Read Committed
+ isolation. In addition, they are optimistic transactions in that
+ write locking and conflict checks are performed as part of the
+ commit operation.
+
+ <p>For guaranteed Read Committed isolation, avoid making "in place"
+ changes, because such changes will be "seen" by other transactions
+ and break the Read Committed isolation guarantee. e.g.
+
+ <pre>
+ CacheTransactionManager txMgr = cache.getCacheTransactionManager();
+ txMgr.begin();
+ StringBuffer s = (StringBuffer) r.get("stringBuf");
+ s.append("Changes seen before commit. NOT Read Committed!");
+ r.put("stringBuf", s);
+ txMgr.commit();
+ </pre>
+
+ <p>To aid in creating copies, the "copy on read"
+ <code>Cache</code> attribute and the <a href="../../../../com/gemstone/gemfire/CopyHelper.html#copy-T-"><code>CopyHelper.copy(T)</code></a> method are provided.
+ The following is a Read Committed safe example using the
+ <code>CopyHelper.copy</code> method.
+
+ <pre>
+ CacheTransactionManager txMgr = cache.getCacheTransactionManager();
+ txMgr.begin();
+ Object o = r.get("stringBuf");
+ StringBuffer s = (StringBuffer) CopyHelper.copy(o);
+ s.append("Changes unseen before commit. Read Committed.");
+ r.put("stringBuf", s);
+ txMgr.commit();
+ </pre>
+
+ <p>Its important to note that creating copies can negatively
+ impact both performance and memory consumption.
+
+ <p>Partitioned Regions, Distributed No Ack and Distributed Ack Regions are supported
+ (see <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="class in com.gemstone.gemfire.cache"><code>AttributesFactory</code></a> for Scope). For both scopes, a
+ consistent configuration (per VM) is enforced.
+
+ <p>Global Regions, client Regions (see com.gemstone.gemfire.cache.client package)
+ and persistent Regions (see <a href="../../../../com/gemstone/gemfire/cache/DiskWriteAttributes.html" title="interface in com.gemstone.gemfire.cache"><code>DiskWriteAttributes</code></a>) do not
+ support transactions.
+
+ <p>When PartitionedRegions are involved in a transaction, all data in the
+ transaction must be colocated together on one data node. See the GemFire
+ Developer Guide for details on using transactions with Partitioned Regions.</div>
+<dl>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>4.0</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../com/gemstone/gemfire/cache/Cache.html" title="interface in com.gemstone.gemfire.cache"><code>Cache</code></a></dd>
+</dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#addListener-com.gemstone.gemfire.cache.TransactionListener-">addListener</a></span>(<a href="../../../../com/gemstone/gemfire/cache/TransactionListener.html" title="interface in com.gemstone.gemfire.cache">TransactionListener</a> aListener)</code>
+<div class="block">Adds a transaction listener to the end of the list of transaction listeners on 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="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#begin--">begin</a></span>()</code>
+<div class="block">Creates a new transaction and associates it with the current thread.</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#commit--">commit</a></span>()</code>
+<div class="block">Commit the transaction associated with the current thread.</div>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#exists--">exists</a></span>()</code>
+<div class="block">Reports the existence of a Transaction for this thread</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#exists-com.gemstone.gemfire.cache.TransactionId-">exists</a></span>(<a href="../../../../com/gemstone/gemfire/cache/TransactionId.html" title="interface in com.gemstone.gemfire.cache">TransactionId</a> transactionId)</code>
+<div class="block">Reports the existence of a transaction for the given transactionId.</div>
+</td>
+</tr>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code><a href="../../../../com/gemstone/gemfire/cache/TransactionListener.html" title="interface in com.gemstone.gemfire.cache">TransactionListener</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#getListener--">getListener</a></span>()</code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#getListeners--"><code>getListeners()</code></a> instead</span></div>
+</div>
+</td>
+</tr>
+<tr id="i6" class="altColor">
+<td class="colFirst"><code><a href="../../../../com/gemstone/gemfire/cache/TransactionListener.html" title="interface in com.gemstone.gemfire.cache">TransactionListener</a>[]</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#getListeners--">getListeners</a></span>()</code>
+<div class="block">Returns an array of all the transaction listeners on this cache.</div>
+</td>
+</tr>
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code><a href="../../../../com/gemstone/gemfire/cache/TransactionId.html" title="interface in com.gemstone.gemfire.cache">TransactionId</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#getTransactionId--">getTransactionId</a></span>()</code>
+<div class="block">Returns the transaction identifier for the current thread</div>
+</td>
+</tr>
+<tr id="i8" class="altColor">
+<td class="colFirst"><code><a href="../../../../com/gemstone/gemfire/cache/TransactionWriter.html" title="interface in com.gemstone.gemfire.cache">TransactionWriter</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#getWriter--">getWriter</a></span>()</code>
+<div class="block">Returns the current <a href="../../../../com/gemstone/gemfire/cache/TransactionWriter.html" title="interface in com.gemstone.gemfire.cache"><code>TransactionWriter</code></a></div>
+</td>
+</tr>
+<tr id="i9" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#initListeners-com.gemstone.gemfire.cache.TransactionListener:A-">initListeners</a></span>(<a href="../../../../com/gemstone/gemfire/cache/TransactionListener.html" title="interface in com.gemstone.gemfire.cache">TransactionListener</a>[] newListeners)</code>
+<div class="block">Removes all transaction listeners, calling <a href="../../../../com/gemstone/gemfire/cache/CacheCallback.html#close--"><code>CacheCallback.close()</code></a> on each of them, and then adds each listener in the specified array.</div>
+</td>
+</tr>
+<tr id="i10" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#isDistributed--">isDistributed</a></span>()</code>
+<div class="block">Returns the execution mode of transactions</div>
+</td>
+</tr>
+<tr id="i11" class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#isSuspended-com.gemstone.gemfire.cache.TransactionId-">isSuspended</a></span>(<a href="../../../../com/gemstone/gemfire/cache/TransactionId.html" title="interface in com.gemstone.gemfire.cache">TransactionId</a> transactionId)</code>
+<div class="block">This method can be used to determine if a transaction with the given
+ transaction identifier is currently suspended locally.</div>
+</td>
+</tr>
+<tr id="i12" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#removeListener-com.gemstone.gemfire.cache.TransactionListener-">removeListener</a></span>(<a href="../../../../com/gemstone/gemfire/cache/TransactionListener.html" title="interface in com.gemstone.gemfire.cache">TransactionListener</a> aListener)</code>
+<div class="block">Removes a transaction listener from the list of transaction listeners on this cache.</div>
+</td>
+</tr>
+<tr id="i13" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#resume-com.gemstone.gemfire.cache.TransactionId-">resume</a></span>(<a href="../../../../com/gemstone/gemfire/cache/TransactionId.html" title="interface in com.gemstone.gemfire.cache">TransactionId</a> transactionId)</code>
+<div class="block">On the current thread, resumes a transaction that was previously suspended
+ using <a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#suspend--"><code>suspend()</code></a></div>
+</td>
+</tr>
+<tr id="i14" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#rollback--">rollback</a></span>()</code>
+<div class="block">Roll back the transaction associated with the current thread.</div>
+</td>
+</tr>
+<tr id="i15" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#setDistributed-boolean-">setDistributed</a></span>(boolean distributed)</code>
+<div class="block">Sets whether transactions should be executed in distributed or
+ non-distributed mode.</div>
+</td>
+</tr>
+<tr id="i16" class="altColor">
+<td class="colFirst"><code><a href="../../../../com/gemstone/gemfire/cache/TransactionListener.html" title="interface in com.gemstone.gemfire.cache">TransactionListener</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#setListener-com.gemstone.gemfire.cache.TransactionListener-">setListener</a></span>(<a href="../../../../com/gemstone/gemfire/cache/TransactionListener.html" title="interface in com.gemstone.gemfire.cache">TransactionListener</a> newListener)</code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#addListener-com.gemstone.gemfire.cache.TransactionListener-"><code>addListener(com.gemstone.gemfire.cache.TransactionListener)</code></a> or <a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#initListeners-com.gemstone.gemfire.cache.TransactionListener:A-"><code>initListeners(com.gemstone.gemfire.cache.TransactionListener[])</code></a> instead.</span></div>
+</div>
+</td>
+</tr>
+<tr id="i17" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#setWriter-com.gemstone.gemfire.cache.TransactionWriter-">setWriter</a></span>(<a href="../../../../com/gemstone/gemfire/cache/TransactionWriter.html" title="interface in com.gemstone.gemfire.cache">TransactionWriter</a> writer)</code>
+<div class="block">Set the TransactionWriter for the cache</div>
+</td>
+</tr>
+<tr id="i18" class="altColor">
+<td class="colFirst"><code><a href="../../../../com/gemstone/gemfire/cache/TransactionId.html" title="interface in com.gemstone.gemfire.cache">TransactionId</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#suspend--">suspend</a></span>()</code>
+<div class="block">Suspends the transaction on the current thread.</div>
+</td>
+</tr>
+<tr id="i19" class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#tryResume-com.gemstone.gemfire.cache.TransactionId-">tryResume</a></span>(<a href="../../../../com/gemstone/gemfire/cache/TransactionId.html" title="interface in com.gemstone.gemfire.cache">TransactionId</a> transactionId)</code>
+<div class="block">On the current thread, resumes a transaction that was previously suspended
+ using <a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#suspend--"><code>suspend()</code></a>.</div>
+</td>
+</tr>
+<tr id="i20" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#tryResume-com.gemstone.gemfire.cache.TransactionId-long-java.util.concurrent.TimeUnit-">tryResume</a></span>(<a href="../../../../com/gemstone/gemfire/cache/TransactionId.html" title="interface in com.gemstone.gemfire.cache">TransactionId</a> transactionId,
+ long time,
+ java.util.concurrent.TimeUnit unit)</code>
+<div class="block">On the current thread, resumes a transaction that was previously suspended
+ using <a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#suspend--"><code>suspend()</code></a>, or waits for the specified timeout interval if
+ the transaction has not been suspended.</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="begin--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>begin</h4>
+<pre>void begin()</pre>
+<div class="block">Creates a new transaction and associates it with the current thread.</div>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if the thread is already associated with a transaction</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>4.0</dd>
+</dl>
+</li>
+</ul>
+<a name="commit--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>commit</h4>
+<pre>void commit()
+ throws <a href="../../../../com/gemstone/gemfire/cache/CommitConflictException.html" title="class in com.gemstone.gemfire.cache">CommitConflictException</a></pre>
+<div class="block">Commit the transaction associated with the current thread. If
+ the commit operation fails due to a conflict it will destroy
+ the transaction state and throw a <a href="../../../../com/gemstone/gemfire/cache/CommitConflictException.html" title="class in com.gemstone.gemfire.cache"><code>CommitConflictException</code></a>. If the commit operation succeeds,
+ it returns after the transaction state has been merged with
+ committed state. When this method completes, the thread is no
+ longer associated with a transaction.</div>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if the thread is not associated with a transaction</dd>
+<dd><code><a href="../../../../com/gemstone/gemfire/cache/CommitConflictException.html" title="class in com.gemstone.gemfire.cache">CommitConflictException</a></code> - if the commit operation fails due to
+ a write conflict.</dd>
+<dd><code><a href="../../../../com/gemstone/gemfire/cache/TransactionDataNodeHasDepartedException.html" title="class in com.gemstone.gemfire.cache">TransactionDataNodeHasDepartedException</a></code> - if the node hosting the
+ transaction data has departed. This is only relevant for transaction that
+ involve PartitionedRegions.</dd>
+<dd><code><a href="../../../../com/gemstone/gemfire/cache/TransactionDataNotColocatedException.html" title="class in com.gemstone.gemfire.cache">TransactionDataNotColocatedException</a></code> - if at commit time, the data
+ involved in the transaction has moved away from the transaction hosting
+ node. This can only happen if rebalancing/recovery happens during a
+ transaction that involves a PartitionedRegion.</dd>
+<dd><code><a href="../../../../com/gemstone/gemfire/cache/TransactionInDoubtException.html" title="class in com.gemstone.gemfire.cache">TransactionInDoubtException</a></code> - when GemFire cannot tell which nodes
+ have applied the transaction and which have not. This only occurs if nodes
+ fail mid-commit, and only then in very rare circumstances.</dd>
+</dl>
+</li>
+</ul>
+<a name="rollback--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>rollback</h4>
+<pre>void rollback()</pre>
+<div class="block">Roll back the transaction associated with the current thread. When
+ this method completes, the thread is no longer associated with a
+ transaction and the transaction context is destroyed.</div>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if the thread is not associated with a transaction</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>4.0</dd>
+</dl>
+</li>
+</ul>
+<a name="suspend--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>suspend</h4>
+<pre><a href="../../../../com/gemstone/gemfire/cache/TransactionId.html" title="interface in com.gemstone.gemfire.cache">TransactionId</a> suspend()</pre>
+<div class="block">Suspends the transaction on the current thread. All subsequent operations
+ performed by this thread will be non-transactional. The suspended
+ transaction can be resumed by calling <a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#resume-com.gemstone.gemfire.cache.TransactionId-"><code>resume(TransactionId)</code></a></div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the transaction identifier of the suspended transaction or null if
+ the thread was not associated with a transaction</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>6.6.2</dd>
+</dl>
+</li>
+</ul>
+<a name="resume-com.gemstone.gemfire.cache.TransactionId-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>resume</h4>
+<pre>void resume(<a href="../../../../com/gemstone/gemfire/cache/TransactionId.html" title="interface in com.gemstone.gemfire.cache">TransactionId</a> transactionId)</pre>
+<div class="block">On the current thread, resumes a transaction that was previously suspended
+ using <a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#suspend--"><code>suspend()</code></a></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>transactionId</code> - the transaction to resume</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if the thread is associated with a transaction or if
+ <a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#isSuspended-com.gemstone.gemfire.cache.TransactionId-"><code>isSuspended(TransactionId)</code></a> would return false for the
+ given transactionId</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>6.6.2</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#tryResume-com.gemstone.gemfire.cache.TransactionId-"><code>tryResume(TransactionId)</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="isSuspended-com.gemstone.gemfire.cache.TransactionId-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isSuspended</h4>
+<pre>boolean isSuspended(<a href="../../../../com/gemstone/gemfire/cache/TransactionId.html" title="interface in com.gemstone.gemfire.cache">TransactionId</a> transactionId)</pre>
+<div class="block">This method can be used to determine if a transaction with the given
+ transaction identifier is currently suspended locally. This method does not
+ check other members for transaction status.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>transactionId</code> - </dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if the transaction is in suspended state, false otherwise</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>6.6.2</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#exists-com.gemstone.gemfire.cache.TransactionId-"><code>exists(TransactionId)</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="tryResume-com.gemstone.gemfire.cache.TransactionId-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>tryResume</h4>
+<pre>boolean tryResume(<a href="../../../../com/gemstone/gemfire/cache/TransactionId.html" title="interface in com.gemstone.gemfire.cache">TransactionId</a> transactionId)</pre>
+<div class="block">On the current thread, resumes a transaction that was previously suspended
+ using <a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#suspend--"><code>suspend()</code></a>.
+
+ This method is equivalent to
+ <pre>
+ if (isSuspended(txId)) {
+ resume(txId);
+ }
+ </pre>
+ except that this action is performed atomically</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>transactionId</code> - the transaction to resume</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if the transaction was resumed, false otherwise</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>6.6.2</dd>
+</dl>
+</li>
+</ul>
+<a name="tryResume-com.gemstone.gemfire.cache.TransactionId-long-java.util.concurrent.TimeUnit-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>tryResume</h4>
+<pre>boolean tryResume(<a href="../../../../com/gemstone/gemfire/cache/TransactionId.html" title="interface in com.gemstone.gemfire.cache">TransactionId</a> transactionId,
+ long time,
+ java.util.concurrent.TimeUnit unit)</pre>
+<div class="block">On the current thread, resumes a transaction that was previously suspended
+ using <a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#suspend--"><code>suspend()</code></a>, or waits for the specified timeout interval if
+ the transaction has not been suspended. This method will return if:
+ <ul>
+ <li>Another thread suspends the transaction</li>
+ <li>Another thread calls commit/rollback on the transaction</li>
+ <li>This thread has waited for the specified timeout</li>
+ </ul>
+
+ This method returns immediately if <a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#exists-com.gemstone.gemfire.cache.TransactionId-"><code>exists(TransactionId)</code></a> returns false.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>transactionId</code> - the transaction to resume</dd>
+<dd><code>time</code> - the maximum time to wait</dd>
+<dd><code>unit</code> - the time unit of the <code>time</code> argument</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if the transaction was resumed, false otherwise</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>6.6.2</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#tryResume-com.gemstone.gemfire.cache.TransactionId-"><code>tryResume(TransactionId)</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="exists-com.gemstone.gemfire.cache.TransactionId-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>exists</h4>
+<pre>boolean exists(<a href="../../../../com/gemstone/gemfire/cache/TransactionId.html" title="interface in com.gemstone.gemfire.cache">TransactionId</a> transactionId)</pre>
+<div class="block">Reports the existence of a transaction for the given transactionId. This
+ method can be used to determine if a transaction with the given transaction
+ identifier is currently in progress locally.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>transactionId</code> - the given transaction identifier</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if the transaction is in progress, false otherwise.</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>6.6.2</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#isSuspended-com.gemstone.gemfire.cache.TransactionId-"><code>isSuspended(TransactionId)</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="exists--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>exists</h4>
+<pre>boolean exists()</pre>
+<div class="block">Reports the existence of a Transaction for this thread</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if a transaction exists, false otherwise</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>4.0</dd>
+</dl>
+</li>
+</ul>
+<a name="getTransactionId--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getTransactionId</h4>
+<pre><a href="../../../../com/gemstone/gemfire/cache/TransactionId.html" title="interface in com.gemstone.gemfire.cache">TransactionId</a> getTransactionId()</pre>
+<div class="block">Returns the transaction identifier for the current thread</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the transaction identifier or null if no transaction exists</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>4.0</dd>
+</dl>
+</li>
+</ul>
+<a name="getListener--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getListener</h4>
+<pre>@Deprecated
+<a href="../../../../com/gemstone/gemfire/cache/TransactionListener.html" title="interface in com.gemstone.gemfire.cache">TransactionListener</a> getListener()</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#getListeners--"><code>getListeners()</code></a> instead</span></div>
+<div class="block">Gets the transaction listener for this Cache.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The TransactionListener instance or null if no listener.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if more than one listener exists on this cache</dd>
+</dl>
+</li>
+</ul>
+<a name="getListeners--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getListeners</h4>
+<pre><a href="../../../../com/gemstone/gemfire/cache/TransactionListener.html" title="interface in com.gemstone.gemfire.cache">TransactionListener</a>[] getListeners()</pre>
+<div class="block">Returns an array of all the transaction listeners on this cache.
+ Modifications to the returned array will not effect what listeners are on this cache.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the cache's <code>TransactionListener</code>s; an empty array if no listeners</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>5.0</dd>
+</dl>
+</li>
+</ul>
+<a name="setListener-com.gemstone.gemfire.cache.TransactionListener-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setListener</h4>
+<pre>@Deprecated
+<a href="../../../../com/gemstone/gemfire/cache/TransactionListener.html" title="interface in com.gemstone.gemfire.cache">TransactionListener</a> setListener(<a href="../../../../com/gemstone/gemfire/cache/TransactionListener.html" title="interface in com.gemstone.gemfire.cache">TransactionListener</a> newListener)</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#addListener-com.gemstone.gemfire.cache.TransactionListener-"><code>addListener(com.gemstone.gemfire.cache.TransactionListener)</code></a> or <a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#initListeners-com.gemstone.gemfire.cache.TransactionListener:A-"><code>initListeners(com.gemstone.gemfire.cache.TransactionListener[])</code></a> instead.</span></div>
+<div class="block">Sets the transaction listener for this Cache.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>newListener</code> - the TransactionListener to register with the Cache.
+ Use a <code>null</code> to deregister the current listener without
+ registering a new one.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the previous TransactionListener</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if more than one listener exists on this cache</dd>
+</dl>
+</li>
+</ul>
+<a name="addListener-com.gemstone.gemfire.cache.TransactionListener-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addListener</h4>
+<pre>void addListener(<a href="../../../../com/gemstone/gemfire/cache/TransactionListener.html" title="interface in com.gemstone.gemfire.cache">TransactionListener</a> aListener)</pre>
+<div class="block">Adds a transaction listener to the end of the list of transaction listeners on this cache.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>aListener</code> - the user defined transaction listener to add to the cache.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if <code>aListener</code> is null</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>5.0</dd>
+</dl>
+</li>
+</ul>
+<a name="removeListener-com.gemstone.gemfire.cache.TransactionListener-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>removeListener</h4>
+<pre>void removeListener(<a href="../../../../com/gemstone/gemfire/cache/TransactionListener.html" title="interface in com.gemstone.gemfire.cache">TransactionListener</a> aListener)</pre>
+<div class="block">Removes a transaction listener from the list of transaction listeners on this cache.
+ Does nothing if the specified listener has not been added.
+ If the specified listener has been added then <a href="../../../../com/gemstone/gemfire/cache/CacheCallback.html#close--"><code>CacheCallback.close()</code></a> will
+ be called on it; otherwise does nothing.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>aListener</code> - the transaction listener to remove from the cache.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if <code>aListener</code> is null</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>5.0</dd>
+</dl>
+</li>
+</ul>
+<a name="initListeners-com.gemstone.gemfire.cache.TransactionListener:A-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>initListeners</h4>
+<pre>void initListeners(<a href="../../../../com/gemstone/gemfire/cache/TransactionListener.html" title="interface in com.gemstone.gemfire.cache">TransactionListener</a>[] newListeners)</pre>
+<div class="block">Removes all transaction listeners, calling <a href="../../../../com/gemstone/gemfire/cache/CacheCallback.html#close--"><code>CacheCallback.close()</code></a> on each of them, and then adds each listener in the specified array.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>newListeners</code> - a possibly null or empty array of listeners to add to this cache.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if the <code>newListeners</code> array has a null element</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>5.0</dd>
+</dl>
+</li>
+</ul>
+<a name="setWriter-com.gemstone.gemfire.cache.TransactionWriter-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setWriter</h4>
+<pre>void setWriter(<a href="../../../../com/gemstone/gemfire/cache/TransactionWriter.html" title="interface in com.gemstone.gemfire.cache">TransactionWriter</a> writer)</pre>
+<div class="block">Set the TransactionWriter for the cache</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>writer</code> - </dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>6.5</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../com/gemstone/gemfire/cache/TransactionWriter.html" title="interface in com.gemstone.gemfire.cache"><code>TransactionWriter</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="getWriter--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getWriter</h4>
+<pre><a href="../../../../com/gemstone/gemfire/cache/TransactionWriter.html" title="interface in com.gemstone.gemfire.cache">TransactionWriter</a> getWriter()</pre>
+<div class="block">Returns the current <a href="../../../../com/gemstone/gemfire/cache/TransactionWriter.html" title="interface in com.gemstone.gemfire.cache"><code>TransactionWriter</code></a></div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the current <a href="../../../../com/gemstone/gemfire/cache/TransactionWriter.html" title="interface in com.gemstone.gemfire.cache"><code>TransactionWriter</code></a></dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>6.5</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html#setWriter-com.gemstone.gemfire.cache.TransactionWriter-"><code>setWriter(TransactionWriter)</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="setDistributed-boolean-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setDistributed</h4>
+<pre>void setDistributed(boolean distributed)</pre>
+<div class="block">Sets whether transactions should be executed in distributed or
+ non-distributed mode. Once set this mode should not be changed during
+ the course of transactions.</div>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if a transaction is already in progress
+ and this method sets the distributed mode to a different value.</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>9.0</dd>
+</dl>
+</li>
+</ul>
+<a name="isDistributed--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>isDistributed</h4>
+<pre>boolean isDistributed()</pre>
+<div class="block">Returns the execution mode of transactions</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if distributed,
+ false otherwise.</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>9.0</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../index-all.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../com/gemstone/gemfire/cache/CacheStatistics.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/gemstone/gemfire/cache/CacheTransactionManager.html" target="_top">Frames</a></li>
+<li><a href="CacheTransactionManager.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/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheWriter.html
----------------------------------------------------------------------
diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheWriter.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheWriter.html
new file mode 100644
index 0000000..c2b6e1c
--- /dev/null
+++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheWriter.html
@@ -0,0 +1,419 @@
+<!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 Fri Mar 11 16:13:08 PST 2016 -->
+<title>CacheWriter (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)</title>
+<meta name="date" content="2016-03-11">
+<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="CacheWriter (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../com/gemstone/gemfire/cache/CacheWriterException.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/gemstone/gemfire/cache/CacheWriter.html" target="_top">Frames</a></li>
+<li><a href="CacheWriter.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">com.gemstone.gemfire.cache</div>
+<h2 title="Interface CacheWriter" class="title">Interface CacheWriter<K,V></h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Superinterfaces:</dt>
+<dd><a href="../../../../com/gemstone/gemfire/cache/CacheCallback.html" title="interface in com.gemstone.gemfire.cache">CacheCallback</a></dd>
+</dl>
+<dl>
+<dt>All Known Implementing Classes:</dt>
+<dd><a href="../../../../com/gemstone/gemfire/cache/util/CacheWriterAdapter.html" title="class in com.gemstone.gemfire.cache.util">CacheWriterAdapter</a>, <a href="../../../../com/gemstone/gemfire/modules/session/catalina/callback/LocalSessionCacheWriter.html" title="class in com.gemstone.gemfire.modules.session.catalina.callback">LocalSessionCacheWriter</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public interface <span class="typeNameLabel">CacheWriter<K,V></span>
+extends <a href="../../../../com/gemstone/gemfire/cache/CacheCallback.html" title="interface in com.gemstone.gemfire.cache">CacheCallback</a></pre>
+<div class="block">A user-defined object defined in the <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html" title="interface in com.gemstone.gemfire.cache"><code>RegionAttributes</code></a> that is
+ called synchronously before a region or entry in the cache is
+ modified. The typical use for a <code>CacheWriter</code> is to update a database.
+ Application writers should implement these methods to execute
+ application-specific behavior before the cache is modified.
+
+ <p>Before the region is updated via a put, create, or destroy operation,
+ GemFire will call a <code>CacheWriter</code> that is installed anywhere in any
+ participating cache for that region, preferring a local <code>CacheWriter</code>
+ if there is one. Usually there will be only one <code>CacheWriter</code> in
+ the distributed system. If there are multiple <code>CacheWriter</code>s
+ available in the distributed system, the GemFire
+ implementation always prefers one that is stored locally, or else picks one
+ arbitrarily; in any case only one <code>CacheWriter</code> will be invoked.
+
+ <p>The <code>CacheWriter</code> is capable of aborting the update to the cache by throwing
+ a <code>CacheWriterException</code>. This exception or any runtime exception
+ thrown by the <code>CacheWriter</code> will abort the operation and the
+ exception will be propagated to the initiator of the operation, regardless
+ of whether the initiator is in the same VM as the <code>CacheWriter</code>.</div>
+<dl>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>3.0</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setCacheWriter-com.gemstone.gemfire.cache.CacheWriter-"><code>AttributesFactory.setCacheWriter(com.gemstone.gemfire.cache.CacheWriter<K, V>)</code></a>,
+<a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getCacheWriter--"><code>RegionAttributes.getCacheWriter()</code></a>,
+<a href="../../../../com/gemstone/gemfire/cache/AttributesMutator.html#setCacheWriter-com.gemstone.gemfire.cache.CacheWriter-"><code>AttributesMutator.setCacheWriter(com.gemstone.gemfire.cache.CacheWriter<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="../../../../com/gemstone/gemfire/cache/CacheWriter.html#beforeCreate-com.gemstone.gemfire.cache.EntryEvent-">beforeCreate</a></span>(<a href="../../../../com/gemstone/gemfire/cache/EntryEvent.html" title="interface in com.gemstone.gemfire.cache">EntryEvent</a><<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">K</a>,<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">V</a>> event)</code>
+<div class="block">Called before an entry is created.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html#beforeDestroy-com.gemstone.gemfire.cache.EntryEvent-">beforeDestroy</a></span>(<a href="../../../../com/gemstone/gemfire/cache/EntryEvent.html" title="interface in com.gemstone.gemfire.cache">EntryEvent</a><<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">K</a>,<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">V</a>> event)</code>
+<div class="block">Called before an entry is 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="../../../../com/gemstone/gemfire/cache/CacheWriter.html#beforeRegionClear-com.gemstone.gemfire.cache.RegionEvent-">beforeRegionClear</a></span>(<a href="../../../../com/gemstone/gemfire/cache/RegionEvent.html" title="interface in com.gemstone.gemfire.cache">RegionEvent</a><<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">K</a>,<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">V</a>> event)</code>
+<div class="block">Called before a region is cleared.</div>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html#beforeRegionDestroy-com.gemstone.gemfire.cache.RegionEvent-">beforeRegionDestroy</a></span>(<a href="../../../../com/gemstone/gemfire/cache/RegionEvent.html" title="interface in com.gemstone.gemfire.cache">RegionEvent</a><<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">K</a>,<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">V</a>> event)</code>
+<div class="block">Called before a region is destroyed.</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html#beforeUpdate-com.gemstone.gemfire.cache.EntryEvent-">beforeUpdate</a></span>(<a href="../../../../com/gemstone/gemfire/cache/EntryEvent.html" title="interface in com.gemstone.gemfire.cache">EntryEvent</a><<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">K</a>,<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">V</a>> event)</code>
+<div class="block">Called before an entry is updated.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.com.gemstone.gemfire.cache.CacheCallback">
+<!-- -->
+</a>
+<h3>Methods inherited from interface com.gemstone.gemfire.cache.<a href="../../../../com/gemstone/gemfire/cache/CacheCallback.html" title="interface in com.gemstone.gemfire.cache">CacheCallback</a></h3>
+<code><a href="../../../../com/gemstone/gemfire/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="beforeUpdate-com.gemstone.gemfire.cache.EntryEvent-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>beforeUpdate</h4>
+<pre>void beforeUpdate(<a href="../../../../com/gemstone/gemfire/cache/EntryEvent.html" title="interface in com.gemstone.gemfire.cache">EntryEvent</a><<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">K</a>,<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">V</a>> event)
+ throws <a href="../../../../com/gemstone/gemfire/cache/CacheWriterException.html" title="class in com.gemstone.gemfire.cache">CacheWriterException</a></pre>
+<div class="block">Called before an entry is updated. The entry update is initiated by a <code>put</code>
+ or a <code>get</code> that causes the loader to update an existing entry.
+ The entry previously existed in the cache where the operation was
+ initiated, although the old value may have been null. The entry being
+ updated may or may not exist in the local cache where the CacheWriter is
+ installed.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>event</code> - an EntryEvent that provides information about the operation in progress</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../com/gemstone/gemfire/cache/CacheWriterException.html" title="class in com.gemstone.gemfire.cache">CacheWriterException</a></code> - if thrown will abort the operation in progress,
+ and the exception will be propagated back to caller that initiated
+ the operation</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../com/gemstone/gemfire/cache/Region.html#put-K-V-"><code>Region.put(Object, Object)</code></a>,
+<a href="../../../../com/gemstone/gemfire/cache/Region.html#get-java.lang.Object-"><code>Region.get(Object)</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="beforeCreate-com.gemstone.gemfire.cache.EntryEvent-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>beforeCreate</h4>
+<pre>void beforeCreate(<a href="../../../../com/gemstone/gemfire/cache/EntryEvent.html" title="interface in com.gemstone.gemfire.cache">EntryEvent</a><<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">K</a>,<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">V</a>> event)
+ throws <a href="../../../../com/gemstone/gemfire/cache/CacheWriterException.html" title="class in com.gemstone.gemfire.cache">CacheWriterException</a></pre>
+<div class="block">Called before an entry is created. Entry creation is initiated by a
+ <code>create</code>, a <code>put</code>, or a <code>get</code>.
+ The <code>CacheWriter</code> can determine whether this value comes from a
+ <code>get</code> or not by evaluating the <a href="../../../../com/gemstone/gemfire/cache/CacheEvent.html#getOperation--"><code>Operation</code></a>'s <a href="../../../../com/gemstone/gemfire/cache/Operation.html#isLoad--"><code>Operation.isLoad()</code></a> method.
+ The entry being created may already exist in the local cache where this <code>CacheWriter</code>
+ is installed, but it does not yet exist in the cache where the operation was initiated.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>event</code> - an EntryEvent that provides information about the operation in progress</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../com/gemstone/gemfire/cache/CacheWriterException.html" title="class in com.gemstone.gemfire.cache">CacheWriterException</a></code> - if thrown will abort the operation in progress,
+ and the exception will be propagated back to caller that initiated
+ the operation</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../com/gemstone/gemfire/cache/Region.html#create-K-V-"><code>Region.create(Object, Object)</code></a>,
+<a href="../../../../com/gemstone/gemfire/cache/Region.html#put-K-V-"><code>Region.put(Object, Object)</code></a>,
+<a href="../../../../com/gemstone/gemfire/cache/Region.html#get-java.lang.Object-"><code>Region.get(Object)</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="beforeDestroy-com.gemstone.gemfire.cache.EntryEvent-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>beforeDestroy</h4>
+<pre>void beforeDestroy(<a href="../../../../com/gemstone/gemfire/cache/EntryEvent.html" title="interface in com.gemstone.gemfire.cache">EntryEvent</a><<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">K</a>,<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">V</a>> event)
+ throws <a href="../../../../com/gemstone/gemfire/cache/CacheWriterException.html" title="class in com.gemstone.gemfire.cache">CacheWriterException</a></pre>
+<div class="block">Called before an entry is destroyed. The entry being destroyed may or may
+ not exist in the local cache where the CacheWriter is installed. This method
+ is <em>not</em> called as a result of expiration or
+ <a href="../../../../com/gemstone/gemfire/cache/Region.html#localDestroy-java.lang.Object-"><code>Region.localDestroy(Object)</code></a>.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>event</code> - an EntryEvent that provides information about the operation in progress</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../com/gemstone/gemfire/cache/CacheWriterException.html" title="class in com.gemstone.gemfire.cache">CacheWriterException</a></code> - if thrown will abort the operation in progress,
+ and the exception will be propagated back to caller that initiated
+ the operation</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../com/gemstone/gemfire/cache/Region.html#destroy-java.lang.Object-"><code>Region.destroy(Object)</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="beforeRegionDestroy-com.gemstone.gemfire.cache.RegionEvent-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>beforeRegionDestroy</h4>
+<pre>void beforeRegionDestroy(<a href="../../../../com/gemstone/gemfire/cache/RegionEvent.html" title="interface in com.gemstone.gemfire.cache">RegionEvent</a><<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">K</a>,<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">V</a>> event)
+ throws <a href="../../../../com/gemstone/gemfire/cache/CacheWriterException.html" title="class in com.gemstone.gemfire.cache">CacheWriterException</a></pre>
+<div class="block">Called before a region is destroyed. The <code>CacheWriter</code>
+ will not additionally be called for each entry that is destroyed
+ in the region as a result of a region destroy. If the region's
+ subregions have <code>CacheWriter</code>s installed, then they
+ will be called for the cascading subregion destroys.
+ This method is <em>not</em> called as a result of
+ <a href="../../../../com/gemstone/gemfire/cache/Region.html#close--"><code>Region.close()</code></a>, <a href="../../../../com/gemstone/gemfire/cache/Cache.html#close-boolean-"><code>Cache.close(boolean)</code></a>, or <a href="../../../../com/gemstone/gemfire/cache/Region.html#localDestroyRegion--"><code>Region.localDestroyRegion()</code></a>. However, the
+ <a href="../../../../com/gemstone/gemfire/cache/Region.html#close--"><code>Region.close()</code></a> method is invoked regardless of whether a
+ region is destroyed locally. A non-local region destroy results
+ in an invocation of <a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html#beforeRegionDestroy-com.gemstone.gemfire.cache.RegionEvent-"><code>beforeRegionDestroy(com.gemstone.gemfire.cache.RegionEvent<K, V>)</code></a> followed by an
+ invocation of <a href="../../../../com/gemstone/gemfire/cache/Region.html#close--"><code>Region.close()</code></a>.
+<p>
+ WARNING: This method should not destroy or create any regions itself or a
+ deadlock will occur.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>event</code> - a RegionEvent that provides information about the operation</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../com/gemstone/gemfire/cache/CacheWriterException.html" title="class in com.gemstone.gemfire.cache">CacheWriterException</a></code> - if thrown, will abort the operation in progress, and the
+ exception will be propagated back to the caller that
+ initiated the operation</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../com/gemstone/gemfire/cache/Region.html#destroyRegion--"><code>Region.destroyRegion()</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="beforeRegionClear-com.gemstone.gemfire.cache.RegionEvent-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>beforeRegionClear</h4>
+<pre>void beforeRegionClear(<a href="../../../../com/gemstone/gemfire/cache/RegionEvent.html" title="interface in com.gemstone.gemfire.cache">RegionEvent</a><<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">K</a>,<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="type parameter in CacheWriter">V</a>> event)
+ throws <a href="../../../../com/gemstone/gemfire/cache/CacheWriterException.html" title="class in com.gemstone.gemfire.cache">CacheWriterException</a></pre>
+<div class="block">Called before a region is cleared. The <code>CacheWriter</code>
+ will not additionally be called for each entry that is cleared
+ in the region as a result of a region clear.
+
+<p>
+ WARNING: This method should not clear/destroy any regions</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>event</code> - a RegionEvent that provides information about the operation</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../com/gemstone/gemfire/cache/CacheWriterException.html" title="class in com.gemstone.gemfire.cache">CacheWriterException</a></code> - if thrown, will abort the operation in progress, and the
+ exception will be propagated back to the caller that
+ initiated the operation</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../com/gemstone/gemfire/cache/Region.html#clear--"><code>Region.clear()</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="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../com/gemstone/gemfire/cache/CacheWriterException.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/gemstone/gemfire/cache/CacheWriter.html" target="_top">Frames</a></li>
+<li><a href="CacheWriter.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/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheWriterException.html
----------------------------------------------------------------------
diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheWriterException.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheWriterException.html
new file mode 100644
index 0000000..e3a1e7c
--- /dev/null
+++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheWriterException.html
@@ -0,0 +1,370 @@
+<!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 Fri Mar 11 16:13:08 PST 2016 -->
+<title>CacheWriterException (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)</title>
+<meta name="date" content="2016-03-11">
+<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="CacheWriterException (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+</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="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../com/gemstone/gemfire/cache/CacheXmlException.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/gemstone/gemfire/cache/CacheWriterException.html" target="_top">Frames</a></li>
+<li><a href="CacheWriterException.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="#methods.inherited.from.class.com.gemstone.gemfire.cache.CacheRuntimeException">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li>Method</li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">com.gemstone.gemfire.cache</div>
+<h2 title="Class CacheWriterException" class="title">Class CacheWriterException</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>java.lang.Throwable</li>
+<li>
+<ul class="inheritance">
+<li>java.lang.Exception</li>
+<li>
+<ul class="inheritance">
+<li>java.lang.RuntimeException</li>
+<li>
+<ul class="inheritance">
+<li><a href="../../../../com/gemstone/gemfire/GemFireException.html" title="class in com.gemstone.gemfire">com.gemstone.gemfire.GemFireException</a></li>
+<li>
+<ul class="inheritance">
+<li><a href="../../../../com/gemstone/gemfire/cache/CacheRuntimeException.html" title="class in com.gemstone.gemfire.cache">com.gemstone.gemfire.cache.CacheRuntimeException</a></li>
+<li>
+<ul class="inheritance">
+<li><a href="../../../../com/gemstone/gemfire/cache/OperationAbortedException.html" title="class in com.gemstone.gemfire.cache">com.gemstone.gemfire.cache.OperationAbortedException</a></li>
+<li>
+<ul class="inheritance">
+<li>com.gemstone.gemfire.cache.CacheWriterException</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd>java.io.Serializable</dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="typeNameLabel">CacheWriterException</span>
+extends <a href="../../../../com/gemstone/gemfire/cache/OperationAbortedException.html" title="class in com.gemstone.gemfire.cache">OperationAbortedException</a></pre>
+<div class="block">An exception thrown by a <code>CacheWriter</code> method. This exception
+ is propagated back to the caller that initiated modification of the
+ cache, even if the caller is not in the same cache VM.</div>
+<dl>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>3.0</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="interface in com.gemstone.gemfire.cache"><code>CacheWriter</code></a>,
+<a href="../../../../com/gemstone/gemfire/cache/Region.html#put-K-V-"><code>Region.put(Object, Object)</code></a>,
+<a href="../../../../com/gemstone/gemfire/cache/Region.html#destroy-java.lang.Object-"><code>Region.destroy(Object)</code></a>,
+<a href="../../../../com/gemstone/gemfire/cache/Region.html#create-K-V-"><code>Region.create(Object, Object)</code></a>,
+<a href="../../../../com/gemstone/gemfire/cache/Region.html#destroyRegion--"><code>Region.destroyRegion()</code></a>,
+<a href="../../../../com/gemstone/gemfire/cache/Region.html#get-java.lang.Object-"><code>Region.get(Object)</code></a>,
+<a href="../../../../serialized-form.html#com.gemstone.gemfire.cache.CacheWriterException">Serialized Form</a></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="../../../../com/gemstone/gemfire/cache/CacheWriterException.html#CacheWriterException--">CacheWriterException</a></span>()</code>
+<div class="block">Creates a new instance of <code>CacheWriterException</code>.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheWriterException.html#CacheWriterException-java.lang.String-">CacheWriterException</a></span>(java.lang.String msg)</code>
+<div class="block">Constructs an instance of <code>CacheWriterException</code> with the specified detail message.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheWriterException.html#CacheWriterException-java.lang.String-java.lang.Throwable-">CacheWriterException</a></span>(java.lang.String msg,
+ java.lang.Throwable cause)</code>
+<div class="block">Constructs an instance of <code>CacheWriterException</code> with the specified detail message
+ and cause.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheWriterException.html#CacheWriterException-java.lang.Throwable-">CacheWriterException</a></span>(java.lang.Throwable cause)</code>
+<div class="block">Constructs an instance of <code>CacheWriterException</code> with the specified cause.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.com.gemstone.gemfire.cache.CacheRuntimeException">
+<!-- -->
+</a>
+<h3>Methods inherited from class com.gemstone.gemfire.cache.<a href="../../../../com/gemstone/gemfire/cache/CacheRuntimeException.html" title="class in com.gemstone.gemfire.cache">CacheRuntimeException</a></h3>
+<code><a href="../../../../com/gemstone/gemfire/cache/CacheRuntimeException.html#toString--">toString</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.com.gemstone.gemfire.GemFireException">
+<!-- -->
+</a>
+<h3>Methods inherited from class com.gemstone.gemfire.<a href="../../../../com/gemstone/gemfire/GemFireException.html" title="class in com.gemstone.gemfire">GemFireException</a></h3>
+<code><a href="../../../../com/gemstone/gemfire/GemFireException.html#getRootCause--">getRootCause</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.Throwable</h3>
+<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace</code></li>
+</ul>
+<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, 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="CacheWriterException--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>CacheWriterException</h4>
+<pre>public CacheWriterException()</pre>
+<div class="block">Creates a new instance of <code>CacheWriterException</code>.</div>
+</li>
+</ul>
+<a name="CacheWriterException-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>CacheWriterException</h4>
+<pre>public CacheWriterException(java.lang.String msg)</pre>
+<div class="block">Constructs an instance of <code>CacheWriterException</code> with the specified detail message.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>msg</code> - the detail message</dd>
+</dl>
+</li>
+</ul>
+<a name="CacheWriterException-java.lang.String-java.lang.Throwable-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>CacheWriterException</h4>
+<pre>public CacheWriterException(java.lang.String msg,
+ java.lang.Throwable cause)</pre>
+<div class="block">Constructs an instance of <code>CacheWriterException</code> with the specified detail message
+ and cause.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>msg</code> - the detail message</dd>
+<dd><code>cause</code> - the causal Throwable</dd>
+</dl>
+</li>
+</ul>
+<a name="CacheWriterException-java.lang.Throwable-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>CacheWriterException</h4>
+<pre>public CacheWriterException(java.lang.Throwable cause)</pre>
+<div class="block">Constructs an instance of <code>CacheWriterException</code> with the specified cause.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>cause</code> - the causal Throwable</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="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../com/gemstone/gemfire/cache/CacheXmlException.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/gemstone/gemfire/cache/CacheWriterException.html" target="_top">Frames</a></li>
+<li><a href="CacheWriterException.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="#methods.inherited.from.class.com.gemstone.gemfire.cache.CacheRuntimeException">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li>Method</li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>