<!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_75) on Fri May 13 13:32:17 PDT 2016 -->
<title>CurrentTransaction (Oracle - Berkeley DB Java API)</title>
<meta name="date" content="2016-05-13">
<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CurrentTransaction (Oracle - Berkeley DB Java 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/CurrentTransaction.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 class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.29</font></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="class in com.sleepycat.collections"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/collections/CurrentTransaction.html" target="_top">Frames</a></li>
<li><a href="CurrentTransaction.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.sleepycat.collections</div>
<h2 title="Class CurrentTransaction" class="title">Class CurrentTransaction</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.collections.CurrentTransaction</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">CurrentTransaction</span>
extends java.lang.Object</pre>
<div class="block">Provides access to the current transaction for the current thread within the
context of a Berkeley DB environment. This class provides explicit
transaction control beyond that provided by the <a href="../../../com/sleepycat/collections/TransactionRunner.html" title="class in com.sleepycat.collections"><code>TransactionRunner</code></a>
class. However, both methods of transaction control manage per-thread
transactions.</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="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/CurrentTransaction.html#abortTransaction()">abortTransaction</a></strong>()</code>
<div class="block">Aborts the transaction that is active for the current thread for this
environment and makes the parent transaction (if any) the current
transaction.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/CurrentTransaction.html#beginTransaction(com.sleepycat.db.TransactionConfig)">beginTransaction</a></strong>(<a href="../../../com/sleepycat/db/TransactionConfig.html" title="class in com.sleepycat.db">TransactionConfig</a> config)</code>
<div class="block">Begins a new transaction for this environment and associates it with
the current thread.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/CurrentTransaction.html#commitTransaction()">commitTransaction</a></strong>()</code>
<div class="block">Commits the transaction that is active for the current thread for this
environment and makes the parent transaction (if any) the current
transaction.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db">Environment</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/CurrentTransaction.html#getEnvironment()">getEnvironment</a></strong>()</code>
<div class="block">Returns the underlying Berkeley DB environment.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../com/sleepycat/collections/CurrentTransaction.html" title="class in com.sleepycat.collections">CurrentTransaction</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/CurrentTransaction.html#getInstance(com.sleepycat.db.Environment)">getInstance</a></strong>(<a href="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db">Environment</a> env)</code>
<div class="block">Gets the CurrentTransaction accessor for a specified Berkeley DB
environment.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/collections/CurrentTransaction.html#getTransaction()">getTransaction</a></strong>()</code>
<div class="block">Returns the transaction associated with the current thread for this
environment, or null if no transaction is active.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInstance(com.sleepycat.db.Environment)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre>public static <a href="../../../com/sleepycat/collections/CurrentTransaction.html" title="class in com.sleepycat.collections">CurrentTransaction</a> getInstance(<a href="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db">Environment</a> env)</pre>
<div class="block">Gets the CurrentTransaction accessor for a specified Berkeley DB
environment. This method always returns the same reference when called
more than once with the same environment parameter.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>env</code> - is an open Berkeley DB environment.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the CurrentTransaction accessor for the given environment, or
null if the environment is not transactional.</dd></dl>
</li>
</ul>
<a name="getEnvironment()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnvironment</h4>
<pre>public final <a href="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db">Environment</a> getEnvironment()</pre>
<div class="block">Returns the underlying Berkeley DB environment.</div>
</li>
</ul>
<a name="getTransaction()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransaction</h4>
<pre>public final <a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> getTransaction()</pre>
<div class="block">Returns the transaction associated with the current thread for this
environment, or null if no transaction is active.</div>
</li>
</ul>
<a name="beginTransaction(com.sleepycat.db.TransactionConfig)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beginTransaction</h4>
<pre>public final <a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> beginTransaction(<a href="../../../com/sleepycat/db/TransactionConfig.html" title="class in com.sleepycat.db">TransactionConfig</a> config)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Begins a new transaction for this environment and associates it with
the current thread. If a transaction is already active for this
environment and thread, a nested transaction will be created.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - the transaction configuration used for calling
<a href="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction,%20com.sleepycat.db.TransactionConfig)"><code>Environment.beginTransaction(com.sleepycat.db.Transaction, com.sleepycat.db.TransactionConfig)</code></a>, or null to use the default
configuration.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the new transaction.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if the transaction cannot be started, in which
case any existing transaction is not affected.</dd>
<dd><code>java.lang.IllegalStateException</code> - if a transaction is already active and
nested transactions are not supported by the environment.</dd></dl>
</li>
</ul>
<a name="commitTransaction()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commitTransaction</h4>
<pre>public final <a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> commitTransaction()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a>,
java.lang.IllegalStateException</pre>
<div class="block">Commits the transaction that is active for the current thread for this
environment and makes the parent transaction (if any) the current
transaction.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the parent transaction or null if the committed transaction was
not nested.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if an error occurs committing the transaction.
The transaction will still be closed and the parent transaction will
become the current transaction.</dd>
<dd><code>java.lang.IllegalStateException</code> - if no transaction is active for the
current thread for this environment.</dd></dl>
</li>
</ul>
<a name="abortTransaction()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>abortTransaction</h4>
<pre>public final <a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> abortTransaction()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a>,
java.lang.IllegalStateException</pre>
<div class="block">Aborts the transaction that is active for the current thread for this
environment and makes the parent transaction (if any) the current
transaction.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the parent transaction or null if the aborted transaction was
not nested.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if an error occurs aborting the transaction.
The transaction will still be closed and the parent transaction will
become the current transaction.</dd>
<dd><code>java.lang.IllegalStateException</code> - if no transaction is active for the
current thread for this environment.</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/CurrentTransaction.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 class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.29</font></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../com/sleepycat/collections/MapEntryParameter.html" title="class in com.sleepycat.collections"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/collections/CurrentTransaction.html" target="_top">Frames</a></li>
<li><a href="CurrentTransaction.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><font size=1>Copyright (c) 1996, 2016 Oracle and/or its affiliates. All rights reserved.</font></small></p>
</body>
</html>
