Google Git
Sign in
apache / tomee-site-pub / 43cf80e624a0cecf0f38bef5ef2614bfb2410f57 / . / tomee-8.0 / javadoc / org / apache / openejb / core / transaction / TxRequired.html
blob: db5116fcfae1de3d0b98eca526ed8198831bec0c [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>TxRequired</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="TxRequired";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/TxNotSupported.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/TxRequiresNew.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/TxRequired.html" target="_top">Frames</a></li>
<li><a href="TxRequired.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="#fields.inherited.from.class.org.apache.openejb.core.transaction.JtaTransactionPolicy">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>Field&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 TxRequired" class="title">Class TxRequired</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html" title="class in org.apache.openejb.core.transaction">org.apache.openejb.core.transaction.JtaTransactionPolicy</a></li>
<li>
<ul class="inheritance">
<li>org.apache.openejb.core.transaction.TxRequired</li>
</ul>
</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>
<hr>
<br>
<pre>public class <span class="typeNameLabel">TxRequired</span>
extends <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html" title="class in org.apache.openejb.core.transaction">JtaTransactionPolicy</a></pre>
<div class="block">17.6.2.2 Required
The Container must invoke an enterprise Bean method whose transaction
attribute is set to Required with a valid transaction context.
If a client invokes the enterprise Bean's method while the client is
associated with a transaction context, the container invokes the enterprise
Bean's method in the client's transaction context.
If the client invokes the enterprise Bean's method while the client is not
associated with a transaction context, the container automatically starts a
new transaction before delegating a method call to the enterprise Bean
business method. The Container automatically enlists all the resource
managers accessed by the business method with the transaction. If the
business method invokes other enterprise beans, the Container passes the
transaction context with the invocation. The Container attempts to commit the
transaction when the business method has completed. The container performs
the commit protocol before the method result is sent to the client.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.openejb.core.transaction.JtaTransactionPolicy">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.openejb.core.transaction.<a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html" title="class in org.apache.openejb.core.transaction">JtaTransactionPolicy</a></h3>
<code><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#logger">logger</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#transactionManager">transactionManager</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#transactionType">transactionType</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#txLogger">txLogger</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="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/TxRequired.html#TxRequired-TransactionManager-">TxRequired</a></span>(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="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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TxRequired.html#commit--">commit</a></span>()</code>
<div class="block">Commits or rolls back this TransactionPolicy.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>Transaction</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TxRequired.html#getCurrentTransaction--">getCurrentTransaction</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TxRequired.html#isClientTransaction--">isClientTransaction</a></span>()</code>
<div class="block">Is this policy running in an inhreited transaction? Some
TransactionTypes, such as Required or Supported, use the caller's
transaction instead of starting a new transaction.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TxRequired.html#isNewTransaction--">isNewTransaction</a></span>()</code>
<div class="block">Is this a new transaction and not an inhreited transaction or no transaction? Some
TransactionTypes, such as Required or Supported, use the caller's
transaction instead of starting a new transaction.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.openejb.core.transaction.JtaTransactionPolicy">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openejb.core.transaction.<a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html" title="class in org.apache.openejb.core.transaction">JtaTransactionPolicy</a></h3>
<code><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#beginTransaction--">beginTransaction</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#completeTransaction-Transaction-">completeTransaction</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#enlistResource-javax.transaction.xa.XAResource-">enlistResource</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#fireNonTransactionalCompletion--">fireNonTransactionalCompletion</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#getResource-java.lang.Object-">getResource</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#getTransaction--">getTransaction</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#getTransactionType--">getTransactionType</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#isRollbackOnly--">isRollbackOnly</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#isTransactionActive--">isTransactionActive</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#putResource-java.lang.Object-java.lang.Object-">putResource</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#registerSynchronization-org.apache.openejb.core.transaction.TransactionPolicy.TransactionSynchronization-">registerSynchronization</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#removeResource-java.lang.Object-">removeResource</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#resumeTransaction-Transaction-">resumeTransaction</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#rollbackTransaction-Transaction-">rollbackTransaction</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#setRollbackOnly--">setRollbackOnly</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#setRollbackOnly-java.lang.Throwable-">setRollbackOnly</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#setRollbackOnly-Transaction-java.lang.Throwable-">setRollbackOnly</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#suspendTransaction--">suspendTransaction</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="TxRequired-TransactionManager-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TxRequired</h4>
<pre>public&nbsp;TxRequired(TransactionManager&nbsp;transactionManager)
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>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isNewTransaction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNewTransaction</h4>
<pre>public&nbsp;boolean&nbsp;isNewTransaction()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isNewTransaction--">TransactionPolicy</a></code></span></div>
<div class="block">Is this a new transaction and not an inhreited transaction or no transaction? Some
TransactionTypes, such as Required or Supported, use the caller's
transaction instead of starting a new transaction. If there is no active
transaction (e.g., TransactionType is NotSupported), this method will</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this not an inherited transaction</dd>
</dl>
</li>
</ul>
<a name="isClientTransaction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isClientTransaction</h4>
<pre>public&nbsp;boolean&nbsp;isClientTransaction()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isClientTransaction--">TransactionPolicy</a></code></span></div>
<div class="block">Is this policy running in an inhreited transaction? Some
TransactionTypes, such as Required or Supported, use the caller's
transaction instead of starting a new transaction. If there is no active
transaction (e.g., TransactionType is NotSupported), this method will
return false.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this is an inherited transaction</dd>
</dl>
</li>
</ul>
<a name="getCurrentTransaction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentTransaction</h4>
<pre>public&nbsp;Transaction&nbsp;getCurrentTransaction()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#getCurrentTransaction--">getCurrentTransaction</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html" title="class in org.apache.openejb.core.transaction">JtaTransactionPolicy</a></code></dd>
</dl>
</li>
</ul>
<a name="commit--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>commit</h4>
<pre>public&nbsp;void&nbsp;commit()
throws <a href="../../../../../org/apache/openejb/ApplicationException.html" title="class in org.apache.openejb">ApplicationException</a>,
<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#commit--">TransactionPolicy</a></code></span></div>
<div class="block">Commits or rolls back this TransactionPolicy. If there the actual
transaction is completed or there is no actual transaction, the
registered TransactionSynchronization are called. Otherwise, the
registered TransactionSynchronization are called when the actual
transaction is completed.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/ApplicationException.html" title="class in org.apache.openejb">ApplicationException</a></code> - if recoverable exception is encountered</dd>
<dd><code><a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></code> - if an unrecoverable exception is encountered</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<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/TxNotSupported.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/TxRequiresNew.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/TxRequired.html" target="_top">Frames</a></li>
<li><a href="TxRequired.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="#fields.inherited.from.class.org.apache.openejb.core.transaction.JtaTransactionPolicy">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>Field&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>