Google Git
Sign in
apache / tomee-site-pub / 43cf80e624a0cecf0f38bef5ef2614bfb2410f57 / . / tomee-9.0 / javadoc / org / apache / openejb / core / transaction / JtaTransactionPolicy.html
blob: e2d97eb35c92e88c4f051e5f4842eeb5dc3bef93 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>JtaTransactionPolicy</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JtaTransactionPolicy";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":6,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="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/openejb/core/transaction/EjbUserTransaction.html" title="class in org.apache.openejb.core.transaction"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicyFactory.html" title="class in org.apache.openejb.core.transaction"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openejb/core/transaction/JtaTransactionPolicy.html" target="_top">Frames</a></li>
<li><a href="JtaTransactionPolicy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.openejb.core.transaction</div>
<h2 title="Class JtaTransactionPolicy" class="title">Class JtaTransactionPolicy</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.openejb.core.transaction.JtaTransactionPolicy</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/openejb/core/transaction/TxBeanManaged.html" title="class in org.apache.openejb.core.transaction">TxBeanManaged</a>, <a href="../../../../../org/apache/openejb/core/transaction/TxMandatory.html" title="class in org.apache.openejb.core.transaction">TxMandatory</a>, <a href="../../../../../org/apache/openejb/core/transaction/TxNever.html" title="class in org.apache.openejb.core.transaction">TxNever</a>, <a href="../../../../../org/apache/openejb/core/transaction/TxNotSupported.html" title="class in org.apache.openejb.core.transaction">TxNotSupported</a>, <a href="../../../../../org/apache/openejb/core/transaction/TxRequired.html" title="class in org.apache.openejb.core.transaction">TxRequired</a>, <a href="../../../../../org/apache/openejb/core/transaction/TxRequiresNew.html" title="class in org.apache.openejb.core.transaction">TxRequiresNew</a>, <a href="../../../../../org/apache/openejb/core/transaction/TxSupports.html" title="class in org.apache.openejb.core.transaction">TxSupports</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">JtaTransactionPolicy</span>
extends java.lang.Object
implements <a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</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.org.apache.openejb.core.transaction.TransactionPolicy">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.openejb.core.transaction.<a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></h3>
<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.TransactionSynchronization.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy.TransactionSynchronization</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static <a href="../../../../../org/apache/openejb/util/Logger.html" title="class in org.apache.openejb.util">Logger</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#logger">logger</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected TransactionManager</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#transactionManager">transactionManager</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/openejb/core/transaction/TransactionType.html" title="enum in org.apache.openejb.core.transaction">TransactionType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#transactionType">transactionType</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static <a href="../../../../../org/apache/openejb/util/Logger.html" title="class in org.apache.openejb.util">Logger</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#txLogger">txLogger</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#JtaTransactionPolicy-org.apache.openejb.core.transaction.TransactionType-TransactionManager-">JtaTransactionPolicy</a></span>(<a href="../../../../../org/apache/openejb/core/transaction/TransactionType.html" title="enum in org.apache.openejb.core.transaction">TransactionType</a>&nbsp;transactionType,
TransactionManager&nbsp;transactionManager)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected Transaction</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#beginTransaction--">beginTransaction</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#completeTransaction-Transaction-">completeTransaction</a></span>(Transaction&nbsp;tx)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#enlistResource-javax.transaction.xa.XAResource-">enlistResource</a></span>(javax.transaction.xa.XAResource&nbsp;xaResource)</code>
<div class="block">Enlists a XAResource in the actual active transaction.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#fireNonTransactionalCompletion--">fireNonTransactionalCompletion</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract Transaction</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#getCurrentTransaction--">getCurrentTransaction</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#getResource-java.lang.Object-">getResource</a></span>(java.lang.Object&nbsp;key)</code>
<div class="block">Gets a resource associated with the specified key.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected Transaction</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#getTransaction--">getTransaction</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openejb/core/transaction/TransactionType.html" title="enum in org.apache.openejb.core.transaction">TransactionType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#getTransactionType--">getTransactionType</a></span>()</code>
<div class="block">Gets the TransactionType for this policy.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#isRollbackOnly--">isRollbackOnly</a></span>()</code>
<div class="block">If true, this TransactionPolicy will ultimately end with rollback.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#isTransactionActive--">isTransactionActive</a></span>()</code>
<div class="block">Is there a actual transaction active?</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#putResource-java.lang.Object-java.lang.Object-">putResource</a></span>(java.lang.Object&nbsp;key,
java.lang.Object&nbsp;value)</code>
<div class="block">Associates the specified resource with the specified key.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#registerSynchronization-org.apache.openejb.core.transaction.TransactionPolicy.TransactionSynchronization-">registerSynchronization</a></span>(<a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.TransactionSynchronization.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy.TransactionSynchronization</a>&nbsp;synchronization)</code>
<div class="block">Registers a listener for transaction synchronization events.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#removeResource-java.lang.Object-">removeResource</a></span>(java.lang.Object&nbsp;key)</code>
<div class="block">Removes and returns the resource associated with the specified key.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#resumeTransaction-Transaction-">resumeTransaction</a></span>(Transaction&nbsp;tx)</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#rollbackTransaction-Transaction-">rollbackTransaction</a></span>(Transaction&nbsp;tx)</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#setRollbackOnly--">setRollbackOnly</a></span>()</code>
<div class="block">Sets this TransactionPolicy to rollback when completed</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#setRollbackOnly-java.lang.Throwable-">setRollbackOnly</a></span>(java.lang.Throwable&nbsp;reason)</code>
<div class="block">Sets this TransactionPolicy to rollback when completed</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#setRollbackOnly-Transaction-java.lang.Throwable-">setRollbackOnly</a></span>(Transaction&nbsp;tx,
java.lang.Throwable&nbsp;reason)</code>&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>protected Transaction</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#suspendTransaction--">suspendTransaction</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.openejb.core.transaction.TransactionPolicy">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openejb.core.transaction.<a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></h3>
<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#commit--">commit</a>, <a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isClientTransaction--">isClientTransaction</a>, <a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isNewTransaction--">isNewTransaction</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="logger">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logger</h4>
<pre>protected static final&nbsp;<a href="../../../../../org/apache/openejb/util/Logger.html" title="class in org.apache.openejb.util">Logger</a> logger</pre>
</li>
</ul>
<a name="txLogger">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>txLogger</h4>
<pre>protected static final&nbsp;<a href="../../../../../org/apache/openejb/util/Logger.html" title="class in org.apache.openejb.util">Logger</a> txLogger</pre>
</li>
</ul>
<a name="transactionType">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transactionType</h4>
<pre>protected final&nbsp;<a href="../../../../../org/apache/openejb/core/transaction/TransactionType.html" title="enum in org.apache.openejb.core.transaction">TransactionType</a> transactionType</pre>
</li>
</ul>
<a name="transactionManager">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>transactionManager</h4>
<pre>protected final&nbsp;TransactionManager transactionManager</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JtaTransactionPolicy-org.apache.openejb.core.transaction.TransactionType-TransactionManager-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JtaTransactionPolicy</h4>
<pre>public&nbsp;JtaTransactionPolicy(<a href="../../../../../org/apache/openejb/core/transaction/TransactionType.html" title="enum in org.apache.openejb.core.transaction">TransactionType</a>&nbsp;transactionType,
TransactionManager&nbsp;transactionManager)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getTransactionType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransactionType</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/openejb/core/transaction/TransactionType.html" title="enum in org.apache.openejb.core.transaction">TransactionType</a>&nbsp;getTransactionType()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#getTransactionType--">TransactionPolicy</a></code></span></div>
<div class="block">Gets the TransactionType for this policy.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#getTransactionType--">getTransactionType</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the TransactionType for this policy</dd>
</dl>
</li>
</ul>
<a name="getCurrentTransaction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentTransaction</h4>
<pre>public abstract&nbsp;Transaction&nbsp;getCurrentTransaction()</pre>
</li>
</ul>
<a name="isTransactionActive--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTransactionActive</h4>
<pre>public&nbsp;boolean&nbsp;isTransactionActive()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isTransactionActive--">TransactionPolicy</a></code></span></div>
<div class="block">Is there a actual transaction active?</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isTransactionActive--">isTransactionActive</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if there is an actual transaction active</dd>
</dl>
</li>
</ul>
<a name="isRollbackOnly--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRollbackOnly</h4>
<pre>public&nbsp;boolean&nbsp;isRollbackOnly()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isRollbackOnly--">TransactionPolicy</a></code></span></div>
<div class="block">If true, this TransactionPolicy will ultimately end with rollback.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isRollbackOnly--">isRollbackOnly</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this TransactionPolicy will ultimately end with rollback</dd>
</dl>
</li>
</ul>
<a name="setRollbackOnly--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRollbackOnly</h4>
<pre>public&nbsp;void&nbsp;setRollbackOnly()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#setRollbackOnly--">TransactionPolicy</a></code></span></div>
<div class="block">Sets this TransactionPolicy to rollback when completed</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#setRollbackOnly--">setRollbackOnly</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></code></dd>
</dl>
</li>
</ul>
<a name="setRollbackOnly-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRollbackOnly</h4>
<pre>public&nbsp;void&nbsp;setRollbackOnly(java.lang.Throwable&nbsp;reason)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#setRollbackOnly-java.lang.Throwable-">TransactionPolicy</a></code></span></div>
<div class="block">Sets this TransactionPolicy to rollback when completed</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#setRollbackOnly-java.lang.Throwable-">setRollbackOnly</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></code></dd>
</dl>
</li>
</ul>
<a name="getResource-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResource</h4>
<pre>public&nbsp;java.lang.Object&nbsp;getResource(java.lang.Object&nbsp;key)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#getResource-java.lang.Object-">TransactionPolicy</a></code></span></div>
<div class="block">Gets a resource associated with the specified key. If there is an actual
transaction active, the resource associated with the transaction is
returned; otherwise the resource is scoped to this TransactionPolicy.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#getResource-java.lang.Object-">getResource</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the resource key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the resource or null if no resource was associated with the key</dd>
</dl>
</li>
</ul>
<a name="putResource-java.lang.Object-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putResource</h4>
<pre>public&nbsp;void&nbsp;putResource(java.lang.Object&nbsp;key,
java.lang.Object&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#putResource-java.lang.Object-java.lang.Object-">TransactionPolicy</a></code></span></div>
<div class="block">Associates the specified resource with the specified key. If there is an
actual transaction active, the resource associated with the transaction
is set; otherwise the resource is scoped to this TransactionPolicy.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#putResource-java.lang.Object-java.lang.Object-">putResource</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the resource key</dd>
<dd><code>value</code> - the resource</dd>
</dl>
</li>
</ul>
<a name="removeResource-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeResource</h4>
<pre>public&nbsp;java.lang.Object&nbsp;removeResource(java.lang.Object&nbsp;key)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#removeResource-java.lang.Object-">TransactionPolicy</a></code></span></div>
<div class="block">Removes and returns the resource associated with the specified key. If
there is an actual transaction active, the resource associated with the
transaction is returned; otherwise the resource is scoped to this
TransactionPolicy.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#removeResource-java.lang.Object-">removeResource</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the resource key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the resource previously associated with the key</dd>
</dl>
</li>
</ul>
<a name="registerSynchronization-org.apache.openejb.core.transaction.TransactionPolicy.TransactionSynchronization-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerSynchronization</h4>
<pre>public&nbsp;void&nbsp;registerSynchronization(<a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.TransactionSynchronization.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy.TransactionSynchronization</a>&nbsp;synchronization)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#registerSynchronization-org.apache.openejb.core.transaction.TransactionPolicy.TransactionSynchronization-">TransactionPolicy</a></code></span></div>
<div class="block">Registers a listener for transaction synchronization events. If there is
an actual transaction active, the events are fired when the acutal
transaction is commited; otherwise the events are fired when this
TransactionPolicy completes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#registerSynchronization-org.apache.openejb.core.transaction.TransactionPolicy.TransactionSynchronization-">registerSynchronization</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>synchronization</code> - the transaction synchronization listener</dd>
</dl>
</li>
</ul>
<a name="fireNonTransactionalCompletion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fireNonTransactionalCompletion</h4>
<pre>protected&nbsp;void&nbsp;fireNonTransactionalCompletion()</pre>
</li>
</ul>
<a name="enlistResource-javax.transaction.xa.XAResource-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enlistResource</h4>
<pre>public&nbsp;void&nbsp;enlistResource(javax.transaction.xa.XAResource&nbsp;xaResource)
throws <a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#enlistResource-javax.transaction.xa.XAResource-">TransactionPolicy</a></code></span></div>
<div class="block">Enlists a XAResource in the actual active transaction. This only works
if the TransactionPolicy is associated with an actual transaction and the
TransactionPolicy supports XAResouce enlistment.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#enlistResource-javax.transaction.xa.XAResource-">enlistResource</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>xaResource</code> - the XAResource to enlist</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></code> - if the xaResource could not be enlisted in the
transaction</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="getTransaction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransaction</h4>
<pre>protected&nbsp;Transaction&nbsp;getTransaction()
throws <a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></code></dd>
</dl>
</li>
</ul>
<a name="setRollbackOnly-Transaction-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRollbackOnly</h4>
<pre>protected&nbsp;void&nbsp;setRollbackOnly(Transaction&nbsp;tx,
java.lang.Throwable&nbsp;reason)</pre>
</li>
</ul>
<a name="beginTransaction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beginTransaction</h4>
<pre>protected&nbsp;Transaction&nbsp;beginTransaction()
throws <a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></code></dd>
</dl>
</li>
</ul>
<a name="suspendTransaction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>suspendTransaction</h4>
<pre>protected&nbsp;Transaction&nbsp;suspendTransaction()
throws <a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></code></dd>
</dl>
</li>
</ul>
<a name="resumeTransaction-Transaction-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resumeTransaction</h4>
<pre>protected&nbsp;void&nbsp;resumeTransaction(Transaction&nbsp;tx)
throws <a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></code></dd>
</dl>
</li>
</ul>
<a name="completeTransaction-Transaction-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>completeTransaction</h4>
<pre>protected&nbsp;void&nbsp;completeTransaction(Transaction&nbsp;tx)
throws <a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a>,
<a href="../../../../../org/apache/openejb/ApplicationException.html" title="class in org.apache.openejb">ApplicationException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></code></dd>
<dd><code><a href="../../../../../org/apache/openejb/ApplicationException.html" title="class in org.apache.openejb">ApplicationException</a></code></dd>
</dl>
</li>
</ul>
<a name="rollbackTransaction-Transaction-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>rollbackTransaction</h4>
<pre>protected&nbsp;void&nbsp;rollbackTransaction(Transaction&nbsp;tx)
throws <a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="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/openejb/core/transaction/EjbUserTransaction.html" title="class in org.apache.openejb.core.transaction"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicyFactory.html" title="class in org.apache.openejb.core.transaction"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openejb/core/transaction/JtaTransactionPolicy.html" target="_top">Frames</a></li>
<li><a href="JtaTransactionPolicy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>