http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/1047fad6/src/site/resources/apidocs-0.8.0-incubating/org/apache/tephra/distributed/ThriftClientProvider.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.8.0-incubating/org/apache/tephra/distributed/ThriftClientProvider.html b/src/site/resources/apidocs-0.8.0-incubating/org/apache/tephra/distributed/ThriftClientProvider.html new file mode 100644 index 0000000..fed4f75 --- /dev/null +++ b/src/site/resources/apidocs-0.8.0-incubating/org/apache/tephra/distributed/ThriftClientProvider.html @@ -0,0 +1,280 @@ +<!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 Tue Jun 21 15:13:03 PDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ThriftClientProvider (Apache Tephra 0.8.0-incubating API)</title> +<meta name="date" content="2016-06-21"> +<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="ThriftClientProvider (Apache Tephra 0.8.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/ThriftClientProvider.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/distributed/ThreadLocalClientProvider.html" title="class in org.apache.tephra.distributed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/TransactionConverterUtils.html" title="class in org.apache.tephra.distributed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/ThriftClientProvider.html" target="_top">Frames</a></li> +<li><a href="ThriftClientProvider.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.distributed</div> +<h2 title="Interface ThriftClientProvider" class="title">Interface ThriftClientProvider</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/distributed/AbstractClientProvider.html" title="class in org.apache.tephra.distributed">AbstractClientProvider</a>, <a href="../../../../org/apache/tephra/distributed/PooledClientProvider.html" title="class in org.apache.tephra.distributed">PooledClientProvider</a>, <a href="../../../../org/apache/tephra/distributed/SingleUseClientProvider.html" title="class in org.apache.tephra.distributed">SingleUseClientProvider</a>, <a href="../../../../org/apache/tephra/distributed/ThreadLocalClientProvider.html" title="class in org.apache.tephra.distributed">ThreadLocalClientProvider</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ThriftClientProvider</span></pre> +<div class="block">This interface is used to provide thrift tx service clients: + there is only one (singleton) + tx service per JVM, but many threads may use it concurrently. + However, being a thrift client, it is not thread-safe. In + order to avoid serializing all tx calls by synchronizing + on the tx service client, we employ a pool of clients. But + in different scenarios there are different strategies for + pooling: If there are many short-lived threads, it is wise + to have a shared pool between all threads. But if there are + few long-lived threads, it may be better to have thread-local + client for each thread. + + This interface provides an abstraction of the pooling strategy.</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><a href="../../../../org/apache/tephra/distributed/CloseableThriftClient.html" title="class in org.apache.tephra.distributed">CloseableThriftClient</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/ThriftClientProvider.html#getCloseableClient()">getCloseableClient</a></strong>()</code> +<div class="block">Retrieve an AutoCloseable wrapper around tx client for exclusive use by the + current thread.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/ThriftClientProvider.html#initialize()">initialize</a></strong>()</code> +<div class="block">Initialize the provider.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/ThriftClientProvider.html#returnClient(org.apache.tephra.distributed.TransactionServiceThriftClient)">returnClient</a></strong>(<a href="../../../../org/apache/tephra/distributed/TransactionServiceThriftClient.html" title="class in org.apache.tephra.distributed">TransactionServiceThriftClient</a> client)</code> +<div class="block">Release an tx client back to the provider's pool, if the client is valid.</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="initialize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialize</h4> +<pre>void initialize() + throws org.apache.thrift.TException</pre> +<div class="block">Initialize the provider. At this point, it should be verified + that tx service is up and running and getClient() can + create new clients when necessary.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>org.apache.thrift.TException</code></dd></dl> +</li> +</ul> +<a name="getCloseableClient()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCloseableClient</h4> +<pre><a href="../../../../org/apache/tephra/distributed/CloseableThriftClient.html" title="class in org.apache.tephra.distributed">CloseableThriftClient</a> getCloseableClient() + throws org.apache.thrift.TException, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeoutException.html?is-external=true"; title="class or interface in java.util.concurrent">TimeoutException</a>, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></pre> +<div class="block">Retrieve an AutoCloseable wrapper around tx client for exclusive use by the + current thread. The client must be closed (returned) to the provider after use.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an tx client, connected and fully functional</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>org.apache.thrift.TException</code></dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeoutException.html?is-external=true"; title="class or interface in java.util.concurrent">TimeoutException</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></code></dd></dl> +</li> +</ul> +<a name="returnClient(org.apache.tephra.distributed.TransactionServiceThriftClient)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>returnClient</h4> +<pre>void returnClient(<a href="../../../../org/apache/tephra/distributed/TransactionServiceThriftClient.html" title="class in org.apache.tephra.distributed">TransactionServiceThriftClient</a> client)</pre> +<div class="block">Release an tx client back to the provider's pool, if the client is valid. + If the client becomes disfunctional, for instance, due to a socket + exception. The provider must make sure to close the client, and it + must remove the client from its arsenal and be prepared to create + a new client subsequently.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>client</code> - The client to return</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/ThriftClientProvider.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/distributed/ThreadLocalClientProvider.html" title="class in org.apache.tephra.distributed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/TransactionConverterUtils.html" title="class in org.apache.tephra.distributed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/ThriftClientProvider.html" target="_top">Frames</a></li> +<li><a href="ThriftClientProvider.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/1047fad6/src/site/resources/apidocs-0.8.0-incubating/org/apache/tephra/distributed/TransactionConverterUtils.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.8.0-incubating/org/apache/tephra/distributed/TransactionConverterUtils.html b/src/site/resources/apidocs-0.8.0-incubating/org/apache/tephra/distributed/TransactionConverterUtils.html new file mode 100644 index 0000000..f476397 --- /dev/null +++ b/src/site/resources/apidocs-0.8.0-incubating/org/apache/tephra/distributed/TransactionConverterUtils.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 Tue Jun 21 15:13:03 PDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TransactionConverterUtils (Apache Tephra 0.8.0-incubating API)</title> +<meta name="date" content="2016-06-21"> +<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="TransactionConverterUtils (Apache Tephra 0.8.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/TransactionConverterUtils.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/distributed/ThriftClientProvider.html" title="interface in org.apache.tephra.distributed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/TransactionService.html" title="class in org.apache.tephra.distributed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/TransactionConverterUtils.html" target="_top">Frames</a></li> +<li><a href="TransactionConverterUtils.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.distributed</div> +<h2 title="Class TransactionConverterUtils" class="title">Class TransactionConverterUtils</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.distributed.TransactionConverterUtils</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="strong">TransactionConverterUtils</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 methods to convert to thrift and back.</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/distributed/TransactionConverterUtils.html#TransactionConverterUtils()">TransactionConverterUtils</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>static <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/distributed/TransactionConverterUtils.html#unwrap(org.apache.tephra.distributed.thrift.TTransaction)">unwrap</a></strong>(<a href="../../../../org/apache/tephra/distributed/thrift/TTransaction.html" title="class in org.apache.tephra.distributed.thrift">TTransaction</a> thriftTx)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/tephra/distributed/thrift/TTransaction.html" title="class in org.apache.tephra.distributed.thrift">TTransaction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/TransactionConverterUtils.html#wrap(org.apache.tephra.Transaction)">wrap</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="TransactionConverterUtils()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TransactionConverterUtils</h4> +<pre>public TransactionConverterUtils()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="wrap(org.apache.tephra.Transaction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>wrap</h4> +<pre>public static <a href="../../../../org/apache/tephra/distributed/thrift/TTransaction.html" title="class in org.apache.tephra.distributed.thrift">TTransaction</a> wrap(<a href="../../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> tx)</pre> +</li> +</ul> +<a name="unwrap(org.apache.tephra.distributed.thrift.TTransaction)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>unwrap</h4> +<pre>public static <a href="../../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> unwrap(<a href="../../../../org/apache/tephra/distributed/thrift/TTransaction.html" title="class in org.apache.tephra.distributed.thrift">TTransaction</a> thriftTx)</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/TransactionConverterUtils.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/distributed/ThriftClientProvider.html" title="interface in org.apache.tephra.distributed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/TransactionService.html" title="class in org.apache.tephra.distributed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/TransactionConverterUtils.html" target="_top">Frames</a></li> +<li><a href="TransactionConverterUtils.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/1047fad6/src/site/resources/apidocs-0.8.0-incubating/org/apache/tephra/distributed/TransactionService.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.8.0-incubating/org/apache/tephra/distributed/TransactionService.html b/src/site/resources/apidocs-0.8.0-incubating/org/apache/tephra/distributed/TransactionService.html new file mode 100644 index 0000000..57e0bd7 --- /dev/null +++ b/src/site/resources/apidocs-0.8.0-incubating/org/apache/tephra/distributed/TransactionService.html @@ -0,0 +1,387 @@ +<!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 Tue Jun 21 15:13:03 PDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TransactionService (Apache Tephra 0.8.0-incubating API)</title> +<meta name="date" content="2016-06-21"> +<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="TransactionService (Apache Tephra 0.8.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/TransactionService.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/distributed/TransactionConverterUtils.html" title="class in org.apache.tephra.distributed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/TransactionServiceClient.html" title="class in org.apache.tephra.distributed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/TransactionService.html" target="_top">Frames</a></li> +<li><a href="TransactionService.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><a href="#fields_inherited_from_class_org.apache.tephra.inmemory.InMemoryTransactionService">Field</a> | </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.distributed</div> +<h2 title="Class TransactionService" class="title">Class TransactionService</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><a href="../../../../org/apache/tephra/inmemory/InMemoryTransactionService.html" title="class in org.apache.tephra.inmemory">org.apache.tephra.inmemory.InMemoryTransactionService</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.tephra.distributed.TransactionService</li> +</ul> +</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 final class <span class="strong">TransactionService</span> +extends <a href="../../../../org/apache/tephra/inmemory/InMemoryTransactionService.html" title="class in org.apache.tephra.inmemory">InMemoryTransactionService</a></pre> +</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> +<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> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.tephra.inmemory.InMemoryTransactionService"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.tephra.inmemory.<a href="../../../../org/apache/tephra/inmemory/InMemoryTransactionService.html" title="class in org.apache.tephra.inmemory">InMemoryTransactionService</a></h3> +<code><a href="../../../../org/apache/tephra/inmemory/InMemoryTransactionService.html#address">address</a>, <a href="../../../../org/apache/tephra/inmemory/InMemoryTransactionService.html#ioThreads">ioThreads</a>, <a href="../../../../org/apache/tephra/inmemory/InMemoryTransactionService.html#maxReadBufferBytes">maxReadBufferBytes</a>, <a href="../../../../org/apache/tephra/inmemory/InMemoryTransactionService.html#port">port</a>, <a href="../../../../org/apache/tephra/inmemory/InMemoryTransactionService.html#threads">threads</a>, <a href="../../../../org/apache/tephra/inmemory/InMemoryTransactionService.html#txManager">txManager</a>, <a href="../../../../org/apache/tephra/inmemory/InMemoryTransactionService.html#txManagerProvider">txManagerProvider</a></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/distributed/TransactionService.html#TransactionService(org.apache.hadoop.conf.Configuration,%20org.apache.twill.zookeeper.ZKClient,%20org.apache.twill.discovery.DiscoveryService,%20com.google.inject.Provider)">TransactionService</a></strong>(org.apache.hadoop.conf.Configuration conf, + org.apache.twill.zookeeper.ZKClient zkClient, + org.apache.twill.discovery.DiscoveryService discoveryService, + com.google.inject.Provider<<a href="../../../../org/apache/tephra/TransactionManager.html" title="class in org.apache.tephra">TransactionManager</a>> txManagerProvider)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/TransactionService.html#abort(java.lang.Throwable)">abort</a></strong>(<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> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/TransactionService.html#doStart()">doStart</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/TransactionService.html#doStop()">doStop</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/net/InetSocketAddress.html?is-external=true"; title="class or interface in java.net">InetSocketAddress</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/TransactionService.html#getAddress()">getAddress</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/TransactionService.html#internalStop()">internalStop</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.tephra.inmemory.InMemoryTransactionService"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.tephra.inmemory.<a href="../../../../org/apache/tephra/inmemory/InMemoryTransactionService.html" title="class in org.apache.tephra.inmemory">InMemoryTransactionService</a></h3> +<code><a href="../../../../org/apache/tephra/inmemory/InMemoryTransactionService.html#doRegister()">doRegister</a>, <a href="../../../../org/apache/tephra/inmemory/InMemoryTransactionService.html#undoRegister()">undoRegister</a></code></li> +</ul> +<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="TransactionService(org.apache.hadoop.conf.Configuration, org.apache.twill.zookeeper.ZKClient, org.apache.twill.discovery.DiscoveryService, com.google.inject.Provider)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TransactionService</h4> +<pre>@Inject +public TransactionService(org.apache.hadoop.conf.Configuration conf, + org.apache.twill.zookeeper.ZKClient zkClient, + org.apache.twill.discovery.DiscoveryService discoveryService, + com.google.inject.Provider<<a href="../../../../org/apache/tephra/TransactionManager.html" title="class in org.apache.tephra">TransactionManager</a>> txManagerProvider)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getAddress()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAddress</h4> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/net/InetSocketAddress.html?is-external=true"; title="class or interface in java.net">InetSocketAddress</a> getAddress()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../org/apache/tephra/inmemory/InMemoryTransactionService.html#getAddress()">getAddress</a></code> in class <code><a href="../../../../org/apache/tephra/inmemory/InMemoryTransactionService.html" title="class in org.apache.tephra.inmemory">InMemoryTransactionService</a></code></dd> +</dl> +</li> +</ul> +<a name="doStart()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doStart</h4> +<pre>protected void doStart()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../org/apache/tephra/inmemory/InMemoryTransactionService.html#doStart()">doStart</a></code> in class <code><a href="../../../../org/apache/tephra/inmemory/InMemoryTransactionService.html" title="class in org.apache.tephra.inmemory">InMemoryTransactionService</a></code></dd> +</dl> +</li> +</ul> +<a name="doStop()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doStop</h4> +<pre>protected void doStop()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../org/apache/tephra/inmemory/InMemoryTransactionService.html#doStop()">doStop</a></code> in class <code><a href="../../../../org/apache/tephra/inmemory/InMemoryTransactionService.html" title="class in org.apache.tephra.inmemory">InMemoryTransactionService</a></code></dd> +</dl> +</li> +</ul> +<a name="abort(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>abort</h4> +<pre>protected void abort(<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> +<a name="internalStop()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>internalStop</h4> +<pre>protected void internalStop()</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/TransactionService.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/distributed/TransactionConverterUtils.html" title="class in org.apache.tephra.distributed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/TransactionServiceClient.html" title="class in org.apache.tephra.distributed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/TransactionService.html" target="_top">Frames</a></li> +<li><a href="TransactionService.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><a href="#fields_inherited_from_class_org.apache.tephra.inmemory.InMemoryTransactionService">Field</a> | </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/1047fad6/src/site/resources/apidocs-0.8.0-incubating/org/apache/tephra/distributed/TransactionServiceClient.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.8.0-incubating/org/apache/tephra/distributed/TransactionServiceClient.html b/src/site/resources/apidocs-0.8.0-incubating/org/apache/tephra/distributed/TransactionServiceClient.html new file mode 100644 index 0000000..9b213d4 --- /dev/null +++ b/src/site/resources/apidocs-0.8.0-incubating/org/apache/tephra/distributed/TransactionServiceClient.html @@ -0,0 +1,624 @@ +<!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 Tue Jun 21 15:13:03 PDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TransactionServiceClient (Apache Tephra 0.8.0-incubating API)</title> +<meta name="date" content="2016-06-21"> +<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="TransactionServiceClient (Apache Tephra 0.8.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/TransactionServiceClient.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/distributed/TransactionService.html" title="class in org.apache.tephra.distributed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/TransactionServiceThriftClient.html" title="class in org.apache.tephra.distributed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/TransactionServiceClient.html" target="_top">Frames</a></li> +<li><a href="TransactionServiceClient.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.distributed</div> +<h2 title="Class TransactionServiceClient" class="title">Class TransactionServiceClient</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.distributed.TransactionServiceClient</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">TransactionServiceClient</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> +implements <a href="../../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a></pre> +<div class="block">A tx service client</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/distributed/TransactionServiceClient.html#TransactionServiceClient(org.apache.hadoop.conf.Configuration,%20org.apache.tephra.distributed.ThriftClientProvider)">TransactionServiceClient</a></strong>(org.apache.hadoop.conf.Configuration config, + <a href="../../../../org/apache/tephra/distributed/ThriftClientProvider.html" title="interface in org.apache.tephra.distributed">ThriftClientProvider</a> clientProvider)</code> +<div class="block">Create from a configuration.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="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/distributed/TransactionServiceClient.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> +<div class="block">Makes transaction visible.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/TransactionServiceClient.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> +<div class="block">Checks if transaction with the set of changes can be committed.</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/distributed/TransactionServiceClient.html#checkpoint(org.apache.tephra.Transaction)">checkpoint</a></strong>(<a href="../../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra">Transaction</a> tx)</code> +<div class="block">Performs a checkpoint operation on the current transaction, returning a new Transaction instance with the + updated state.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/TransactionServiceClient.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> +<div class="block">Makes transaction visible.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/TransactionServiceClient.html#doMain(boolean,%20org.apache.hadoop.conf.Configuration)">doMain</a></strong>(boolean verbose, + org.apache.hadoop.conf.Configuration conf)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/TransactionServiceClient.html#getInvalidSize()">getInvalidSize</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/TransactionServiceClient.html#getSnapshotInputStream()">getSnapshotInputStream</a></strong>()</code> +<div class="block">Retrieves the state of the transaction manager and send it as a stream.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/TransactionServiceClient.html#invalidate(long)">invalidate</a></strong>(long tx)</code> +<div class="block">Makes transaction invalid.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/TransactionServiceClient.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> +<div class="block">Utility to be used for basic verification of transaction system availability and functioning</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/TransactionServiceClient.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/distributed/TransactionServiceClient.html#startLong()">startLong</a></strong>()</code> +<div class="block">Starts new 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/distributed/TransactionServiceClient.html#startShort()">startShort</a></strong>()</code> +<div class="block">Starts new short transaction.</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/distributed/TransactionServiceClient.html#startShort(int)">startShort</a></strong>(int timeout)</code> +<div class="block">Starts new short transaction.</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/distributed/TransactionServiceClient.html#status()">status</a></strong>()</code> +<div class="block">Return the status of the transaction Manager</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/tephra/distributed/TransactionServiceClient.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/distributed/TransactionServiceClient.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> +</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="TransactionServiceClient(org.apache.hadoop.conf.Configuration, org.apache.tephra.distributed.ThriftClientProvider)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TransactionServiceClient</h4> +<pre>@Inject +public TransactionServiceClient(org.apache.hadoop.conf.Configuration config, + <a href="../../../../org/apache/tephra/distributed/ThriftClientProvider.html" title="interface in org.apache.tephra.distributed">ThriftClientProvider</a> clientProvider)</pre> +<div class="block">Create from a configuration. This will first attempt to find a zookeeper + for service discovery. Otherwise it will look for the port in the + config and use localhost.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - a configuration containing the zookeeper properties</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="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> +<div class="block">Utility to be used for basic verification of transaction system availability and functioning</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - arguments list, accepts single option "-v" that makes it to print out more details about started tx</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="doMain(boolean, org.apache.hadoop.conf.Configuration)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doMain</h4> +<pre>public static void doMain(boolean verbose, + org.apache.hadoop.conf.Configuration conf) + 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="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"><strong>Description copied from interface: <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#startLong()">TransactionSystemClient</a></code></strong></div> +<div class="block">Starts new long transaction.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#startLong()">startLong</a></code> in interface <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>instance of <a href="../../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra"><code>Transaction</code></a></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"><strong>Description copied from interface: <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#startShort()">TransactionSystemClient</a></code></strong></div> +<div class="block">Starts new short transaction.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#startShort()">startShort</a></code> in interface <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>instance of <a href="../../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra"><code>Transaction</code></a></dd></dl> +</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 timeout)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#startShort(int)">TransactionSystemClient</a></code></strong></div> +<div class="block">Starts new short transaction.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#startShort(int)">startShort</a></code> in interface <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - the timeout for the transaction</dd> +<dt><span class="strong">Returns:</span></dt><dd>instance of <a href="../../../../org/apache/tephra/Transaction.html" title="class in org.apache.tephra"><code>Transaction</code></a></dd></dl> +</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> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#canCommit(org.apache.tephra.Transaction,%20java.util.Collection)">TransactionSystemClient</a></code></strong></div> +<div class="block">Checks if transaction with the set of changes can be committed. E.g. it can check conflicts with other changes and + refuse commit if there are conflicts. It is assumed that no other changes will be done in between this method call + and <a href="../../../../org/apache/tephra/TransactionSystemClient.html#commit(org.apache.tephra.Transaction)"><code>TransactionSystemClient.commit(Transaction)</code></a> which may check conflicts again to avoid races. + <p/> + Since we do conflict detection at commit time as well, this may seem redundant. The idea is to check for conflicts + before we persist changes to avoid rollback in case of conflicts as much as possible. + NOTE: in some situations we may want to skip this step to save on RPC with a risk of many rollback ops. So by + default we take safe path.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#canCommit(org.apache.tephra.Transaction,%20java.util.Collection)">canCommit</a></code> in interface <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>tx</code> - transaction to verify</dd><dd><code>changeIds</code> - ids of changes made by transaction</dd> +<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="../../../../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> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#commit(org.apache.tephra.Transaction)">TransactionSystemClient</a></code></strong></div> +<div class="block">Makes transaction visible. It will again check conflicts of changes submitted previously with + <a href="../../../../org/apache/tephra/TransactionSystemClient.html#canCommit(org.apache.tephra.Transaction,%20java.util.Collection)"><code>TransactionSystemClient.canCommit(Transaction, java.util.Collection)</code></a></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#commit(org.apache.tephra.Transaction)">commit</a></code> in interface <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>tx</code> - transaction to make visible.</dd> +<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="../../../../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> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#abort(org.apache.tephra.Transaction)">TransactionSystemClient</a></code></strong></div> +<div class="block">Makes transaction visible. You should call it only when all changes of this tx are undone. + NOTE: it will not throw <a href="../../../../org/apache/tephra/TransactionNotInProgressException.html" title="class in org.apache.tephra"><code>TransactionNotInProgressException</code></a> if transaction has timed out.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#abort(org.apache.tephra.Transaction)">abort</a></code> in interface <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>tx</code> - transaction to make visible.</dd></dl> +</li> +</ul> +<a name="invalidate(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>invalidate</h4> +<pre>public boolean invalidate(long tx)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#invalidate(long)">TransactionSystemClient</a></code></strong></div> +<div class="block">Makes transaction invalid. You should call it if not all changes of this tx could be undone. + NOTE: it will not throw <a href="../../../../org/apache/tephra/TransactionNotInProgressException.html" title="class in org.apache.tephra"><code>TransactionNotInProgressException</code></a> if transaction has timed out.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#invalidate(long)">invalidate</a></code> in interface <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>tx</code> - transaction id to invalidate.</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if transaction has been successfully invalidated</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> tx) + throws <a href="../../../../org/apache/tephra/TransactionNotInProgressException.html" title="class in org.apache.tephra">TransactionNotInProgressException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#checkpoint(org.apache.tephra.Transaction)">TransactionSystemClient</a></code></strong></div> +<div class="block">Performs a checkpoint operation on the current transaction, returning a new Transaction instance with the + updated state. A checkpoint operation assigns a new write pointer for the current transaction.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#checkpoint(org.apache.tephra.Transaction)">checkpoint</a></code> in interface <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>tx</code> - the current transaction to checkpoint</dd> +<dt><span class="strong">Returns:</span></dt><dd>an updated transaction instance with the new write pointer</dd> +<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="getSnapshotInputStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSnapshotInputStream</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> getSnapshotInputStream() + throws <a href="../../../../org/apache/tephra/TransactionCouldNotTakeSnapshotException.html" title="class in org.apache.tephra">TransactionCouldNotTakeSnapshotException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#getSnapshotInputStream()">TransactionSystemClient</a></code></strong></div> +<div class="block">Retrieves the state of the transaction manager and send it as a stream. The snapshot will not be persisted.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#getSnapshotInputStream()">getSnapshotInputStream</a></code> in interface <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>an input stream containing an encoded snapshot of the transaction manager</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/tephra/TransactionCouldNotTakeSnapshotException.html" title="class in org.apache.tephra">TransactionCouldNotTakeSnapshotException</a></code></dd></dl> +</li> +</ul> +<a name="status()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>status</h4> +<pre>public <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> status()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#status()">TransactionSystemClient</a></code></strong></div> +<div class="block">Return the status of the transaction Manager</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#status()">status</a></code> in interface <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a String which denotes the status of txManager</dd></dl> +</li> +</ul> +<a name="resetState()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resetState</h4> +<pre>public void resetState()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#resetState()">TransactionSystemClient</a></code></strong></div> +<div class="block">Resets the state of the transaction manager.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#resetState()">resetState</a></code> in interface <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a></code></dd> +</dl> +</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"><strong>Description copied from interface: <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#truncateInvalidTx(java.util.Set)">TransactionSystemClient</a></code></strong></div> +<div class="block">Removes the given transaction ids from the invalid list.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#truncateInvalidTx(java.util.Set)">truncateInvalidTx</a></code> in interface <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a></code></dd> +<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"><strong>Description copied from interface: <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#truncateInvalidTxBefore(long)">TransactionSystemClient</a></code></strong></div> +<div class="block">Removes all transaction ids started before the given time from invalid list.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#truncateInvalidTxBefore(long)">truncateInvalidTxBefore</a></code> in interface <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a></code></dd> +<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="getInvalidSize()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getInvalidSize</h4> +<pre>public int getInvalidSize()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/tephra/TransactionSystemClient.html#getInvalidSize()">getInvalidSize</a></code> in interface <code><a href="../../../../org/apache/tephra/TransactionSystemClient.html" title="interface in org.apache.tephra">TransactionSystemClient</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the size of invalid list</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/TransactionServiceClient.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/distributed/TransactionService.html" title="class in org.apache.tephra.distributed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/tephra/distributed/TransactionServiceThriftClient.html" title="class in org.apache.tephra.distributed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/tephra/distributed/TransactionServiceClient.html" target="_top">Frames</a></li> +<li><a href="TransactionServiceClient.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>
