http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/49c6e8bd/src/site/resources/apidocs/org/apache/tephra/TransactionAware.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs/org/apache/tephra/TransactionAware.html b/src/site/resources/apidocs/org/apache/tephra/TransactionAware.html new file mode 100644 index 0000000..d753bc7 --- /dev/null +++ b/src/site/resources/apidocs/org/apache/tephra/TransactionAware.html @@ -0,0 +1,358 @@ +<!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_80) on Mon Sep 19 21:33:26 PDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TransactionAware (Apache Tephra 0.10.0-incubating-SNAPSHOT API)</title> +<meta name="date" content="2016-09-19"> +<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="TransactionAware (Apache Tephra 0.10.0-incubating-SNAPSHOT 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/TransactionAware.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-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/apache/tephra/TransactionAdmin.html" title="class in org.apache.tephra"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/tephra/TransactionAwares.html" title="class in org.apache.tephra"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/tephra/TransactionAware.html" target="_top">Frames</a></li> +<li><a href="TransactionAware.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.tephra</div> +<h2 title="Interface TransactionAware" class="title">Interface TransactionAware</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../org/apache/tephra/AbstractTransactionAwareTable.html" title="class in org.apache.tephra">AbstractTransactionAwareTable</a>, <a href="../../../org/apache/tephra/hbase/TransactionAwareHTable.html" title="class in org.apache.tephra.hbase">TransactionAwareHTable</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">TransactionAware</span></pre> +<div class="block">Interface to be implemented by a component that interacts with transaction logic. + <p/> + The client code that uses transaction logic looks like this: + <pre> + TransactionAware dataSet = // ... // dataSet is one example of component that interacts with tx logic + + Transaction tx = txClient.start(); + dataSet.startTx(tx); // notifying about new transaction + dataSet.write(...); + // ... do other operations on dataSet + Collection<byte[]> changes = dataSet.getTxChanges(); + boolean rollback = true; + if (txClient.canCommit(changes)) { // checking conflicts before commit, if none, commit tx + if (dataSet.commitTx()) { // try persisting changes + if (txClient.commit(tx)) { // if OK, make tx visible; if not - tx stays invisible to others + dataSet.postTxCommit(); // notifying dataset about tx commit success via callback + rollback = false; + } + } + } + + if (rollback) { // if there are conflicts (or cannot commit), try rollback changes + if (dataSet.rollbackTx()) { // try undo changes + txClient.abort(tx); // if OK, make tx visible; if not - tx stays invisible to others + } + } + + </pre></div> +</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="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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionAware.html#commitTx()">commitTx</a></strong>()</code> +<div class="block">Called before transaction has been committed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionAware.html#getTransactionAwareName()">getTransactionAwareName</a></strong>()</code> +<div class="block">Used for error reporting.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><byte[]></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionAware.html#getTxChanges()">getTxChanges</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionAware.html#postTxCommit()">postTxCommit</a></strong>()</code> +<div class="block">Called after transaction has been committed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionAware.html#rollbackTx()">rollbackTx</a></strong>()</code> +<div class="block">Called during transaction rollback (for whatever reason: conflicts, errors, etc.).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionAware.html#startTx(org.apache.tephra.Transaction)">startTx</a></strong>(<a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> tx)</code> +<div class="block">Called when new transaction has started.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionAware.html#updateTx(org.apache.tephra.Transaction)">updateTx</a></strong>(<a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> tx)</code> +<div class="block">Called when the state of the current transaction has been updated.</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="startTx(org.apache.tephra.Transaction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>startTx</h4> +<pre>void startTx(<a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> tx)</pre> +<div class="block">Called when new transaction has started. This may reset any state which has been left behind by the previous + transaction.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tx</code> - transaction info</dd></dl> +</li> +</ul> +<a name="updateTx(org.apache.tephra.Transaction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>updateTx</h4> +<pre>void updateTx(<a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> tx)</pre> +<div class="block">Called when the state of the current transaction has been updated. This should replace any reference to the + current <a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra"><code>Transaction</code></a> held by this <code>TransactionAware</code>, but should <strong>not</strong> reset + any state (such as the write change sets) that is currently maintained.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tx</code> - the updated transaction</dd></dl> +</li> +</ul> +<a name="getTxChanges()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTxChanges</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><byte[]> getTxChanges()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>changes made by current transaction to be used for conflicts detection before commit.</dd></dl> +</li> +</ul> +<a name="commitTx()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>commitTx</h4> +<pre>boolean commitTx() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block">Called before transaction has been committed. + Can be used e.g. to flush changes cached in-memory to persistent store.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if transaction can be committed, otherwise false.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> +</li> +</ul> +<a name="postTxCommit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>postTxCommit</h4> +<pre>void postTxCommit()</pre> +<div class="block">Called after transaction has been committed. + Can be used e.g. evict entries from a cache etc. Because this is called after the transaction is committed, + the success or failure of the transaction cannot depend on it. Hence this method returns nothing and it is not + expected to throw exceptions.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code> - in case of serious failure that should not be ignored.</dd></dl> +</li> +</ul> +<a name="rollbackTx()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>rollbackTx</h4> +<pre>boolean rollbackTx() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block">Called during transaction rollback (for whatever reason: conflicts, errors, etc.).</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if all changes made during transaction were rolled back, false otherwise (e.g. if more cleanup needed + or changes cannot be undone). True also means that this transaction can be made visible to others without + breaking consistency of the data: since all changes were undone there's "nothing to see".</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> +</li> +</ul> +<a name="getTransactionAwareName()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getTransactionAwareName</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getTransactionAwareName()</pre> +<div class="block">Used for error reporting.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><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/TransactionAware.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-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/apache/tephra/TransactionAdmin.html" title="class in org.apache.tephra"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/tephra/TransactionAwares.html" title="class in org.apache.tephra"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/tephra/TransactionAware.html" target="_top">Frames</a></li> +<li><a href="TransactionAware.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 ======= --> +<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/49c6e8bd/src/site/resources/apidocs/org/apache/tephra/TransactionAwares.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs/org/apache/tephra/TransactionAwares.html b/src/site/resources/apidocs/org/apache/tephra/TransactionAwares.html new file mode 100644 index 0000000..3fa1e0f --- /dev/null +++ b/src/site/resources/apidocs/org/apache/tephra/TransactionAwares.html @@ -0,0 +1,232 @@ +<!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_80) on Mon Sep 19 21:33:26 PDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TransactionAwares (Apache Tephra 0.10.0-incubating-SNAPSHOT API)</title> +<meta name="date" content="2016-09-19"> +<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="TransactionAwares (Apache Tephra 0.10.0-incubating-SNAPSHOT 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/TransactionAwares.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-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/tephra/TransactionCodec.html" title="class in org.apache.tephra"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/tephra/TransactionAwares.html" target="_top">Frames</a></li> +<li><a href="TransactionAwares.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.tephra</div> +<h2 title="Class TransactionAwares" class="title">Class TransactionAwares</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.tephra.TransactionAwares</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="strong">TransactionAwares</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> +<div class="block">Utility class that provides handy methods for working with <a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra"><code>TransactionAware</code></a> classes and their instances.</div> +</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="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>static <a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra">TransactionAware</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionAwares.html#of(java.util.Collection)">of</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra">TransactionAware</a>> transactionAwares)</code> +<div class="block">Create composite transaction aware object that delegates transaction logic to given collection of + <a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra"><code>TransactionAware</code></a>s</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</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="of(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>of</h4> +<pre>public static <a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra">TransactionAware</a> of(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra">TransactionAware</a>> transactionAwares)</pre> +<div class="block">Create composite transaction aware object that delegates transaction logic to given collection of + <a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra"><code>TransactionAware</code></a>s</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>transactionAwares</code> - collection of <a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra"><code>TransactionAware</code></a>s</dd> +<dt><span class="strong">Returns:</span></dt><dd>instance of <a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra"><code>TransactionAware</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><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/TransactionAwares.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-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/tephra/TransactionCodec.html" title="class in org.apache.tephra"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/tephra/TransactionAwares.html" target="_top">Frames</a></li> +<li><a href="TransactionAwares.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 ======= --> +<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/49c6e8bd/src/site/resources/apidocs/org/apache/tephra/TransactionCodec.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs/org/apache/tephra/TransactionCodec.html b/src/site/resources/apidocs/org/apache/tephra/TransactionCodec.html new file mode 100644 index 0000000..00d2b90 --- /dev/null +++ b/src/site/resources/apidocs/org/apache/tephra/TransactionCodec.html @@ -0,0 +1,278 @@ +<!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_80) on Mon Sep 19 21:33:26 PDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TransactionCodec (Apache Tephra 0.10.0-incubating-SNAPSHOT API)</title> +<meta name="date" content="2016-09-19"> +<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="TransactionCodec (Apache Tephra 0.10.0-incubating-SNAPSHOT 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/TransactionCodec.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-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/apache/tephra/TransactionAwares.html" title="class in org.apache.tephra"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/tephra/TransactionConflictException.html" title="class in org.apache.tephra"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/tephra/TransactionCodec.html" target="_top">Frames</a></li> +<li><a href="TransactionCodec.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.tephra</div> +<h2 title="Class TransactionCodec" class="title">Class TransactionCodec</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.tephra.TransactionCodec</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">TransactionCodec</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> +<div class="block">Handles serialization and deserialization of <a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra"><code>Transaction</code></a> instances to and from <code>byte[]</code>.</div> +</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="../../../org/apache/tephra/TransactionCodec.html#TransactionCodec()">TransactionCodec</a></strong>()</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><a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionCodec.html#decode(byte[])">decode</a></strong>(byte[] encoded)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionCodec.html#encode(org.apache.tephra.Transaction)">encode</a></strong>(<a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> tx)</code> </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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></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="TransactionCodec()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TransactionCodec</h4> +<pre>public TransactionCodec()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="encode(org.apache.tephra.Transaction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public byte[] encode(<a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> tx) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="decode(byte[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>decode</h4> +<pre>public <a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> decode(byte[] encoded) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</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/TransactionCodec.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-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/apache/tephra/TransactionAwares.html" title="class in org.apache.tephra"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/tephra/TransactionConflictException.html" title="class in org.apache.tephra"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/tephra/TransactionCodec.html" target="_top">Frames</a></li> +<li><a href="TransactionCodec.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 © 2016 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/49c6e8bd/src/site/resources/apidocs/org/apache/tephra/TransactionConflictException.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs/org/apache/tephra/TransactionConflictException.html b/src/site/resources/apidocs/org/apache/tephra/TransactionConflictException.html new file mode 100644 index 0000000..7f17a1f --- /dev/null +++ b/src/site/resources/apidocs/org/apache/tephra/TransactionConflictException.html @@ -0,0 +1,272 @@ +<!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_80) on Mon Sep 19 21:33:26 PDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TransactionConflictException (Apache Tephra 0.10.0-incubating-SNAPSHOT API)</title> +<meta name="date" content="2016-09-19"> +<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="TransactionConflictException (Apache Tephra 0.10.0-incubating-SNAPSHOT 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/TransactionConflictException.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-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/apache/tephra/TransactionCodec.html" title="class in org.apache.tephra"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/tephra/TransactionContext.html" title="class in org.apache.tephra"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/tephra/TransactionConflictException.html" target="_top">Frames</a></li> +<li><a href="TransactionConflictException.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_java.lang.Throwable">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">org.apache.tephra</div> +<h2 title="Class TransactionConflictException" class="title">Class TransactionConflictException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../org/apache/tephra/TransactionFailureException.html" title="class in org.apache.tephra">org.apache.tephra.TransactionFailureException</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.tephra.TransactionConflictException</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><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">TransactionConflictException</span> +extends <a href="../../../org/apache/tephra/TransactionFailureException.html" title="class in org.apache.tephra">TransactionFailureException</a></pre> +<div class="block">Thrown to indicate transaction conflict occurred when trying to commit a transaction.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#org.apache.tephra.TransactionConflictException">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="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="../../../org/apache/tephra/TransactionConflictException.html#TransactionConflictException(java.lang.String)">TransactionConflictException</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../org/apache/tephra/TransactionConflictException.html#TransactionConflictException(java.lang.String,%20java.lang.Throwable)">TransactionConflictException</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> cause)</code> </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_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed(java.lang.Throwable)" title="class or interface in java.lang">addSuppressed</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace()" title="class or interface in java.lang">fillInStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getCause()" title="class or interface in java.lang">getCause</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage()" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getMessage()" title="class or interface in java.lang">getMessage</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace()" title="class or inter face in java.lang">getStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed()" title="class or interface in java.lang">getSuppressed</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#initCause(java.lang.Throwable)" title="class or interface in java.lang">initCause</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace()" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace(java.io.PrintStream)" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace(java.io.PrintWriter)" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lan g/Throwable.html?is-external=true#setStackTrace(java.lang.StackTraceElement[])" title="class or interface in java.lang">setStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></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="TransactionConflictException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TransactionConflictException</h4> +<pre>public TransactionConflictException(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message)</pre> +</li> +</ul> +<a name="TransactionConflictException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TransactionConflictException</h4> +<pre>public TransactionConflictException(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> cause)</pre> +</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/TransactionConflictException.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-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/apache/tephra/TransactionCodec.html" title="class in org.apache.tephra"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/tephra/TransactionContext.html" title="class in org.apache.tephra"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/tephra/TransactionConflictException.html" target="_top">Frames</a></li> +<li><a href="TransactionConflictException.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_java.lang.Throwable">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 ======= --> +<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/49c6e8bd/src/site/resources/apidocs/org/apache/tephra/TransactionContext.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs/org/apache/tephra/TransactionContext.html b/src/site/resources/apidocs/org/apache/tephra/TransactionContext.html new file mode 100644 index 0000000..f820e13 --- /dev/null +++ b/src/site/resources/apidocs/org/apache/tephra/TransactionContext.html @@ -0,0 +1,440 @@ +<!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_80) on Mon Sep 19 21:33:26 PDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TransactionContext (Apache Tephra 0.10.0-incubating-SNAPSHOT API)</title> +<meta name="date" content="2016-09-19"> +<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="TransactionContext (Apache Tephra 0.10.0-incubating-SNAPSHOT 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/TransactionContext.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-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/apache/tephra/TransactionConflictException.html" title="class in org.apache.tephra"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/tephra/TransactionCouldNotTakeSnapshotException.html" title="class in org.apache.tephra"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/tephra/TransactionContext.html" target="_top">Frames</a></li> +<li><a href="TransactionContext.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.tephra</div> +<h2 title="Class TransactionContext" class="title">Class TransactionContext</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.tephra.TransactionContext</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">TransactionContext</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> +<div class="block">Utility class that encapsulates the transaction life cycle over a given set of + transaction-aware datasets. It is not thread-safe for concurrent execution.</div> +</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="../../../org/apache/tephra/TransactionContext.html#TransactionContext(org.apache.tephra.TransactionSystemClient,%20java.lang.Iterable)">TransactionContext</a></strong>(<a href="../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a> txClient, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra">TransactionAware</a>> txAwares)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../org/apache/tephra/TransactionContext.html#TransactionContext(org.apache.tephra.TransactionSystemClient,%20org.apache.tephra.TransactionAware...)">TransactionContext</a></strong>(<a href="../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a> txClient, + <a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra">TransactionAware</a>... txAwares)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionContext.html#abort()">abort</a></strong>()</code> +<div class="block">Aborts the given transaction, and rolls back all data set changes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionContext.html#abort(org.apache.tephra.TransactionFailureException)">abort</a></strong>(<a href="../../../org/apache/tephra/TransactionFailureException.html" title="class in org.apache.tephra">TransactionFailureException</a> cause)</code> +<div class="block">Aborts the given transaction, and rolls back all data set changes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionContext.html#addTransactionAware(org.apache.tephra.TransactionAware)">addTransactionAware</a></strong>(<a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra">TransactionAware</a> txAware)</code> +<div class="block">Adds a new transaction-aware to participate in the transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionContext.html#checkpoint()">checkpoint</a></strong>()</code> +<div class="block">Checkpoints the current transaction by flushing any pending writes for the registered <a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra"><code>TransactionAware</code></a> + instances, and obtaining a new current write pointer for the transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionContext.html#finish()">finish</a></strong>()</code> +<div class="block">Commits the current transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionContext.html#getCurrentTransaction()">getCurrentTransaction</a></strong>()</code> +<div class="block">Returns the current transaction or null if no transaction is currently in progress.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionContext.html#removeTransactionAware(org.apache.tephra.TransactionAware)">removeTransactionAware</a></strong>(<a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra">TransactionAware</a> txAware)</code> +<div class="block">Removes a <a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra"><code>TransactionAware</code></a> and withdraws from participation in the transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionContext.html#start()">start</a></strong>()</code> +<div class="block">Starts a new transaction.</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></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="TransactionContext(org.apache.tephra.TransactionSystemClient, org.apache.tephra.TransactionAware...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TransactionContext</h4> +<pre>public TransactionContext(<a href="../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a> txClient, + <a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra">TransactionAware</a>... txAwares)</pre> +</li> +</ul> +<a name="TransactionContext(org.apache.tephra.TransactionSystemClient, java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TransactionContext</h4> +<pre>public TransactionContext(<a href="../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a> txClient, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra">TransactionAware</a>> txAwares)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="addTransactionAware(org.apache.tephra.TransactionAware)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addTransactionAware</h4> +<pre>public boolean addTransactionAware(<a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra">TransactionAware</a> txAware)</pre> +<div class="block">Adds a new transaction-aware to participate in the transaction.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txAware</code> - the new transaction-aware</dd></dl> +</li> +</ul> +<a name="removeTransactionAware(org.apache.tephra.TransactionAware)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeTransactionAware</h4> +<pre>public boolean removeTransactionAware(<a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra">TransactionAware</a> txAware)</pre> +<div class="block">Removes a <a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra"><code>TransactionAware</code></a> and withdraws from participation in the transaction. + Withdrawal is only allowed if there is no active transaction.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txAware</code> - the <a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra"><code>TransactionAware</code></a> to be removed</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the given <a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra"><code>TransactionAware</code></a> is removed; false otherwise.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if there is an active transaction going on with this TransactionContext.</dd></dl> +</li> +</ul> +<a name="start()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>start</h4> +<pre>public void start() + throws <a href="../../../org/apache/tephra/TransactionFailureException.html" title="class in org.apache.tephra">TransactionFailureException</a></pre> +<div class="block">Starts a new transaction. Calling this will initiate a new transaction using the <a href="../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra"><code>TransactionSystemClient</code></a>, + and pass the returned transaction to <a href="../../../org/apache/tephra/TransactionAware.html#startTx(org.apache.tephra.Transaction)"><code>TransactionAware.startTx(Transaction)</code></a> for each registered + TransactionAware. If an exception is encountered, the transaction will be aborted and a + <code>TransactionFailureException</code> wrapping the root cause will be thrown.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../org/apache/tephra/TransactionFailureException.html" title="class in org.apache.tephra">TransactionFailureException</a></code> - if an exception occurs starting the transaction with any registered + TransactionAware</dd></dl> +</li> +</ul> +<a name="finish()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>finish</h4> +<pre>public void finish() + throws <a href="../../../org/apache/tephra/TransactionFailureException.html" title="class in org.apache.tephra">TransactionFailureException</a></pre> +<div class="block">Commits the current transaction. This will: check for any conflicts, based on the change set aggregated from + all registered <a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra"><code>TransactionAware</code></a> instances; flush any pending writes from the <code>TransactionAware</code>s; + commit the current transaction with the <a href="../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra"><code>TransactionSystemClient</code></a>; and clear the current transaction state.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../org/apache/tephra/TransactionConflictException.html" title="class in org.apache.tephra">TransactionConflictException</a></code> - if a conflict is detected with a recently committed transaction</dd> +<dd><code><a href="../../../org/apache/tephra/TransactionFailureException.html" title="class in org.apache.tephra">TransactionFailureException</a></code> - if an error occurs while committing</dd></dl> +</li> +</ul> +<a name="abort()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>abort</h4> +<pre>public void abort() + throws <a href="../../../org/apache/tephra/TransactionFailureException.html" title="class in org.apache.tephra">TransactionFailureException</a></pre> +<div class="block">Aborts the given transaction, and rolls back all data set changes. If rollback fails, + the transaction is invalidated. If an exception is caught during rollback, the exception + is rethrown wrapped in a TransactionFailureException, after all remaining TransactionAwares have + completed rollback.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../org/apache/tephra/TransactionFailureException.html" title="class in org.apache.tephra">TransactionFailureException</a></code> - for any exception that is encountered.</dd></dl> +</li> +</ul> +<a name="checkpoint()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>checkpoint</h4> +<pre>public void checkpoint() + throws <a href="../../../org/apache/tephra/TransactionFailureException.html" title="class in org.apache.tephra">TransactionFailureException</a></pre> +<div class="block">Checkpoints the current transaction by flushing any pending writes for the registered <a href="../../../org/apache/tephra/TransactionAware.html" title="interface in org.apache.tephra"><code>TransactionAware</code></a> + instances, and obtaining a new current write pointer for the transaction. By performing a checkpoint, + the client can ensure that all previous writes were flushed and are visible. By default, the current write + pointer for the transaction is also visible. The current write pointer can be excluded from read + operations by calling <a href="../../../org/apache/tephra/Transaction.html#setVisibility(org.apache.tephra.Transaction.VisibilityLevel)"><code>Transaction.setVisibility(Transaction.VisibilityLevel)</code></a> with the visibility level set + to <a href="../../../org/apache/tephra/Transaction.VisibilityLevel.html#SNAPSHOT_EXCLUDE_CURRENT"><code>Transaction.VisibilityLevel.SNAPSHOT_EXCLUDE_CURRENT</code></a> on the <a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra"><code>Transaction</code></a> instance created + by the checkpoint call, which can be retrieved by calling <a href="../../../org/apache/tephra/TransactionContext.html#getCurrentTransaction()"><code>getCurrentTransaction()</code></a>. + + After the checkpoint operation is performed, the updated + <a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra"><code>Transaction</code></a> instance will be passed to <a href="../../../org/apache/tephra/TransactionAware.html#startTx(org.apache.tephra.Transaction)"><code>TransactionAware.startTx(Transaction)</code></a> for each + registered <code>TransactionAware</code> instance.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../org/apache/tephra/TransactionFailureException.html" title="class in org.apache.tephra">TransactionFailureException</a></code> - if an error occurs while performing the checkpoint</dd></dl> +</li> +</ul> +<a name="getCurrentTransaction()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCurrentTransaction</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a> +public <a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> getCurrentTransaction()</pre> +<div class="block">Returns the current transaction or null if no transaction is currently in progress.</div> +</li> +</ul> +<a name="abort(org.apache.tephra.TransactionFailureException)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>abort</h4> +<pre>public void abort(<a href="../../../org/apache/tephra/TransactionFailureException.html" title="class in org.apache.tephra">TransactionFailureException</a> cause) + throws <a href="../../../org/apache/tephra/TransactionFailureException.html" title="class in org.apache.tephra">TransactionFailureException</a></pre> +<div class="block">Aborts the given transaction, and rolls back all data set changes. If rollback fails, + the transaction is invalidated. If an exception is caught during rollback, the exception + is rethrown wrapped into a TransactionFailureException, after all remaining TransactionAwares have + completed rollback. If an existing exception is passed in, that exception is thrown in either + case, whether the rollback is successful or not. In other words, this method always throws the + first exception that it encounters.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cause</code> - the original exception that caused the abort</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../org/apache/tephra/TransactionFailureException.html" title="class in org.apache.tephra">TransactionFailureException</a></code> - for any exception that is encountered.</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/TransactionContext.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-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/apache/tephra/TransactionConflictException.html" title="class in org.apache.tephra"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/tephra/TransactionCouldNotTakeSnapshotException.html" title="class in org.apache.tephra"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/tephra/TransactionContext.html" target="_top">Frames</a></li> +<li><a href="TransactionContext.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 © 2016 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>