blob: 37cd579d79dfc181b40d2d68abc06af1fd101715 [file] [log] [blame]
Hono Bot650d39f2021-02-02 02:17:46 +00001<!DOCTYPE html>
2<html lang="1.6" class="js csstransforms3d">
3 <head>
4 <meta charset="utf-8">
5 <meta name="viewport" content="width=device-width, initial-scale=1.0">
Hono Botef930712021-04-08 01:12:09 +00006 <meta name="generator" content="Hugo 0.81.0" />
Hono Bot650d39f2021-02-02 02:17:46 +00007 <meta name="description" content="A set of micro-services for connecting millions of devices.">
8<meta name="author" content="The Eclipse Hono Project">
9
10 <link rel="apple-touch-icon" sizes="180x180" href="/hono/docs/favicon/apple-touch-icon.png">
11<link rel="icon" type="image/png" sizes="48x48" href="/hono/docs/favicon/favicon-48x48.png">
12<link rel="icon" type="image/png" sizes="32x32" href="/hono/docs/favicon/favicon-32x32.png">
13<link rel="icon" type="image/png" sizes="16x16" href="/hono/docs/favicon/favicon-16x16.png">
14<link rel="manifest" href="/hono/docs/favicon/site.webmanifest">
15<link rel="mask-icon" href="/hono/docs/favicon/safari-pinned-tab.svg" color="#5bbad5">
16<link rel="shortcut icon" href="/hono/docs/favicon/favicon.ico">
17<meta name="msapplication-TileColor" content="#da532c">
18<meta name="msapplication-config" content="/hono/docs/favicon/browserconfig.xml">
19<meta name="theme-color" content="#ffffff">
20
21 <title>Hono Kafka Client Configuration :: Eclipse Hono&trade; Vers.: 1.6</title>
22
23
Hono Botd107b6f2021-07-28 01:13:41 +000024 <link href="/hono/docs/css/nucleus.css?1627434790" rel="stylesheet">
25 <link href="/hono/docs/css/fontawesome-all.min.css?1627434790" rel="stylesheet">
26 <link href="/hono/docs/css/hybrid.css?1627434790" rel="stylesheet">
27 <link href="/hono/docs/css/featherlight.min.css?1627434790" rel="stylesheet">
28 <link href="/hono/docs/css/perfect-scrollbar.min.css?1627434790" rel="stylesheet">
29 <link href="/hono/docs/css/auto-complete.css?1627434790" rel="stylesheet">
30 <link href="/hono/docs/css/atom-one-dark-reasonable.css?1627434790" rel="stylesheet">
31 <link href="/hono/docs/css/theme.css?1627434790" rel="stylesheet">
32 <link href="/hono/docs/css/hugo-theme.css?1627434790" rel="stylesheet">
Hono Bot650d39f2021-02-02 02:17:46 +000033
Hono Botd107b6f2021-07-28 01:13:41 +000034 <link href="/hono/docs/css/theme-hono.css?1627434790" rel="stylesheet">
Hono Bot650d39f2021-02-02 02:17:46 +000035
Hono Botd107b6f2021-07-28 01:13:41 +000036 <link href="/hono/docs/css/hono.css?1627434790" rel="stylesheet">
Hono Bot650d39f2021-02-02 02:17:46 +000037
Hono Botd107b6f2021-07-28 01:13:41 +000038 <script src="/hono/docs/js/jquery-3.3.1.min.js?1627434790"></script>
Hono Bot650d39f2021-02-02 02:17:46 +000039
Hono Botbf26a122021-02-10 02:11:36 +000040 <style>
Hono Bot650d39f2021-02-02 02:17:46 +000041 :root #header + #content > #left > #rlblock_left{
42 display:none !important;
43 }
44
45 :not(pre) > code + span.copy-to-clipboard {
46 display: none;
47 }
48
49 </style>
50
Hono Bot650d39f2021-02-02 02:17:46 +000051<link rel="stylesheet" href="https://www.eclipse.org/eclipse.org-common/themes/solstice/public/stylesheets/vendor/cookieconsent/cookieconsent.min.css">
Hono Bot650d39f2021-02-02 02:17:46 +000052
53
54<meta name="twitter:card" content="summary_large_image">
55<meta name="twitter:site" content="@EclipseHono">
56<meta name="twitter:title" content="Hono Kafka Client Configuration :: Eclipse Hono&amp;trade; Vers.: 1.6">
57<meta name="twitter:image" content="https://www.eclipse.org/hono/docs/images/twitter_image.png">
58<meta name="twitter:description" content="A set of micro-services for connecting millions of devices.">
59
60
61<meta property="og:title" content="Hono Kafka Client Configuration :: Eclipse Hono&amp;trade; Vers.: 1.6" />
62<meta property="og:type" content="website" />
63<meta property="og:url" content="https://www.eclipse.org/hono/docs/1.6/admin-guide/hono-kafka-client-configuration//" />
64<meta property="og:image" content="https://www.eclipse.org/hono/docs/images/twitter_image.png" />
65
66 </head>
67 <body class="" data-url="/hono/docs/1.6/admin-guide/hono-kafka-client-configuration/">
68 <nav id="sidebar" class="">
69
70
71
72 <div id="header-wrapper">
73 <div id="header">
74 <a href="https://www.eclipse.org/hono/">
75 <img src="/hono/docs/images/HONO-Logo_Bild-Wort_quer-w-310x120px.svg" alt="Hono logo" class="logo-img">
76</a>
77
78 </div>
79
80 <div class="searchbox">
81 <label for="search-by"><i class="fas fa-search"></i></label>
82 <input data-search-input id="search-by" type="search" placeholder="Search...">
83 <span data-search-clear=""><i class="fas fa-times"></i></span>
84</div>
85
Hono Botd107b6f2021-07-28 01:13:41 +000086<script type="text/javascript" src="/hono/docs/js/lunr.min.js?1627434790"></script>
87<script type="text/javascript" src="/hono/docs/js/auto-complete.js?1627434790"></script>
Hono Bot650d39f2021-02-02 02:17:46 +000088<script type="text/javascript">
89
90 var baseurl = "https:\/\/www.eclipse.org\/hono\/docs\/\/1.6";
91
92</script>
Hono Botd107b6f2021-07-28 01:13:41 +000093<script type="text/javascript" src="/hono/docs/js/search.js?1627434790"></script>
Hono Bot650d39f2021-02-02 02:17:46 +000094
95
96 </div>
97
98 <div class="highlightable">
99 <ul class="topics">
100
101
102
103
104
105
Hono Botbf26a122021-02-10 02:11:36 +0000106
107
Hono Bot650d39f2021-02-02 02:17:46 +0000108
109
110
111 <li data-nav-id="/hono/docs/1.6/concepts/" title="Concepts" class="dd-item
112
113
114
115 ">
116 <a href="/hono/docs/1.6/concepts/">
117 <i class="far fa-lightbulb"></i> Concepts
118
119 </a>
120
121
122 <ul>
123
124
125
126
127
128
129
130
131
132
Hono Botbf26a122021-02-10 02:11:36 +0000133
134
Hono Bot650d39f2021-02-02 02:17:46 +0000135
136
137
138 <li data-nav-id="/hono/docs/1.6/concepts/device-identity/" title="Device Identity" class="dd-item ">
139 <a href="/hono/docs/1.6/concepts/device-identity/">
140 Device Identity
141
142 </a>
143 </li>
144
145
146
147
148
149
150
151
152
153
Hono Botbf26a122021-02-10 02:11:36 +0000154
155
Hono Bot650d39f2021-02-02 02:17:46 +0000156
157
158
159 <li data-nav-id="/hono/docs/1.6/concepts/tenancy/" title="Multi-Tenancy" class="dd-item ">
160 <a href="/hono/docs/1.6/concepts/tenancy/">
161 Multi-Tenancy
162
163 </a>
164 </li>
165
166
167
168
169
170
171
172
173
174
Hono Botbf26a122021-02-10 02:11:36 +0000175
176
Hono Bot650d39f2021-02-02 02:17:46 +0000177
178
179
180 <li data-nav-id="/hono/docs/1.6/concepts/device-provisioning/" title="Device Provisioning" class="dd-item ">
181 <a href="/hono/docs/1.6/concepts/device-provisioning/">
182 Device Provisioning
183
184 </a>
185 </li>
186
187
188
189
190
191
192
193
194
195
Hono Botbf26a122021-02-10 02:11:36 +0000196
197
Hono Bot650d39f2021-02-02 02:17:46 +0000198
199
200
201 <li data-nav-id="/hono/docs/1.6/concepts/connecting-devices/" title="Connecting Devices" class="dd-item ">
202 <a href="/hono/docs/1.6/concepts/connecting-devices/">
203 Connecting Devices
204
205 </a>
206 </li>
207
208
209
210
211
212
213
214
215
216
Hono Botbf26a122021-02-10 02:11:36 +0000217
218
Hono Bot650d39f2021-02-02 02:17:46 +0000219
220
221
222 <li data-nav-id="/hono/docs/1.6/concepts/device-notifications/" title="Device Notifications" class="dd-item ">
223 <a href="/hono/docs/1.6/concepts/device-notifications/">
224 Device Notifications
225
226 </a>
227 </li>
228
229
230
231
232
233
234
235
236
237
Hono Botbf26a122021-02-10 02:11:36 +0000238
239
Hono Bot650d39f2021-02-02 02:17:46 +0000240
241
242
243 <li data-nav-id="/hono/docs/1.6/concepts/command-and-control/" title="Command &amp; Control" class="dd-item ">
244 <a href="/hono/docs/1.6/concepts/command-and-control/">
245 Command &amp; Control
246
247 </a>
248 </li>
249
250
251
252
253
254
255
256
257
258
Hono Botbf26a122021-02-10 02:11:36 +0000259
260
Hono Bot650d39f2021-02-02 02:17:46 +0000261
262
263
264 <li data-nav-id="/hono/docs/1.6/concepts/resource-limits/" title="Resource limits" class="dd-item ">
265 <a href="/hono/docs/1.6/concepts/resource-limits/">
266 Resource limits
267
268 </a>
269 </li>
270
271
272
273
274
275
276
277
278
279
Hono Botbf26a122021-02-10 02:11:36 +0000280
281
Hono Bot650d39f2021-02-02 02:17:46 +0000282
283
284
285 <li data-nav-id="/hono/docs/1.6/concepts/connection-events/" title="Connection Events" class="dd-item ">
286 <a href="/hono/docs/1.6/concepts/connection-events/">
287 Connection Events
288
289 </a>
290 </li>
291
292
293
294
295
296
297
298 </ul>
Hono Botbf26a122021-02-10 02:11:36 +0000299
Hono Bot650d39f2021-02-02 02:17:46 +0000300 </li>
301
302
303
304
305
306
307
Hono Botbf26a122021-02-10 02:11:36 +0000308
309
Hono Bot650d39f2021-02-02 02:17:46 +0000310
311
312
313 <li data-nav-id="/hono/docs/1.6/user-guide/" title="User Guide" class="dd-item
314
315
316
317 ">
318 <a href="/hono/docs/1.6/user-guide/">
319 <i class="fas fa-book-reader"></i> User Guide
320
321 </a>
322
323
324 <ul>
325
326
327
328
329
330
331
332
333
334
Hono Botbf26a122021-02-10 02:11:36 +0000335
336
Hono Bot650d39f2021-02-02 02:17:46 +0000337
338
339
340 <li data-nav-id="/hono/docs/1.6/user-guide/mongodb-based-device-registry/" title="MongoDB Based Device Registry" class="dd-item ">
341 <a href="/hono/docs/1.6/user-guide/mongodb-based-device-registry/">
342 MongoDB Based Device Registry
343
344 </a>
345 </li>
346
347
348
349
350
351
352
353
354
355
Hono Botbf26a122021-02-10 02:11:36 +0000356
357
Hono Bot650d39f2021-02-02 02:17:46 +0000358
359
360
361 <li data-nav-id="/hono/docs/1.6/user-guide/jdbc-based-device-registry/" title="JDBC Based Device Registry" class="dd-item ">
362 <a href="/hono/docs/1.6/user-guide/jdbc-based-device-registry/">
363 JDBC Based Device Registry
364
365 </a>
366 </li>
367
368
369
370
371
372
373
374
375
376
Hono Botbf26a122021-02-10 02:11:36 +0000377
378
Hono Bot650d39f2021-02-02 02:17:46 +0000379
380
381
382 <li data-nav-id="/hono/docs/1.6/user-guide/file-based-device-registry/" title="File Based Device Registry" class="dd-item ">
383 <a href="/hono/docs/1.6/user-guide/file-based-device-registry/">
384 File Based Device Registry
385
386 </a>
387 </li>
388
389
390
391
392
393
394
395
396
397
Hono Botbf26a122021-02-10 02:11:36 +0000398
399
Hono Bot650d39f2021-02-02 02:17:46 +0000400
401
402
403 <li data-nav-id="/hono/docs/1.6/user-guide/http-adapter/" title="HTTP Adapter" class="dd-item ">
404 <a href="/hono/docs/1.6/user-guide/http-adapter/">
405 HTTP Adapter
406
407 </a>
408 </li>
409
410
411
412
413
414
415
416
417
418
Hono Botbf26a122021-02-10 02:11:36 +0000419
420
Hono Bot650d39f2021-02-02 02:17:46 +0000421
422
423
424 <li data-nav-id="/hono/docs/1.6/user-guide/mqtt-adapter/" title="MQTT Adapter" class="dd-item ">
425 <a href="/hono/docs/1.6/user-guide/mqtt-adapter/">
426 MQTT Adapter
427
428 </a>
429 </li>
430
431
432
433
434
435
436
437
438
439
Hono Botbf26a122021-02-10 02:11:36 +0000440
441
Hono Bot650d39f2021-02-02 02:17:46 +0000442
443
444
445 <li data-nav-id="/hono/docs/1.6/user-guide/amqp-adapter/" title="AMQP Adapter" class="dd-item ">
446 <a href="/hono/docs/1.6/user-guide/amqp-adapter/">
447 AMQP Adapter
448
449 </a>
450 </li>
451
452
453
454
455
456
457
458
459
460
Hono Botbf26a122021-02-10 02:11:36 +0000461
462
Hono Bot650d39f2021-02-02 02:17:46 +0000463
464
465
466 <li data-nav-id="/hono/docs/1.6/user-guide/coap-adapter/" title="CoAP Adapter" class="dd-item ">
467 <a href="/hono/docs/1.6/user-guide/coap-adapter/">
468 CoAP Adapter
469
470 </a>
471 </li>
472
473
474
475
476
477
478
479
480
481
Hono Botbf26a122021-02-10 02:11:36 +0000482
483
Hono Bot650d39f2021-02-02 02:17:46 +0000484
485
486
487 <li data-nav-id="/hono/docs/1.6/user-guide/kura-adapter/" title="Kura Adapter" class="dd-item ">
488 <a href="/hono/docs/1.6/user-guide/kura-adapter/">
489 Kura Adapter
490
491 </a>
492 </li>
493
494
495
496
497
498
499
500
501
502
Hono Botbf26a122021-02-10 02:11:36 +0000503
504
Hono Bot650d39f2021-02-02 02:17:46 +0000505
506
507
508 <li data-nav-id="/hono/docs/1.6/user-guide/sigfox-adapter/" title="Sigfox Adapter" class="dd-item ">
509 <a href="/hono/docs/1.6/user-guide/sigfox-adapter/">
510 Sigfox Adapter
511
512 </a>
513 </li>
514
515
516
517
518
519
520
521
522
523
524 </ul>
Hono Botbf26a122021-02-10 02:11:36 +0000525
Hono Bot650d39f2021-02-02 02:17:46 +0000526 </li>
527
528
529
530
531
532
533
Hono Botbf26a122021-02-10 02:11:36 +0000534
535
Hono Bot650d39f2021-02-02 02:17:46 +0000536
537
538
539 <li data-nav-id="/hono/docs/1.6/admin-guide/" title="Admin Guide" class="dd-item
540 parent
541
542
543 ">
544 <a href="/hono/docs/1.6/admin-guide/">
545 <i class="fas fa-sliders-h"></i> Admin Guide
546
547 </a>
548
549
550 <ul>
551
552
553
554
555
556
557
558
559
560
Hono Botbf26a122021-02-10 02:11:36 +0000561
562
Hono Bot650d39f2021-02-02 02:17:46 +0000563
564
565
566 <li data-nav-id="/hono/docs/1.6/admin-guide/common-config/" title="Common Configuration" class="dd-item ">
567 <a href="/hono/docs/1.6/admin-guide/common-config/">
568 Common Configuration
569
570 </a>
571 </li>
572
573
574
575
576
577
578
579
580
581
Hono Botbf26a122021-02-10 02:11:36 +0000582
583
Hono Bot650d39f2021-02-02 02:17:46 +0000584
585
586
587 <li data-nav-id="/hono/docs/1.6/admin-guide/auth-server-config/" title="Auth Server Configuration" class="dd-item ">
588 <a href="/hono/docs/1.6/admin-guide/auth-server-config/">
589 Auth Server Configuration
590
591 </a>
592 </li>
593
594
595
596
597
598
599
600
601
602
Hono Botbf26a122021-02-10 02:11:36 +0000603
604
Hono Bot650d39f2021-02-02 02:17:46 +0000605
606
607
608 <li data-nav-id="/hono/docs/1.6/admin-guide/mongodb-device-registry-config/" title="MongoDB Based Device Registry Configuration" class="dd-item ">
609 <a href="/hono/docs/1.6/admin-guide/mongodb-device-registry-config/">
610 MongoDB Based Device Registry Configuration
611
612 </a>
613 </li>
614
615
616
617
618
619
620
621
622
623
Hono Botbf26a122021-02-10 02:11:36 +0000624
625
Hono Bot650d39f2021-02-02 02:17:46 +0000626
627
628
629 <li data-nav-id="/hono/docs/1.6/admin-guide/jdbc-device-registry-config/" title="JDBC Based Device Registry Configuration" class="dd-item ">
630 <a href="/hono/docs/1.6/admin-guide/jdbc-device-registry-config/">
631 JDBC Based Device Registry Configuration
632
633 </a>
634 </li>
635
636
637
638
639
640
641
642
643
644
Hono Botbf26a122021-02-10 02:11:36 +0000645
646
Hono Bot650d39f2021-02-02 02:17:46 +0000647
648
649
650 <li data-nav-id="/hono/docs/1.6/admin-guide/file-based-device-registry-config/" title="File Based Device Registry Configuration" class="dd-item ">
651 <a href="/hono/docs/1.6/admin-guide/file-based-device-registry-config/">
652 File Based Device Registry Configuration
653
654 </a>
655 </li>
656
657
658
659
660
661
662
663
664
665
Hono Botbf26a122021-02-10 02:11:36 +0000666
667
Hono Bot650d39f2021-02-02 02:17:46 +0000668
669
670
671 <li data-nav-id="/hono/docs/1.6/admin-guide/command-router-config/" title="Configuring the Command Router Service" class="dd-item ">
672 <a href="/hono/docs/1.6/admin-guide/command-router-config/">
673 Command Router Service Configuration
674
675 </a>
676 </li>
677
678
679
680
681
682
683
684
685
686
Hono Botbf26a122021-02-10 02:11:36 +0000687
688
Hono Bot650d39f2021-02-02 02:17:46 +0000689
690
691
692 <li data-nav-id="/hono/docs/1.6/admin-guide/device-connection-config/" title="Configuring the Device Connection Service" class="dd-item ">
693 <a href="/hono/docs/1.6/admin-guide/device-connection-config/">
694 Device Connection Service Configuration
695
696 </a>
697 </li>
698
699
700
701
702
703
704
705
706
707
Hono Botbf26a122021-02-10 02:11:36 +0000708
709
Hono Bot650d39f2021-02-02 02:17:46 +0000710
711
712
713 <li data-nav-id="/hono/docs/1.6/admin-guide/http-adapter-config/" title="HTTP Adapter Configuration" class="dd-item ">
714 <a href="/hono/docs/1.6/admin-guide/http-adapter-config/">
715 HTTP Adapter Configuration
716
717 </a>
718 </li>
719
720
721
722
723
724
725
726
727
728
Hono Botbf26a122021-02-10 02:11:36 +0000729
730
Hono Bot650d39f2021-02-02 02:17:46 +0000731
732
733
734 <li data-nav-id="/hono/docs/1.6/admin-guide/mqtt-adapter-config/" title="MQTT Adapter Configuration" class="dd-item ">
735 <a href="/hono/docs/1.6/admin-guide/mqtt-adapter-config/">
736 MQTT Adapter Configuration
737
738 </a>
739 </li>
740
741
742
743
744
745
746
747
748
749
Hono Botbf26a122021-02-10 02:11:36 +0000750
751
Hono Bot650d39f2021-02-02 02:17:46 +0000752
753
754
755 <li data-nav-id="/hono/docs/1.6/admin-guide/amqp-adapter-config/" title="AMQP Adapter Configuration" class="dd-item ">
756 <a href="/hono/docs/1.6/admin-guide/amqp-adapter-config/">
757 AMQP Adapter Configuration
758
759 </a>
760 </li>
761
762
763
764
765
766
767
768
769
770
Hono Botbf26a122021-02-10 02:11:36 +0000771
772
Hono Bot650d39f2021-02-02 02:17:46 +0000773
774
775
776 <li data-nav-id="/hono/docs/1.6/admin-guide/coap-adapter-config/" title="CoAP Adapter Configuration" class="dd-item ">
777 <a href="/hono/docs/1.6/admin-guide/coap-adapter-config/">
778 CoAP Adapter Configuration
779
780 </a>
781 </li>
782
783
784
785
786
787
788
789
790
791
Hono Botbf26a122021-02-10 02:11:36 +0000792
793
Hono Bot650d39f2021-02-02 02:17:46 +0000794
795
796
797 <li data-nav-id="/hono/docs/1.6/admin-guide/kura-adapter-config/" title="Kura Adapter Configuration" class="dd-item ">
798 <a href="/hono/docs/1.6/admin-guide/kura-adapter-config/">
799 Kura Adapter Configuration
800
801 </a>
802 </li>
803
804
805
806
807
808
809
810
811
812
Hono Botbf26a122021-02-10 02:11:36 +0000813
814
Hono Bot650d39f2021-02-02 02:17:46 +0000815
816
817
818 <li data-nav-id="/hono/docs/1.6/admin-guide/hono-client-configuration/" title="Hono Client Configuration" class="dd-item ">
819 <a href="/hono/docs/1.6/admin-guide/hono-client-configuration/">
820 Hono Client Configuration
821
822 </a>
823 </li>
824
825
826
827
828
829
830
831
832
833
Hono Botbf26a122021-02-10 02:11:36 +0000834
835
Hono Bot650d39f2021-02-02 02:17:46 +0000836
837
838
839 <li data-nav-id="/hono/docs/1.6/admin-guide/hono-kafka-client-configuration/" title="Hono Kafka Client Configuration" class="dd-item active">
840 <a href="/hono/docs/1.6/admin-guide/hono-kafka-client-configuration/">
841 Hono Kafka Client Configuration
842
843 </a>
844 </li>
845
846
847
848
849
850
851
852
853
854
Hono Botbf26a122021-02-10 02:11:36 +0000855
856
Hono Bot650d39f2021-02-02 02:17:46 +0000857
858
859
860 <li data-nav-id="/hono/docs/1.6/admin-guide/amqp-network-config/" title="AMQP 1.0 Messaging Network Configuration" class="dd-item ">
861 <a href="/hono/docs/1.6/admin-guide/amqp-network-config/">
862 AMQP 1.0 Messaging Network Configuration
863
864 </a>
865 </li>
866
867
868
869
870
871
872
873
874
875
Hono Botbf26a122021-02-10 02:11:36 +0000876
877
Hono Bot650d39f2021-02-02 02:17:46 +0000878
879
880
881 <li data-nav-id="/hono/docs/1.6/admin-guide/secure_communication/" title="Secure Communication" class="dd-item ">
882 <a href="/hono/docs/1.6/admin-guide/secure_communication/">
883 Secure Communication
884
885 </a>
886 </li>
887
888
889
890
891
892
893
894
895
896
Hono Botbf26a122021-02-10 02:11:36 +0000897
898
Hono Bot650d39f2021-02-02 02:17:46 +0000899
900
901
902 <li data-nav-id="/hono/docs/1.6/admin-guide/monitoring-tracing-config/" title="Monitoring &amp; Tracing" class="dd-item ">
903 <a href="/hono/docs/1.6/admin-guide/monitoring-tracing-config/">
904 Monitoring &amp; Tracing
905
906 </a>
907 </li>
908
909
910
911
912
913
914
915
916
917
918 </ul>
Hono Botbf26a122021-02-10 02:11:36 +0000919
Hono Bot650d39f2021-02-02 02:17:46 +0000920 </li>
921
922
923
924
925
926
927
Hono Botbf26a122021-02-10 02:11:36 +0000928
929
Hono Bot650d39f2021-02-02 02:17:46 +0000930
931
932
933 <li data-nav-id="/hono/docs/1.6/dev-guide/" title="Developer Guide" class="dd-item
934
935
936
937 ">
938 <a href="/hono/docs/1.6/dev-guide/">
939 <i class="fas fa-tools"></i> Developer Guide
940
941 </a>
942
943
944 <ul>
945
946
947
948
949
950
951
952
953
954
Hono Botbf26a122021-02-10 02:11:36 +0000955
956
Hono Bot650d39f2021-02-02 02:17:46 +0000957
958
959
960 <li data-nav-id="/hono/docs/1.6/dev-guide/building_hono/" title="Building from Source" class="dd-item ">
961 <a href="/hono/docs/1.6/dev-guide/building_hono/">
962 Building from Source
963
964 </a>
965 </li>
966
967
968
969
970
971
972
973
974
975
Hono Botbf26a122021-02-10 02:11:36 +0000976
977
Hono Bot650d39f2021-02-02 02:17:46 +0000978
979
980
981 <li data-nav-id="/hono/docs/1.6/dev-guide/amqp_adapter_client/" title="AMQP Adapter Client for Java" class="dd-item ">
982 <a href="/hono/docs/1.6/dev-guide/amqp_adapter_client/">
983 AMQP Adapter Client for Java
984
985 </a>
986 </li>
987
988
989
990
991
992
993
994
995
996
Hono Botbf26a122021-02-10 02:11:36 +0000997
998
Hono Bot650d39f2021-02-02 02:17:46 +0000999
1000
1001
1002 <li data-nav-id="/hono/docs/1.6/dev-guide/java_client_consumer/" title="Consuming Messages from Java" class="dd-item ">
1003 <a href="/hono/docs/1.6/dev-guide/java_client_consumer/">
1004 Consuming Messages from Java
1005
1006 </a>
1007 </li>
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
Hono Botbf26a122021-02-10 02:11:36 +00001018
1019
Hono Bot650d39f2021-02-02 02:17:46 +00001020
1021
1022
1023 <li data-nav-id="/hono/docs/1.6/dev-guide/custom_http_adapter/" title="Implement a Custom Hono HTTP Protocol Adapter" class="dd-item ">
1024 <a href="/hono/docs/1.6/dev-guide/custom_http_adapter/">
1025 Implement a Custom Hono HTTP Protocol Adapter
1026
1027 </a>
1028 </li>
1029
1030
1031
1032
1033
1034
1035
1036 </ul>
Hono Botbf26a122021-02-10 02:11:36 +00001037
Hono Bot650d39f2021-02-02 02:17:46 +00001038 </li>
1039
1040
1041
1042
1043
1044
1045
Hono Botbf26a122021-02-10 02:11:36 +00001046
1047
Hono Bot650d39f2021-02-02 02:17:46 +00001048
1049
1050
1051 <li data-nav-id="/hono/docs/1.6/api/" title="API" class="dd-item
1052
1053
1054
1055 ">
1056 <a href="/hono/docs/1.6/api/">
1057 &nbsp;<i class='fas fa-plug'></i>&nbsp;API
1058
1059 </a>
1060
1061
1062 <ul>
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
Hono Botbf26a122021-02-10 02:11:36 +00001073
1074
Hono Bot650d39f2021-02-02 02:17:46 +00001075
1076
1077
1078 <li data-nav-id="/hono/docs/1.6/api/telemetry/" title="Telemetry API Specification" class="dd-item ">
1079 <a href="/hono/docs/1.6/api/telemetry/">
1080 Telemetry API
1081
1082 </a>
1083 </li>
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
Hono Botbf26a122021-02-10 02:11:36 +00001094
1095
Hono Bot650d39f2021-02-02 02:17:46 +00001096
1097
1098
1099 <li data-nav-id="/hono/docs/1.6/api/event/" title="Event API Specification" class="dd-item ">
1100 <a href="/hono/docs/1.6/api/event/">
1101 Event API
1102
1103 </a>
1104 </li>
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
Hono Botbf26a122021-02-10 02:11:36 +00001115
1116
Hono Bot650d39f2021-02-02 02:17:46 +00001117
1118
1119
1120 <li data-nav-id="/hono/docs/1.6/api/command-and-control/" title="Command &amp; Control API Specification" class="dd-item ">
1121 <a href="/hono/docs/1.6/api/command-and-control/">
1122 Command &amp; Control API
1123
1124 </a>
1125 </li>
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
Hono Botbf26a122021-02-10 02:11:36 +00001136
1137
Hono Bot650d39f2021-02-02 02:17:46 +00001138
1139
1140
1141 <li data-nav-id="/hono/docs/1.6/api/kafka-api/" title="Kafka-based APIs" class="dd-item ">
1142 <a href="/hono/docs/1.6/api/kafka-api/">
1143 Kafka-based APIs
1144
1145 </a>
1146 </li>
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
Hono Botbf26a122021-02-10 02:11:36 +00001157
1158
Hono Bot650d39f2021-02-02 02:17:46 +00001159
1160
1161
1162 <li data-nav-id="/hono/docs/1.6/api/telemetry-kafka/" title="Telemetry API for Kafka Specification" class="dd-item ">
1163 <a href="/hono/docs/1.6/api/telemetry-kafka/">
1164 Telemetry API for Kafka
1165
1166 </a>
1167 </li>
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
Hono Botbf26a122021-02-10 02:11:36 +00001178
1179
Hono Bot650d39f2021-02-02 02:17:46 +00001180
1181
1182
1183 <li data-nav-id="/hono/docs/1.6/api/event-kafka/" title="Event API for Kafka Specification" class="dd-item ">
1184 <a href="/hono/docs/1.6/api/event-kafka/">
1185 Event API for Kafka
1186
1187 </a>
1188 </li>
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
Hono Botbf26a122021-02-10 02:11:36 +00001202
1203
Hono Bot650d39f2021-02-02 02:17:46 +00001204
1205
1206
1207 <li data-nav-id="/hono/docs/1.6/api/tenant/" title="Tenant API Specification" class="dd-item ">
1208 <a href="/hono/docs/1.6/api/tenant/">
1209 Tenant API
1210
1211 </a>
1212 </li>
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
Hono Botbf26a122021-02-10 02:11:36 +00001223
1224
Hono Bot650d39f2021-02-02 02:17:46 +00001225
1226
1227
1228 <li data-nav-id="/hono/docs/1.6/api/command-router/" title="Command Router API Specification" class="dd-item ">
1229 <a href="/hono/docs/1.6/api/command-router/">
1230 Command Router API
1231
1232 </a>
1233 </li>
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
Hono Botbf26a122021-02-10 02:11:36 +00001244
1245
Hono Bot650d39f2021-02-02 02:17:46 +00001246
1247
1248
1249 <li data-nav-id="/hono/docs/1.6/api/device-connection/" title="Device Connection API Specification" class="dd-item ">
1250 <a href="/hono/docs/1.6/api/device-connection/">
1251 Device Connection API
1252
1253 </a>
1254 </li>
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
Hono Botbf26a122021-02-10 02:11:36 +00001265
1266
Hono Bot650d39f2021-02-02 02:17:46 +00001267
1268
1269
1270 <li data-nav-id="/hono/docs/1.6/api/device-registration/" title="Device Registration API Specification" class="dd-item ">
1271 <a href="/hono/docs/1.6/api/device-registration/">
1272 Device Registration API
1273
1274 </a>
1275 </li>
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
Hono Botbf26a122021-02-10 02:11:36 +00001286
1287
Hono Bot650d39f2021-02-02 02:17:46 +00001288
1289
1290
1291 <li data-nav-id="/hono/docs/1.6/api/credentials/" title="Credentials API Specification" class="dd-item ">
1292 <a href="/hono/docs/1.6/api/credentials/">
1293 Credentials API
1294
1295 </a>
1296 </li>
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
Hono Botbf26a122021-02-10 02:11:36 +00001307
1308
Hono Bot650d39f2021-02-02 02:17:46 +00001309
1310
1311
1312 <li data-nav-id="/hono/docs/1.6/api/authentication/" title="Authentication API Specification" class="dd-item ">
1313 <a href="/hono/docs/1.6/api/authentication/">
1314 Authentication API
1315
1316 </a>
1317 </li>
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
Hono Botbf26a122021-02-10 02:11:36 +00001328
1329
Hono Bot650d39f2021-02-02 02:17:46 +00001330
1331
1332
1333 <li data-nav-id="/hono/docs/1.6/api/management/" title="Device Registry Management API Specification" class="dd-item ">
1334 <a href="/hono/docs/1.6/api/management/">
1335 Device Registry Management API
1336
1337 </a>
1338 </li>
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
Hono Botbf26a122021-02-10 02:11:36 +00001349
1350
Hono Bot650d39f2021-02-02 02:17:46 +00001351
1352
1353
1354 <li data-nav-id="/hono/docs/1.6/api/metrics/" title="Metrics" class="dd-item ">
1355 <a href="/hono/docs/1.6/api/metrics/">
1356 Metrics
1357
1358 </a>
1359 </li>
1360
1361
1362
1363
1364
1365
1366
1367 </ul>
Hono Botbf26a122021-02-10 02:11:36 +00001368
Hono Bot650d39f2021-02-02 02:17:46 +00001369 </li>
1370
1371
1372
1373
1374
1375
1376
Hono Botbf26a122021-02-10 02:11:36 +00001377
1378
Hono Bot650d39f2021-02-02 02:17:46 +00001379
1380
1381
1382 <li data-nav-id="/hono/docs/1.6/deployment/" title="Deployment" class="dd-item
1383
1384
1385
1386 ">
1387 <a href="/hono/docs/1.6/deployment/">
1388 <i class="fas fa-shipping-fast"></i> Deployment
1389
1390 </a>
1391
1392
1393 <ul>
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
Hono Botbf26a122021-02-10 02:11:36 +00001404
1405
Hono Bot650d39f2021-02-02 02:17:46 +00001406
1407
1408
1409 <li data-nav-id="/hono/docs/1.6/deployment/helm-based-deployment/" title="Helm based Deployment" class="dd-item ">
1410 <a href="/hono/docs/1.6/deployment/helm-based-deployment/">
1411 Helm based Deployment
1412
1413 </a>
1414 </li>
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
Hono Botbf26a122021-02-10 02:11:36 +00001425
1426
Hono Bot650d39f2021-02-02 02:17:46 +00001427
1428
1429
1430 <li data-nav-id="/hono/docs/1.6/deployment/openshift/" title="OpenShift / OKD" class="dd-item ">
1431 <a href="/hono/docs/1.6/deployment/openshift/">
1432 OpenShift / OKD
1433
1434 </a>
1435 </li>
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
Hono Botbf26a122021-02-10 02:11:36 +00001446
1447
Hono Bot650d39f2021-02-02 02:17:46 +00001448
1449
1450
1451 <li data-nav-id="/hono/docs/1.6/deployment/create-kubernetes-cluster/" title="Setting up a Kubernetes Cluster" class="dd-item ">
1452 <a href="/hono/docs/1.6/deployment/create-kubernetes-cluster/">
1453 Setting up a Kubernetes Cluster
1454
1455 </a>
1456 </li>
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
Hono Botbf26a122021-02-10 02:11:36 +00001467
1468
Hono Bot650d39f2021-02-02 02:17:46 +00001469
1470
1471
1472 <li data-nav-id="/hono/docs/1.6/deployment/resource-limitation/" title="Limiting Resource Usage" class="dd-item ">
1473 <a href="/hono/docs/1.6/deployment/resource-limitation/">
1474 Limiting Resource Usage
1475
1476 </a>
1477 </li>
1478
1479
1480
1481
1482
1483
1484
1485 </ul>
Hono Botbf26a122021-02-10 02:11:36 +00001486
Hono Bot650d39f2021-02-02 02:17:46 +00001487 </li>
1488
1489
1490
1491
1492
1493
1494
Hono Botbf26a122021-02-10 02:11:36 +00001495
1496
Hono Bot650d39f2021-02-02 02:17:46 +00001497
1498
1499
1500 <li data-nav-id="/hono/docs/1.6/architecture/" title="Architecture" class="dd-item
1501
1502
1503
1504 ">
1505 <a href="/hono/docs/1.6/architecture/">
1506 <i class="fas fa-landmark"></i> Architecture
1507
1508 </a>
1509
1510
1511 <ul>
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
Hono Botbf26a122021-02-10 02:11:36 +00001522
1523
Hono Bot650d39f2021-02-02 02:17:46 +00001524
1525
1526
1527 <li data-nav-id="/hono/docs/1.6/architecture/component-view/" title="Component View" class="dd-item ">
1528 <a href="/hono/docs/1.6/architecture/component-view/">
1529 Component View
1530
1531 </a>
1532 </li>
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
Hono Botbf26a122021-02-10 02:11:36 +00001543
1544
Hono Bot650d39f2021-02-02 02:17:46 +00001545
1546
1547
1548 <li data-nav-id="/hono/docs/1.6/architecture/auth/" title="Authentication/Authorization" class="dd-item ">
1549 <a href="/hono/docs/1.6/architecture/auth/">
1550 Authentication/Authorization
1551
1552 </a>
1553 </li>
1554
1555
1556
1557
1558
1559
1560
1561 </ul>
Hono Botbf26a122021-02-10 02:11:36 +00001562
Hono Bot650d39f2021-02-02 02:17:46 +00001563 </li>
1564
1565
1566
1567
1568
1569 </ul>
1570
1571
1572
1573 <section id="shortcuts">
1574 <h3></h3>
1575 <ul>
1576
1577 <li>
1578 <a class="padding" href="https://www.eclipse.org/hono/" title="Hono&#39;s Homepage"><i class='fas fa-home'></i> Hono Home</a>
1579 </li>
1580
1581 <li>
1582 <a class="padding" href="https://www.eclipse.org/hono/getting-started/" title="Getting started with Eclipse Hono"><i class='fas fa-plane-departure'></i> Getting Started</a>
1583 </li>
1584
1585 </ul>
1586 </section>
1587
1588
1589
1590 <section id="prefooter">
1591 <hr/>
1592 <ul>
1593
1594 <li>
1595 <div id="select-box-wrapper">
1596 <div id="select-box">
1597 <a class="padding">
1598 Version:&nbsp;
1599 <div class="select-style">
1600 <select id="select-language" onchange="location = this.value;">
1601
1602
1603
1604
1605
1606
1607
1608
Hono Bot8fa7d952021-07-14 01:12:12 +00001609 <option id="stable" value="https://www.eclipse.org/hono/docs/admin-guide/hono-kafka-client-configuration/">stable (1.9)</option>
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643 <option id="1.9" value="https://www.eclipse.org/hono/docs/1.9/admin-guide/hono-kafka-client-configuration/">1.9</option>
Hono Bot1f51cfc2021-05-21 01:12:32 +00001644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
Hono Bot8fa7d952021-07-14 01:12:12 +00001673
1674
Hono Bot1f51cfc2021-05-21 01:12:32 +00001675
1676
1677 <option id="1.8" value="https://www.eclipse.org/hono/docs/1.8/admin-guide/hono-kafka-client-configuration/">1.8</option>
Hono Botef930712021-04-08 01:12:09 +00001678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
Hono Bot1f51cfc2021-05-21 01:12:32 +00001705
1706
Hono Bot8fa7d952021-07-14 01:12:12 +00001707
1708
Hono Botef930712021-04-08 01:12:09 +00001709
1710
1711 <option id="1.7" value="https://www.eclipse.org/hono/docs/1.7/admin-guide/hono-kafka-client-configuration/">1.7</option>
Hono Bot650d39f2021-02-02 02:17:46 +00001712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
Hono Botef930712021-04-08 01:12:09 +00001737
1738
Hono Bot1f51cfc2021-05-21 01:12:32 +00001739
1740
Hono Bot8fa7d952021-07-14 01:12:12 +00001741
1742
Hono Bot650d39f2021-02-02 02:17:46 +00001743
1744
Hono Botbf26a122021-02-10 02:11:36 +00001745 <option id="1.6" value="https://www.eclipse.org/hono/docs/1.6/admin-guide/hono-kafka-client-configuration/" selected>1.6</option>
Hono Bot650d39f2021-02-02 02:17:46 +00001746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
Hono Botef930712021-04-08 01:12:09 +00001783
1784
Hono Bot1f51cfc2021-05-21 01:12:32 +00001785
1786
Hono Bot8fa7d952021-07-14 01:12:12 +00001787
1788
Hono Bot650d39f2021-02-02 02:17:46 +00001789
1790
Hono Botbf26a122021-02-10 02:11:36 +00001791 <option id="dev" value="https://www.eclipse.org/hono/docs/dev/admin-guide/hono-kafka-client-configuration/">dev</option>
Hono Bot650d39f2021-02-02 02:17:46 +00001792
1793
1794
1795
1796 </select>
1797 <svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
1798 width="255px" height="255px" viewBox="0 0 255 255" style="enable-background:new 0 0 255 255;" xml:space="preserve">
1799 <g>
1800 <g id="arrow-drop-down">
1801 <polygon points="0,63.75 127.5,191.25 255,63.75 " />
1802 </g>
1803 </g>
1804 </svg>
1805 </div>
1806 </a>
1807 </div>
1808 </div>
1809 </li>
1810
1811
1812
1813 </ul>
1814 </section>
1815
1816 <section id="footer">
1817
1818
1819<p>&copy; 2021 <a href="https://www.eclipse.org/hono/">The Eclipse Hono Project</a></p>
1820
1821<p>
1822 Documentation built with
1823 <a href="https://gohugo.io/" target="_blank">Hugo</a>
1824 using the
1825 <a href="https://github.com/matcornic/hugo-theme-learn" target="_blank">Learn</a> theme.
1826</p>
1827
1828<div class="eclipse-logo">
1829 <a href="https://www.eclipse.org" target="_blank">
1830 <img src="https://www.eclipse.org/hono/docs/images/eclipse_foundation_logo.svg"/>
1831 </a>
1832</div>
1833
1834 </section>
1835 </div>
1836</nav>
1837
1838
1839
1840
Hono Bot650d39f2021-02-02 02:17:46 +00001841 <section id="body">
1842 <div id="overlay"></div>
Hono Botbf26a122021-02-10 02:11:36 +00001843
Hono Bot650d39f2021-02-02 02:17:46 +00001844
Hono Botef930712021-04-08 01:12:09 +00001845 <div class="old-version-hint">
1846 <p>This page refers to version <em>1.6</em>.
1847 You might want to use the <a href="https://www.eclipse.org/hono/docs/">current stable</a> version.
1848 </p>
1849 </div>
1850
Hono Bot650d39f2021-02-02 02:17:46 +00001851
Hono Botbf26a122021-02-10 02:11:36 +00001852
Hono Bot650d39f2021-02-02 02:17:46 +00001853 <div class="padding highlightable">
1854
1855 <div>
1856 <div id="top-bar">
1857
1858
1859
1860
1861 <div id="top-github-link">
1862 <a class="github-link" title='Edit this page' href="https://github.com/eclipse/hono/edit/master/site/documentation/content/admin-guide/hono-kafka-client-configuration.md" target="blank">
1863 <i class="fas fa-code-branch"></i>
1864 <span id="top-github-link-text">Edit this page</span>
1865 </a>
1866 </div>
1867
1868
1869
1870 <div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
1871 <span id="sidebar-toggle-span">
1872 <a href="#" id="sidebar-toggle" data-sidebar-toggle="">
1873 <i class="fas fa-bars"></i>
1874 </a>
1875 </span>
1876
1877 <span id="toc-menu"><i class="fas fa-list-alt"></i></span>
1878
1879 <span class="links">
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893 <a href='/hono/docs/1.6/'>Documentation</a> > <a href='/hono/docs/1.6/admin-guide/'>Admin Guide</a> > Hono Kafka Client Configuration
1894
Hono Botbf26a122021-02-10 02:11:36 +00001895
Hono Bot650d39f2021-02-02 02:17:46 +00001896
Hono Botbf26a122021-02-10 02:11:36 +00001897
Hono Bot650d39f2021-02-02 02:17:46 +00001898
1899
1900
1901 </span>
1902 </div>
1903
1904 <div class="progress">
1905 <div class="wrapper">
1906<nav id="TableOfContents">
Hono Botef930712021-04-08 01:12:09 +00001907 <ul>
1908 <li><a href="#producer-configuration-properties">Producer Configuration Properties</a>
1909 <ul>
1910 <li><a href="#using-tls">Using TLS</a></li>
1911 </ul>
1912 </li>
1913 <li><a href="#consumer-configuration-properties">Consumer Configuration Properties</a>
1914 <ul>
1915 <li><a href="#using-tls-1">Using TLS</a></li>
1916 </ul>
1917 </li>
1918 <li><a href="#admin-client-configuration-properties">Admin Client Configuration Properties</a>
1919 <ul>
1920 <li><a href="#using-tls-2">Using TLS</a></li>
1921 </ul>
1922 </li>
1923 <li><a href="#common-configuration-properties">Common Configuration Properties</a></li>
1924 </ul>
Hono Bot650d39f2021-02-02 02:17:46 +00001925</nav>
1926 </div>
1927</div>
1928
1929
1930 </div>
1931 </div>
1932
Hono Botbf26a122021-02-10 02:11:36 +00001933 <div id="head-tags">
1934
1935 </div>
Hono Bot650d39f2021-02-02 02:17:46 +00001936
1937 <div id="body-inner">
1938
Hono Botbf26a122021-02-10 02:11:36 +00001939 <h1>
1940
1941 Hono Kafka Client Configuration
1942 </h1>
Hono Bot650d39f2021-02-02 02:17:46 +00001943
1944
1945
1946
1947
Hono Bot650d39f2021-02-02 02:17:46 +00001948<p>Protocol adapters can be configured to use Kafka for the messaging. The Kafka client used there can be configured with
1949environment variables and/or command line options.</p>
Hono Bot650d39f2021-02-02 02:17:46 +00001950<div class="alert alert-notice">
1951 <h4 class="alert-heading"><i class="fas fa-info-circle"></i> Tech preview</h4>
1952 <div>The support of Kafka as a messaging system is currently a preview and not yet ready for production.
1953The implementation as well as it&rsquo;s APIs may change with the next version.</div>
1954</div>
Hono Bot650d39f2021-02-02 02:17:46 +00001955<h2 id="producer-configuration-properties">Producer Configuration Properties</h2>
Hono Bot650d39f2021-02-02 02:17:46 +00001956<p>The <code>org.eclipse.hono.client.kafka.CachingKafkaProducerFactory</code> factory can be used to create Kafka producers for Hono&rsquo;s Kafka based APIs.
1957The producers created by the factory are configured with instances of the class <code>org.eclipse.hono.client.kafka.KafkaProducerConfigProperties</code>
1958which can be used to programmatically configure a producer.</p>
Hono Bot650d39f2021-02-02 02:17:46 +00001959<p>The configuration needs to be provided in the form <code>HONO_KAFKA_PRODUCERCONFIG_${PROPERTY}</code> as an environment variable or
1960as a command line option in the form <code>hono.kafka.producerConfig.${property}</code>, where <code>${PROPERTY}</code> respectively
1961<code>${property}</code> is any of the Kafka client&rsquo;s <a href="https://kafka.apache.org/documentation/#producerconfigs">producer properties</a>.
1962The provided configuration is passed directly to the Kafka producer without Hono parsing or validating it.</p>
Hono Bot650d39f2021-02-02 02:17:46 +00001963<p>The following properties can <em>not</em> be set using this mechanism because the protocol adapters use fixed values instead
1964in order to implement the message delivery semantics defined by Hono&rsquo;s Telemetry and Event APIs.</p>
Hono Bot650d39f2021-02-02 02:17:46 +00001965<table>
1966<thead>
1967<tr>
Hono Botef930712021-04-08 01:12:09 +00001968<th style="text-align:left">Kafka Producer Config Property</th>
1969<th style="text-align:left">Fixed Value</th>
Hono Bot650d39f2021-02-02 02:17:46 +00001970</tr>
1971</thead>
Hono Bot650d39f2021-02-02 02:17:46 +00001972<tbody>
1973<tr>
Hono Botef930712021-04-08 01:12:09 +00001974<td style="text-align:left"><code>key.serializer</code></td>
1975<td style="text-align:left"><code>org.apache.kafka.common.serialization.StringSerializer</code></td>
Hono Bot650d39f2021-02-02 02:17:46 +00001976</tr>
Hono Bot650d39f2021-02-02 02:17:46 +00001977<tr>
Hono Botef930712021-04-08 01:12:09 +00001978<td style="text-align:left"><code>value.serializer</code></td>
1979<td style="text-align:left"><code>io.vertx.kafka.client.serialization.BufferSerializer</code></td>
Hono Bot650d39f2021-02-02 02:17:46 +00001980</tr>
Hono Bot650d39f2021-02-02 02:17:46 +00001981<tr>
Hono Botef930712021-04-08 01:12:09 +00001982<td style="text-align:left"><code>enable.idempotence</code></td>
1983<td style="text-align:left"><code>true</code></td>
Hono Bot650d39f2021-02-02 02:17:46 +00001984</tr>
1985</tbody>
1986</table>
Hono Bot650d39f2021-02-02 02:17:46 +00001987<div class="alert alert-notice">
1988 <h4 class="alert-heading"><i class="fas fa-info-circle"></i> Enable Kafka based Messaging</h4>
1989 <div>The Kafka client requires the property <code>bootstrap.servers</code> to be provided. This variable is the minimal configuration
1990required to enable Kafka based messaging.</div>
1991</div>
Hono Bot650d39f2021-02-02 02:17:46 +00001992<h3 id="using-tls">Using TLS</h3>
Hono Bot650d39f2021-02-02 02:17:46 +00001993<p>The factory can be configured to use TLS for</p>
Hono Bot650d39f2021-02-02 02:17:46 +00001994<ul>
1995<li>authenticating the brokers in the Kafka cluster during connection establishment and</li>
1996<li>(optionally) authenticating to the broker using a client certificate</li>
1997</ul>
Hono Bot650d39f2021-02-02 02:17:46 +00001998<p>To use this, a Kafka Producer configuration as described in
1999<a href="https://kafka.apache.org/documentation/#security_configclients">Kafka documentation - section &ldquo;Security&rdquo;</a> needs to be provided.
2000The properties must be prefixed with <code>HONO_KAFKA_PRODUCERCONFIG_</code> and <code>hono.kafka.producerConfig.</code> respectively as shown in
2001<a href="#producer-configuration-properties">Producer Configuration Properties</a>.
2002The complete reference of available properties and the possible values is available in
2003<a href="https://kafka.apache.org/documentation/#producerconfigs">Kafka documentation - section &ldquo;Producer Configs&rdquo;</a>.</p>
Hono Bot650d39f2021-02-02 02:17:46 +00002004<h2 id="consumer-configuration-properties">Consumer Configuration Properties</h2>
Hono Bot650d39f2021-02-02 02:17:46 +00002005<p>Consumers for Hono&rsquo;s Kafka based APIs are configured with instances of the class <code>org.eclipse.hono.client.kafka.consumer.KafkaConsumerConfigProperties</code>
2006which can be used to programmatically configure a consumer.</p>
Hono Bot650d39f2021-02-02 02:17:46 +00002007<p>The configuration needs to be provided in the form <code>HONO_KAFKA_CONSUMERCONFIG_${PROPERTY}</code> as an environment variable or
2008as a command line option in the form <code>hono.kafka.consumerConfig.${property}</code>, where <code>${PROPERTY}</code> respectively
2009<code>${property}</code> is any of the Kafka client&rsquo;s <a href="https://kafka.apache.org/documentation/#consumerconfigs">consumer properties</a>.
2010The provided configuration is passed directly to the Kafka consumer without Hono parsing or validating it.</p>
Hono Bot650d39f2021-02-02 02:17:46 +00002011<p>The following properties can <em>not</em> be set using this mechanism because the protocol adapters use fixed values instead.</p>
Hono Bot650d39f2021-02-02 02:17:46 +00002012<table>
2013<thead>
2014<tr>
Hono Botef930712021-04-08 01:12:09 +00002015<th style="text-align:left">Kafka Consumer Config Property</th>
2016<th style="text-align:left">Fixed Value</th>
Hono Bot650d39f2021-02-02 02:17:46 +00002017</tr>
2018</thead>
Hono Bot650d39f2021-02-02 02:17:46 +00002019<tbody>
2020<tr>
Hono Botef930712021-04-08 01:12:09 +00002021<td style="text-align:left"><code>key.deserializer</code></td>
2022<td style="text-align:left"><code>org.apache.kafka.common.serialization.StringDeserializer</code></td>
Hono Bot650d39f2021-02-02 02:17:46 +00002023</tr>
Hono Bot650d39f2021-02-02 02:17:46 +00002024<tr>
Hono Botef930712021-04-08 01:12:09 +00002025<td style="text-align:left"><code>value.deserializer</code></td>
2026<td style="text-align:left"><code>io.vertx.kafka.client.serialization.BufferDeserializer</code></td>
Hono Bot650d39f2021-02-02 02:17:46 +00002027</tr>
2028</tbody>
2029</table>
Hono Bot650d39f2021-02-02 02:17:46 +00002030<div class="alert alert-notice">
2031 <h4 class="alert-heading"><i class="fas fa-info-circle"></i> Enable Kafka based Messaging</h4>
2032 <div>The Kafka client requires the property <code>bootstrap.servers</code> to be provided. This variable is the minimal configuration
2033required to enable Kafka based messaging.</div>
2034</div>
Hono Bot650d39f2021-02-02 02:17:46 +00002035<h3 id="using-tls-1">Using TLS</h3>
Hono Bot650d39f2021-02-02 02:17:46 +00002036<p>The factory can be configured to use TLS for</p>
Hono Bot650d39f2021-02-02 02:17:46 +00002037<ul>
2038<li>authenticating the brokers in the Kafka cluster during connection establishment and</li>
2039<li>(optionally) authenticating to the broker using a client certificate</li>
2040</ul>
Hono Bot650d39f2021-02-02 02:17:46 +00002041<p>To use this, a Kafka Consumer configuration as described in
2042<a href="https://kafka.apache.org/documentation/#security_configclients">Kafka documentation - section &ldquo;Security&rdquo;</a> needs to be provided.
2043The properties must be prefixed with <code>HONO_KAFKA_CONSUMERCONFIG_</code> and <code>hono.kafka.consumerConfig.</code> respectively as shown in
2044<a href="#consumer-configuration-properties">Consumer Configuration Properties</a>.
2045The complete reference of available properties and the possible values is available in
2046<a href="https://kafka.apache.org/documentation/#consumerconfigs">Kafka documentation - section &ldquo;Consumer Configs&rdquo;</a>.</p>
Hono Bot650d39f2021-02-02 02:17:46 +00002047<h2 id="admin-client-configuration-properties">Admin Client Configuration Properties</h2>
Hono Bot650d39f2021-02-02 02:17:46 +00002048<p>Admin clients for Hono&rsquo;s Kafka based APIs are configured with instances of the class <code>org.eclipse.hono.client.kafka.KafkaAdminClientConfigProperties</code>
2049which can be used to programmatically configure an admin client.</p>
Hono Bot650d39f2021-02-02 02:17:46 +00002050<p>The configuration needs to be provided in the form <code>HONO_KAFKA_ADMINCLIENTCONFIG_${PROPERTY}</code> as an environment variable or
2051as a command line option in the form <code>hono.kafka.adminClientConfig.${property}</code>, where <code>${PROPERTY}</code> respectively
2052<code>${property}</code> is any of the Kafka client&rsquo;s <a href="https://kafka.apache.org/documentation/#adminclientconfigs">admin client properties</a>.
2053The provided configuration is passed directly to the Kafka admin client without Hono parsing or validating it.</p>
Hono Bot650d39f2021-02-02 02:17:46 +00002054<div class="alert alert-notice">
2055 <h4 class="alert-heading"><i class="fas fa-info-circle"></i> Enable Kafka based Messaging</h4>
2056 <div>The Kafka client requires the property <code>bootstrap.servers</code> to be provided. This variable is the minimal configuration
2057required to enable Kafka based messaging.</div>
2058</div>
Hono Bot650d39f2021-02-02 02:17:46 +00002059<h3 id="using-tls-2">Using TLS</h3>
Hono Bot650d39f2021-02-02 02:17:46 +00002060<p>The factory can be configured to use TLS for</p>
Hono Bot650d39f2021-02-02 02:17:46 +00002061<ul>
2062<li>authenticating the brokers in the Kafka cluster during connection establishment and</li>
2063<li>(optionally) authenticating to the broker using a client certificate</li>
2064</ul>
Hono Bot650d39f2021-02-02 02:17:46 +00002065<p>To use this, a Kafka admin client configuration as described in
2066<a href="https://kafka.apache.org/documentation/#security_configclients">Kafka documentation - section &ldquo;Security&rdquo;</a> needs to be provided.
2067The properties must be prefixed with <code>HONO_KAFKA_ADMINCLIENTCONFIG_</code> and <code>hono.kafka.adminClientConfig.</code> respectively as shown in
2068<a href="#admin-client-configuration-properties">Admin Client Configuration Properties</a>.
2069The complete reference of available properties and the possible values is available in
2070<a href="https://kafka.apache.org/documentation/#adminclientconfigs">Kafka documentation - section &ldquo;Admin Configs&rdquo;</a>.</p>
Hono Bot650d39f2021-02-02 02:17:46 +00002071<h2 id="common-configuration-properties">Common Configuration Properties</h2>
Hono Bot650d39f2021-02-02 02:17:46 +00002072<p>Configuration properties that are common to all the client types described above can be put in a common configuration section.
2073This will avoid having to define duplicate configuration properties for the different client types.</p>
Hono Bot650d39f2021-02-02 02:17:46 +00002074<p>Relevant properties are <code>bootstrap.servers</code> and the properties related to the TLS configuration (see chapters above).</p>
Hono Bot650d39f2021-02-02 02:17:46 +00002075<p>The properties must be prefixed with <code>HONO_KAFKA_COMMONCLIENTCONFIG_</code> and <code>hono.kafka.commonClientConfig.</code> respectively.</p>
Hono Bot650d39f2021-02-02 02:17:46 +00002076<p>A property with the same name defined in the configuration of one of the specific client types above will have precedence
2077over the common property.</p>
2078
2079
Hono Botbf26a122021-02-10 02:11:36 +00002080<footer class="footline">
Hono Bot650d39f2021-02-02 02:17:46 +00002081
2082</footer>
2083
Hono Bot650d39f2021-02-02 02:17:46 +00002084
2085 </div>
2086
2087
2088 </div>
2089
2090 <div id="navigation">
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184 </div>
3185
3186 </section>
3187
3188 <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
3189 <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
3190 </div>
Hono Botd107b6f2021-07-28 01:13:41 +00003191 <script src="/hono/docs/js/clipboard.min.js?1627434791"></script>
3192 <script src="/hono/docs/js/perfect-scrollbar.min.js?1627434791"></script>
3193 <script src="/hono/docs/js/perfect-scrollbar.jquery.min.js?1627434791"></script>
3194 <script src="/hono/docs/js/jquery.sticky.js?1627434791"></script>
3195 <script src="/hono/docs/js/featherlight.min.js?1627434791"></script>
3196 <script src="/hono/docs/js/highlight.pack.js?1627434791"></script>
Hono Bot650d39f2021-02-02 02:17:46 +00003197 <script>hljs.initHighlightingOnLoad();</script>
Hono Botd107b6f2021-07-28 01:13:41 +00003198 <script src="/hono/docs/js/modernizr.custom-3.6.0.js?1627434791"></script>
3199 <script src="/hono/docs/js/learn.js?1627434791"></script>
3200 <script src="/hono/docs/js/hugo-learn.js?1627434791"></script>
Hono Bot650d39f2021-02-02 02:17:46 +00003201
Hono Botd107b6f2021-07-28 01:13:41 +00003202 <link href="/hono/docs/mermaid/mermaid.css?1627434791" rel="stylesheet" />
3203 <script src="/hono/docs/mermaid/mermaid.js?1627434791"></script>
Hono Bot650d39f2021-02-02 02:17:46 +00003204 <script>
3205 mermaid.initialize({ startOnLoad: true });
3206 </script>
3207
3208
3209
3210
Hono Bot650d39f2021-02-02 02:17:46 +00003211<script>
3212 (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
3213 new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
3214 j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
3215 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
3216 })(window,document,'script','dataLayer','GTM-5WLCZXC');
3217</script>
3218
3219
3220<script src="https://www.eclipse.org/eclipse.org-common/themes/solstice/public/javascript/vendor/cookieconsent/default.min.js"></script>
3221
3222 </body>
3223</html>
3224