bookkeeperProgrammer.html 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988
  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.4 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 class="menuitem">
  164. <a href="zookeeperObservers.html">Observers Guide</a>
  165. </div>
  166. </div>
  167. <div onclick="SwitchMenu('menu_1.5', 'skin/')" id="menu_1.5Title" class="menutitle">Contributor</div>
  168. <div id="menu_1.5" class="menuitemgroup">
  169. <div class="menuitem">
  170. <a href="zookeeperInternals.html">ZooKeeper Internals</a>
  171. </div>
  172. </div>
  173. <div onclick="SwitchMenu('menu_1.6', 'skin/')" id="menu_1.6Title" class="menutitle">Miscellaneous</div>
  174. <div id="menu_1.6" class="menuitemgroup">
  175. <div class="menuitem">
  176. <a href="http://wiki.apache.org/hadoop/ZooKeeper">Wiki</a>
  177. </div>
  178. <div class="menuitem">
  179. <a href="http://wiki.apache.org/hadoop/ZooKeeper/FAQ">FAQ</a>
  180. </div>
  181. <div class="menuitem">
  182. <a href="http://hadoop.apache.org/zookeeper/mailing_lists.html">Mailing Lists</a>
  183. </div>
  184. </div>
  185. <div id="credit"></div>
  186. <div id="roundbottom">
  187. <img style="display: none" class="corner" height="15" width="15" alt="" src="skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
  188. <!--+
  189. |alternative credits
  190. +-->
  191. <div id="credit2"></div>
  192. </div>
  193. <!--+
  194. |end Menu
  195. +-->
  196. <!--+
  197. |start content
  198. +-->
  199. <div id="content">
  200. <div title="Portable Document Format" class="pdflink">
  201. <a class="dida" href="bookkeeperProgrammer.pdf"><img alt="PDF -icon" src="skin/images/pdfdoc.gif" class="skin"><br>
  202. PDF</a>
  203. </div>
  204. <h1>BookKeeper Getting Started Guide</h1>
  205. <div id="minitoc-area">
  206. <ul class="minitoc">
  207. <li>
  208. <a href="#bk_GettingStarted">Programming with BookKeeper</a>
  209. <ul class="minitoc">
  210. <li>
  211. <a href="#bk_instance"> Instantiating BookKeeper.</a>
  212. </li>
  213. <li>
  214. <a href="#bk_createLedger"> Creating a ledger. </a>
  215. </li>
  216. <li>
  217. <a href="#bk_writeLedger"> Adding entries to a ledger. </a>
  218. </li>
  219. <li>
  220. <a href="#bk_closeLedger"> Closing a ledger. </a>
  221. </li>
  222. <li>
  223. <a href="#bk_openLedger"> Opening a ledger. </a>
  224. </li>
  225. <li>
  226. <a href="#bk_readLedger"> Reading from ledger </a>
  227. </li>
  228. </ul>
  229. </li>
  230. </ul>
  231. </div>
  232. <a name="N10009"></a><a name="bk_GettingStarted"></a>
  233. <h2 class="h3">Programming with BookKeeper</h2>
  234. <div class="section">
  235. <ul>
  236. <li>
  237. <p>
  238. <a href="#bk_instance"> Instantiating BookKeeper.</a>
  239. </p>
  240. </li>
  241. <li>
  242. <p>
  243. <a href="#bk_createLedger"> Creating a ledger. </a>
  244. </p>
  245. </li>
  246. <li>
  247. <p>
  248. <a href="#bk_writeLedger"> Adding entries to a ledger. </a>
  249. </p>
  250. </li>
  251. <li>
  252. <p>
  253. <a href="#bk_closeLedger"> Closing a ledger. </a>
  254. </p>
  255. </li>
  256. <li>
  257. <p>
  258. <a href="#bk_openLedger"> Opening a ledger. </a>
  259. </p>
  260. </li>
  261. <li>
  262. <p>
  263. <a href="#bk_readLedger"> Reading from ledger </a>
  264. </p>
  265. </li>
  266. </ul>
  267. <a name="N10042"></a><a name="bk_instance"></a>
  268. <h3 class="h4"> Instantiating BookKeeper.</h3>
  269. <p>
  270. The first step to use BookKeeper is to instantiate a BookKeeper object:
  271. </p>
  272. <p>
  273. <span class="codefrag computeroutput">
  274. org.apache.bookkeeper.BookKeeper
  275. </span>
  276. </p>
  277. <p>
  278. There are three BookKeeper constructors:
  279. </p>
  280. <p>
  281. <span class="codefrag computeroutput">
  282. public BookKeeper(String servers)
  283. throws KeeperException, IOException
  284. </span>
  285. </p>
  286. <p>
  287. where:
  288. </p>
  289. <ul>
  290. <li>
  291. <p>
  292. <span class="codefrag computeroutput">servers</span> is a comma-separated list of ZooKeeper servers.
  293. </p>
  294. </li>
  295. </ul>
  296. <p>
  297. <span class="codefrag computeroutput">
  298. public BookKeeper(ZooKeeper zk)
  299. throws InterruptedException, KeeperException
  300. </span>
  301. </p>
  302. <p>
  303. where:
  304. </p>
  305. <ul>
  306. <li>
  307. <p>
  308. <span class="codefrag computeroutput">zk</span> is a ZooKeeper object. This constructor is useful when
  309. the application also using ZooKeeper and wants to have a single instance of ZooKeeper.
  310. </p>
  311. </li>
  312. </ul>
  313. <p>
  314. <span class="codefrag computeroutput">
  315. public BookKeeper(ZooKeeper zk, ClientSocketChannelFactory channelFactory)
  316. throws InterruptedException, KeeperException
  317. </span>
  318. </p>
  319. <p>
  320. where:
  321. </p>
  322. <ul>
  323. <li>
  324. <p>
  325. <span class="codefrag computeroutput">zk</span> is a ZooKeeper object. This constructor is useful when
  326. the application also using ZooKeeper and wants to have a single instance of ZooKeeper.
  327. </p>
  328. </li>
  329. <li>
  330. <p>
  331. <span class="codefrag computeroutput">channelFactory</span> is a netty channel object
  332. (<span class="codefrag computeroutput">org.jboss.netty.channel.socket</span>).
  333. </p>
  334. </li>
  335. </ul>
  336. <a name="N100A9"></a><a name="bk_createLedger"></a>
  337. <h3 class="h4"> Creating a ledger. </h3>
  338. <p> Before writing entries to BookKeeper, it is necessary to create a ledger.
  339. With the current BookKeeper API, it is possible to create a ledger both synchronously
  340. or asynchronously. The following methods belong
  341. to <span class="codefrag computeroutput">org.apache.bookkeeper.client.BookKeeper</span>.
  342. </p>
  343. <p>
  344. <strong>Synchronous call:</strong>
  345. </p>
  346. <p>
  347. <span class="codefrag computeroutput">
  348. public LedgerHandle createLedger(int ensSize, int qSize, DigestType type, byte passwd[])
  349. throws KeeperException, InterruptedException,
  350. IOException, BKException
  351. </span>
  352. </p>
  353. <p>
  354. where:
  355. </p>
  356. <ul>
  357. <li>
  358. <p>
  359. <span class="codefrag computeroutput">ensSize</span> is the number of bookies (ensemble size);
  360. </p>
  361. </li>
  362. <li>
  363. <p>
  364. <span class="codefrag computeroutput">qSize</span> is the write quorum size;
  365. </p>
  366. </li>
  367. <li>
  368. <p>
  369. <span class="codefrag computeroutput">type</span> is the type of digest used with entries: either MAC or CRC32.
  370. </p>
  371. </li>
  372. <li>
  373. <p>
  374. <span class="codefrag computeroutput">passwd</span> is a password that authorizes the client to write to the
  375. ledger being created.
  376. </p>
  377. </li>
  378. </ul>
  379. <p>
  380. All further operations on a ledger are invoked through the <span class="codefrag computeroutput">LedgerHandle</span>
  381. object returned.
  382. </p>
  383. <p>
  384. As a convenience, we provide a <span class="codefrag computeroutput">createLedger</span> with default parameters (3,2,VERIFIABLE),
  385. and the only two input parameters it requires are a digest type and a password.
  386. </p>
  387. <p>
  388. <strong>Asynchronous call:</strong>
  389. </p>
  390. <p>
  391. <span class="codefrag computeroutput">
  392. public void asyncCreateLedger(int ensSize,
  393. int qSize,
  394. DigestType type,
  395. byte passwd[],
  396. CreateCallback cb,
  397. Object ctx
  398. )
  399. </span>
  400. </p>
  401. <p>
  402. The parameters are the same of the synchronous version, with the
  403. exception of <span class="codefrag computeroutput">cb</span> and <span class="codefrag computeroutput">ctx</span>. <span class="codefrag computeroutput">CreateCallback</span>
  404. is an interface in <span class="codefrag computeroutput">org.apache.bookkeeper.client.AsyncCallback</span>, and
  405. a class implementing it has to implement a method called <span class="codefrag computeroutput">createComplete</span>
  406. that has the following signature:
  407. </p>
  408. <p>
  409. <span class="codefrag computeroutput">
  410. void createComplete(int rc, LedgerHandle lh, Object ctx);
  411. </span>
  412. </p>
  413. <p>
  414. where:
  415. </p>
  416. <ul>
  417. <li>
  418. <p>
  419. <span class="codefrag computeroutput">rc</span> is a return code (please refer to <span class="codefrag computeroutput">org.apache.bookeeper.client.BKException</span> for a list);
  420. </p>
  421. </li>
  422. <li>
  423. <p>
  424. <span class="codefrag computeroutput">lh</span> is a <span class="codefrag computeroutput">LedgerHandle</span> object to manipulate a ledger;
  425. </p>
  426. </li>
  427. <li>
  428. <p>
  429. <span class="codefrag computeroutput">ctx</span> is a control object for accountability purposes. It can be essentially any object the application is happy with.
  430. </p>
  431. </li>
  432. </ul>
  433. <p>
  434. The <span class="codefrag computeroutput">ctx</span> object passed as a parameter to the call to create a ledger
  435. is the one same returned in the callback.
  436. </p>
  437. <a name="N1015E"></a><a name="bk_writeLedger"></a>
  438. <h3 class="h4"> Adding entries to a ledger. </h3>
  439. <p>
  440. Once we have a ledger handle <span class="codefrag computeroutput">lh</span> obtained through a call to create a ledger, we
  441. can start writing entries. As with creating ledgers, we can write both synchronously and
  442. asynchronously. The following methods belong
  443. to <span class="codefrag computeroutput">org.apache.bookkeeper.client.LedgerHandle</span>.
  444. </p>
  445. <p>
  446. <strong>Synchronous call:</strong>
  447. </p>
  448. <p>
  449. <span class="codefrag computeroutput">
  450. public long addEntry(byte[] data)
  451. throws InterruptedException
  452. </span>
  453. </p>
  454. <p>
  455. where:
  456. </p>
  457. <ul>
  458. <li>
  459. <p>
  460. <span class="codefrag computeroutput">data</span> is a byte array;
  461. </p>
  462. </li>
  463. </ul>
  464. <p>
  465. 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);
  466. </p>
  467. <p>
  468. <strong>Asynchronous call:</strong>
  469. </p>
  470. <p>
  471. <span class="codefrag computeroutput">
  472. public void asyncAddEntry(byte[] data, AddCallback cb, Object ctx)
  473. </span>
  474. </p>
  475. <p>
  476. It also takes a byte array as the sequence of bytes to be stored as an entry. Additionaly, it takes
  477. a callback object <span class="codefrag computeroutput">cb</span> and a control object <span class="codefrag computeroutput">ctx</span>. The callback object must implement
  478. the <span class="codefrag computeroutput">AddCallback</span> interface in <span class="codefrag computeroutput">org.apache.bookkeeper.client.AsyncCallback</span>, and
  479. a class implementing it has to implement a method called <span class="codefrag computeroutput">addComplete</span>
  480. that has the following signature:
  481. </p>
  482. <p>
  483. <span class="codefrag computeroutput">
  484. void addComplete(int rc, LedgerHandle lh, long entryId, Object ctx);
  485. </span>
  486. </p>
  487. <p>
  488. where:
  489. </p>
  490. <ul>
  491. <li>
  492. <p>
  493. <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);
  494. </p>
  495. </li>
  496. <li>
  497. <p>
  498. <span class="codefrag computeroutput">lh</span> is a <span class="codefrag computeroutput">LedgerHandle</span> object to manipulate a ledger;
  499. </p>
  500. </li>
  501. <li>
  502. <p>
  503. <span class="codefrag computeroutput">entryId</span> is the identifier of entry associated with this request;
  504. </p>
  505. </li>
  506. <li>
  507. <p>
  508. <span class="codefrag computeroutput">ctx</span> is control object used for accountability purposes. It can be any object the application is happy with.
  509. </p>
  510. </li>
  511. </ul>
  512. <a name="N101F9"></a><a name="bk_closeLedger"></a>
  513. <h3 class="h4"> Closing a ledger. </h3>
  514. <p>
  515. Once a client is done writing, it closes the ledger. The following methods belong
  516. to <span class="codefrag computeroutput">org.apache.bookkeeper.client.LedgerHandle</span>.
  517. </p>
  518. <p>
  519. <strong>Synchronous close:</strong>
  520. </p>
  521. <p>
  522. <span class="codefrag computeroutput">
  523. public void close()
  524. throws InterruptedException
  525. </span>
  526. </p>
  527. <p>
  528. It takes no input parameters.
  529. </p>
  530. <p>
  531. <strong>Asynchronous close:</strong>
  532. </p>
  533. <p>
  534. <span class="codefrag computeroutput">
  535. public void asyncClose(CloseCallback cb, Object ctx)
  536. throws InterruptedException
  537. </span>
  538. </p>
  539. <p>
  540. 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
  541. the <span class="codefrag computeroutput">CloseCallback</span> interface in <span class="codefrag computeroutput">org.apache.bookkeeper.client.AsyncCallback</span>, and
  542. a class implementing it has to implement a method called <span class="codefrag computeroutput">closeComplete</span>
  543. that has the following signature:
  544. </p>
  545. <p>
  546. <span class="codefrag computeroutput">
  547. void closeComplete(int rc, LedgerHandle lh, Object ctx)
  548. </span>
  549. </p>
  550. <p>
  551. where:
  552. </p>
  553. <ul>
  554. <li>
  555. <p>
  556. <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);
  557. </p>
  558. </li>
  559. <li>
  560. <p>
  561. <span class="codefrag computeroutput">lh</span> is a <span class="codefrag computeroutput">LedgerHandle</span> object to manipulate a ledger;
  562. </p>
  563. </li>
  564. <li>
  565. <p>
  566. <span class="codefrag computeroutput">ctx</span> is control object used for accountability purposes.
  567. </p>
  568. </li>
  569. </ul>
  570. <a name="N1026E"></a><a name="bk_openLedger"></a>
  571. <h3 class="h4"> Opening a ledger. </h3>
  572. <p>
  573. To read from a ledger, a client must open it first. The following methods belong
  574. to <span class="codefrag computeroutput">org.apache.bookkeeper.client.BookKeeper</span>.
  575. </p>
  576. <p>
  577. <strong>Synchronous open:</strong>
  578. </p>
  579. <p>
  580. <span class="codefrag computeroutput">
  581. public LedgerHandle openLedger(long lId, DigestType type, byte passwd[])
  582. throws InterruptedException, BKException
  583. </span>
  584. </p>
  585. <ul>
  586. <li>
  587. <p>
  588. <span class="codefrag computeroutput">ledgerId</span> is the ledger identifier;
  589. </p>
  590. </li>
  591. <li>
  592. <p>
  593. <span class="codefrag computeroutput">type</span> is the type of digest used with entries: either MAC or CRC32.
  594. </p>
  595. </li>
  596. <li>
  597. <p>
  598. <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);
  599. </p>
  600. </li>
  601. </ul>
  602. <p>
  603. <strong>Asynchronous open:</strong>
  604. </p>
  605. <p>
  606. <span class="codefrag computeroutput">
  607. public void asyncOpenLedger(long lId, DigestType type, byte passwd[], OpenCallback cb, Object ctx)
  608. </span>
  609. </p>
  610. <p>
  611. It also takes a a ledger identifier and a password. Additionaly, it takes a callback object
  612. <span class="codefrag computeroutput">cb</span> and a control object <span class="codefrag computeroutput">ctx</span>. The callback object must implement
  613. the <span class="codefrag computeroutput">OpenCallback</span> interface in <span class="codefrag computeroutput">org.apache.bookkeeper.client.AsyncCallback</span>, and
  614. a class implementing it has to implement a method called <span class="codefrag computeroutput">openComplete</span>
  615. that has the following signature:
  616. </p>
  617. <p>
  618. <span class="codefrag computeroutput">
  619. public void openComplete(int rc, LedgerHandle lh, Object ctx)
  620. </span>
  621. </p>
  622. <p>
  623. where:
  624. </p>
  625. <ul>
  626. <li>
  627. <p>
  628. <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);
  629. </p>
  630. </li>
  631. <li>
  632. <p>
  633. <span class="codefrag computeroutput">lh</span> is a <span class="codefrag computeroutput">LedgerHandle</span> object to manipulate a ledger;
  634. </p>
  635. </li>
  636. <li>
  637. <p>
  638. <span class="codefrag computeroutput">ctx</span> is control object used for accountability purposes.
  639. </p>
  640. </li>
  641. </ul>
  642. <a name="N10305"></a><a name="bk_readLedger"></a>
  643. <h3 class="h4"> Reading from ledger </h3>
  644. <p>
  645. Read calls may request one or more consecutive entries. The following methods belong
  646. to <span class="codefrag computeroutput">org.apache.bookkeeper.client.LedgerHandle</span>.
  647. </p>
  648. <p>
  649. <strong>Synchronous read:</strong>
  650. </p>
  651. <p>
  652. <span class="codefrag computeroutput">
  653. public LedgerSequence readEntries(long firstEntry, long lastEntry)
  654. throws InterruptedException, BKException
  655. </span>
  656. </p>
  657. <ul>
  658. <li>
  659. <p>
  660. <span class="codefrag computeroutput">firstEntry</span> is the identifier of the first entry in the sequence of entries to read;
  661. </p>
  662. </li>
  663. <li>
  664. <p>
  665. <span class="codefrag computeroutput">lastEntry</span> is the identifier of the last entry in the sequence of entries to read.
  666. </p>
  667. </li>
  668. </ul>
  669. <p>
  670. <strong>Asynchronous read:</strong>
  671. </p>
  672. <p>
  673. <span class="codefrag computeroutput">
  674. public void asyncReadEntries(long firstEntry,
  675. long lastEntry, ReadCallback cb, Object ctx)
  676. throws BKException, InterruptedException
  677. </span>
  678. </p>
  679. <p>
  680. It also takes a first and a last entry identifiers. Additionaly, it takes a callback object
  681. <span class="codefrag computeroutput">cb</span> and a control object <span class="codefrag computeroutput">ctx</span>. The callback object must implement
  682. the <span class="codefrag computeroutput">ReadCallback</span> interface in <span class="codefrag computeroutput">org.apache.bookkeeper.client.AsyncCallback</span>, and
  683. a class implementing it has to implement a method called <span class="codefrag computeroutput">readComplete</span>
  684. that has the following signature:
  685. </p>
  686. <p>
  687. <span class="codefrag computeroutput">
  688. void readComplete(int rc, LedgerHandle lh, Enumeration&lt;LedgerEntry&gt; seq, Object ctx)
  689. </span>
  690. </p>
  691. <p>
  692. where:
  693. </p>
  694. <ul>
  695. <li>
  696. <p>
  697. <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);
  698. </p>
  699. </li>
  700. <li>
  701. <p>
  702. <span class="codefrag computeroutput">lh</span> is a <span class="codefrag computeroutput">LedgerHandle</span> object to manipulate a ledger;
  703. </p>
  704. </li>
  705. <li>
  706. <p>
  707. <span class="codefrag computeroutput">seq</span> is a <span class="codefrag computeroutput">Enumeration&lt;LedgerEntry&gt; </span> object to containing the list of entries requested;
  708. </p>
  709. </li>
  710. <li>
  711. <p>
  712. <span class="codefrag computeroutput">ctx</span> is control object used for accountability purposes.
  713. </p>
  714. </li>
  715. </ul>
  716. </div>
  717. <p align="right">
  718. <font size="-2"></font>
  719. </p>
  720. </div>
  721. <!--+
  722. |end content
  723. +-->
  724. <div class="clearboth">&nbsp;</div>
  725. </div>
  726. <div id="footer">
  727. <!--+
  728. |start bottomstrip
  729. +-->
  730. <div class="lastmodified">
  731. <script type="text/javascript"><!--
  732. document.write("Last Published: " + document.lastModified);
  733. // --></script>
  734. </div>
  735. <div class="copyright">
  736. Copyright &copy;
  737. 2008 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
  738. </div>
  739. <!--+
  740. |end bottomstrip
  741. +-->
  742. </div>
  743. </body>
  744. </html>