| <!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 (1.8.0_252) on Fri Jul 16 09:39:10 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>JTATransactionController (EclipseLink 3.0.2, API Reference)</title> |
| <meta name="date" content="2021-07-16"> |
| <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="JTATransactionController (EclipseLink 3.0.2, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":9,"i19":10,"i20":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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 class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/transaction/JTASynchronizationListener.html" title="class in org.eclipse.persistence.transaction"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/transaction/SynchronizationListenerFactory.html" title="interface in org.eclipse.persistence.transaction"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/transaction/JTATransactionController.html" target="_top">Frames</a></li> |
| <li><a href="JTATransactionController.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="#field.summary">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><a href="#field.detail">Field</a> | </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.eclipse.persistence.transaction</div> |
| <h2 title="Class JTATransactionController" class="title">Class JTATransactionController</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction">org.eclipse.persistence.transaction.AbstractTransactionController</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.persistence.transaction.JTATransactionController</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/eclipse/persistence/sessions/ExternalTransactionController.html" title="interface in org.eclipse.persistence.sessions">ExternalTransactionController</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/eclipse/persistence/transaction/glassfish/GlassfishTransactionController.html" title="class in org.eclipse.persistence.transaction.glassfish">GlassfishTransactionController</a>, <a href="../../../../org/eclipse/persistence/transaction/jboss/JBossTransactionController.html" title="class in org.eclipse.persistence.transaction.jboss">JBossTransactionController</a>, <a href="../../../../org/eclipse/persistence/transaction/jotm/JotmTransactionController.html" title="class in org.eclipse.persistence.transaction.jotm">JotmTransactionController</a>, <a href="../../../../org/eclipse/persistence/transaction/JTA11TransactionController.html" title="class in org.eclipse.persistence.transaction">JTA11TransactionController</a>, <a href="../../../../org/eclipse/persistence/transaction/oc4j/Oc4jTransactionController.html" title="class in org.eclipse.persistence.transaction.oc4j">Oc4jTransactionController</a>, <a href="../../../../org/eclipse/persistence/transaction/sap/SAPNetWeaverTransactionController.html" title="class in org.eclipse.persistence.transaction.sap">SAPNetWeaverTransactionController</a>, <a href="../../../../org/eclipse/persistence/transaction/wls/WebLogicTransactionController.html" title="class in org.eclipse.persistence.transaction.wls">WebLogicTransactionController</a>, <a href="../../../../org/eclipse/persistence/transaction/was/WebSphereTransactionController.html" title="class in org.eclipse.persistence.transaction.was">WebSphereTransactionController</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">JTATransactionController</span> |
| extends <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction">AbstractTransactionController</a></pre> |
| <div class="block"><p> |
| <b>Purpose</b>: TransactionController implementation for JTA 1.0 |
| <p> |
| <b>Description</b>: Implements the required behavior for controlling JTA 1.0 |
| transactions. Specific JTA implementations may need to extend this class |
| when special controller behavior is necessary. |
| <p> |
| The JTA TransactionManager must be obtained and set on the |
| instance in order for a Synchronization listener to be registered against |
| the transaction. This can be done either by extending this class and defining |
| acquireTransactionManager() to return the manager for the server, or by using |
| this class and explicitly calling the setTransactionManager() method on it |
| after the fact. |
| e.g. |
| TransactionManager mgr = controller.jndiLookup("java:comp/TransactionManager"); |
| controller.setTransactionManager(mgr); |
| <p> |
| If a different listener needs to be used for synchronization, the |
| SynchronizationListenerFactory should be set on the controller instance. |
| The listener subclass should implement the factory interface, so that |
| setting the factory is simply a matter of assigning an instance of the |
| listener. |
| e.g. |
| controller.setSynchronizationListenerFactory( |
| new DifferentServerSynchronizationListener()); |
| |
| The default listener factory creates instances of JTATransactionListener.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/transaction/JTASynchronizationListener.html" title="class in org.eclipse.persistence.transaction"><code>JTASynchronizationListener</code></a>, |
| <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction"><code>AbstractTransactionController</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== 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"> </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 jakarta.transaction.TransactionManager</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#defaultTransactionManager">defaultTransactionManager</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected jakarta.transaction.TransactionManager</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#transactionManager">transactionManager</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.transaction.AbstractTransactionController"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.persistence.transaction.<a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction">AbstractTransactionController</a></h3> |
| <code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#activeUnitOfWorkThreadLocal">activeUnitOfWorkThreadLocal</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#currentlyProcessedListeners">currentlyProcessedListeners</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#exceptionHandler">exceptionHandler</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#listenerFactory">listenerFactory</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#numSessionsRequiringSequencingCallback">numSessionsRequiringSequencingCallback</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#sequencingListeners">sequencingListeners</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#session">session</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#unitsOfWork">unitsOfWork</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"> </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/eclipse/persistence/transaction/JTATransactionController.html#JTATransactionController--">JTATransactionController</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return a new controller for use with a JTA 1.0 compliant TransactionManager.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#JTATransactionController-jakarta.transaction.TransactionManager-">JTATransactionController</a></span>(jakarta.transaction.TransactionManager transactionManager)</code> |
| <div class="block">PUBLIC: |
| Return a new controller for use with a JTA 1.0 compliant TransactionManager.</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="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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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 jakarta.transaction.TransactionManager</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#acquireTransactionManager--">acquireTransactionManager</a></span>()</code> |
| <div class="block">INTERNAL: |
| Obtain and return the JTA TransactionManager on this platform.</div> |
| </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/eclipse/persistence/transaction/JTATransactionController.html#beginTransaction_impl--">beginTransaction_impl</a></span>()</code> |
| <div class="block">INTERNAL: |
| Begin an external transaction.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#canBeginTransaction_impl-java.lang.Object-">canBeginTransaction_impl</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> status)</code> |
| <div class="block">INTERNAL: |
| Return true if the status indicates that a transaction can be started.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#canCommitTransaction_impl-java.lang.Object-">canCommitTransaction_impl</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> status)</code> |
| <div class="block">INTERNAL: |
| Return true if the status indicates that a transaction can be committed.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#canIssueSQLToDatabase_impl-java.lang.Object-">canIssueSQLToDatabase_impl</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> status)</code> |
| <div class="block">INTERNAL: |
| Return true if the status indicates that the SQL should be issued to the db.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#canMergeUnitOfWork_impl-java.lang.Object-">canMergeUnitOfWork_impl</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> status)</code> |
| <div class="block">INTERNAL: |
| Return true if the status indicates that the unit of work should be merged |
| into the shared cache.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#canRollbackTransaction_impl-java.lang.Object-">canRollbackTransaction_impl</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> status)</code> |
| <div class="block">INTERNAL: |
| Return true if the status indicates that a transaction can be rolled back.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#commitTransaction_impl--">commitTransaction_impl</a></span>()</code> |
| <div class="block">INTERNAL: |
| Commit the external transaction.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static jakarta.transaction.TransactionManager</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#getDefaultTransactionManager--">getDefaultTransactionManager</a></span>()</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#getIntStatus-java.lang.Object-">getIntStatus</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> status)</code> |
| <div class="block">INTERNAL: |
| Convenience method to return the int value of the transaction status.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#getTransaction_impl--">getTransaction_impl</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return the active external transaction, or null if none is currently |
| active for this thread.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#getTransactionKey_impl-java.lang.Object-">getTransactionKey_impl</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> transaction)</code> |
| <div class="block">INTERNAL: |
| Return a key for the specified external transaction object.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>jakarta.transaction.TransactionManager</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#getTransactionManager--">getTransactionManager</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the transaction manager used to control the JTA transactions.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#getTransactionStatus_impl--">getTransactionStatus_impl</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return the transaction status as an object.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#isRolledBack_impl-java.lang.Object-">isRolledBack_impl</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> status)</code> |
| <div class="block">INTERNAL: |
| Return true if the transaction is rolled back.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#markTransactionForRollback_impl--">markTransactionForRollback_impl</a></span>()</code> |
| <div class="block">INTERNAL: |
| Mark the external transaction for rollback.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#registerSynchronization_impl-org.eclipse.persistence.transaction.AbstractSynchronizationListener-java.lang.Object-">registerSynchronization_impl</a></span>(<a href="../../../../org/eclipse/persistence/transaction/AbstractSynchronizationListener.html" title="class in org.eclipse.persistence.transaction">AbstractSynchronizationListener</a> listener, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> txn)</code> |
| <div class="block">INTERNAL: |
| Register the specified synchronization listener with the given active |
| transaction.</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/eclipse/persistence/transaction/JTATransactionController.html#rollbackTransaction_impl--">rollbackTransaction_impl</a></span>()</code> |
| <div class="block">INTERNAL: |
| Roll back the external transaction.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#setDefaultTransactionManager-jakarta.transaction.TransactionManager-">setDefaultTransactionManager</a></span>(jakarta.transaction.TransactionManager defaultTransactionManager)</code> |
| <div class="block">PUBLIC: |
| Set the JTA transaction manager to be used.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#setTransactionManager-jakarta.transaction.TransactionManager-">setTransactionManager</a></span>(jakarta.transaction.TransactionManager mgr)</code> |
| <div class="block">PUBLIC: |
| Set the transaction manager used to control the JTA transactions.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/transaction/JTATransactionController.html#statusToString_impl-java.lang.Object-">statusToString_impl</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> status)</code> |
| <div class="block">INTERNAL: |
| Convert the status to a string for tracing.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.transaction.AbstractTransactionController"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.persistence.transaction.<a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction">AbstractTransactionController</a></h3> |
| <code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#addUnitOfWork-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">addUnitOfWork</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#beginTransaction-org.eclipse.persistence.internal.sessions.AbstractSession-">beginTransaction</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#bindToCurrentTransaction-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-org.eclipse.persistence.internal.sessions.AbstractSession-">bindToCurrentTransaction</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#clearSequencingListeners--">clearSequencingListeners</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#commitTransaction-org.eclipse.persistence.internal.sessions.AbstractSession-">commitTransaction</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#getActiveSequencingCallback-org.eclipse.persistence.sessions.DatabaseSession-org.eclipse.persistence.internal.sequencing.SequencingCallbackFactory-">getActiveSequencingCallback</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#getActiveUnitOfWork--">getActiveUnitOfWork</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#getExceptionHandler--">getExceptionHandler</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#getListenerFactory--">getListenerFactory</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#getSession--">getSession</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#getTransaction--">getTransaction</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#getTransactionKey-java.lang.Object-">getTransactionKey</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#getTransactionStatus--">getTransactionStatus</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#getUnitsOfWork--">getUnitsOfWork</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#hasActiveUnitOfWork--">hasActiveUnitOfWork</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#initializeSequencingListeners--">initializeSequencingListeners</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#isSequencingCallbackRequired--">isSequencingCallbackRequired</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#jndiLookup-java.lang.String-">jndiLookup</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#logTxStateTrace-org.eclipse.persistence.internal.sessions.AbstractSession-java.lang.String-java.lang.Object-">logTxStateTrace</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#logTxTrace-org.eclipse.persistence.internal.sessions.AbstractSession-java.lang.String-java.lang.Object:A-">logTxTrace</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#lookupActiveUnitOfWork--">lookupActiveUnitOfWork</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#lookupActiveUnitOfWork-java.lang.Object-">lookupActiveUnitOfWork</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#markTransactionForRollback--">markTransactionForRollback</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#noTransactionOrRolledBackOrCommited--">noTransactionOrRolledBackOrCommited</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#numSessionsRequiringSequencingCallback--">numSessionsRequiringSequencingCallback</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#registerSynchronizationListener-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-org.eclipse.persistence.internal.sessions.AbstractSession-">registerSynchronizationListener</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#removeSequencingListener-java.lang.Object-">removeSequencingListener</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#removeUnitOfWork-java.lang.Object-">removeUnitOfWork</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#rollbackTransaction-org.eclipse.persistence.internal.sessions.AbstractSession-">rollbackTransaction</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#setExceptionHandler-org.eclipse.persistence.exceptions.ExceptionHandler-">setExceptionHandler</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#setListenerFactory-org.eclipse.persistence.transaction.SynchronizationListenerFactory-">setListenerFactory</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#setSession-org.eclipse.persistence.internal.sessions.AbstractSession-">setSession</a>, <a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#setUnitsOfWork-java.util.concurrent.ConcurrentMap-">setUnitsOfWork</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" 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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="defaultTransactionManager"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defaultTransactionManager</h4> |
| <pre>protected static jakarta.transaction.TransactionManager defaultTransactionManager</pre> |
| </li> |
| </ul> |
| <a name="transactionManager"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>transactionManager</h4> |
| <pre>protected jakarta.transaction.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="JTATransactionController--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JTATransactionController</h4> |
| <pre>public JTATransactionController()</pre> |
| <div class="block">PUBLIC: |
| Return a new controller for use with a JTA 1.0 compliant TransactionManager.</div> |
| </li> |
| </ul> |
| <a name="JTATransactionController-jakarta.transaction.TransactionManager-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JTATransactionController</h4> |
| <pre>public JTATransactionController(jakarta.transaction.TransactionManager transactionManager)</pre> |
| <div class="block">PUBLIC: |
| Return a new controller for use with a JTA 1.0 compliant TransactionManager.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="registerSynchronization_impl-org.eclipse.persistence.transaction.AbstractSynchronizationListener-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerSynchronization_impl</h4> |
| <pre>protected void registerSynchronization_impl(<a href="../../../../org/eclipse/persistence/transaction/AbstractSynchronizationListener.html" title="class in org.eclipse.persistence.transaction">AbstractSynchronizationListener</a> listener, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> txn) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">INTERNAL: |
| Register the specified synchronization listener with the given active |
| transaction.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#registerSynchronization_impl-org.eclipse.persistence.transaction.AbstractSynchronizationListener-java.lang.Object-">registerSynchronization_impl</a></code> in class <code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction">AbstractTransactionController</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - The synchronization listener created for this transaction</dd> |
| <dd><code>txn</code> - The active transaction for which notification is being requested</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/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="getTransaction_impl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransaction_impl</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getTransaction_impl() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">INTERNAL: |
| Return the active external transaction, or null if none is currently |
| active for this thread.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#getTransaction_impl--">getTransaction_impl</a></code> in class <code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction">AbstractTransactionController</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The active transaction object or id, or null if no transaction is active</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/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="getTransactionKey_impl-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransactionKey_impl</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getTransactionKey_impl(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> transaction) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">INTERNAL: |
| Return a key for the specified external transaction object. |
| The key is just something that can be inserted into a hashtable (must support |
| hashCode() and equals() methods).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#getTransactionKey_impl-java.lang.Object-">getTransactionKey_impl</a></code> in class <code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction">AbstractTransactionController</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>transaction</code> - The transaction to which the returned key applies (may be null)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A key for the passed in transaction, or null if no transaction specified</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/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="getTransactionStatus_impl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransactionStatus_impl</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getTransactionStatus_impl() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">INTERNAL: |
| Return the transaction status as an object. We will pass around Integers that |
| wrap the int JTA status values.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#getTransactionStatus_impl--">getTransactionStatus_impl</a></code> in class <code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction">AbstractTransactionController</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The current transaction status</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/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="beginTransaction_impl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beginTransaction_impl</h4> |
| <pre>protected void beginTransaction_impl() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">INTERNAL: |
| Begin an external transaction.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#beginTransaction_impl--">beginTransaction_impl</a></code> in class <code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction">AbstractTransactionController</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/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="commitTransaction_impl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commitTransaction_impl</h4> |
| <pre>protected void commitTransaction_impl() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">INTERNAL: |
| Commit the external transaction.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#commitTransaction_impl--">commitTransaction_impl</a></code> in class <code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction">AbstractTransactionController</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/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="rollbackTransaction_impl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rollbackTransaction_impl</h4> |
| <pre>protected void rollbackTransaction_impl() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">INTERNAL: |
| Roll back the external transaction.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#rollbackTransaction_impl--">rollbackTransaction_impl</a></code> in class <code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction">AbstractTransactionController</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/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="markTransactionForRollback_impl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>markTransactionForRollback_impl</h4> |
| <pre>protected void markTransactionForRollback_impl() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">INTERNAL: |
| Mark the external transaction for rollback.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#markTransactionForRollback_impl--">markTransactionForRollback_impl</a></code> in class <code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction">AbstractTransactionController</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/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="canBeginTransaction_impl-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canBeginTransaction_impl</h4> |
| <pre>protected boolean canBeginTransaction_impl(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> status)</pre> |
| <div class="block">INTERNAL: |
| Return true if the status indicates that a transaction can be started. This |
| would normally mean that no transaction is currently active.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#canBeginTransaction_impl-java.lang.Object-">canBeginTransaction_impl</a></code> in class <code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction">AbstractTransactionController</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>status</code> - The current transaction status</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the current state allows for a transaction to be started</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="canCommitTransaction_impl-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canCommitTransaction_impl</h4> |
| <pre>protected boolean canCommitTransaction_impl(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> status)</pre> |
| <div class="block">INTERNAL: |
| Return true if the status indicates that a transaction can be committed. This |
| would normally mean that a transaction is currently active.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#canCommitTransaction_impl-java.lang.Object-">canCommitTransaction_impl</a></code> in class <code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction">AbstractTransactionController</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>status</code> - The current transaction status</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the current state allows for a transaction to be committed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="canRollbackTransaction_impl-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canRollbackTransaction_impl</h4> |
| <pre>protected boolean canRollbackTransaction_impl(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> status)</pre> |
| <div class="block">INTERNAL: |
| Return true if the status indicates that a transaction can be rolled back. This |
| would normally mean that a transaction is currently active.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#canRollbackTransaction_impl-java.lang.Object-">canRollbackTransaction_impl</a></code> in class <code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction">AbstractTransactionController</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>status</code> - The current transaction status</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the current state allows for a transaction to be rolled back</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="canIssueSQLToDatabase_impl-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canIssueSQLToDatabase_impl</h4> |
| <pre>protected boolean canIssueSQLToDatabase_impl(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> status)</pre> |
| <div class="block">INTERNAL: |
| Return true if the status indicates that the SQL should be issued to the db. |
| This would normally mean that a transaction was active.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#canIssueSQLToDatabase_impl-java.lang.Object-">canIssueSQLToDatabase_impl</a></code> in class <code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction">AbstractTransactionController</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>status</code> - The current transaction status</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the current state allows for the SQL to be sent to the database</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="canMergeUnitOfWork_impl-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canMergeUnitOfWork_impl</h4> |
| <pre>protected boolean canMergeUnitOfWork_impl(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> status)</pre> |
| <div class="block">INTERNAL: |
| Return true if the status indicates that the unit of work should be merged |
| into the shared cache. This would normally mean that the transaction was |
| committed successfully.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#canMergeUnitOfWork_impl-java.lang.Object-">canMergeUnitOfWork_impl</a></code> in class <code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction">AbstractTransactionController</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>status</code> - The current transaction status</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the current state dictates that the unit of work should be merged</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isRolledBack_impl-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRolledBack_impl</h4> |
| <pre>public boolean isRolledBack_impl(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> status)</pre> |
| <div class="block">INTERNAL: |
| Return true if the transaction is rolled back.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#isRolledBack_impl-java.lang.Object-">isRolledBack_impl</a></code> in class <code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction">AbstractTransactionController</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="acquireTransactionManager--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>acquireTransactionManager</h4> |
| <pre>protected jakarta.transaction.TransactionManager acquireTransactionManager() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">INTERNAL: |
| Obtain and return the JTA TransactionManager on this platform. |
| By default try java:comp JNDI lookup. |
| |
| This method can be can be overridden by subclasses to obtain the |
| transaction manager by whatever means is appropriate to the server. |
| This method is invoked by the constructor to initialize the transaction |
| manager at instance-creation time. Alternatively the transaction manager |
| can be set directly on the controller instance using the |
| setTransactionManager() method after the instance has been created.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The TransactionManager for the transaction system</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/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="getIntStatus-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIntStatus</h4> |
| <pre>protected int getIntStatus(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> status)</pre> |
| <div class="block">INTERNAL: |
| Convenience method to return the int value of the transaction status. |
| Assumes that the status object is an Integer.</div> |
| </li> |
| </ul> |
| <a name="getTransactionManager--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransactionManager</h4> |
| <pre>public jakarta.transaction.TransactionManager getTransactionManager()</pre> |
| <div class="block">PUBLIC: |
| Return the transaction manager used to control the JTA transactions.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The JTA TransactionManager that is used to obtain transaction |
| state information and control the active transaction.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTransactionManager-jakarta.transaction.TransactionManager-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTransactionManager</h4> |
| <pre>public void setTransactionManager(jakarta.transaction.TransactionManager mgr)</pre> |
| <div class="block">PUBLIC: |
| Set the transaction manager used to control the JTA transactions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mgr</code> - A valid JTA TransactionManager that can be |
| accessed by this controller to obtain transaction state information and |
| control the active transaction.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="statusToString_impl-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>statusToString_impl</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> statusToString_impl(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> status)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#statusToString_impl-java.lang.Object-">AbstractTransactionController</a></code></span></div> |
| <div class="block">INTERNAL: |
| Convert the status to a string for tracing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html#statusToString_impl-java.lang.Object-">statusToString_impl</a></code> in class <code><a href="../../../../org/eclipse/persistence/transaction/AbstractTransactionController.html" title="class in org.eclipse.persistence.transaction">AbstractTransactionController</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefaultTransactionManager--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultTransactionManager</h4> |
| <pre>public static jakarta.transaction.TransactionManager getDefaultTransactionManager()</pre> |
| </li> |
| </ul> |
| <a name="setDefaultTransactionManager-jakarta.transaction.TransactionManager-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setDefaultTransactionManager</h4> |
| <pre>public static void setDefaultTransactionManager(jakarta.transaction.TransactionManager defaultTransactionManager)</pre> |
| <div class="block">PUBLIC: |
| Set the JTA transaction manager to be used. |
| This can be called directly before login to configure JTA integration manually, or using Spring injection.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <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 class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/transaction/JTASynchronizationListener.html" title="class in org.eclipse.persistence.transaction"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/transaction/SynchronizationListenerFactory.html" title="interface in org.eclipse.persistence.transaction"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/transaction/JTATransactionController.html" target="_top">Frames</a></li> |
| <li><a href="JTATransactionController.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="#field.summary">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><a href="#field.detail">Field</a> | </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 © 2007–2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
