summaryrefslogtreecommitdiff
path: root/apidocs/com/amazon/carbonado/spi/BelatedRepositoryCreator.html
blob: 4849f11e659a7113995b5b980229ed0ff74c267d (plain)
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
<!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:42 PST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>BelatedRepositoryCreator (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="BelatedRepositoryCreator (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/BelatedRepositoryCreator.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/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/amazon/carbonado/spi/BelatedRepositoryCreator.html" target="_top">Frames</a></li>
<li><a href="BelatedRepositoryCreator.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.amazon.carbonado.spi</div>
<h2 title="Class BelatedRepositoryCreator" class="title">Class BelatedRepositoryCreator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">com.amazon.carbonado.util.BelatedCreator</a>&lt;<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>&gt;</li>
<li>
<ul class="inheritance">
<li>com.amazon.carbonado.spi.BelatedRepositoryCreator</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">BelatedRepositoryCreator</span>
extends <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a>&lt;<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>&gt;</pre>
<div class="block">Generic one-shot Repository builder which supports late object creation. If
 the Repository building results in an exception or is taking too long, the
 Repository produced instead is a bogus one. Many operations result in an
 IllegalStateException. After retrying, if the real Repository is created,
 then the bogus Repository turns into a wrapper to the real Repository.</div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Brian S O'Neill</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi"><code>BelatedStorageCreator</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#BelatedRepositoryCreator(org.apache.commons.logging.Log, com.amazon.carbonado.RepositoryBuilder, java.util.concurrent.atomic.AtomicReference, int)">BelatedRepositoryCreator</a></strong>(org.apache.commons.logging.Log&nbsp;log,
                        <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a>&nbsp;builder,
                        java.util.concurrent.atomic.AtomicReference&lt;<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>&gt;&nbsp;rootRef,
                        int&nbsp;minRetryDelayMillis)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#BelatedRepositoryCreator(org.apache.commons.logging.Log, com.amazon.carbonado.RepositoryBuilder, int)">BelatedRepositoryCreator</a></strong>(org.apache.commons.logging.Log&nbsp;log,
                        <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a>&nbsp;builder,
                        int&nbsp;minRetryDelayMillis)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</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>protected <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#createBogus()">createBogus</a></strong>()</code>
<div class="block">Create instance of bogus object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#createReal()">createReal</a></strong>()</code>
<div class="block">Create instance of real object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#timedOutNotification(long)">timedOutNotification</a></strong>(long&nbsp;timedOutMillis)</code>
<div class="block">Notification that createReal is taking too long.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.util.BelatedCreator">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a></h3>
<code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createdNotification(T)">createdNotification</a>, <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#get(int)">get</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="BelatedRepositoryCreator(org.apache.commons.logging.Log, com.amazon.carbonado.RepositoryBuilder, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BelatedRepositoryCreator</h4>
<pre>public&nbsp;BelatedRepositoryCreator(org.apache.commons.logging.Log&nbsp;log,
                        <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a>&nbsp;builder,
                        int&nbsp;minRetryDelayMillis)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>log</code> - error reporting log</dd><dd><code>builder</code> - builds real Repository</dd><dd><code>minRetryDelayMillis</code> - minimum milliseconds to wait before retrying
 to create object after failure; if negative, never retry</dd></dl>
</li>
</ul>
<a name="BelatedRepositoryCreator(org.apache.commons.logging.Log, com.amazon.carbonado.RepositoryBuilder, java.util.concurrent.atomic.AtomicReference, int)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BelatedRepositoryCreator</h4>
<pre>public&nbsp;BelatedRepositoryCreator(org.apache.commons.logging.Log&nbsp;log,
                        <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a>&nbsp;builder,
                        java.util.concurrent.atomic.AtomicReference&lt;<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>&gt;&nbsp;rootRef,
                        int&nbsp;minRetryDelayMillis)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>log</code> - error reporting log</dd><dd><code>builder</code> - builds real Repository</dd><dd><code>rootRef</code> - reference to root repository</dd><dd><code>minRetryDelayMillis</code> - minimum milliseconds to wait before retrying
 to create object after failure; if negative, never retry</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="createReal()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createReal</h4>
<pre>protected&nbsp;<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>&nbsp;createReal()
                         throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createReal()">BelatedCreator</a></code></strong></div>
<div class="block">Create instance of real object. If there is a recoverable error creating
 the object, return null. Any error logging must be performed by the
 implementation of this method. If null is returned, expect this method
 to be called again in the future.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createReal()">createReal</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a>&lt;<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>&gt;</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>real object, or null if there was a recoverable error</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code></dd></dl>
</li>
</ul>
<a name="createBogus()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createBogus</h4>
<pre>protected&nbsp;<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>&nbsp;createBogus()</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createBogus()">BelatedCreator</a></code></strong></div>
<div class="block">Create instance of bogus object.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createBogus()">createBogus</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a>&lt;<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="timedOutNotification(long)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>timedOutNotification</h4>
<pre>protected&nbsp;void&nbsp;timedOutNotification(long&nbsp;timedOutMillis)</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#timedOutNotification(long)">BelatedCreator</a></code></strong></div>
<div class="block">Notification that createReal is taking too long. This can be used to log
 a message.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#timedOutNotification(long)">timedOutNotification</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a>&lt;<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>&gt;</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>timedOutMillis</code> - milliseconds waited before giving up</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/BelatedRepositoryCreator.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/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/amazon/carbonado/spi/BelatedRepositoryCreator.html" target="_top">Frames</a></li>
<li><a href="BelatedRepositoryCreator.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
</body>
</html>