bookkeeperProgrammer.html 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <head>
  4. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  5. <meta content="Apache Forrest" name="Generator">
  6. <meta name="Forrest-version" content="0.8">
  7. <meta name="Forrest-skin-name" content="pelt">
  8. <title>BookKeeper Getting Started Guide</title>
  9. <link type="text/css" href="skin/basic.css" rel="stylesheet">
  10. <link media="screen" type="text/css" href="skin/screen.css" rel="stylesheet">
  11. <link media="print" type="text/css" href="skin/print.css" rel="stylesheet">
  12. <link type="text/css" href="skin/profile.css" rel="stylesheet">
  13. <script src="skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="skin/fontsize.js" language="javascript" type="text/javascript"></script>
  14. <link rel="shortcut icon" href="images/favicon.ico">
  15. </head>
  16. <body onload="init()">
  17. <script type="text/javascript">ndeSetTextSize();</script>
  18. <div id="top">
  19. <!--+
  20. |breadtrail
  21. +-->
  22. <div class="breadtrail">
  23. <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://hadoop.apache.org/">Hadoop</a> &gt; <a href="http://hadoop.apache.org/zookeeper/">ZooKeeper</a><script src="skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
  24. </div>
  25. <!--+
  26. |header
  27. +-->
  28. <div class="header">
  29. <!--+
  30. |start group logo
  31. +-->
  32. <div class="grouplogo">
  33. <a href="http://hadoop.apache.org/"><img class="logoImage" alt="Hadoop" src="images/hadoop-logo.jpg" title="Apache Hadoop"></a>
  34. </div>
  35. <!--+
  36. |end group logo
  37. +-->
  38. <!--+
  39. |start Project Logo
  40. +-->
  41. <div class="projectlogo">
  42. <a href="http://hadoop.apache.org/zookeeper/"><img class="logoImage" alt="ZooKeeper" src="images/zookeeper_small.gif" title="ZooKeeper: distributed coordination"></a>
  43. </div>
  44. <!--+
  45. |end Project Logo
  46. +-->
  47. <!--+
  48. |start Search
  49. +-->
  50. <div class="searchbox">
  51. <form action="http://www.google.com/search" method="get" class="roundtopsmall">
  52. <input value="hadoop.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google">&nbsp;
  53. <input name="Search" value="Search" type="submit">
  54. </form>
  55. </div>
  56. <!--+
  57. |end search
  58. +-->
  59. <!--+
  60. |start Tabs
  61. +-->
  62. <ul id="tabs">
  63. <li>
  64. <a class="unselected" href="http://hadoop.apache.org/zookeeper/">Project</a>
  65. </li>
  66. <li>
  67. <a class="unselected" href="http://wiki.apache.org/hadoop/ZooKeeper">Wiki</a>
  68. </li>
  69. <li class="current">
  70. <a class="selected" href="index.html">ZooKeeper 3.3 Documentation</a>
  71. </li>
  72. </ul>
  73. <!--+
  74. |end Tabs
  75. +-->
  76. </div>
  77. </div>
  78. <div id="main">
  79. <div id="publishedStrip">
  80. <!--+
  81. |start Subtabs
  82. +-->
  83. <div id="level2tabs"></div>
  84. <!--+
  85. |end Endtabs
  86. +-->
  87. <script type="text/javascript"><!--
  88. document.write("Last Published: " + document.lastModified);
  89. // --></script>
  90. </div>
  91. <!--+
  92. |breadtrail
  93. +-->
  94. <div class="breadtrail">
  95. &nbsp;
  96. </div>
  97. <!--+
  98. |start Menu, mainarea
  99. +-->
  100. <!--+
  101. |start Menu
  102. +-->
  103. <div id="menu">
  104. <div onclick="SwitchMenu('menu_1.1', 'skin/')" id="menu_1.1Title" class="menutitle">Overview</div>
  105. <div id="menu_1.1" class="menuitemgroup">
  106. <div class="menuitem">
  107. <a href="index.html">Welcome</a>
  108. </div>
  109. <div class="menuitem">
  110. <a href="zookeeperOver.html">Overview</a>
  111. </div>
  112. <div class="menuitem">
  113. <a href="zookeeperStarted.html">Getting Started</a>
  114. </div>
  115. <div class="menuitem">
  116. <a href="releasenotes.html">Release Notes</a>
  117. </div>
  118. </div>
  119. <div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Developer</div>
  120. <div id="menu_1.2" class="menuitemgroup">
  121. <div class="menuitem">
  122. <a href="api/index.html">API Docs</a>
  123. </div>
  124. <div class="menuitem">
  125. <a href="zookeeperProgrammers.html">Programmer's Guide</a>
  126. </div>
  127. <div class="menuitem">
  128. <a href="javaExample.html">Java Example</a>
  129. </div>
  130. <div class="menuitem">
  131. <a href="zookeeperTutorial.html">Barrier and Queue Tutorial</a>
  132. </div>
  133. <div class="menuitem">
  134. <a href="recipes.html">Recipes</a>
  135. </div>
  136. </div>
  137. <div onclick="SwitchMenu('menu_selected_1.3', 'skin/')" id="menu_selected_1.3Title" class="menutitle" style="background-image: url('skin/images/chapter_open.gif');">BookKeeper</div>
  138. <div id="menu_selected_1.3" class="selectedmenuitemgroup" style="display: block;">
  139. <div class="menuitem">
  140. <a href="bookkeeperStarted.html">Getting started</a>
  141. </div>
  142. <div class="menuitem">
  143. <a href="bookkeeperOverview.html">Overview</a>
  144. </div>
  145. <div class="menuitem">
  146. <a href="bookkeeperConfig.html">Setup guide</a>
  147. </div>
  148. <div class="menupage">
  149. <div class="menupagetitle">Programmer's guide</div>
  150. </div>
  151. </div>
  152. <div onclick="SwitchMenu('menu_1.4', 'skin/')" id="menu_1.4Title" class="menutitle">Admin &amp; Ops</div>
  153. <div id="menu_1.4" class="menuitemgroup">
  154. <div class="menuitem">
  155. <a href="zookeeperAdmin.html">Administrator's Guide</a>
  156. </div>
  157. <div class="menuitem">
  158. <a href="zookeeperQuotas.html">Quota Guide</a>
  159. </div>
  160. <div class="menuitem">
  161. <a href="zookeeperJMX.html">JMX</a>
  162. </div>
  163. </div>
  164. <div onclick="SwitchMenu('menu_1.5', 'skin/')" id="menu_1.5Title" class="menutitle">Contributor</div>
  165. <div id="menu_1.5" class="menuitemgroup">
  166. <div class="menuitem">
  167. <a href="zookeeperInternals.html">ZooKeeper Internals</a>
  168. </div>
  169. </div>
  170. <div onclick="SwitchMenu('menu_1.6', 'skin/')" id="menu_1.6Title" class="menutitle">Miscellaneous</div>
  171. <div id="menu_1.6" class="menuitemgroup">
  172. <div class="menuitem">
  173. <a href="http://wiki.apache.org/hadoop/ZooKeeper">Wiki</a>
  174. </div>
  175. <div class="menuitem">
  176. <a href="http://wiki.apache.org/hadoop/ZooKeeper/FAQ">FAQ</a>
  177. </div>
  178. <div class="menuitem">
  179. <a href="http://hadoop.apache.org/zookeeper/mailing_lists.html">Mailing Lists</a>
  180. </div>
  181. </div>
  182. <div id="credit"></div>
  183. <div id="roundbottom">
  184. <img style="display: none" class="corner" height="15" width="15" alt="" src="skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
  185. <!--+
  186. |alternative credits
  187. +-->
  188. <div id="credit2"></div>
  189. </div>
  190. <!--+
  191. |end Menu
  192. +-->
  193. <!--+
  194. |start content
  195. +-->
  196. <div id="content">
  197. <div title="Portable Document Format" class="pdflink">
  198. <a class="dida" href="bookkeeperProgrammer.pdf"><img alt="PDF -icon" src="skin/images/pdfdoc.gif" class="skin"><br>
  199. PDF</a>
  200. </div>
  201. <h1>BookKeeper Getting Started Guide</h1>
  202. <div id="minitoc-area">
  203. <ul class="minitoc">
  204. <li>
  205. <a href="#bk_GettingStarted">Programming with BookKeeper</a>
  206. <ul class="minitoc">
  207. <li>
  208. <a href="#bk_instance"> Instantiating BookKeeper.</a>
  209. </li>
  210. <li>
  211. <a href="#bk_createLedger"> Creating a ledger. </a>
  212. </li>
  213. <li>
  214. <a href="#bk_writeLedger"> Adding entries to a ledger. </a>
  215. </li>
  216. <li>
  217. <a href="#bk_closeLedger"> Closing a ledger. </a>
  218. </li>
  219. <li>
  220. <a href="#bk_openLedger"> Opening a ledger. </a>
  221. </li>
  222. <li>
  223. <a href="#bk_readLedger"> Reading from ledger </a>
  224. </li>
  225. </ul>
  226. </li>
  227. </ul>
  228. </div>
  229. <a name="N10009"></a><a name="bk_GettingStarted"></a>
  230. <h2 class="h3">Programming with BookKeeper</h2>
  231. <div class="section">
  232. <ul>
  233. <li>
  234. <p>
  235. <a href="#bk_instance"> Instantiating BookKeeper.</a>
  236. </p>
  237. </li>
  238. <li>
  239. <p>
  240. <a href="#bk_createLedger"> Creating a ledger. </a>
  241. </p>
  242. </li>
  243. <li>
  244. <p>
  245. <a href="#bk_writeLedger"> Adding entries to a ledger. </a>
  246. </p>
  247. </li>
  248. <li>
  249. <p>
  250. <a href="#bk_closeLedger"> Closing a ledger. </a>
  251. </p>
  252. </li>
  253. <li>
  254. <p>
  255. <a href="#bk_openLedger"> Opening a ledger. </a>
  256. </p>
  257. </li>
  258. <li>
  259. <p>
  260. <a href="#bk_readLedger"> Reading from ledger </a>
  261. </p>
  262. </li>
  263. </ul>
  264. <a name="N10042"></a><a name="bk_instance"></a>
  265. <h3 class="h4"> Instantiating BookKeeper.</h3>
  266. <p>
  267. The first step to use BookKeeper is to instantiate a BookKeeper object:
  268. </p>
  269. <p>
  270. <span class="codefrag computeroutput">
  271. org.apache.bookkeeper.BookKeeper
  272. </span>
  273. </p>
  274. <p>
  275. There is one BookKeeper constructor:
  276. </p>
  277. <p>
  278. <span class="codefrag computeroutput">
  279. public BookKeeper(String servers)
  280. throws KeeperException, IOException
  281. </span>
  282. </p>
  283. <p>
  284. where <span class="codefrag computeroutput">servers</span> is a comma-separated list of ZooKeeper servers.
  285. </p>
  286. <a name="N10064"></a><a name="bk_createLedger"></a>
  287. <h3 class="h4"> Creating a ledger. </h3>
  288. <p> Before writing entries to BookKeeper, it is necessary to create a ledger.
  289. With the current BookKeeper API, it is possible to create a ledger both synchronously
  290. or asynchronously. The following methods belong
  291. to <span class="codefrag computeroutput">org.apache.bookkeeper.client.BookKeeper</span>.
  292. </p>
  293. <p>
  294. <strong>Synchronous call:</strong>
  295. </p>
  296. <p>
  297. <span class="codefrag computeroutput">
  298. public LedgerHandle createLedger(int ensSize, int qSize, QMode mode, byte passwd[])
  299. throws KeeperException, InterruptedException,
  300. IOException, BKException
  301. </span>
  302. </p>
  303. <p>
  304. where:
  305. </p>
  306. <ul>
  307. <li>
  308. <p>
  309. <span class="codefrag computeroutput">ensSize</span> is the number of bookies (ensemble size);
  310. </p>
  311. </li>
  312. <li>
  313. <p>
  314. <span class="codefrag computeroutput">qSize</span> is the write quorum size;
  315. </p>
  316. </li>
  317. <li>
  318. <p>
  319. <span class="codefrag computeroutput">mode</span> is the ledger mode (QMode.GENERIC, QMode.VERIFIABLE).
  320. If <span class="codefrag computeroutput">mode</span> is QMode.GENERIC, then <span class="codefrag computeroutput">ensSize</span> has to
  321. be at least <em>3t+1</em>, and <span class="codefrag computeroutput">qSize</span> has to be <em>2t+1</em>.
  322. <em>t</em> is the maximum number of tolerated bookie failures.
  323. </p>
  324. </li>
  325. <li>
  326. <p>
  327. <span class="codefrag computeroutput">passwd</span> is a password that authorizes the client to write to the
  328. ledger being created.
  329. </p>
  330. </li>
  331. </ul>
  332. <p>
  333. All further operations on a ledger are invoked through the <span class="codefrag computeroutput">LedgerHandle</span>
  334. object returned.
  335. </p>
  336. <p>
  337. As a convenience, we provide a <span class="codefrag computeroutput">createLedger</span> with default parameters (3,2,VERIFIABLE),
  338. and the only input parameter it requires is a password.
  339. </p>
  340. <p>
  341. <strong>Asynchronous call:</strong>
  342. </p>
  343. <p>
  344. <span class="codefrag computeroutput">
  345. public void asyncCreateLedger(int ensSize,
  346. int qSize,
  347. QMode mode,
  348. byte passwd[],
  349. CreateCallback cb,
  350. Object ctx
  351. )
  352. throws KeeperException, InterruptedException,
  353. IOException, BKException
  354. </span>
  355. </p>
  356. <p>
  357. The parameters are the same of the synchronous version, with the
  358. exception of <span class="codefrag computeroutput">cb</span> and <span class="codefrag computeroutput">ctx</span>. <span class="codefrag computeroutput">CreateCallback</span>
  359. is an interface in <span class="codefrag computeroutput">org.apache.bookkeeper.client.AsyncCallback</span>, and
  360. a class implementing it has to implement a method called <span class="codefrag computeroutput">createComplete</span>
  361. that has the following signature:
  362. </p>
  363. <p>
  364. <span class="codefrag computeroutput">
  365. void createComplete(int rc, LedgerHandle lh, Object ctx);
  366. </span>
  367. </p>
  368. <p>
  369. where:
  370. </p>
  371. <ul>
  372. <li>
  373. <p>
  374. <span class="codefrag computeroutput">rc</span> is a return code (please refer to <span class="codefrag computeroutput">org.apache.bookeeper.client.BKDefs</span> for a list);
  375. </p>
  376. </li>
  377. <li>
  378. <p>
  379. <span class="codefrag computeroutput">lh</span> is a <span class="codefrag computeroutput">LedgerHandle</span> object to manipulate a ledger;
  380. </p>
  381. </li>
  382. <li>
  383. <p>
  384. <span class="codefrag computeroutput">ctx</span> is a control object for accountability purposes;
  385. </p>
  386. </li>
  387. </ul>
  388. <p>
  389. The <span class="codefrag computeroutput">ctx</span> object passed as a parameter to the call to create a ledger
  390. is the one same returned in the callback.
  391. </p>
  392. <a name="N1012E"></a><a name="bk_writeLedger"></a>
  393. <h3 class="h4"> Adding entries to a ledger. </h3>
  394. <p>
  395. Once we have a ledger handle <span class="codefrag computeroutput">lh</span> obtained through a call to create a ledger, we
  396. can start writing entries. As with creating ledgers, we can write both synchronously and
  397. asynchronously. The following methods belong
  398. to <span class="codefrag computeroutput">org.apache.bookkeeper.client.LedgerHandle</span>.
  399. </p>
  400. <p>
  401. <strong>Synchronous call:</strong>
  402. </p>
  403. <p>
  404. <span class="codefrag computeroutput">
  405. public long addEntry(byte[] data)
  406. throws InterruptedException
  407. </span>
  408. </p>
  409. <p>
  410. where:
  411. </p>
  412. <ul>
  413. <li>
  414. <p>
  415. <span class="codefrag computeroutput">data</span> is a byte array;
  416. </p>
  417. </li>
  418. </ul>
  419. <p>
  420. A call to <span class="codefrag computeroutput">addEntry</span> returns the status of the operation ((please refer to <span class="codefrag computeroutput">org.apache.bookeeper.client.BKDefs</span> for a list);
  421. </p>
  422. <p>
  423. <strong>Asynchronous call:</strong>
  424. </p>
  425. <p>
  426. <span class="codefrag computeroutput">
  427. public void asyncAddEntry(byte[] data, AddCallback cb, Object ctx)
  428. throws InterruptedException
  429. </span>
  430. </p>
  431. <p>
  432. It also takes a byte array as the sequence of bytes to be stored as an entry. Additionaly, it takes
  433. a callback object <span class="codefrag computeroutput">cb</span> and a control object <span class="codefrag computeroutput">ctx</span>. The callback object must implement
  434. the <span class="codefrag computeroutput">AddCallback</span> interface in <span class="codefrag computeroutput">org.apache.bookkeeper.client.AsyncCallback</span>, and
  435. a class implementing it has to implement a method called <span class="codefrag computeroutput">addComplete</span>
  436. that has the following signature:
  437. </p>
  438. <p>
  439. <span class="codefrag computeroutput">
  440. void addComplete(int rc, LedgerHandle lh, long entryId, Object ctx);
  441. </span>
  442. </p>
  443. <p>
  444. where:
  445. </p>
  446. <ul>
  447. <li>
  448. <p>
  449. <span class="codefrag computeroutput">rc</span> is a return code (please refer to <span class="codefrag computeroutput">org.apache.bookeeper.client.BKDefs</span> for a list);
  450. </p>
  451. </li>
  452. <li>
  453. <p>
  454. <span class="codefrag computeroutput">lh</span> is a <span class="codefrag computeroutput">LedgerHandle</span> object to manipulate a ledger;
  455. </p>
  456. </li>
  457. <li>
  458. <p>
  459. <span class="codefrag computeroutput">entryId</span> is the identifier of entry associated with this request;
  460. </p>
  461. </li>
  462. <li>
  463. <p>
  464. <span class="codefrag computeroutput">ctx</span> is control object used for accountability purposes.
  465. </p>
  466. </li>
  467. </ul>
  468. <a name="N101C9"></a><a name="bk_closeLedger"></a>
  469. <h3 class="h4"> Closing a ledger. </h3>
  470. <p>
  471. Once a client is done writing, it closes the ledger. The following methods belong
  472. to <span class="codefrag computeroutput">org.apache.bookkeeper.client.LedgerHandle</span>.
  473. </p>
  474. <p>
  475. <strong>Synchronous close:</strong>
  476. </p>
  477. <p>
  478. <span class="codefrag computeroutput">
  479. public void close()
  480. throws KeeperException, InterruptedException
  481. </span>
  482. </p>
  483. <p>
  484. It takes no input parameters.
  485. </p>
  486. <p>
  487. <strong>Asynchronous close:</strong>
  488. </p>
  489. <p>
  490. <span class="codefrag computeroutput">
  491. public void asyncClose(CloseCallback cb, Object ctx)
  492. throws InterruptedException
  493. </span>
  494. </p>
  495. <p>
  496. It takes a callback object <span class="codefrag computeroutput">cb</span> and a control object <span class="codefrag computeroutput">ctx</span>. The callback object must implement
  497. the <span class="codefrag computeroutput">CloseCallback</span> interface in <span class="codefrag computeroutput">org.apache.bookkeeper.client.AsyncCallback</span>, and
  498. a class implementing it has to implement a method called <span class="codefrag computeroutput">closeComplete</span>
  499. that has the following signature:
  500. </p>
  501. <p>
  502. <span class="codefrag computeroutput">
  503. void closeComplete(int rc, LedgerHandle lh, Object ctx)
  504. </span>
  505. </p>
  506. <p>
  507. where:
  508. </p>
  509. <ul>
  510. <li>
  511. <p>
  512. <span class="codefrag computeroutput">rc</span> is a return code (please refer to <span class="codefrag computeroutput">org.apache.bookeeper.client.BKDefs</span> for a list);
  513. </p>
  514. </li>
  515. <li>
  516. <p>
  517. <span class="codefrag computeroutput">lh</span> is a <span class="codefrag computeroutput">LedgerHandle</span> object to manipulate a ledger;
  518. </p>
  519. </li>
  520. <li>
  521. <p>
  522. <span class="codefrag computeroutput">ctx</span> is control object used for accountability purposes.
  523. </p>
  524. </li>
  525. </ul>
  526. <a name="N1023E"></a><a name="bk_openLedger"></a>
  527. <h3 class="h4"> Opening a ledger. </h3>
  528. <p>
  529. To read from a ledger, a client must open it first. The following methods belong
  530. to <span class="codefrag computeroutput">org.apache.bookkeeper.client.BookKeeper</span>.
  531. </p>
  532. <p>
  533. <strong>Synchronous open:</strong>
  534. </p>
  535. <p>
  536. <span class="codefrag computeroutput">
  537. public LedgerHandle openLedger(long lId, byte passwd[])
  538. throws KeeperException, InterruptedException, IOException, BKException
  539. </span>
  540. </p>
  541. <ul>
  542. <li>
  543. <p>
  544. <span class="codefrag computeroutput">ledgerId</span> is the ledger identifier;
  545. </p>
  546. </li>
  547. <li>
  548. <p>
  549. <span class="codefrag computeroutput">passwd</span> is a password to access the ledger (used only in the case of <span class="codefrag computeroutput">VERIFIABLE</span> ledgers);
  550. </p>
  551. </li>
  552. </ul>
  553. <p>
  554. <strong>Asynchronous open:</strong>
  555. </p>
  556. <p>
  557. <span class="codefrag computeroutput">
  558. public void asyncOpenLedger(long lId, byte passwd[], OpenCallback cb, Object ctx)
  559. throws InterruptedException
  560. </span>
  561. </p>
  562. <p>
  563. It also takes a a ledger identifier and a password. Additionaly, it takes a callback object
  564. <span class="codefrag computeroutput">cb</span> and a control object <span class="codefrag computeroutput">ctx</span>. The callback object must implement
  565. the <span class="codefrag computeroutput">OpenCallback</span> interface in <span class="codefrag computeroutput">org.apache.bookkeeper.client.AsyncCallback</span>, and
  566. a class implementing it has to implement a method called <span class="codefrag computeroutput">openComplete</span>
  567. that has the following signature:
  568. </p>
  569. <p>
  570. <span class="codefrag computeroutput">
  571. public void openComplete(int rc, LedgerHandle lh, Object ctx)
  572. </span>
  573. </p>
  574. <p>
  575. where:
  576. </p>
  577. <ul>
  578. <li>
  579. <p>
  580. <span class="codefrag computeroutput">rc</span> is a return code (please refer to <span class="codefrag computeroutput">org.apache.bookeeper.client.BKDefs</span> for a list);
  581. </p>
  582. </li>
  583. <li>
  584. <p>
  585. <span class="codefrag computeroutput">lh</span> is a <span class="codefrag computeroutput">LedgerHandle</span> object to manipulate a ledger;
  586. </p>
  587. </li>
  588. <li>
  589. <p>
  590. <span class="codefrag computeroutput">ctx</span> is control object used for accountability purposes.
  591. </p>
  592. </li>
  593. </ul>
  594. <a name="N102CB"></a><a name="bk_readLedger"></a>
  595. <h3 class="h4"> Reading from ledger </h3>
  596. <p>
  597. Read calls may request one or more consecutive entries. The following methods belong
  598. to <span class="codefrag computeroutput">org.apache.bookkeeper.client.LedgerHandle</span>.
  599. </p>
  600. <p>
  601. <strong>Synchronous read:</strong>
  602. </p>
  603. <p>
  604. <span class="codefrag computeroutput">
  605. public LedgerSequence readEntries(long firstEntry, long lastEntry)
  606. throws InterruptedException, BKException
  607. </span>
  608. </p>
  609. <ul>
  610. <li>
  611. <p>
  612. <span class="codefrag computeroutput">firstEntry</span> is the identifier of the first entry in the sequence of entries to read;
  613. </p>
  614. </li>
  615. <li>
  616. <p>
  617. <span class="codefrag computeroutput">lastEntry</span> is the identifier of the last entry in the sequence of entries to read;
  618. </p>
  619. </li>
  620. </ul>
  621. <p>
  622. <strong>Asynchronous read:</strong>
  623. </p>
  624. <p>
  625. <span class="codefrag computeroutput">
  626. public void asyncReadEntries(long firstEntry,
  627. long lastEntry, ReadCallback cb, Object ctx)
  628. throws BKException, InterruptedException
  629. </span>
  630. </p>
  631. <p>
  632. It also takes a first and a last entry identifiers. Additionaly, it takes a callback object
  633. <span class="codefrag computeroutput">cb</span> and a control object <span class="codefrag computeroutput">ctx</span>. The callback object must implement
  634. the <span class="codefrag computeroutput">ReadCallback</span> interface in <span class="codefrag computeroutput">org.apache.bookkeeper.client.AsyncCallback</span>, and
  635. a class implementing it has to implement a method called <span class="codefrag computeroutput">readComplete</span>
  636. that has the following signature:
  637. </p>
  638. <p>
  639. <span class="codefrag computeroutput">
  640. void readComplete(int rc, LedgerHandle lh, LedgerSequence seq, Object ctx)
  641. </span>
  642. </p>
  643. <p>
  644. where:
  645. </p>
  646. <ul>
  647. <li>
  648. <p>
  649. <span class="codefrag computeroutput">rc</span> is a return code (please refer to <span class="codefrag computeroutput">org.apache.bookeeper.client.BKDefs</span> for a list);
  650. </p>
  651. </li>
  652. <li>
  653. <p>
  654. <span class="codefrag computeroutput">lh</span> is a <span class="codefrag computeroutput">LedgerHandle</span> object to manipulate a ledger;
  655. </p>
  656. </li>
  657. <li>
  658. <p>
  659. <span class="codefrag computeroutput">seq</span> is a <span class="codefrag computeroutput">LedgerSequence</span> object to containing the list of entries requested;
  660. </p>
  661. </li>
  662. <li>
  663. <p>
  664. <span class="codefrag computeroutput">ctx</span> is control object used for accountability purposes.
  665. </p>
  666. </li>
  667. </ul>
  668. </div>
  669. <p align="right">
  670. <font size="-2"></font>
  671. </p>
  672. </div>
  673. <!--+
  674. |end content
  675. +-->
  676. <div class="clearboth">&nbsp;</div>
  677. </div>
  678. <div id="footer">
  679. <!--+
  680. |start bottomstrip
  681. +-->
  682. <div class="lastmodified">
  683. <script type="text/javascript"><!--
  684. document.write("Last Published: " + document.lastModified);
  685. // --></script>
  686. </div>
  687. <div class="copyright">
  688. Copyright &copy;
  689. 2008 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
  690. </div>
  691. <!--+
  692. |end bottomstrip
  693. +-->
  694. </div>
  695. </body>
  696. </html>