1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_25) on Tue Dec 03 13:53:40 PST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Transaction (Carbonado 1.2.3 API)</title>
<meta name="date" content="2013-12-03">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Transaction (Carbonado 1.2.3 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Transaction.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/amazon/carbonado/Transaction.html" target="_top">Frames</a></li>
<li><a href="Transaction.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.amazon.carbonado</div>
<h2 title="Interface Transaction" class="title">Interface Transaction</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn">TransactionPair</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Transaction</span></pre>
<div class="block">Transactions define atomic operations which can be committed or aborted as a
unit. Transactions are entered by calling <a href="../../../com/amazon/carbonado/Repository.html#enterTransaction()"><code>Repository.enterTransaction()</code></a>.
Transactions are thread-local, and so no special action needs to be taken to
bind operations to them. Cursors which are opened in the scope of a
transaction are automatically closed when the transaction is committed or
aborted.
<p>Transactions do not exit when they are committed. The transaction is
still valid after a commit, but new operations are grouped into a separate
atomic unit. The exit method <em>must</em> be invoked on every
transaction. The following pattern is recommended:
<pre>
Transaction txn = repository.enterTransaction();
try {
// Make updates to storage layer
...
// Commit the changes up to this point
txn.commit();
// Optionally make more updates
...
// Commit remaining changes
txn.commit();
} finally {
// Ensure transaction exits, aborting uncommitted changes if an exception was thrown
txn.exit();
}
</pre>
<p>Transactions may be nested. Calling commit or abort on an outer
transaction will recursively apply the same operation to all inner
transactions as well. All Cursors contained within are also closed.
<p>Transaction instances are mutable, but they are thread-safe.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Brian S O'Neill</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Transaction.html#attach()">attach</a></strong>()</code>
<div class="block">Attaches this transaction to the current thread, if it has been
detached.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Transaction.html#commit()">commit</a></strong>()</code>
<div class="block">If currently in a transaction, commits all changes to the storage layer
since the last commit within the transaction.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Transaction.html#detach()">detach</a></strong>()</code>
<div class="block">Detaches this transaction from the current thread.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Transaction.html#exit()">exit</a></strong>()</code>
<div class="block">Closes the current transaction, aborting all changes since the last
commit.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Transaction.html#getIsolationLevel()">getIsolationLevel</a></strong>()</code>
<div class="block">Returns the isolation level of this transaction.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Transaction.html#isForUpdate()">isForUpdate</a></strong>()</code>
<div class="block">Returns true if this transaction is in update mode, which is adjusted by
calling <a href="../../../com/amazon/carbonado/Transaction.html#setForUpdate(boolean)"><code>setForUpdate(boolean)</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Transaction.html#preCommit()">preCommit</a></strong>()</code>
<div class="block">Calling this method commits all nested child transactions, closes all
scoped cursors, and locks out some interactions from other threads.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Transaction.html#setDesiredLockTimeout(int, java.util.concurrent.TimeUnit)">setDesiredLockTimeout</a></strong>(int timeout,
java.util.concurrent.TimeUnit unit)</code>
<div class="block">Specify a desired timeout for aquiring locks within this
transaction.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Transaction.html#setForUpdate(boolean)">setForUpdate</a></strong>(boolean forUpdate)</code>
<div class="block">Set to true to force all read operations within this transaction to
acquire upgradable or write locks.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="commit()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commit</h4>
<pre>void commit()
throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre>
<div class="block">If currently in a transaction, commits all changes to the storage layer
since the last commit within the transaction.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl>
</li>
</ul>
<a name="exit()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exit</h4>
<pre>void exit()
throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre>
<div class="block">Closes the current transaction, aborting all changes since the last
commit.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl>
</li>
</ul>
<a name="setForUpdate(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setForUpdate</h4>
<pre>void setForUpdate(boolean forUpdate)</pre>
<div class="block">Set to true to force all read operations within this transaction to
acquire upgradable or write locks. This option eliminates deadlocks that
may occur when updating records, except it may increase contention.</div>
</li>
</ul>
<a name="isForUpdate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isForUpdate</h4>
<pre>boolean isForUpdate()</pre>
<div class="block">Returns true if this transaction is in update mode, which is adjusted by
calling <a href="../../../com/amazon/carbonado/Transaction.html#setForUpdate(boolean)"><code>setForUpdate(boolean)</code></a>.</div>
</li>
</ul>
<a name="setDesiredLockTimeout(int, java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDesiredLockTimeout</h4>
<pre>void setDesiredLockTimeout(int timeout,
java.util.concurrent.TimeUnit unit)</pre>
<div class="block">Specify a desired timeout for aquiring locks within this
transaction. Calling this method may have have no effect at all, if the
repository does not support this feature. In addition, the lock timeout
might not be alterable if the transaction contains uncommitted data.
<p>Also, the range of lock timeout values supported might be small. For
example, only a timeout value of zero might be supported. In that case,
the transaction is configured to not wait at all when trying to acquire
locks. Expect immediate timeout exceptions when locks cannot be
granted.
<p>Nested transactions inherit the desired lock timeout of their
parent. Top transactions always begin with the default lock timeout.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - Desired lock timeout. If negative, revert lock timeout to
default value.</dd><dd><code>unit</code> - Time unit for timeout. If null, revert lock timeout to
default value.</dd></dl>
</li>
</ul>
<a name="getIsolationLevel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIsolationLevel</h4>
<pre><a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> getIsolationLevel()</pre>
<div class="block">Returns the isolation level of this transaction.</div>
</li>
</ul>
<a name="detach()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>detach</h4>
<pre>void detach()</pre>
<div class="block">Detaches this transaction from the current thread. It can be attached
later, and to any thread which currently has no thread-local
transaction.
<p>Detaching a transaction also detaches any parent and nested child
transactions. Attaching any of them achieves the same result as
attaching this transaction.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if transaction is attached to a different
thread</dd><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="attach()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>attach</h4>
<pre>void attach()</pre>
<div class="block">Attaches this transaction to the current thread, if it has been
detached. Attaching a transaction also attaches any parent and nested
child transactions.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if current thread has a different
transaction already attached</dd><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="preCommit()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>preCommit</h4>
<pre>boolean preCommit()
throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre>
<div class="block">Calling this method commits all nested child transactions, closes all
scoped cursors, and locks out some interactions from other threads. The
commit method must still be called to finish the commit. Most applications
have no use for pre-commit and should only ever call commit.
<p>The intent of this method is to complete as many operations as
possible leading up to the actual commit. If pre-commit succeeds, then
commit will most likely succeed as well. While in a pre-commit state, the
transaction can still be used by the current thread. Calling pre-commit
again ensures that child transactions and cursors are closed.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>false if transaction has exited</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Transaction.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/amazon/carbonado/Transaction.html" target="_top">Frames</a></li>
<li><a href="Transaction.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
</body>
</html>
|
