| <!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_121) on Sun Jul 09 07:41:25 CEST 2017 --> |
| <title>HadoopCheckpointStore</title> |
| <meta name="date" content="2017-07-09"> |
| <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="HadoopCheckpointStore"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":10,"i7":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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../org/apache/gearpump/streaming/hadoop/HadoopCheckpointStoreFactory.html" title="class in org.apache.gearpump.streaming.hadoop"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/gearpump/streaming/hadoop/HadoopCheckpointStore.html" target="_top">Frames</a></li> |
| <li><a href="HadoopCheckpointStore.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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.apache.gearpump.streaming.hadoop</div> |
| <h2 title="Class HadoopCheckpointStore" class="title">Class HadoopCheckpointStore</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.gearpump.streaming.hadoop.HadoopCheckpointStore</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/gearpump/streaming/transaction/api/CheckpointStore.html" title="interface in org.apache.gearpump.streaming.transaction.api">CheckpointStore</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">HadoopCheckpointStore</span> |
| extends java.lang.Object |
| implements <a href="../../../../../org/apache/gearpump/streaming/transaction/api/CheckpointStore.html" title="interface in org.apache.gearpump.streaming.transaction.api">CheckpointStore</a></pre> |
| <div class="block">Stores timestamp-checkpoint mapping to Hadoop-compatible filesystem. |
| <p> |
| Store file layout: |
| <pre><code> |
| timestamp1, index1, |
| timestamp2, index2, |
| ... |
| timestampN, indexN |
| </code></pre></div> |
| </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="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/apache/gearpump/streaming/hadoop/HadoopCheckpointStore.html#HadoopCheckpointStore-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.conf.Configuration-org.apache.gearpump.streaming.hadoop.lib.rotation.Rotation-">HadoopCheckpointStore</a></span>(org.apache.hadoop.fs.Path dir, |
| org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.conf.Configuration hadoopConfig, |
| <a href="../../../../../org/apache/gearpump/streaming/hadoop/lib/rotation/Rotation.html" title="interface in org.apache.gearpump.streaming.hadoop.lib.rotation">Rotation</a> rotation)</code> </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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/hadoop/HadoopCheckpointStore.html#close--">close</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>scala.Option<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/hadoop/HadoopCheckpointStore.html#curFile--">curFile</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/hadoop/HadoopCheckpointStore.html#curStartTime--">curStartTime</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/hadoop/HadoopCheckpointStore.html#curTime--">curTime</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>scala.Option<<a href="../../../../../org/apache/gearpump/streaming/hadoop/lib/HadoopCheckpointStoreWriter.html" title="class in org.apache.gearpump.streaming.hadoop.lib">HadoopCheckpointStoreWriter</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/hadoop/HadoopCheckpointStore.html#curWriter--">curWriter</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static org.slf4j.Logger</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/hadoop/HadoopCheckpointStore.html#LOG--">LOG</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/hadoop/HadoopCheckpointStore.html#persist-long-byte:A-">persist</a></span>(long timestamp, |
| byte[] checkpoint)</code> |
| <div class="block">Persists a pair of timestamp and checkpoint, which:</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>scala.Option<byte[]></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/hadoop/HadoopCheckpointStore.html#recover-long-">recover</a></span>(long timestamp)</code> |
| <div class="block">Recovers checkpoint given timestamp, which</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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="HadoopCheckpointStore-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.conf.Configuration-org.apache.gearpump.streaming.hadoop.lib.rotation.Rotation-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HadoopCheckpointStore</h4> |
| <pre>public HadoopCheckpointStore(org.apache.hadoop.fs.Path dir, |
| org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.conf.Configuration hadoopConfig, |
| <a href="../../../../../org/apache/gearpump/streaming/hadoop/lib/rotation/Rotation.html" title="interface in org.apache.gearpump.streaming.hadoop.lib.rotation">Rotation</a> rotation)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="LOG--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOG</h4> |
| <pre>public static org.slf4j.Logger LOG()</pre> |
| </li> |
| </ul> |
| <a name="curTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>curTime</h4> |
| <pre>public long curTime()</pre> |
| </li> |
| </ul> |
| <a name="curStartTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>curStartTime</h4> |
| <pre>public long curStartTime()</pre> |
| </li> |
| </ul> |
| <a name="curFile--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>curFile</h4> |
| <pre>public scala.Option<java.lang.String> curFile()</pre> |
| </li> |
| </ul> |
| <a name="curWriter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>curWriter</h4> |
| <pre>public scala.Option<<a href="../../../../../org/apache/gearpump/streaming/hadoop/lib/HadoopCheckpointStoreWriter.html" title="class in org.apache.gearpump.streaming.hadoop.lib">HadoopCheckpointStoreWriter</a>> curWriter()</pre> |
| </li> |
| </ul> |
| <a name="persist-long-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>persist</h4> |
| <pre>public void persist(long timestamp, |
| byte[] checkpoint)</pre> |
| <div class="block">Persists a pair of timestamp and checkpoint, which: |
| <p> |
| 1. creates a temporary checkpoint file, checkpoints-\$startTime.store, if not exist |
| 2. writes out (timestamp, checkpoint) and marks rotation |
| 3. rotates checkpoint file if needed |
| a. renames temporary checkpoint file to checkpoints-\$startTime-\$endTime.store |
| b. closes current writer and reset |
| c. rotation rotates</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/gearpump/streaming/transaction/api/CheckpointStore.html#persist-long-byte:A-">persist</a></code> in interface <code><a href="../../../../../org/apache/gearpump/streaming/transaction/api/CheckpointStore.html" title="interface in org.apache.gearpump.streaming.transaction.api">CheckpointStore</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timestamp</code> - (undocumented)</dd> |
| <dd><code>checkpoint</code> - (undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="recover-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>recover</h4> |
| <pre>public scala.Option<byte[]> recover(long timestamp)</pre> |
| <div class="block">Recovers checkpoint given timestamp, which |
| <pre><code> |
| 1. returns None if no store exists |
| 2. searches checkpoint stores for |
| a. complete store checkpoints-\$startTime-\$endTime.store |
| where startTime <= timestamp <= endTime |
| b. temporary store checkpoints-\$startTime.store |
| where startTime <= timestamp |
| 3. renames store to checkpoints-\$startTime-\$endTime.store |
| 4. deletes all stores whose name has a startTime larger than timestamp |
| 5. looks for the checkpoint in the found store |
| </code></pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/gearpump/streaming/transaction/api/CheckpointStore.html#recover-long-">recover</a></code> in interface <code><a href="../../../../../org/apache/gearpump/streaming/transaction/api/CheckpointStore.html" title="interface in org.apache.gearpump.streaming.transaction.api">CheckpointStore</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timestamp</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/gearpump/streaming/transaction/api/CheckpointStore.html#close--">close</a></code> in interface <code><a href="../../../../../org/apache/gearpump/streaming/transaction/api/CheckpointStore.html" title="interface in org.apache.gearpump.streaming.transaction.api">CheckpointStore</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> |
| <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>Prev Class</li> |
| <li><a href="../../../../../org/apache/gearpump/streaming/hadoop/HadoopCheckpointStoreFactory.html" title="class in org.apache.gearpump.streaming.hadoop"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/gearpump/streaming/hadoop/HadoopCheckpointStore.html" target="_top">Frames</a></li> |
| <li><a href="HadoopCheckpointStore.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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 ======= --> |
| </body> |
| </html> |
