forked from apache/zookeeper
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathbookkeeperProgrammer.html
1083 lines (810 loc) · 25 KB
/
bookkeeperProgrammer.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta content="Apache Forrest" name="Generator">
<meta name="Forrest-version" content="0.9">
<meta name="Forrest-skin-name" content="pelt">
<title>BookKeeper Getting Started Guide</title>
<link type="text/css" href="skin/basic.css" rel="stylesheet">
<link media="screen" type="text/css" href="skin/screen.css" rel="stylesheet">
<link media="print" type="text/css" href="skin/print.css" rel="stylesheet">
<link type="text/css" href="skin/profile.css" rel="stylesheet">
<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>
<link rel="shortcut icon" href="images/favicon.ico">
</head>
<body onload="init()">
<script type="text/javascript">ndeSetTextSize();</script>
<div id="top">
<!--+
|breadtrail
+-->
<div class="breadtrail">
<a href="http://www.apache.org/">Apache</a> > <a href="http://zookeeper.apache.org/">ZooKeeper</a> > <a href="http://zookeeper.apache.org/">ZooKeeper</a><script src="skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
</div>
<!--+
|header
+-->
<div class="header">
<!--+
|start group logo
+-->
<div class="grouplogo">
<a href="http://hadoop.apache.org/"><img class="logoImage" alt="Hadoop" src="images/hadoop-logo.jpg" title="Apache Hadoop"></a>
</div>
<!--+
|end group logo
+-->
<!--+
|start Project Logo
+-->
<div class="projectlogo">
<a href="http://zookeeper.apache.org/"><img class="logoImage" alt="ZooKeeper" src="images/zookeeper_small.gif" title="ZooKeeper: distributed coordination"></a>
</div>
<!--+
|end Project Logo
+-->
<!--+
|start Search
+-->
<div class="searchbox">
<form action="http://www.google.com/search" method="get" class="roundtopsmall">
<input value="zookeeper.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">
<input name="Search" value="Search" type="submit">
</form>
</div>
<!--+
|end search
+-->
<!--+
|start Tabs
+-->
<ul id="tabs">
<li>
<a class="unselected" href="http://zookeeper.apache.org/">Project</a>
</li>
<li>
<a class="unselected" href="https://cwiki.apache.org/confluence/display/ZOOKEEPER/">Wiki</a>
</li>
<li class="current">
<a class="selected" href="index.html">ZooKeeper 3.4 Documentation</a>
</li>
</ul>
<!--+
|end Tabs
+-->
</div>
</div>
<div id="main">
<div id="publishedStrip">
<!--+
|start Subtabs
+-->
<div id="level2tabs"></div>
<!--+
|end Endtabs
+-->
<script type="text/javascript"><!--
document.write("Last Published: " + document.lastModified);
// --></script>
</div>
<!--+
|breadtrail
+-->
<div class="breadtrail">
</div>
<!--+
|start Menu, mainarea
+-->
<!--+
|start Menu
+-->
<div id="menu">
<div onclick="SwitchMenu('menu_1.1', 'skin/')" id="menu_1.1Title" class="menutitle">Overview</div>
<div id="menu_1.1" class="menuitemgroup">
<div class="menuitem">
<a href="index.html">Welcome</a>
</div>
<div class="menuitem">
<a href="zookeeperOver.html">Overview</a>
</div>
<div class="menuitem">
<a href="zookeeperStarted.html">Getting Started</a>
</div>
<div class="menuitem">
<a href="releasenotes.html">Release Notes</a>
</div>
</div>
<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Developer</div>
<div id="menu_1.2" class="menuitemgroup">
<div class="menuitem">
<a href="api/index.html">API Docs</a>
</div>
<div class="menuitem">
<a href="zookeeperProgrammers.html">Programmer's Guide</a>
</div>
<div class="menuitem">
<a href="javaExample.html">Java Example</a>
</div>
<div class="menuitem">
<a href="zookeeperTutorial.html">Barrier and Queue Tutorial</a>
</div>
<div class="menuitem">
<a href="recipes.html">Recipes</a>
</div>
</div>
<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>
<div id="menu_selected_1.3" class="selectedmenuitemgroup" style="display: block;">
<div class="menuitem">
<a href="bookkeeperStarted.html">Getting started</a>
</div>
<div class="menuitem">
<a href="bookkeeperOverview.html">Overview</a>
</div>
<div class="menuitem">
<a href="bookkeeperConfig.html">Setup guide</a>
</div>
<div class="menupage">
<div class="menupagetitle">Programmer's guide</div>
</div>
</div>
<div onclick="SwitchMenu('menu_1.4', 'skin/')" id="menu_1.4Title" class="menutitle">Admin & Ops</div>
<div id="menu_1.4" class="menuitemgroup">
<div class="menuitem">
<a href="zookeeperAdmin.html">Administrator's Guide</a>
</div>
<div class="menuitem">
<a href="zookeeperQuotas.html">Quota Guide</a>
</div>
<div class="menuitem">
<a href="zookeeperJMX.html">JMX</a>
</div>
<div class="menuitem">
<a href="zookeeperObservers.html">Observers Guide</a>
</div>
</div>
<div onclick="SwitchMenu('menu_1.5', 'skin/')" id="menu_1.5Title" class="menutitle">Contributor</div>
<div id="menu_1.5" class="menuitemgroup">
<div class="menuitem">
<a href="zookeeperInternals.html">ZooKeeper Internals</a>
</div>
</div>
<div onclick="SwitchMenu('menu_1.6', 'skin/')" id="menu_1.6Title" class="menutitle">Miscellaneous</div>
<div id="menu_1.6" class="menuitemgroup">
<div class="menuitem">
<a href="https://cwiki.apache.org/confluence/display/ZOOKEEPER">Wiki</a>
</div>
<div class="menuitem">
<a href="https://cwiki.apache.org/confluence/display/ZOOKEEPER/FAQ">FAQ</a>
</div>
<div class="menuitem">
<a href="http://zookeeper.apache.org/mailing_lists.html">Mailing Lists</a>
</div>
</div>
<div id="credit"></div>
<div id="roundbottom">
<img style="display: none" class="corner" height="15" width="15" alt="" src="skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
<!--+
|alternative credits
+-->
<div id="credit2"></div>
</div>
<!--+
|end Menu
+-->
<!--+
|start content
+-->
<div id="content">
<div title="Portable Document Format" class="pdflink">
<a class="dida" href="bookkeeperProgrammer.pdf"><img alt="PDF -icon" src="skin/images/pdfdoc.gif" class="skin"><br>
PDF</a>
</div>
<h1>BookKeeper Getting Started Guide</h1>
<div id="front-matter">
<div id="minitoc-area">
<ul class="minitoc">
<li>
<a href="#bk_GettingStarted">Programming with BookKeeper</a>
<ul class="minitoc">
<li>
<a href="#bk_instance"> Instantiating BookKeeper.</a>
</li>
<li>
<a href="#bk_createLedger"> Creating a ledger. </a>
</li>
<li>
<a href="#bk_writeLedger"> Adding entries to a ledger. </a>
</li>
<li>
<a href="#bk_closeLedger"> Closing a ledger. </a>
</li>
<li>
<a href="#bk_openLedger"> Opening a ledger. </a>
</li>
<li>
<a href="#bk_readLedger"> Reading from ledger </a>
</li>
<li>
<a href="#bk_deleteLedger"> Deleting a ledger </a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<a name="bk_GettingStarted"></a>
<h2 class="h3">Programming with BookKeeper</h2>
<div class="section">
<ul>
<li>
<p>
<a href="#bk_instance"> Instantiating BookKeeper.</a>
</p>
</li>
<li>
<p>
<a href="#bk_createLedger"> Creating a ledger. </a>
</p>
</li>
<li>
<p>
<a href="#bk_writeLedger"> Adding entries to a ledger. </a>
</p>
</li>
<li>
<p>
<a href="#bk_closeLedger"> Closing a ledger. </a>
</p>
</li>
<li>
<p>
<a href="#bk_openLedger"> Opening a ledger. </a>
</p>
</li>
<li>
<p>
<a href="#bk_readLedger"> Reading from ledger </a>
</p>
</li>
<li>
<p>
<a href="#bk_deleteLedger"> Deleting a ledger </a>
</p>
</li>
</ul>
<a name="bk_instance"></a>
<h3 class="h4"> Instantiating BookKeeper.</h3>
<p>
The first step to use BookKeeper is to instantiate a BookKeeper object:
</p>
<p>
<span class="codefrag computeroutput">
org.apache.bookkeeper.BookKeeper
</span>
</p>
<p>
There are three BookKeeper constructors:
</p>
<p>
<span class="codefrag computeroutput">
public BookKeeper(String servers)
throws KeeperException, IOException
</span>
</p>
<p>
where:
</p>
<ul>
<li>
<p>
<span class="codefrag computeroutput">servers</span> is a comma-separated list of ZooKeeper servers.
</p>
</li>
</ul>
<p>
<span class="codefrag computeroutput">
public BookKeeper(ZooKeeper zk)
throws InterruptedException, KeeperException
</span>
</p>
<p>
where:
</p>
<ul>
<li>
<p>
<span class="codefrag computeroutput">zk</span> is a ZooKeeper object. This constructor is useful when
the application also using ZooKeeper and wants to have a single instance of ZooKeeper.
</p>
</li>
</ul>
<p>
<span class="codefrag computeroutput">
public BookKeeper(ZooKeeper zk, ClientSocketChannelFactory channelFactory)
throws InterruptedException, KeeperException
</span>
</p>
<p>
where:
</p>
<ul>
<li>
<p>
<span class="codefrag computeroutput">zk</span> is a ZooKeeper object. This constructor is useful when
the application also using ZooKeeper and wants to have a single instance of ZooKeeper.
</p>
</li>
<li>
<p>
<span class="codefrag computeroutput">channelFactory</span> is a netty channel object
(<span class="codefrag computeroutput">org.jboss.netty.channel.socket</span>).
</p>
</li>
</ul>
<a name="bk_createLedger"></a>
<h3 class="h4"> Creating a ledger. </h3>
<p> Before writing entries to BookKeeper, it is necessary to create a ledger.
With the current BookKeeper API, it is possible to create a ledger both synchronously
or asynchronously. The following methods belong
to <span class="codefrag computeroutput">org.apache.bookkeeper.client.BookKeeper</span>.
</p>
<p>
<strong>Synchronous call:</strong>
</p>
<p>
<span class="codefrag computeroutput">
public LedgerHandle createLedger(int ensSize, int qSize, DigestType type, byte passwd[])
throws KeeperException, InterruptedException,
IOException, BKException
</span>
</p>
<p>
where:
</p>
<ul>
<li>
<p>
<span class="codefrag computeroutput">ensSize</span> is the number of bookies (ensemble size);
</p>
</li>
<li>
<p>
<span class="codefrag computeroutput">qSize</span> is the write quorum size;
</p>
</li>
<li>
<p>
<span class="codefrag computeroutput">type</span> is the type of digest used with entries: either MAC or CRC32.
</p>
</li>
<li>
<p>
<span class="codefrag computeroutput">passwd</span> is a password that authorizes the client to write to the
ledger being created.
</p>
</li>
</ul>
<p>
All further operations on a ledger are invoked through the <span class="codefrag computeroutput">LedgerHandle</span>
object returned.
</p>
<p>
As a convenience, we provide a <span class="codefrag computeroutput">createLedger</span> with default parameters (3,2,VERIFIABLE),
and the only two input parameters it requires are a digest type and a password.
</p>
<p>
<strong>Asynchronous call:</strong>
</p>
<p>
<span class="codefrag computeroutput">
public void asyncCreateLedger(int ensSize,
int qSize,
DigestType type,
byte passwd[],
CreateCallback cb,
Object ctx
)
</span>
</p>
<p>
The parameters are the same of the synchronous version, with the
exception of <span class="codefrag computeroutput">cb</span> and <span class="codefrag computeroutput">ctx</span>. <span class="codefrag computeroutput">CreateCallback</span>
is an interface in <span class="codefrag computeroutput">org.apache.bookkeeper.client.AsyncCallback</span>, and
a class implementing it has to implement a method called <span class="codefrag computeroutput">createComplete</span>
that has the following signature:
</p>
<p>
<span class="codefrag computeroutput">
void createComplete(int rc, LedgerHandle lh, Object ctx);
</span>
</p>
<p>
where:
</p>
<ul>
<li>
<p>
<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);
</p>
</li>
<li>
<p>
<span class="codefrag computeroutput">lh</span> is a <span class="codefrag computeroutput">LedgerHandle</span> object to manipulate a ledger;
</p>
</li>
<li>
<p>
<span class="codefrag computeroutput">ctx</span> is a control object for accountability purposes. It can be essentially any object the application is happy with.
</p>
</li>
</ul>
<p>
The <span class="codefrag computeroutput">ctx</span> object passed as a parameter to the call to create a ledger
is the one same returned in the callback.
</p>
<a name="bk_writeLedger"></a>
<h3 class="h4"> Adding entries to a ledger. </h3>
<p>
Once we have a ledger handle <span class="codefrag computeroutput">lh</span> obtained through a call to create a ledger, we
can start writing entries. As with creating ledgers, we can write both synchronously and
asynchronously. The following methods belong
to <span class="codefrag computeroutput">org.apache.bookkeeper.client.LedgerHandle</span>.
</p>
<p>
<strong>Synchronous call:</strong>
</p>
<p>
<span class="codefrag computeroutput">
public long addEntry(byte[] data)
throws InterruptedException
</span>
</p>
<p>
where:
</p>
<ul>
<li>
<p>
<span class="codefrag computeroutput">data</span> is a byte array;
</p>
</li>
</ul>
<p>
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);
</p>
<p>
<strong>Asynchronous call:</strong>
</p>
<p>
<span class="codefrag computeroutput">
public void asyncAddEntry(byte[] data, AddCallback cb, Object ctx)
</span>
</p>
<p>
It also takes a byte array as the sequence of bytes to be stored as an entry. Additionaly, 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
the <span class="codefrag computeroutput">AddCallback</span> interface in <span class="codefrag computeroutput">org.apache.bookkeeper.client.AsyncCallback</span>, and
a class implementing it has to implement a method called <span class="codefrag computeroutput">addComplete</span>
that has the following signature:
</p>
<p>
<span class="codefrag computeroutput">
void addComplete(int rc, LedgerHandle lh, long entryId, Object ctx);
</span>
</p>
<p>
where:
</p>
<ul>
<li>
<p>
<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);
</p>
</li>
<li>
<p>
<span class="codefrag computeroutput">lh</span> is a <span class="codefrag computeroutput">LedgerHandle</span> object to manipulate a ledger;
</p>
</li>
<li>
<p>
<span class="codefrag computeroutput">entryId</span> is the identifier of entry associated with this request;
</p>
</li>
<li>
<p>
<span class="codefrag computeroutput">ctx</span> is control object used for accountability purposes. It can be any object the application is happy with.
</p>
</li>
</ul>
<a name="bk_closeLedger"></a>
<h3 class="h4"> Closing a ledger. </h3>
<p>
Once a client is done writing, it closes the ledger. The following methods belong
to <span class="codefrag computeroutput">org.apache.bookkeeper.client.LedgerHandle</span>.
</p>
<p>
<strong>Synchronous close:</strong>
</p>
<p>
<span class="codefrag computeroutput">
public void close()
throws InterruptedException
</span>
</p>
<p>
It takes no input parameters.
</p>
<p>
<strong>Asynchronous close:</strong>
</p>
<p>
<span class="codefrag computeroutput">
public void asyncClose(CloseCallback cb, Object ctx)
throws InterruptedException
</span>
</p>
<p>
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
the <span class="codefrag computeroutput">CloseCallback</span> interface in <span class="codefrag computeroutput">org.apache.bookkeeper.client.AsyncCallback</span>, and
a class implementing it has to implement a method called <span class="codefrag computeroutput">closeComplete</span>
that has the following signature:
</p>
<p>
<span class="codefrag computeroutput">
void closeComplete(int rc, LedgerHandle lh, Object ctx)
</span>
</p>
<p>
where:
</p>
<ul>
<li>
<p>
<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);
</p>
</li>
<li>
<p>
<span class="codefrag computeroutput">lh</span> is a <span class="codefrag computeroutput">LedgerHandle</span> object to manipulate a ledger;
</p>
</li>
<li>
<p>
<span class="codefrag computeroutput">ctx</span> is control object used for accountability purposes.
</p>
</li>
</ul>
<a name="bk_openLedger"></a>
<h3 class="h4"> Opening a ledger. </h3>
<p>
To read from a ledger, a client must open it first. The following methods belong
to <span class="codefrag computeroutput">org.apache.bookkeeper.client.BookKeeper</span>.
</p>
<p>
<strong>Synchronous open:</strong>
</p>
<p>
<span class="codefrag computeroutput">
public LedgerHandle openLedger(long lId, DigestType type, byte passwd[])
throws InterruptedException, BKException
</span>
</p>
<ul>
<li>
<p>
<span class="codefrag computeroutput">ledgerId</span> is the ledger identifier;
</p>
</li>
<li>
<p>
<span class="codefrag computeroutput">type</span> is the type of digest used with entries: either MAC or CRC32.
</p>
</li>
<li>
<p>
<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);
</p>
</li>
</ul>
<p>
<strong>Asynchronous open:</strong>
</p>
<p>
<span class="codefrag computeroutput">
public void asyncOpenLedger(long lId, DigestType type, byte passwd[], OpenCallback cb, Object ctx)
</span>
</p>
<p>
It also takes a a ledger identifier and a password. Additionaly, 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
the <span class="codefrag computeroutput">OpenCallback</span> interface in <span class="codefrag computeroutput">org.apache.bookkeeper.client.AsyncCallback</span>, and
a class implementing it has to implement a method called <span class="codefrag computeroutput">openComplete</span>
that has the following signature:
</p>
<p>
<span class="codefrag computeroutput">
public void openComplete(int rc, LedgerHandle lh, Object ctx)
</span>
</p>
<p>
where:
</p>
<ul>
<li>
<p>
<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);
</p>
</li>
<li>
<p>
<span class="codefrag computeroutput">lh</span> is a <span class="codefrag computeroutput">LedgerHandle</span> object to manipulate a ledger;
</p>
</li>
<li>
<p>
<span class="codefrag computeroutput">ctx</span> is control object used for accountability purposes.
</p>
</li>
</ul>
<a name="bk_readLedger"></a>
<h3 class="h4"> Reading from ledger </h3>
<p>
Read calls may request one or more consecutive entries. The following methods belong
to <span class="codefrag computeroutput">org.apache.bookkeeper.client.LedgerHandle</span>.
</p>
<p>
<strong>Synchronous read:</strong>
</p>
<p>
<span class="codefrag computeroutput">
public Enumeration<LedgerEntry> readEntries(long firstEntry, long lastEntry)
throws InterruptedException, BKException
</span>
</p>
<ul>
<li>
<p>
<span class="codefrag computeroutput">firstEntry</span> is the identifier of the first entry in the sequence of entries to read;
</p>
</li>
<li>
<p>
<span class="codefrag computeroutput">lastEntry</span> is the identifier of the last entry in the sequence of entries to read.
</p>
</li>
</ul>
<p>
<strong>Asynchronous read:</strong>
</p>
<p>
<span class="codefrag computeroutput">
public void asyncReadEntries(long firstEntry,
long lastEntry, ReadCallback cb, Object ctx)
throws BKException, InterruptedException
</span>
</p>
<p>
It also takes a first and a last entry identifiers. Additionaly, 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
the <span class="codefrag computeroutput">ReadCallback</span> interface in <span class="codefrag computeroutput">org.apache.bookkeeper.client.AsyncCallback</span>, and
a class implementing it has to implement a method called <span class="codefrag computeroutput">readComplete</span>
that has the following signature:
</p>
<p>
<span class="codefrag computeroutput">
void readComplete(int rc, LedgerHandle lh, Enumeration<LedgerEntry> seq, Object ctx)
</span>
</p>
<p>
where:
</p>
<ul>
<li>
<p>
<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);
</p>
</li>
<li>
<p>
<span class="codefrag computeroutput">lh</span> is a <span class="codefrag computeroutput">LedgerHandle</span> object to manipulate a ledger;
</p>
</li>
<li>
<p>
<span class="codefrag computeroutput">seq</span> is a <span class="codefrag computeroutput">Enumeration<LedgerEntry> </span> object to containing the list of entries requested;
</p>
</li>
<li>
<p>
<span class="codefrag computeroutput">ctx</span> is control object used for accountability purposes.
</p>
</li>
</ul>
<a name="bk_deleteLedger"></a>
<h3 class="h4"> Deleting a ledger </h3>
<p>
Once a client is done with a ledger and is sure that nobody will ever need to read from it again, they can delete the ledger.
The following methods belong to <span class="codefrag computeroutput">org.apache.bookkeeper.client.BookKeeper</span>.
</p>
<p>
<strong>Synchronous delete:</strong>
</p>
<p>
<span class="codefrag computeroutput">
public void deleteLedger(long lId) throws InterruptedException, BKException
</span>
</p>
<ul>
<li>
<p>
<span class="codefrag computeroutput">lId</span> is the ledger identifier;
</p>
</li>