http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/e3dbdde9/src/site/resources/apidocs-0.11.0-incubating/org/apache/tephra/TransactionManager.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.11.0-incubating/org/apache/tephra/TransactionManager.html b/src/site/resources/apidocs-0.11.0-incubating/org/apache/tephra/TransactionManager.html new file mode 100644 index 0000000..80fc796 --- /dev/null +++ b/src/site/resources/apidocs-0.11.0-incubating/org/apache/tephra/TransactionManager.html @@ -0,0 +1,727 @@ +<!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_60) on Mon Mar 20 11:17:30 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>TransactionManager (Apache Tephra 0.11.0-incubating API)</title> +<meta name="date" content="2017-03-20"> +<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 (Apache Tephra 0.11.0-incubating 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-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/TransactionFailureException.html" title="class in org.apache.tephra"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/tephra/TransactionManager.InProgressTx.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/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><a href="#nested_class_summary">Nested</a> | </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 TransactionManager" class="title">Class TransactionManager</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>com.google.common.util.concurrent.AbstractService</li> +<li> +<ul class="inheritance"> +<li>org.apache.tephra.TransactionManager</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>com.google.common.util.concurrent.Service</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">TransactionManager</span> +extends com.google.common.util.concurrent.AbstractService</pre> +<div class="block">This is the central place to manage all active transactions in the system. + + A transaction consists of + <ul> + <li>A write pointer: This is the version used for all writes of that transaction.</li> + <li>A read pointer: All reads under the transaction use this as an upper bound for the version.</li> + <li>A set of excluded versions: These are the write versions of other transactions that must be excluded from + reads, because those transactions are still in progress, or they failed but couldn't be properly rolled back.</li> + </ul> + To use the transaction system, a client must follow this sequence of steps: + <ol> + <li>Request a new transaction.</li> + <li>Use the transaction to read and write datasets. Datasets are encouraged to cache the writes of the + transaction in memory, to reduce the cost of rollback in case the transaction fails. </li> + <li>Check whether the transaction has conflicts. For this, the set of change keys are submitted via canCommit(), + and the transaction manager verifies that none of these keys are in conflict with other transactions that + committed since the start of this transaction.</li> + <li>If the transaction has conflicts: + <ol> + <li>Roll back the changes in every dataset that was changed. This can happen in-memory if the + changes were cached.</li> + <li>Abort the transaction to remove it from the active transactions.</li> + </ol> + <li>If the transaction has no conflicts:</li> + <ol> + <li>Persist all datasets changes to storage.</li> + <li>Commit the transaction. This will repeat the conflict detection, because more overlapping transactions + may have committed since the first conflict check.</li> + <li>If the transaction has conflicts:</li> + <ol> + <li>Roll back the changes in every dataset that was changed. This is more expensive because + changes must be undone in persistent storage.</li> + <li>Abort the transaction to remove it from the active transactions.</li> + </ol> + </ol> + </ol> + Transactions may be short or long-running. A short transaction is started with a timeout, and if it is not + committed before that timeout, it is invalidated and excluded from future reads. A long-running transaction has + no timeout and will remain active until it is committed or aborted. Long transactions are typically used in + map/reduce jobs and can produce enormous amounts of changes. Therefore, long transactions do not participate in + conflict detection (they would almost always have conflicts). We also assume that the changes of long transactions + are not tracked, and therefore cannot be rolled back. Hence, when a long transaction is aborted, it remains in the + list of excluded transactions to make its writes invisible.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionManager.InProgressTx.html" title="class in org.apache.tephra">TransactionManager.InProgressTx</a></strong></code> +<div class="block">Represents some of the info on in-progress tx</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionManager.InProgressType.html" title="enum in org.apache.tephra">TransactionManager.InProgressType</a></strong></code> +<div class="block">Type of in-progress transaction.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_com.google.common.util.concurrent.Service"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service</h3> +<code>com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State</code></li> +</ul> +</li> +</ul> +<!-- ======== 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/TransactionManager.html#TransactionManager(org.apache.hadoop.conf.Configuration)">TransactionManager</a></strong>(org.apache.hadoop.conf.Configuration config)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../org/apache/tephra/TransactionManager.html#TransactionManager(org.apache.hadoop.conf.Configuration,%20org.apache.tephra.persist.TransactionStateStorage,%20org.apache.tephra.metrics.MetricsCollector)">TransactionManager</a></strong>(org.apache.hadoop.conf.Configuration conf, + <a href="../../../org/apache/tephra/persist/TransactionStateStorage.html" title="interface in org.apache.tephra.persist">TransactionStateStorage</a> persistor, + <a href="../../../org/apache/tephra/metrics/MetricsCollector.html" title="interface in org.apache.tephra.metrics">MetricsCollector</a> txMetricsCollector)</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/TransactionManager.html#abort(org.apache.tephra.Transaction)">abort</a></strong>(<a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> tx)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionManager.html#canCommit(org.apache.tephra.Transaction,%20java.util.Collection)">canCommit</a></strong>(<a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> tx, + <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[]> changeIds)</code> </td> +</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/TransactionManager.html#checkpoint(org.apache.tephra.Transaction)">checkpoint</a></strong>(<a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> originalTx)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionManager.html#commit(org.apache.tephra.Transaction)">commit</a></strong>(<a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> tx)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionManager.html#doStart()">doStart</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/TransactionManager.html#doStop()">doStop</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/tephra/persist/TransactionSnapshot.html" title="class in org.apache.tephra.persist">TransactionSnapshot</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionManager.html#getCurrentState()">getCurrentState</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionManager.html#getExcludedListSize()">getExcludedListSize</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionManager.html#getInvalidSize()">getInvalidSize</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/tephra/persist/TransactionSnapshot.html" title="class in org.apache.tephra.persist">TransactionSnapshot</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionManager.html#getSnapshot()">getSnapshot</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/tephra/persist/TransactionStateStorage.html" title="interface in org.apache.tephra.persist">TransactionStateStorage</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionManager.html#getTransactionStateStorage()">getTransactionStateStorage</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionManager.html#getTxExpirationFromWritePointer(long,%20long)">getTxExpirationFromWritePointer</a></strong>(long writePointer, + long timeoutInSeconds)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionManager.html#invalidate(long)">invalidate</a></strong>(long tx)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionManager.html#logStatistics()">logStatistics</a></strong>()</code> +<div class="block">Called from the tx service every 10 seconds.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionManager.html#recoverState()">recoverState</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/TransactionManager.html#resetState()">resetState</a></strong>()</code> +<div class="block">Resets the state of the transaction manager.</div> +</td> +</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/TransactionManager.html#startLong()">startLong</a></strong>()</code> +<div class="block">Start a long 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/TransactionManager.html#startShort()">startShort</a></strong>()</code> +<div class="block">Start a short transaction with the default timeout.</div> +</td> +</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/TransactionManager.html#startShort(int)">startShort</a></strong>(int timeoutInSeconds)</code> +<div class="block">Start a short transaction with a given timeout.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionManager.html#takeSnapshot(java.io.OutputStream)">takeSnapshot</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true"; title="class or interface in java.io">OutputStream</a> out)</code> +<div class="block">Take a snapshot of the transaction state and serialize it into the given output stream.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionManager.html#truncateInvalidTx(java.util.Set)">truncateInvalidTx</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>> invalidTxIds)</code> +<div class="block">Removes the given transaction ids from the invalid list.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionManager.html#truncateInvalidTxBefore(long)">truncateInvalidTxBefore</a></strong>(long time)</code> +<div class="block">Removes all transaction ids started before the given time from invalid list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>,<a href="../../../org/apache/tephra/TransactionManager.InProgressTx.html" title="class in org.apache.tephra">TransactionManager.InProgressTx</a>></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionManager.html#txnBackwardsCompatCheck(int,%20long,%20java.util.Map)">txnBackwardsCompatCheck</a></strong>(int defaultLongTimeout, + long longTimeoutTolerance, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>,<a href="../../../org/apache/tephra/TransactionManager.InProgressTx.html" title="class in org.apache.tephra">TransactionManager.InProgressTx</a>> inProgress)</code> +<div class="block">Check if in-progress transactions need to be migrated to have expiration time and type, if so do the migration.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.google.common.util.concurrent.AbstractService"> +<!-- --> +</a> +<h3>Methods inherited from class com.google.common.util.concurrent.AbstractService</h3> +<code>addListener, isRunning, notifyFailed, notifyStarted, notifyStopped, start, startAndWait, state, stop, stopAndWait, toString</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="TransactionManager(org.apache.hadoop.conf.Configuration)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TransactionManager</h4> +<pre>public TransactionManager(org.apache.hadoop.conf.Configuration config)</pre> +</li> +</ul> +<a name="TransactionManager(org.apache.hadoop.conf.Configuration, org.apache.tephra.persist.TransactionStateStorage, org.apache.tephra.metrics.MetricsCollector)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TransactionManager</h4> +<pre>@Inject +public TransactionManager(org.apache.hadoop.conf.Configuration conf, + <a href="http://docs.oracle.com/javase/7/docs/api/javax/annotation/Nonnull.html?is-external=true"; title="class or interface in javax.annotation">@Nonnull</a> + <a href="../../../org/apache/tephra/persist/TransactionStateStorage.html" title="interface in org.apache.tephra.persist">TransactionStateStorage</a> persistor, + <a href="../../../org/apache/tephra/metrics/MetricsCollector.html" title="interface in org.apache.tephra.metrics">MetricsCollector</a> txMetricsCollector)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="doStart()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doStart</h4> +<pre>public void doStart()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>doStart</code> in class <code>com.google.common.util.concurrent.AbstractService</code></dd> +</dl> +</li> +</ul> +<a name="getSnapshot()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSnapshot</h4> +<pre>public <a href="../../../org/apache/tephra/persist/TransactionSnapshot.html" title="class in org.apache.tephra.persist">TransactionSnapshot</a> getSnapshot() + 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="takeSnapshot(java.io.OutputStream)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>takeSnapshot</h4> +<pre>public boolean takeSnapshot(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true"; title="class or interface in java.io">OutputStream</a> out) + 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> +<div class="block">Take a snapshot of the transaction state and serialize it into the given output stream.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>whether a snapshot was taken.</dd> +<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="getCurrentState()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCurrentState</h4> +<pre>public <a href="../../../org/apache/tephra/persist/TransactionSnapshot.html" title="class in org.apache.tephra.persist">TransactionSnapshot</a> getCurrentState()</pre> +</li> +</ul> +<a name="recoverState()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>recoverState</h4> +<pre>public void recoverState()</pre> +</li> +</ul> +<a name="txnBackwardsCompatCheck(int, long, java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>txnBackwardsCompatCheck</h4> +<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>,<a href="../../../org/apache/tephra/TransactionManager.InProgressTx.html" title="class in org.apache.tephra">TransactionManager.InProgressTx</a>> txnBackwardsCompatCheck(int defaultLongTimeout, + long longTimeoutTolerance, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>,<a href="../../../org/apache/tephra/TransactionManager.InProgressTx.html" title="class in org.apache.tephra">TransactionManager.InProgressTx</a>> inProgress)</pre> +<div class="block">Check if in-progress transactions need to be migrated to have expiration time and type, if so do the migration. + This is required for backwards compatibility, when long running transactions were represented + with expiration time -1. This can be removed when we stop supporting SnapshotCodec version 1.</div> +</li> +</ul> +<a name="resetState()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resetState</h4> +<pre>public void resetState()</pre> +<div class="block">Resets the state of the transaction manager.</div> +</li> +</ul> +<a name="doStop()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doStop</h4> +<pre>public void doStop()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>doStop</code> in class <code>com.google.common.util.concurrent.AbstractService</code></dd> +</dl> +</li> +</ul> +<a name="startShort()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>startShort</h4> +<pre>public <a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> startShort()</pre> +<div class="block">Start a short transaction with the default timeout.</div> +</li> +</ul> +<a name="startShort(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>startShort</h4> +<pre>public <a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> startShort(int timeoutInSeconds)</pre> +<div class="block">Start a short transaction with a given timeout.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeoutInSeconds</code> - the time out period in seconds.</dd></dl> +</li> +</ul> +<a name="getTxExpirationFromWritePointer(long, long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTxExpirationFromWritePointer</h4> +<pre>public static long getTxExpirationFromWritePointer(long writePointer, + long timeoutInSeconds)</pre> +</li> +</ul> +<a name="startLong()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>startLong</h4> +<pre>public <a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> startLong()</pre> +<div class="block">Start a long transaction. Long transactions and do not participate in conflict detection. Also, aborting a long + transaction moves it to the invalid list because we assume that its writes cannot be rolled back.</div> +</li> +</ul> +<a name="canCommit(org.apache.tephra.Transaction, java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canCommit</h4> +<pre>public boolean canCommit(<a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> tx, + <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[]> changeIds) + throws <a href="../../../org/apache/tephra/TransactionNotInProgressException.html" title="class in org.apache.tephra">TransactionNotInProgressException</a></pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../org/apache/tephra/TransactionNotInProgressException.html" title="class in org.apache.tephra">TransactionNotInProgressException</a></code></dd></dl> +</li> +</ul> +<a name="commit(org.apache.tephra.Transaction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>commit</h4> +<pre>public boolean commit(<a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> tx) + throws <a href="../../../org/apache/tephra/TransactionNotInProgressException.html" title="class in org.apache.tephra">TransactionNotInProgressException</a></pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../org/apache/tephra/TransactionNotInProgressException.html" title="class in org.apache.tephra">TransactionNotInProgressException</a></code></dd></dl> +</li> +</ul> +<a name="abort(org.apache.tephra.Transaction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>abort</h4> +<pre>public void abort(<a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> tx)</pre> +</li> +</ul> +<a name="invalidate(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>invalidate</h4> +<pre>public boolean invalidate(long tx)</pre> +</li> +</ul> +<a name="truncateInvalidTx(java.util.Set)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>truncateInvalidTx</h4> +<pre>public boolean truncateInvalidTx(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>> invalidTxIds)</pre> +<div class="block">Removes the given transaction ids from the invalid list.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>invalidTxIds</code> - transaction ids</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if invalid list got changed, false otherwise</dd></dl> +</li> +</ul> +<a name="truncateInvalidTxBefore(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>truncateInvalidTxBefore</h4> +<pre>public boolean truncateInvalidTxBefore(long time) + throws <a href="../../../org/apache/tephra/InvalidTruncateTimeException.html" title="class in org.apache.tephra">InvalidTruncateTimeException</a></pre> +<div class="block">Removes all transaction ids started before the given time from invalid list.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>time</code> - time in milliseconds</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if invalid list got changed, false otherwise</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../org/apache/tephra/InvalidTruncateTimeException.html" title="class in org.apache.tephra">InvalidTruncateTimeException</a></code> - if there are any in-progress transactions started before given time</dd></dl> +</li> +</ul> +<a name="checkpoint(org.apache.tephra.Transaction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>checkpoint</h4> +<pre>public <a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> checkpoint(<a href="../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> originalTx) + throws <a href="../../../org/apache/tephra/TransactionNotInProgressException.html" title="class in org.apache.tephra">TransactionNotInProgressException</a></pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../org/apache/tephra/TransactionNotInProgressException.html" title="class in org.apache.tephra">TransactionNotInProgressException</a></code></dd></dl> +</li> +</ul> +<a name="getExcludedListSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExcludedListSize</h4> +<pre>public int getExcludedListSize()</pre> +</li> +</ul> +<a name="getInvalidSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInvalidSize</h4> +<pre>public int getInvalidSize()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the size of invalid list</dd></dl> +</li> +</ul> +<a name="logStatistics()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>logStatistics</h4> +<pre>public void logStatistics()</pre> +<div class="block">Called from the tx service every 10 seconds. + This hack is needed because current metrics system is not flexible when it comes to adding new metrics.</div> +</li> +</ul> +<a name="getTransactionStateStorage()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getTransactionStateStorage</h4> +<pre>public <a href="../../../org/apache/tephra/persist/TransactionStateStorage.html" title="interface in org.apache.tephra.persist">TransactionStateStorage</a> getTransactionStateStorage()</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/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-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/TransactionFailureException.html" title="class in org.apache.tephra"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/tephra/TransactionManager.InProgressTx.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/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><a href="#nested_class_summary">Nested</a> | </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 © 2017 <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/e3dbdde9/src/site/resources/apidocs-0.11.0-incubating/org/apache/tephra/TransactionNotInProgressException.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.11.0-incubating/org/apache/tephra/TransactionNotInProgressException.html b/src/site/resources/apidocs-0.11.0-incubating/org/apache/tephra/TransactionNotInProgressException.html new file mode 100644 index 0000000..7aa25f6 --- /dev/null +++ b/src/site/resources/apidocs-0.11.0-incubating/org/apache/tephra/TransactionNotInProgressException.html @@ -0,0 +1,258 @@ +<!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_60) on Mon Mar 20 11:17:30 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>TransactionNotInProgressException (Apache Tephra 0.11.0-incubating API)</title> +<meta name="date" content="2017-03-20"> +<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="TransactionNotInProgressException (Apache Tephra 0.11.0-incubating 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/TransactionNotInProgressException.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/TransactionManager.InProgressType.html" title="enum in org.apache.tephra"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/tephra/TransactionServiceMain.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/TransactionNotInProgressException.html" target="_top">Frames</a></li> +<li><a href="TransactionNotInProgressException.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 TransactionNotInProgressException" class="title">Class TransactionNotInProgressException</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.TransactionNotInProgressException</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">TransactionNotInProgressException</span> +extends <a href="../../../org/apache/tephra/TransactionFailureException.html" title="class in org.apache.tephra">TransactionFailureException</a></pre> +<div class="block">Thrown when transaction has timed out.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#org.apache.tephra.TransactionNotInProgressException">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/TransactionNotInProgressException.html#TransactionNotInProgressException(java.lang.String)">TransactionNotInProgressException</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> +</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="TransactionNotInProgressException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TransactionNotInProgressException</h4> +<pre>public TransactionNotInProgressException(<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> +</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/TransactionNotInProgressException.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/TransactionManager.InProgressType.html" title="enum in org.apache.tephra"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/tephra/TransactionServiceMain.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/TransactionNotInProgressException.html" target="_top">Frames</a></li> +<li><a href="TransactionNotInProgressException.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 © 2017 <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/e3dbdde9/src/site/resources/apidocs-0.11.0-incubating/org/apache/tephra/TransactionServiceMain.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.11.0-incubating/org/apache/tephra/TransactionServiceMain.html b/src/site/resources/apidocs-0.11.0-incubating/org/apache/tephra/TransactionServiceMain.html new file mode 100644 index 0000000..6b77a37 --- /dev/null +++ b/src/site/resources/apidocs-0.11.0-incubating/org/apache/tephra/TransactionServiceMain.html @@ -0,0 +1,361 @@ +<!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_60) on Mon Mar 20 11:17:30 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>TransactionServiceMain (Apache Tephra 0.11.0-incubating API)</title> +<meta name="date" content="2017-03-20"> +<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="TransactionServiceMain (Apache Tephra 0.11.0-incubating 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/TransactionServiceMain.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/TransactionNotInProgressException.html" title="class in org.apache.tephra"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/tephra/TransactionServiceMain.html" target="_top">Frames</a></li> +<li><a href="TransactionServiceMain.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 TransactionServiceMain" class="title">Class TransactionServiceMain</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.TransactionServiceMain</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">TransactionServiceMain</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">Driver class to start and stop tx in distributed mode.</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/TransactionServiceMain.html#TransactionServiceMain()">TransactionServiceMain</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../org/apache/tephra/TransactionServiceMain.html#TransactionServiceMain(org.apache.hadoop.conf.Configuration)">TransactionServiceMain</a></strong>(org.apache.hadoop.conf.Configuration conf)</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/TransactionServiceMain.html#destroy()">destroy</a></strong>()</code> +<div class="block">Invoked by jsvc for resource cleanup.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionServiceMain.html#doMain(java.lang.String[])">doMain</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>[] args)</code> +<div class="block">The main method.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionServiceMain.html#init(java.lang.String[])">init</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>[] args)</code> +<div class="block">Invoked by jsvc to initialize the program.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionServiceMain.html#main(java.lang.String[])">main</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>[] args)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionServiceMain.html#start()">start</a></strong>()</code> +<div class="block">Invoked by jsvc to start the program.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/tephra/TransactionServiceMain.html#stop()">stop</a></strong>()</code> +<div class="block">Invoked by jsvc to stop the program.</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="TransactionServiceMain()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TransactionServiceMain</h4> +<pre>public TransactionServiceMain()</pre> +</li> +</ul> +<a name="TransactionServiceMain(org.apache.hadoop.conf.Configuration)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TransactionServiceMain</h4> +<pre>public TransactionServiceMain(org.apache.hadoop.conf.Configuration conf)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="main(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>main</h4> +<pre>public static void main(<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>[] args) + 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> +<dl><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="doMain(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doMain</h4> +<pre>public void doMain(<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>[] args) + 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">The main method. It simply call methods in the same sequence + as if the program is started by jsvc.</div> +<dl><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="init(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>init</h4> +<pre>public void init(<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>[] args)</pre> +<div class="block">Invoked by jsvc to initialize the program.</div> +</li> +</ul> +<a name="start()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>start</h4> +<pre>public void start() + 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">Invoked by jsvc to start the program.</div> +<dl><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="stop()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>stop</h4> +<pre>public void stop()</pre> +<div class="block">Invoked by jsvc to stop the program.</div> +</li> +</ul> +<a name="destroy()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>destroy</h4> +<pre>public void destroy()</pre> +<div class="block">Invoked by jsvc for resource cleanup.</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/TransactionServiceMain.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/TransactionNotInProgressException.html" title="class in org.apache.tephra"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/tephra/TransactionServiceMain.html" target="_top">Frames</a></li> +<li><a href="TransactionServiceMain.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 © 2017 <a href="http://www.apache.org";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
