| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Transactional</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/jakarta-favicon.ico"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Transactional"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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="../../jakarta/transaction/Transaction.html" title="interface in jakarta.transaction"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/transaction/Transactional.TxType.html" title="enum in jakarta.transaction"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/transaction/Transactional.html" target="_top">Frames</a></li> |
| <li><a href="Transactional.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>Field | </li> |
| <li>Required | </li> |
| <li><a href="#annotation.type.optional.element.summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</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">jakarta.transaction</div> |
| <h2 title="Annotation Type Transactional" class="title">Annotation Type Transactional</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@Inherited |
| <a href="../../jakarta/interceptor/InterceptorBinding.html" title="annotation in jakarta.interceptor">@InterceptorBinding</a> |
| @Target(value={TYPE,METHOD}) |
| @Retention(value=RUNTIME) |
| public @interface <span class="memberNameLabel">Transactional</span></pre> |
| <div class="block"><p>The jakarta.transaction.Transactional annotation provides the application |
| the ability to declaratively control transaction boundaries on CDI managed beans, as |
| well as classes defined as managed beans by the Jakarta EE specification, at both the class |
| and method level where method level annotations override those at the class level.</p> |
| <p>See the Jakarta Enterprise Beans specification for restrictions on the use of @Transactional with Jakarta Enterprise Beans.</p> |
| <p>This support is provided via an implementation of CDI interceptors that conduct the |
| necessary suspending, resuming, etc. The Transactional interceptor interposes on business method |
| invocations only and not on lifecycle events. Lifecycle methods are invoked in an unspecified |
| transaction context.</p> |
| <p>If an attempt is made to call any method of the UserTransaction interface from within the |
| scope of a bean or method annotated with @Transactional and a Transactional.TxType other than |
| NOT_SUPPORTED or NEVER, an IllegalStateException must be thrown. The use of the UserTransaction |
| is allowed within life cycle events. The use of the TransactionSynchronizationRegistry is allowed |
| regardless of any @Transactional annotation.</p> |
| <p>The Transactional interceptors must have a priority of |
| Interceptor.Priority.PLATFORM_BEFORE+200. |
| Refer to the Interceptors specification for more details.</p> |
| <p>The TxType element of the annotation indicates whether a bean method is to be executed within |
| a transaction context. TxType.REQUIRED is the default. </p> |
| |
| <p>By default checked exceptions do not result in the transactional interceptor marking the |
| transaction for rollback and instances of RuntimeException and its subclasses do. This default |
| behavior can be modified by specifying exceptions that result in the interceptor marking the |
| transaction for rollback and/or exceptions that do not result in rollback.</p> |
| <p>The rollbackOn element can be set to indicate exceptions that must cause the interceptor to mark |
| the transaction for rollback.</p> |
| <p>Conversely, the dontRollbackOn element can be set to indicate |
| exceptions that must not cause the interceptor to mark the transaction for rollback.</p> |
| <p>When a class is specified for either of these elements, the designated behavior applies to subclasses |
| of that class as well. If both elements are specified, dontRollbackOn takes precedence.</p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>JTA 1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.optional.element.summary"> |
| <!-- --> |
| </a> |
| <h3>Optional Element Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> |
| <caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Optional Element and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.Class[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/transaction/Transactional.html#dontRollbackOn--">dontRollbackOn</a></span></code> |
| <div class="block">The dontRollbackOn element can be set to indicate exceptions that must not cause |
| the interceptor to mark the transaction for rollback.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.lang.Class[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/transaction/Transactional.html#rollbackOn--">rollbackOn</a></span></code> |
| <div class="block">The rollbackOn element can be set to indicate exceptions that must cause |
| the interceptor to mark the transaction for rollback.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../jakarta/transaction/Transactional.TxType.html" title="enum in jakarta.transaction">Transactional.TxType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/transaction/Transactional.html#value--">value</a></span></code> |
| <div class="block">The TxType element of the Transactional annotation indicates whether a bean method |
| is to be executed within a transaction context.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.element.detail"> |
| <!-- --> |
| </a> |
| <h3>Element Detail</h3> |
| <a name="value--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>value</h4> |
| <pre>public abstract <a href="../../jakarta/transaction/Transactional.TxType.html" title="enum in jakarta.transaction">Transactional.TxType</a> value</pre> |
| <div class="block">The TxType element of the Transactional annotation indicates whether a bean method |
| is to be executed within a transaction context.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>TxType element</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>jakarta.transaction.Transactional.TxType.REQUIRED</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="rollbackOn--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rollbackOn</h4> |
| <pre>public abstract java.lang.Class[] rollbackOn</pre> |
| <div class="block">The rollbackOn element can be set to indicate exceptions that must cause |
| the interceptor to mark the transaction for rollback. Conversely, the dontRollbackOn |
| element can be set to indicate exceptions that must not cause the interceptor to mark |
| the transaction for rollback. When a class is specified for either of these elements, |
| the designated behavior applies to subclasses of that class as well. If both elements |
| are specified, dontRollbackOn takes precedence.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Class[] of Exceptions</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>{}</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="dontRollbackOn--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>dontRollbackOn</h4> |
| <pre>public abstract java.lang.Class[] dontRollbackOn</pre> |
| <div class="block">The dontRollbackOn element can be set to indicate exceptions that must not cause |
| the interceptor to mark the transaction for rollback. Conversely, the rollbackOn element |
| can be set to indicate exceptions that must cause the interceptor to mark the transaction |
| for rollback. When a class is specified for either of these elements, |
| the designated behavior applies to subclasses of that class as well. If both elements |
| are specified, dontRollbackOn takes precedence.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Class[] of Exceptions</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>{}</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="../../jakarta/transaction/Transaction.html" title="interface in jakarta.transaction"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/transaction/Transactional.TxType.html" title="enum in jakarta.transaction"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/transaction/Transactional.html" target="_top">Frames</a></li> |
| <li><a href="Transactional.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>Field | </li> |
| <li>Required | </li> |
| <li><a href="#annotation.type.optional.element.summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |