diff options
| author | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
|---|---|---|
| committer | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
| commit | d479253768d296a40b4f699e1de9b03c7146a97a (patch) | |
| tree | 208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/txn/TransactionManager.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/txn/TransactionManager.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/txn/TransactionManager.html | 573 |
1 files changed, 573 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/txn/TransactionManager.html b/apidocs/com/amazon/carbonado/txn/TransactionManager.html new file mode 100644 index 0000000..eae85dc --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/TransactionManager.html @@ -0,0 +1,573 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:41 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>TransactionManager (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="TransactionManager (Carbonado 1.2.3 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/TransactionManager.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../com/amazon/carbonado/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/txn/TransactionManager.html" target="_top">Frames</a></li> +<li><a href="TransactionManager.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">com.amazon.carbonado.txn</div> +<h2 title="Class TransactionManager" class="title">Class TransactionManager<Txn></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.txn.TransactionManager<Txn></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>Txn</code> - Transaction implementation</dd></dl> +<hr> +<br> +<pre>public abstract class <span class="strong">TransactionManager<Txn></span> +extends java.lang.Object</pre> +<div class="block">Generic transaction manager for repositories.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</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="overviewSummary" 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><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#TransactionManager()">TransactionManager</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#TransactionManager(com.amazon.carbonado.txn.TransactionMonitor)">TransactionManager</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn">TransactionMonitor</a> monitor)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#abortTxn(Txn)">abortTxn</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn)</code> +<div class="block">Aborts and closes the given internal transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#attachNotification(Txn)">attachNotification</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn)</code> +<div class="block">Called to notify internal method that transaction is attached.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#close(boolean)">close</a></strong>(boolean suspend)</code> +<div class="block">Closes all transaction scopes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#commitTxn(Txn)">commitTxn</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn)</code> +<div class="block">Commits and closes the given internal transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#createTxn(Txn, com.amazon.carbonado.IsolationLevel)">createTxn</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> parent, + <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Creates an internal transaction representation, with the optional parent + transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#createTxn(Txn, com.amazon.carbonado.IsolationLevel, int, java.util.concurrent.TimeUnit)">createTxn</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> parent, + <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level, + int timeout, + java.util.concurrent.TimeUnit unit)</code> +<div class="block">Creates an internal transaction representation, with the optional parent + transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a><<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#detachLocalScope()">detachLocalScope</a></strong>()</code> +<div class="block">Detaches the thread-local TransactionScope from the current thread.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#detachNotification(Txn)">detachNotification</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn)</code> +<div class="block">Called to notify internal method that transaction is detached.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#isClosed()">isClosed</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a><<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#localScope()">localScope</a></strong>()</code> +<div class="block">Returns the thread-local TransactionScope, creating it if needed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#reuseTxn(Txn)">reuseTxn</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn)</code> +<div class="block">Called when a transaction is about to be reused.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#selectIsolationLevel(com.amazon.carbonado.Transaction, com.amazon.carbonado.IsolationLevel)">selectIsolationLevel</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> parent, + <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Returns supported isolation level, which may be higher.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#setForUpdate(Txn, boolean)">setForUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn, + boolean forUpdate)</code> +<div class="block">Called when the Transaction.setForUpdate method is called.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#supportsForUpdate()">supportsForUpdate</a></strong>()</code> +<div class="block">Return true if transactions support "for update" mode.</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="TransactionManager()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TransactionManager</h4> +<pre>public TransactionManager()</pre> +</li> +</ul> +<a name="TransactionManager(com.amazon.carbonado.txn.TransactionMonitor)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TransactionManager</h4> +<pre>public TransactionManager(<a href="../../../../com/amazon/carbonado/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn">TransactionMonitor</a> monitor)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="localScope()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>localScope</h4> +<pre>public <a href="../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a><<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a>> localScope()</pre> +<div class="block">Returns the thread-local TransactionScope, creating it if needed.</div> +</li> +</ul> +<a name="detachLocalScope()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>detachLocalScope</h4> +<pre>public <a href="../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a><<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a>> detachLocalScope()</pre> +<div class="block">Detaches the thread-local TransactionScope from the current thread. It + can be <a href="../../../../com/amazon/carbonado/txn/TransactionScope.html#attach()"><code>attached</code></a> later, and to any thread + which does not currently have a TransactionScope.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>detached thread-local TransactionScope or null if none</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="close(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close(boolean suspend) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Closes all transaction scopes. Should be called only when repository is + closed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>suspend</code> - when true, indefinitely suspend all threads interacting + with transactions</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="isClosed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isClosed</h4> +<pre>public boolean isClosed()</pre> +</li> +</ul> +<a name="selectIsolationLevel(com.amazon.carbonado.Transaction, com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectIsolationLevel</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> selectIsolationLevel(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> parent, + <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block">Returns supported isolation level, which may be higher. If isolation + level cannot go higher (or lower than parent) then return null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parent</code> - optional parent transaction</dd><dd><code>level</code> - desired isolation level (may be null)</dd></dl> +</li> +</ul> +<a name="supportsForUpdate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>supportsForUpdate</h4> +<pre>protected abstract boolean supportsForUpdate()</pre> +<div class="block">Return true if transactions support "for update" mode.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="createTxn(java.lang.Object,com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a><a name="createTxn(Txn, com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createTxn</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> createTxn(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> parent, + <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level) + throws java.lang.Exception</pre> +<div class="block">Creates an internal transaction representation, with the optional parent + transaction. If parent is not null and real nested transactions are not + supported, simply return parent transaction for supporting fake nested + transactions.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parent</code> - optional parent transaction</dd><dd><code>level</code> - required isolation level</dd> +<dt><span class="strong">Returns:</span></dt><dd>new transaction, parent transaction, or possibly null if required + isolation level is none</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="createTxn(java.lang.Object,com.amazon.carbonado.IsolationLevel,int,java.util.concurrent.TimeUnit)"> +<!-- --> +</a><a name="createTxn(Txn, com.amazon.carbonado.IsolationLevel, int, java.util.concurrent.TimeUnit)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createTxn</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> createTxn(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> parent, + <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level, + int timeout, + java.util.concurrent.TimeUnit unit) + throws java.lang.Exception</pre> +<div class="block">Creates an internal transaction representation, with the optional parent + transaction. If parent is not null and real nested transactions are not + supported, simply return parent transaction for supporting fake nested + transactions. + + <p>The default implementation of this method just calls the regular + createTxn method, ignoring the timeout parameter.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parent</code> - optional parent transaction</dd><dd><code>level</code> - required isolation level</dd><dd><code>timeout</code> - desired timeout for lock acquisition, never negative</dd><dd><code>unit</code> - timeout unit, never null</dd> +<dt><span class="strong">Returns:</span></dt><dd>new transaction, parent transaction, or possibly null if required + isolation level is none</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="reuseTxn(java.lang.Object)"> +<!-- --> +</a><a name="reuseTxn(Txn)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reuseTxn</h4> +<pre>protected void reuseTxn(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn) + throws java.lang.Exception</pre> +<div class="block">Called when a transaction is about to be reused. The default + implementation of this method does nothing. Override if any preparation + is required to ready a transaction for reuse.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - transaction to reuse, never null</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.1.3</dd></dl> +</li> +</ul> +<a name="setForUpdate(java.lang.Object,boolean)"> +<!-- --> +</a><a name="setForUpdate(Txn, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setForUpdate</h4> +<pre>protected void setForUpdate(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn, + boolean forUpdate)</pre> +<div class="block">Called when the Transaction.setForUpdate method is called. The default + implementation of this method does nothing. Override if internal + transaction needs to switch modes.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2.1</dd></dl> +</li> +</ul> +<a name="attachNotification(java.lang.Object)"> +<!-- --> +</a><a name="attachNotification(Txn)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>attachNotification</h4> +<pre>protected void attachNotification(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn)</pre> +<div class="block">Called to notify internal method that transaction is attached. + The default implementation of this method does nothing. Override if + using remote transactions.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - transaction that is attached, could be null if none exists</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2.2</dd></dl> +</li> +</ul> +<a name="detachNotification(java.lang.Object)"> +<!-- --> +</a><a name="detachNotification(Txn)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>detachNotification</h4> +<pre>protected void detachNotification(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn)</pre> +<div class="block">Called to notify internal method that transaction is detached. + The default implementation of this method does nothing. Override if + using remote transactions.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - transaction that is dettached, could be null if none exists</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2.2</dd></dl> +</li> +</ul> +<a name="commitTxn(java.lang.Object)"> +<!-- --> +</a><a name="commitTxn(Txn)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>commitTxn</h4> +<pre>protected abstract boolean commitTxn(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Commits and closes the given internal transaction.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if transaction object is still valid</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="abortTxn(java.lang.Object)"> +<!-- --> +</a><a name="abortTxn(Txn)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>abortTxn</h4> +<pre>protected abstract void abortTxn(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Aborts and closes the given internal transaction.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/TransactionManager.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../com/amazon/carbonado/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/txn/TransactionManager.html" target="_top">Frames</a></li> +<li><a href="TransactionManager.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 ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> |